com.paypal.base.soap
Class MerchantAPICallPreHandler

java.lang.Object
  com.paypal.base.soap.MerchantAPICallPreHandler

All Implemented Interfaces:

APICallPreHandler

public class MerchantAPICallPreHandler
extends Object
implements APICallPreHandler

MerchantAPICallPreHandler is an implementation of APICallPreHandler for Merchant API service. This serves as a decorator over a basic APICallPreHandler

Constructor Summary

MerchantAPICallPreHandler(APICallPreHandler apiCallHandler, ICredential credential)
Deprecated.

MerchantAPICallPreHandler(APICallPreHandler apiCallHandler, ICredential credential, String sdkName, String sdkVersion, String portName, Map<String,String> configurationMap)
MerchantAPICallPreHandler decorating basic APICallPreHandler using ICredential

MerchantAPICallPreHandler(APICallPreHandler apiCallHandler, String apiUserName, String accessToken, String tokenSecret)
Deprecated.

MerchantAPICallPreHandler(APICallPreHandler apiCallHandler, String apiUserName, String accessToken, String tokenSecret, String sdkName, String sdkVersion, String portName, Map<String,String> configurationMap)
MerchantAPICallPreHandler decorating basic APICallPreHandler using API Username

Method Summary

ICredential	getCredential() Returns ICredential configured for the api call
String	getEndPoint() Returns the endpoint for the API call.
Map<String,String>	getHeaderMap() Returns headers for HTTP call
String	getPayLoad() Returns the payload for the API call.
String	getPortName()
String	getSdkName()
String	getSdkVersion()
void	setPortName(String portName) Deprecated.
void	setSdkName(String sdkName) Deprecated.
void	setSdkVersion(String sdkVersion) Deprecated.
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

MerchantAPICallPreHandler

public MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
                                 String apiUserName,
                                 String accessToken,
                                 String tokenSecret)
                          throws InvalidCredentialException,
                                 MissingCredentialException

Deprecated.

MerchantAPICallPreHandler decorating basic APICallPreHandler using API Username

Parameters:

apiCallHandler - Instance of APICallPreHandler

apiUserName - API Username

accessToken - Access Token

tokenSecret - Token Secret

Throws:

InvalidCredentialException

MissingCredentialException

MerchantAPICallPreHandler

public MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
                                 ICredential credential)

Deprecated.

MerchantAPICallPreHandler decorating basic APICallPreHandler using ICredential

Parameters:

apiCallHandler - Instance of APICallPreHandler

credential - Instance of ICredential

MerchantAPICallPreHandler

public MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
                                 ICredential credential,
                                 String sdkName,
                                 String sdkVersion,
                                 String portName,
                                 Map<String,String> configurationMap)

MerchantAPICallPreHandler decorating basic APICallPreHandler using ICredential

Parameters:

apiCallHandler - Instance of APICallPreHandler

credential - Instance of ICredential

sdkName - SDK Name

sdkVersion - sdkVersion

portName - Port Name

configurationMap -

MerchantAPICallPreHandler

public MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
                                 String apiUserName,
                                 String accessToken,
                                 String tokenSecret,
                                 String sdkName,
                                 String sdkVersion,
                                 String portName,
                                 Map<String,String> configurationMap)
                          throws InvalidCredentialException,
                                 MissingCredentialException

MerchantAPICallPreHandler decorating basic APICallPreHandler using API Username

Parameters:

apiCallHandler - Instance of APICallPreHandler

apiUserName - API Username

accessToken - Access Token

tokenSecret - Token Secret

sdkName - SDK Name

sdkVersion - sdkVersion

portName - Port Name

configurationMap -

Throws:

InvalidCredentialException

MissingCredentialException

Method Detail

getSdkName

public String getSdkName()

Returns:

the sdkName

setSdkName

public void setSdkName(String sdkName)

Deprecated.

Parameters:

sdkName - the sdkName to set

getSdkVersion

public String getSdkVersion()

Returns:

the sdkVersion

setSdkVersion

public void setSdkVersion(String sdkVersion)

Deprecated.

Parameters:

sdkVersion - the sdkVersion to set

getPortName

public String getPortName()

Returns:

the portName

setPortName

public void setPortName(String portName)

Deprecated.

Parameters:

portName - the portName to set

getHeaderMap

public Map<String,String> getHeaderMap()
                                throws OAuthException

Description copied from interface: APICallPreHandler

Returns headers for HTTP call

Specified by:

getHeaderMap in interface APICallPreHandler

Returns:

Map of headers with name and value

Throws:

OAuthException

getPayLoad

public 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 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 ICredential getCredential()

Description copied from interface: APICallPreHandler

Returns ICredential 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