com.paypal.base.rest

Class RESTAPICallPreHandler

java.lang.Object

com.paypal.base.rest.RESTAPICallPreHandler

All Implemented Interfaces:

APICallPreHandler

public class RESTAPICallPreHandler
extends java.lang.Object
implements APICallPreHandler

RESTApiCallPreHandler acts as a APICallPreHandler for REST API calls. The implementation is PayPal specific, To do custom implementation override the protected methods

Constructor Summary

Constructors

Constructor and Description
RESTAPICallPreHandler(java.util.Map<java.lang.String,java.lang.String> configurationMap) Constructor using configurations dynamically
RESTAPICallPreHandler(java.util.Map<java.lang.String,java.lang.String> configurationMap, java.util.Map<java.lang.String,java.lang.String> headersMap) Constructor using a Map of headers for forming custom headers

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.String>	formUserAgentHeader() Returns User-Agent header
java.net.URL	getBaseURL() Returns the base URL configured in application resources or Map passed for dynamic configuration
java.util.Map<java.lang.String,java.lang.String>	getConfigurationMap() Return configurationMap
OAuthTokenCredential	getCredential() Returns OAuthTokenCredential configured for the api call
java.lang.String	getEndPoint() Returns the endpoint for the API call.
java.util.Map<java.lang.String,java.lang.String>	getHeaderMap() Returns HTTP headers as a Map
java.lang.String	getPayLoad() Returns the payload for the API call.
protected java.util.Map<java.lang.String,java.lang.String>	getProcessedHeaderMap() Override this method to return a Map of HTTP headers
protected java.lang.String	getProcessedPayLoad() Override this method to process payload for processing
void	setAuthorizationToken(java.lang.String authorizationToken)
void	setPayLoad(java.lang.String payLoad)
void	setRequestId(java.lang.String requestId)
void	setResourcePath(java.lang.String resourcePath)
void	setSdkVersion(SDKVersion sdkVersion)
void	setUrl(java.lang.String urlString)
void	validate() Validates settings and integrity before call

Methods inherited from class java.lang.Object

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

Constructor Detail

RESTAPICallPreHandler

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

Constructor using configurations dynamically

Parameters:

configurationMap - Map used for dynamic configuration

RESTAPICallPreHandler

public RESTAPICallPreHandler(java.util.Map<java.lang.String,java.lang.String> configurationMap,
                             java.util.Map<java.lang.String,java.lang.String> headersMap)

Constructor using a Map of headers for forming custom headers

Parameters:

configurationMap - Map used for dynamic configuration

headersMap - Headers Map

Method Detail

setAuthorizationToken

public void setAuthorizationToken(java.lang.String authorizationToken)

Parameters:

authorizationToken - the authorizationToken to set

setResourcePath

public void setResourcePath(java.lang.String resourcePath)

Parameters:

resourcePath - the resourcePath to set

setRequestId

public void setRequestId(java.lang.String requestId)

Parameters:

requestId - the requestId to set

setPayLoad

public void setPayLoad(java.lang.String payLoad)

Parameters:

payLoad - the payLoad to set

setSdkVersion

public void setSdkVersion(SDKVersion sdkVersion)

Parameters:

sdkVersion - the sdkVersion to set

getHeaderMap

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

Returns HTTP headers as a Map

Specified by:

getHeaderMap in interface APICallPreHandler

Returns:

Map of Http headers

getPayLoad

public java.lang.String getPayLoad()

Description copied from interface: APICallPreHandler

Returns the payload for the API call. The implementation should take care in formatting the payload appropriately

Specified by:

getPayLoad in interface APICallPreHandler

Returns:

Payload as String

getEndPoint

public java.lang.String getEndPoint()

Description copied from interface: APICallPreHandler

Returns the endpoint for the API call. The implementation may calculate the endpoint depending on parameters set on it. If no endpoint is found in the passed configuration, then SANDBOX endpoints (hardcoded in Constants)are taken to be default for the API call.

Specified by:

getEndPoint in interface APICallPreHandler

Returns:

Endpoint String.

getCredential

public OAuthTokenCredential getCredential()

Description copied from interface: APICallPreHandler

Returns OAuthTokenCredential configured for the api call

Specified by:

getCredential in interface APICallPreHandler

Returns:

ICredential object

validate

public void validate()
              throws ClientActionRequiredException

Description copied from interface: APICallPreHandler

Validates settings and integrity before call

Specified by:

validate in interface APICallPreHandler

Throws:

ClientActionRequiredException

getBaseURL

public java.net.URL getBaseURL()
                        throws java.net.MalformedURLException

Returns the base URL configured in application resources or Map passed for dynamic configuration

Returns:

BaseUrl ending with a '/' character URL

Throws:

java.net.MalformedURLException - if endpoint cannot be found or formed

setUrl

public void setUrl(java.lang.String urlString)
            throws java.net.MalformedURLException

Parameters:

urlString - the url to set

Throws:

java.net.MalformedURLException

formUserAgentHeader

protected java.util.Map<java.lang.String,java.lang.String> formUserAgentHeader()

Returns User-Agent header

Returns:

Map storing the User-Agent header

getProcessedHeaderMap

protected java.util.Map<java.lang.String,java.lang.String> getProcessedHeaderMap()

Override this method to return a Map of HTTP headers

Returns:

Map of HTTP headers

getProcessedPayLoad

protected java.lang.String getProcessedPayLoad()

Override this method to process payload for processing

Returns:

PayLoad as String

getConfigurationMap

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

Return configurationMap

Specified by:

getConfigurationMap in interface APICallPreHandler

Returns:

configurationMap in this call pre-handler