com.paypal.base

Interface APICallPreHandler

All Known Implementing Classes:

RESTAPICallPreHandler

public interface APICallPreHandler

APICallPreHandler defines a high level abstraction for call specific operations. PayPal REST API is provided by RESTAPICallPreHandler

Method Summary

Modifier and Type	Method and Description
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 headers for HTTP call
java.lang.String	getPayLoad() Returns the payload for the API call.
void	validate() Validates settings and integrity before call

Method Detail

getHeaderMap

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

Returns headers for HTTP call

Returns:

Map of headers with name and value

Throws:

OAuthException

getPayLoad

java.lang.String getPayLoad()

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

Returns:

Payload as String

getEndPoint

java.lang.String getEndPoint()

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.

Returns:

Endpoint String.

getCredential

OAuthTokenCredential getCredential()

Returns OAuthTokenCredential configured for the api call

Returns:

ICredential object

validate

void validate()
       throws ClientActionRequiredException

Validates settings and integrity before call

Throws:

ClientActionRequiredException

getConfigurationMap

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

Return configurationMap

Returns:

configurationMap in this call pre-handler