com.paypal.sdk.authentication

Class ClientCredentialsAuthManager

java.lang.Object

io.apimatic.coreinterfaces.authentication.Authentication

io.apimatic.core.authentication.AuthCredential

io.apimatic.core.authentication.HeaderAuth

com.paypal.sdk.authentication.ClientCredentialsAuthManager

All Implemented Interfaces:

ClientCredentialsAuth

public class ClientCredentialsAuthManager
extends io.apimatic.core.authentication.HeaderAuth
implements ClientCredentialsAuth

Utility class for OAuth 2 authorization and token management.

Constructor Summary

Constructors

Constructor and Description
ClientCredentialsAuthManager(ClientCredentialsAuthModel authModel) Constructor.

Method Summary

Modifier and Type	Method and Description
io.apimatic.coreinterfaces.http.request.Request	apply(io.apimatic.coreinterfaces.http.request.Request httpRequest) Apply the Header authentication.
void	applyGlobalConfiguration(io.apimatic.core.GlobalConfiguration config) Apply GlobalConfiguration for token management.
boolean	equals(String oAuthClientId, String oAuthClientSecret, OAuthToken oAuthToken) Checks if provided credentials matched with existing ones.
OAuthToken	fetchToken() Fetch the OAuth token.
OAuthToken	fetchToken(Map<String,Object> additionalParameters) Fetch the OAuth token.
CompletableFuture<OAuthToken>	fetchTokenAsync() Fetch the OAuth token asynchronously.
CompletableFuture<OAuthToken>	fetchTokenAsync(Map<String,Object> additionalParameters) Fetch the OAuth token asynchronously.
String	getErrorMessage() Returns the error message if the auth credentials are not valid.
String	getOAuthClientId() String value for oAuthClientId.
String	getOAuthClientSecret() String value for oAuthClientSecret.
OAuthToken	getOAuthToken() OAuthToken value for oAuthToken.
boolean	isTokenExpired() Has the OAuth token expired?.
boolean	isTokenExpired(OAuthToken oAuthToken) A utility to check the expiry of the OAuth Token.
String	toString() Converts this ClientCredentialsAuthManager into string format.
void	validate() Validate the authentication on the httpRequest

Methods inherited from class io.apimatic.core.authentication.AuthCredential

getAuthParams

Methods inherited from class io.apimatic.coreinterfaces.authentication.Authentication

isValid, setErrorMessage, setValidity

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientCredentialsAuthManager

public ClientCredentialsAuthManager(ClientCredentialsAuthModel authModel)

Constructor.

Method Detail

applyGlobalConfiguration

public void applyGlobalConfiguration(io.apimatic.core.GlobalConfiguration config)

Apply GlobalConfiguration for token management.

Parameters:

config - GlobalConfiguration instance

getOAuthClientId

public String getOAuthClientId()

String value for oAuthClientId.

Specified by:

getOAuthClientId in interface ClientCredentialsAuth

Returns:

oAuthClientId

getOAuthClientSecret

public String getOAuthClientSecret()

String value for oAuthClientSecret.

Specified by:

getOAuthClientSecret in interface ClientCredentialsAuth

Returns:

oAuthClientSecret

getOAuthToken

public OAuthToken getOAuthToken()

OAuthToken value for oAuthToken.

Specified by:

getOAuthToken in interface ClientCredentialsAuth

Returns:

oAuthToken

equals

public boolean equals(String oAuthClientId,
                      String oAuthClientSecret,
                      OAuthToken oAuthToken)

Checks if provided credentials matched with existing ones.

Specified by:

equals in interface ClientCredentialsAuth

Parameters:

oAuthClientId - String value for credentials.

oAuthClientSecret - String value for credentials.

oAuthToken - OAuthToken value for credentials.

Returns:

true if credentials matched.

toString

public String toString()

Converts this ClientCredentialsAuthManager into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

fetchTokenAsync

public CompletableFuture<OAuthToken> fetchTokenAsync(Map<String,Object> additionalParameters)

Fetch the OAuth token asynchronously.

Specified by:

fetchTokenAsync in interface ClientCredentialsAuth

Parameters:

additionalParameters - Additional parameters to send during authorization.

fetchTokenAsync

public CompletableFuture<OAuthToken> fetchTokenAsync()

Fetch the OAuth token asynchronously.

Specified by:

fetchTokenAsync in interface ClientCredentialsAuth

fetchToken

public OAuthToken fetchToken(Map<String,Object> additionalParameters)
                      throws ApiException,
                             IOException

Fetch the OAuth token.

Specified by:

fetchToken in interface ClientCredentialsAuth

Parameters:

additionalParameters - Additional parameters to send during authorization.

Throws:

ApiException

IOException

fetchToken

public OAuthToken fetchToken()
                      throws ApiException,
                             IOException

Fetch the OAuth token.

Specified by:

fetchToken in interface ClientCredentialsAuth

Throws:

ApiException

IOException

isTokenExpired

public boolean isTokenExpired()

Has the OAuth token expired?.

Specified by:

isTokenExpired in interface ClientCredentialsAuth

Returns:

True if expired

isTokenExpired

public boolean isTokenExpired(OAuthToken oAuthToken)

A utility to check the expiry of the OAuth Token.

Specified by:

isTokenExpired in interface ClientCredentialsAuth

Parameters:

oAuthToken - The OAuth token for whose expiry is to check.

Returns:

True if expired

validate

public void validate()

Validate the authentication on the httpRequest

Overrides:

validate in class io.apimatic.core.authentication.AuthCredential

apply

public io.apimatic.coreinterfaces.http.request.Request apply(io.apimatic.coreinterfaces.http.request.Request httpRequest)

Apply the Header authentication.

Overrides:

apply in class io.apimatic.core.authentication.HeaderAuth

Parameters:

httpRequest - The HTTP request on which the auth is to be applied.

Returns:

Request The HTTP request after applying auth.

getErrorMessage

public String getErrorMessage()

Returns the error message if the auth credentials are not valid.

Overrides:

getErrorMessage in class io.apimatic.coreinterfaces.authentication.Authentication

Returns:

the auth specific error message.