com.paypal.sdk

Interface ClientCredentialsAuth

All Known Implementing Classes:

ClientCredentialsAuthManager

public interface ClientCredentialsAuth

Interface for Client Credentials OAuth 2.

Method Summary

Modifier and Type	Method and Description
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	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) Has the OAuth token expired?.

Method Detail

getOAuthClientId

String getOAuthClientId()

String value for oAuthClientId.

Returns:

oAuthClientId

getOAuthClientSecret

String getOAuthClientSecret()

String value for oAuthClientSecret.

Returns:

oAuthClientSecret

getOAuthToken

OAuthToken getOAuthToken()

OAuthToken value for oAuthToken.

Returns:

oAuthToken

equals

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

Checks if provided credentials matched with existing ones.

Parameters:

oAuthClientId - String value for credentials.

oAuthClientSecret - String value for credentials.

oAuthToken - OAuthToken value for credentials.

Returns:

true if credentials matched.

fetchTokenAsync

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

Fetch the OAuth token asynchronously.

Parameters:

additionalParameters - Additional parameters to send during authorization.

fetchTokenAsync

CompletableFuture<OAuthToken> fetchTokenAsync()

Fetch the OAuth token asynchronously.

fetchToken

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

Fetch the OAuth token.

Parameters:

additionalParameters - Additional parameters to send during authorization.

Throws:

ApiException

IOException

fetchToken

OAuthToken fetchToken()
               throws ApiException,
                      IOException

Fetch the OAuth token.

Throws:

ApiException

IOException

isTokenExpired

boolean isTokenExpired()

Has the OAuth token expired?.

Returns:

True if expired

isTokenExpired

boolean isTokenExpired(OAuthToken oAuthToken)

Has the OAuth token expired?.

Returns:

True if expired