com.paypal.base.rest

Class OAuthTokenCredential

java.lang.Object

com.paypal.base.rest.OAuthTokenCredential

public final class OAuthTokenCredential
extends java.lang.Object

OAuthTokenCredential is used for generation of OAuth Token used by PayPal REST API service. ClientID and ClientSecret are required by the class to generate OAuth Token, the resulting token is of the form "Bearer xxxxxx". The class has two constructors, one of it taking an additional configuration map used for dynamic configuration. When using the constructor with out configuration map the endpoint is fetched from the configuration that is used during initialization. See PayPalResource for configuring the system. When using a configuration map the class expects an entry by the name "oauth.EndPoint" or "service.EndPoint" to retrieve the value of the endpoint for the OAuth Service. If either are not present the configuration should have a entry by the name "mode" with values sandbox or live wherein the corresponding endpoints are default to PayPal endpoints.

Constructor Summary

Constructors

Constructor and Description
OAuthTokenCredential(java.lang.String clientID, java.lang.String clientSecret) Pass clientId and secret to OAuthTokenCredential.
OAuthTokenCredential(java.lang.String clientID, java.lang.String clientSecret, java.util.Map<java.lang.String,java.lang.String> configurationMap) Configuration Constructor for dynamic configuration

Method Summary

Modifier and Type	Method and Description
OAuthTokenCredential	addConfiguration(java.lang.String key, java.lang.String value) Adds configuration to list of configurations.
OAuthTokenCredential	addConfigurations(java.util.Map<java.lang.String,java.lang.String> configurations) Adds configurations to list of configurations.
OAuthTokenCredential	addHeader(java.lang.String key, java.lang.String value) Adds header to existing list of headers.
OAuthTokenCredential	addHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Adds headers.
long	expiresIn() Specifies how long this token can be used for placing API calls.
java.lang.String	getAccessToken() Computes Access Token by placing a call to OAuth server using ClientID and ClientSecret.
java.lang.String	getAuthorizationHeader() Computes Access Token by doing a Base64 encoding on the ClientID and ClientSecret.
java.lang.String	getClientID() Returns clientID
java.lang.String	getClientSecret() Returns clientSecret
java.lang.String	getConfiguration(java.lang.String key) Returns specific configuration.
java.util.Map<java.lang.String,java.lang.String>	getConfigurations() Returns list of configurations.
java.lang.String	getHeader(java.lang.String key) Returns the header value
java.util.Map<java.lang.String,java.lang.String>	getHeaders() Returns the list of headers
protected java.lang.String	getRequestPayload() Returns the request payload for OAuth Service.
boolean	hasCredentials() Checks if clientID and secret are set.
OAuthTokenCredential	setConfigurations(java.util.Map<java.lang.String,java.lang.String> configurations) Replaces existing configurations with provided map of configurations.
OAuthTokenCredential	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers) Sets Headers for every calls.
static void	setOAUTH_TOKEN_PATH(java.lang.String oauthTokenPath) Sets the URI path for the OAuth Token service.

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthTokenCredential

public OAuthTokenCredential(java.lang.String clientID,
                            java.lang.String clientSecret)

Pass clientId and secret to OAuthTokenCredential.

Parameters:

clientID - Client ID for the OAuth

clientSecret - Client Secret for OAuth

OAuthTokenCredential

public OAuthTokenCredential(java.lang.String clientID,
                            java.lang.String clientSecret,
                            java.util.Map<java.lang.String,java.lang.String> configurationMap)

Configuration Constructor for dynamic configuration

Parameters:

clientID - Client ID for the OAuth

clientSecret - Client Secret for OAuth

configurationMap - Dynamic configuration map which should have an entry for 'oauth.EndPoint' or 'service.EndPoint'. If either are not present then there should be entry for 'mode' with values sandbox/live, wherein PayPals endpoints are used.

Method Detail

setOAUTH_TOKEN_PATH

public static void setOAUTH_TOKEN_PATH(java.lang.String oauthTokenPath)

Sets the URI path for the OAuth Token service. If not set it defaults to "/v1/oauth2/token"

Parameters:

oauthTokenPath - the URI part to set

hasCredentials

public boolean hasCredentials()

Checks if clientID and secret are set.

Returns:

Boolean

setHeaders

public OAuthTokenCredential setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Sets Headers for every calls.

Parameters:

headers -

Returns:

OAuthTokenCredential

addHeaders

public OAuthTokenCredential addHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

Adds headers.

Parameters:

headers -

Returns:

OAuthTokenCredential

addHeader

public OAuthTokenCredential addHeader(java.lang.String key,
                                      java.lang.String value)

Adds header to existing list of headers.

Parameters:

key -

value -

Returns:

OAuthTokenCredential

getHeaders

public java.util.Map<java.lang.String,java.lang.String> getHeaders()

Returns the list of headers

Returns:

Map of headers

getHeader

public java.lang.String getHeader(java.lang.String key)

Returns the header value

Returns:

String value of header

getAccessToken

public java.lang.String getAccessToken()
                                throws PayPalRESTException

Computes Access Token by placing a call to OAuth server using ClientID and ClientSecret. The token is appended to the token type (Bearer).

Returns:

the accessToken

Throws:

PayPalRESTException

getAuthorizationHeader

public java.lang.String getAuthorizationHeader()
                                        throws PayPalRESTException

Computes Access Token by doing a Base64 encoding on the ClientID and ClientSecret. The token is appended to the String "Basic ".

Returns:

the accessToken

Throws:

PayPalRESTException

getClientID

public java.lang.String getClientID()

Returns clientID

Returns:

String containing clientID

getClientSecret

public java.lang.String getClientSecret()

Returns clientSecret

Returns:

String containing clientSecret

expiresIn

public long expiresIn()

Specifies how long this token can be used for placing API calls. The remaining lifetime is given in seconds.

Returns:

remaining lifetime of this access token in seconds

addConfiguration

public OAuthTokenCredential addConfiguration(java.lang.String key,
                                             java.lang.String value)

Adds configuration to list of configurations.

Parameters:

key -

value -

Returns:

OAuthTokenCredential

addConfigurations

public OAuthTokenCredential addConfigurations(java.util.Map<java.lang.String,java.lang.String> configurations)

Adds configurations to list of configurations.

Parameters:

configurations -

Returns:

OAuthTokenCredential

setConfigurations

public OAuthTokenCredential setConfigurations(java.util.Map<java.lang.String,java.lang.String> configurations)

Replaces existing configurations with provided map of configurations.

Parameters:

configurations -

Returns:

OAuthTokenCredential

getConfigurations

public java.util.Map<java.lang.String,java.lang.String> getConfigurations()

Returns list of configurations.

Returns:

Map of configurations

getConfiguration

public java.lang.String getConfiguration(java.lang.String key)

Returns specific configuration.

Parameters:

key -

Returns:

String value of configuration

getRequestPayload

protected java.lang.String getRequestPayload()

Returns the request payload for OAuth Service. Override this method to alter the payload

Returns:

Payload as String