com.paypal.base.rest

Class APIContext

java.lang.Object

com.paypal.base.rest.APIContext

public class APIContext
extends java.lang.Object

APIContext wraps wire-level parameters for the API call. AccessToken, which is essentially an OAuth token, is treated as a mandatory parameter for (PayPal REST APIs). RequestId is generated if not supplied for marking Idempotency of the API call. OAuth token can be generated using OAuthTokenCredential. The Application Header property may be used by clients to access application level headers. The clients are responsible to cast the Application Header property to appropriate type.

Constructor Summary

Constructors

Constructor and Description
APIContext() Deprecated. Please use APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods: APIContext context = new APIContext(clientId, clientSecret, "sandbox");
APIContext(java.lang.String accessToken) Deprecated. Please use APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods: APIContext context = new APIContext(clientId, clientSecret, "sandbox");
APIContext(java.lang.String accessToken, java.lang.String requestId) Deprecated. Please use APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods: APIContext context = new APIContext(clientId, clientSecret, "sandbox");
APIContext(java.lang.String clientID, java.lang.String clientSecret, java.lang.String mode) Pass the clientID, secret and mode.
APIContext(java.lang.String clientID, java.lang.String clientSecret, java.lang.String mode, java.util.Map<java.lang.String,java.lang.String> configurations) Pass the clientID, secret and mode along with additional configurations.

Method Summary

Modifier and Type	Method and Description
APIContext	addConfiguration(java.lang.String key, java.lang.String value) Adds configuration
APIContext	addConfigurations(java.util.Map<java.lang.String,java.lang.String> configurations) Adds configurations
APIContext	addHTTPHeader(java.lang.String key, java.lang.String value) Adds HTTP Header to existing list
APIContext	addHTTPHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders) Adds HTTP Headers to existing list
java.lang.String	fetchAccessToken() Returns the access Token.
java.lang.String	getAccessToken() Deprecated. Please use fetchAccessToken() instead. Previously, this was a dumb getter method. However, we enabled the feature to re-generate the access Token if null, or expired. This required us to throw proper PayPalRESTException, with error information on failure.
java.lang.String	getClientID()
java.lang.String	getClientSecret()
java.lang.String	getConfiguration(java.lang.String key) Returns string value of specific configuration.
java.util.Map<java.lang.String,java.lang.String>	getConfigurationMap() Returns Configuration Map
java.util.Map<java.lang.String,java.lang.String>	getHeadersMap() Deprecated. Use getHTTPHeaders() instead
java.lang.String	getHTTPHeader(java.lang.String key)
java.util.Map<java.lang.String,java.lang.String>	getHTTPHeaders() Returns HTTP Headers.
java.lang.String	getRequestId() Returns the unique requestId set during creation, if not available and if maskRequestId is set to false returns a generated one, else returns null.
SDKVersion	getSdkVersion()
APIContext	setConfigurationMap(java.util.Map<java.lang.String,java.lang.String> configurationMap) Replaces the existing configurations with provided one
void	setHeadersMap(java.util.Map<java.lang.String,java.lang.String> headersMap) Deprecated. Please use setHTTPHeaders(Map) or addHTTPHeaders(Map) instead.
APIContext	setHTTPHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders) Replaces existing headers with provided one.
void	setMaskRequestId(boolean maskRequestId)
APIContext	setMode(java.lang.String mode) Sets mode to either `live` or `sandbox`.
APIContext	setRefreshToken(java.lang.String refreshToken) Sets refresh token to be used for third party OAuth operations.
APIContext	setRequestId(java.lang.String requestId) Sets the requestId to be sent on each request.
void	setSdkVersion(SDKVersion sdkVersion)
APIContext	usingGoogleAppEngine(boolean usingGoogleAppEngine) Enables settings for Google App Engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

APIContext

public APIContext()

Deprecated. Please use APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods:

 
 APIContext context = new APIContext(clientId, clientSecret, "sandbox");
 
 

Default Constructor

APIContext

public APIContext(java.lang.String clientID,
                  java.lang.String clientSecret,
                  java.lang.String mode)

Pass the clientID, secret and mode. The easiest, and most widely used option.

Parameters:

clientID -

clientSecret -

mode -

APIContext

public APIContext(java.lang.String clientID,
                  java.lang.String clientSecret,
                  java.lang.String mode,
                  java.util.Map<java.lang.String,java.lang.String> configurations)

Pass the clientID, secret and mode along with additional configurations.

Parameters:

clientID -

clientSecret -

mode -

configurations -

APIContext

public APIContext(java.lang.String accessToken)

Deprecated. Please use APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods:

 
 APIContext context = new APIContext(clientId, clientSecret, "sandbox");
 
 

Parameters:

accessToken - OAuthToken required for the call. OAuth token used by the REST API service. The token should be of the form 'Bearer xxxx..'. See OAuthTokenCredential to generate OAuthToken

APIContext

public APIContext(java.lang.String accessToken,
                  java.lang.String requestId)

Deprecated. Please use APIContext(String, String, String) instead. APIContext ideally needs more information than just accessToken to operate correctly. Now, you do not need to fetch accessToken from OAuthTokenCredential separately. Instead, just initialize APIContext with clientId, clientSecret and mode, with optional configurations, as shown below, and pass the context to paypal API methods:

 
 APIContext context = new APIContext(clientId, clientSecret, "sandbox");
 
 

Parameters:

accessToken - OAuthToken required for the call. OAuth token used by the REST API service. The token should be of the form 'Bearer xxxx..'. See OAuthTokenCredential to generate OAuthToken

requestId - Unique requestId required for the call. Idempotency id, Calling setMaskRequestId(true) will override the requestId getter to return null, which can be used by the client (null check) to forcibly not sent requestId in the API call.

Method Detail

setRefreshToken

public APIContext setRefreshToken(java.lang.String refreshToken)

Sets refresh token to be used for third party OAuth operations. This is commonly used for third party invoicing and future payments.

Parameters:

refreshToken -

Returns:

APIContext

setMode

public APIContext setMode(java.lang.String mode)

Sets mode to either `live` or `sandbox`.

Parameters:

mode -

Returns:

APIContext

usingGoogleAppEngine

public APIContext usingGoogleAppEngine(boolean usingGoogleAppEngine)

Enables settings for Google App Engine. Please set to `true` if using SDK in Google App Engine.

Parameters:

usingGoogleAppEngine -

Returns:

APIContext

getHTTPHeaders

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

Returns HTTP Headers.

Returns:

the hTTPHeaders

getHTTPHeader

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

setHTTPHeaders

public APIContext setHTTPHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders)

Replaces existing headers with provided one.

Parameters:

httpHeaders - the httpHeaders to set

addHTTPHeaders

public APIContext addHTTPHeaders(java.util.Map<java.lang.String,java.lang.String> httpHeaders)

Adds HTTP Headers to existing list

Parameters:

httpHeaders - the httpHeaders to set

addHTTPHeader

public APIContext addHTTPHeader(java.lang.String key,
                                java.lang.String value)

Adds HTTP Header to existing list

Parameters:

key -

value -

getConfigurationMap

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

Returns Configuration Map

Returns:

Map of configurations

setConfigurationMap

public APIContext setConfigurationMap(java.util.Map<java.lang.String,java.lang.String> configurationMap)

Replaces the existing configurations with provided one

Parameters:

configurationMap - the configurationMap to set

Returns:

APIContext

addConfigurations

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

Adds configurations

Parameters:

configurations - Map of configurations.

Returns:

APIContext

addConfiguration

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

Adds configuration

Parameters:

key - key

value - value

Returns:

APIContext

getConfiguration

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

Returns string value of specific configuration.

Parameters:

key - key

Returns:

String value of specific configuration.

getAccessToken

public java.lang.String getAccessToken()

Deprecated. Please use fetchAccessToken() instead. Previously, this was a dumb getter method. However, we enabled the feature to re-generate the access Token if null, or expired. This required us to throw proper PayPalRESTException, with error information on failure.

Returns:

Access Token

fetchAccessToken

public java.lang.String fetchAccessToken()
                                  throws PayPalRESTException

Returns the access Token. Regenerates if null or expired.

Returns:

String of AccessToken

Throws:

PayPalRESTException

getRequestId

public java.lang.String getRequestId()

Returns the unique requestId set during creation, if not available and if maskRequestId is set to false returns a generated one, else returns null.

Returns:

requestId

setRequestId

public APIContext setRequestId(java.lang.String requestId)

Sets the requestId to be sent on each request. Used for idempotency purposes. requestId is auto generated if not passed explicitly.

Parameters:

requestId - request Id

Returns:

APIContext

setMaskRequestId

public void setMaskRequestId(boolean maskRequestId)

Parameters:

maskRequestId - the maskRequestId to set

getSdkVersion

public SDKVersion getSdkVersion()

Returns:

the sdkVersion

setSdkVersion

public void setSdkVersion(SDKVersion sdkVersion)

Parameters:

sdkVersion - the sdkVersion to set

getHeadersMap

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

Deprecated. Use getHTTPHeaders() instead

Returns:

the headersMap

setHeadersMap

public void setHeadersMap(java.util.Map<java.lang.String,java.lang.String> headersMap)

Deprecated. Please use setHTTPHeaders(Map) or addHTTPHeaders(Map) instead.

Parameters:

headersMap - the headersMap to set

getClientID

public java.lang.String getClientID()

getClientSecret

public java.lang.String getClientSecret()