Package overit.geocallapp.wfm.orchestrator.planning.utilities.rest.authentication.strategies

Class ApiTokenAuthentication

java.lang.Object

overit.geocallapp.wfm.orchestrator.planning.utilities.rest.authentication.strategies.ApiTokenAuthentication

All Implemented Interfaces:

AuthenticationStrategy

public class ApiTokenAuthentication
extends Object
implements AuthenticationStrategy

Authentication strategy that uses a static API token. This strategy is suitable for APIs that use a fixed token for authentication.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final LogChannel	LOG

Constructor Summary

Constructors

Constructor	Description
ApiTokenAuthentication(String token)	Creates a new API token authentication with the specified token and "Bearer" prefix.
ApiTokenAuthentication(String token, String prefix)	Creates a new API token authentication with the specified token and prefix.

Method Summary

Modifier and Type	Method	Description
void	applyAuthentication(org.springframework.http.HttpHeaders headers)	Applies authentication information to the provided HTTP headers.
boolean	isValid()	Checks if the current authentication is valid.
void	refreshAuthentication()	Refreshes the authentication if needed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG

protected static final LogChannel LOG

Constructor Details

ApiTokenAuthentication

public ApiTokenAuthentication(String token)

Creates a new API token authentication with the specified token and "Bearer" prefix.

Parameters:

token - The API token to use for authentication

ApiTokenAuthentication

public ApiTokenAuthentication(String token,
 String prefix)

Creates a new API token authentication with the specified token and prefix.

Parameters:

token - The API token to use for authentication

prefix - The prefix to use before the token (e.g., "Bearer", "Token", "ApiKey")

Method Details

applyAuthentication

public void applyAuthentication(org.springframework.http.HttpHeaders headers)
                         throws DAValidateException

Description copied from interface: AuthenticationStrategy

Applies authentication information to the provided HTTP headers.

Specified by:

applyAuthentication in interface AuthenticationStrategy

Parameters:

headers - The HTTP headers to which authentication information should be added

Throws:

DAValidateException - if authentication fails

isValid

public boolean isValid()

Description copied from interface: AuthenticationStrategy

Checks if the current authentication is valid.

Specified by:

isValid in interface AuthenticationStrategy

Returns:

true if the authentication is valid, false otherwise

refreshAuthentication

public void refreshAuthentication()
                           throws DAValidateException

Description copied from interface: AuthenticationStrategy

Refreshes the authentication if needed. This method should be called before using the authentication if isValid() returns false.

Specified by:

refreshAuthentication in interface AuthenticationStrategy

Throws:

DAValidateException - if authentication refresh fails