com.paypal.core.soap.MerchantAPICallPreHandler Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of paypal-core Show documentation
Show all versions of paypal-core Show documentation
PayPal Java SDK Core library base and common to PayPal SDKs. The paypal-core library is a dependency for all PayPal related Java SDKs
package com.paypal.core.soap;
import java.text.MessageFormat;
import java.util.HashMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import com.paypal.core.APICallPreHandler;
import com.paypal.core.Constants;
import com.paypal.core.CredentialManager;
import com.paypal.core.credential.CertificateCredential;
import com.paypal.core.credential.ICredential;
import com.paypal.core.credential.SignatureCredential;
import com.paypal.core.credential.ThirdPartyAuthorization;
import com.paypal.core.credential.TokenAuthorization;
import com.paypal.exception.ClientActionRequiredException;
import com.paypal.exception.InvalidCredentialException;
import com.paypal.exception.MissingCredentialException;
import com.paypal.sdk.exceptions.OAuthException;
/**
* MerchantAPICallPreHandler is an implementation of
* {@link APICallPreHandler} for Merchant API service. This serves as a
* decorator over a basic {@link APICallPreHandler}
*
*/
public class MerchantAPICallPreHandler implements APICallPreHandler {
/**
* Pattern for Message Formatting
*/
private static final Pattern REGEX_PATTERN = Pattern.compile("(['])");
/**
* API Username for authentication
*/
private String apiUserName;
/**
* {@link ICredential} for authentication
*/
private ICredential credential;
/**
* Access token if any for authorization
*/
private String accessToken;
/**
* TokenSecret if any for authorization
*/
private String tokenSecret;
/**
* {@link APICallPreHandler} instance
*/
private APICallPreHandler apiCallHandler;
/**
* SDK Name used in tracking
*/
private String sdkName;
/**
* SDK Version
*/
private String sdkVersion;
/**
* PortName to which a particular operation is bound;
*/
private String portName;
/**
* Internal variable to hold headers
*/
private Map headers;
/**
* Internal variable to hold payload
*/
private String payLoad;
/**
* Map used for to override ConfigManager configurations
*/
private Map configurationMap = null;
/**
* Private Constructor
*
* @deprecated
*/
private MerchantAPICallPreHandler(APICallPreHandler apiCallHandler) {
super();
this.apiCallHandler = apiCallHandler;
}
/**
* Private Constructor
*/
private MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
Map configurationMap) {
super();
this.apiCallHandler = apiCallHandler;
this.configurationMap = configurationMap;
}
/**
* MerchantAPICallPreHandler decorating basic {@link APICallPreHandler}
* using API Username
*
* @deprecated
* @param apiCallHandler
* Instance of {@link APICallPreHandler}
* @param apiUserName
* API Username
* @param accessToken
* Access Token
* @param tokenSecret
* Token Secret
* @throws InvalidCredentialException
* @throws MissingCredentialException
*/
public MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
String apiUserName, String accessToken, String tokenSecret)
throws InvalidCredentialException, MissingCredentialException {
this(apiCallHandler);
this.apiUserName = apiUserName;
this.accessToken = accessToken;
this.tokenSecret = tokenSecret;
initCredential();
}
/**
* MerchantAPICallPreHandler decorating basic {@link APICallPreHandler}
* using {@link ICredential}
*
* @deprecated
*
* @param apiCallHandler
* Instance of {@link APICallPreHandler}
* @param credential
* Instance of {@link ICredential}
*/
public MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
ICredential credential) {
this(apiCallHandler);
if (credential == null) {
throw new IllegalArgumentException(
"Credential is null in MerchantAPICallPreHandler");
}
this.credential = credential;
}
/**
* MerchantAPICallPreHandler decorating basic {@link APICallPreHandler}
* using {@link ICredential}
*
* @param apiCallHandler
* Instance of {@link APICallPreHandler}
* @param credential
* Instance of {@link ICredential}
* @param sdkName
* SDK Name
* @param sdkVersion
* sdkVersion
* @param portName
* Port Name
* @param configurationMap
*/
public MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
ICredential credential, String sdkName, String sdkVersion,
String portName, Map configurationMap) {
this(apiCallHandler, configurationMap);
this.sdkName = sdkName;
this.sdkVersion = sdkVersion;
this.portName = portName;
if (credential == null) {
throw new IllegalArgumentException(
"Credential is null in MerchantAPICallPreHandler");
}
this.credential = credential;
}
/**
* MerchantAPICallPreHandler decorating basic {@link APICallPreHandler}
* using API Username
*
* @param apiCallHandler
* Instance of {@link APICallPreHandler}
* @param apiUserName
* API Username
* @param accessToken
* Access Token
* @param tokenSecret
* Token Secret
* @param sdkName
* SDK Name
* @param sdkVersion
* sdkVersion
* @param portName
* Port Name
* @param configurationMap
* @throws InvalidCredentialException
* @throws MissingCredentialException
*/
public MerchantAPICallPreHandler(APICallPreHandler apiCallHandler,
String apiUserName, String accessToken, String tokenSecret,
String sdkName, String sdkVersion, String portName,
Map configurationMap)
throws InvalidCredentialException, MissingCredentialException {
this(apiCallHandler, configurationMap);
this.apiUserName = apiUserName;
this.accessToken = accessToken;
this.tokenSecret = tokenSecret;
this.sdkName = sdkName;
this.sdkVersion = sdkVersion;
this.portName = portName;
initCredential();
}
/**
* @return the sdkName
*/
public String getSdkName() {
return sdkName;
}
/**
* @deprecated
* @param sdkName
* the sdkName to set
*/
public void setSdkName(String sdkName) {
this.sdkName = sdkName;
}
/**
* @return the sdkVersion
*/
public String getSdkVersion() {
return sdkVersion;
}
/**
* @deprecated
* @param sdkVersion
* the sdkVersion to set
*/
public void setSdkVersion(String sdkVersion) {
this.sdkVersion = sdkVersion;
}
/**
* @return the portName
*/
public String getPortName() {
return portName;
}
/**
* @deprecated
* @param portName
* the portName to set
*/
public void setPortName(String portName) {
this.portName = portName;
}
public Map getHeaderMap() throws OAuthException {
if (headers == null) {
headers = apiCallHandler.getHeaderMap();
if (credential instanceof SignatureCredential) {
SignatureHttpHeaderAuthStrategy signatureHttpHeaderAuthStrategy = new SignatureHttpHeaderAuthStrategy(
getEndPoint());
headers = signatureHttpHeaderAuthStrategy
.generateHeaderStrategy((SignatureCredential) credential);
} else if (credential instanceof CertificateCredential) {
CertificateHttpHeaderAuthStrategy certificateHttpHeaderAuthStrategy = new CertificateHttpHeaderAuthStrategy(
getEndPoint());
headers = certificateHttpHeaderAuthStrategy
.generateHeaderStrategy((CertificateCredential) credential);
}
headers.putAll(getDefaultHttpHeadersSOAP());
}
return headers;
}
public String getPayLoad() {
// This method appends SOAP Headers to payload
// if the credentials mandate soap headers
if (payLoad == null) {
payLoad = apiCallHandler.getPayLoad();
String header = null;
if (credential instanceof SignatureCredential) {
SignatureCredential sigCredential = (SignatureCredential) credential;
SignatureSOAPHeaderAuthStrategy signatureSoapHeaderAuthStrategy = new SignatureSOAPHeaderAuthStrategy();
signatureSoapHeaderAuthStrategy
.setThirdPartyAuthorization(sigCredential
.getThirdPartyAuthorization());
header = signatureSoapHeaderAuthStrategy
.generateHeaderStrategy(sigCredential);
} else if (credential instanceof CertificateCredential) {
CertificateCredential certCredential = (CertificateCredential) credential;
CertificateSOAPHeaderAuthStrategy certificateSoapHeaderAuthStrategy = new CertificateSOAPHeaderAuthStrategy();
certificateSoapHeaderAuthStrategy
.setThirdPartyAuthorization(certCredential
.getThirdPartyAuthorization());
header = certificateSoapHeaderAuthStrategy
.generateHeaderStrategy(certCredential);
}
payLoad = getPayLoadUsingSOAPHeader(payLoad, getNamespaces(),
header);
}
return payLoad;
}
public String getEndPoint() {
String endPoint = searchEndpoint();
if (endPoint == null) {
if ((Constants.SANDBOX.equalsIgnoreCase(this.configurationMap.get(
Constants.MODE).trim()))) {
if (getCredential() instanceof CertificateCredential) {
endPoint = Constants.MERCHANT_SANDBOX_CERTIFICATE_ENDPOINT;
} else {
endPoint = Constants.MERCHANT_SANDBOX_SIGNATURE_ENDPOINT;
}
} else if ((Constants.LIVE.equalsIgnoreCase(this.configurationMap
.get(Constants.MODE).trim()))) {
if (getCredential() instanceof CertificateCredential) {
endPoint = Constants.MERCHANT_LIVE_CERTIFICATE_ENDPOINT;
} else {
endPoint = Constants.MERCHANT_LIVE_SIGNATURE_ENDPOINT;
}
}
}
return endPoint;
}
public ICredential getCredential() {
return credential;
}
public void validate() throws ClientActionRequiredException {
String mode = configurationMap.get(Constants.MODE);
if (mode == null && searchEndpoint() == null) {
// Mandatory Mode not specified.
throw new ClientActionRequiredException(
"mode[production/live] OR endpoint not specified");
}
if ((mode != null)
&& (!mode.trim().equalsIgnoreCase(Constants.LIVE) && !mode
.trim().equalsIgnoreCase(Constants.SANDBOX))) {
// Mandatory Mode not specified.
throw new ClientActionRequiredException(
"mode[production/live] OR endpoint not specified");
}
}
/*
* Search a valid endpoint in the configuration, returning null if not found
*/
private String searchEndpoint() {
String endPoint = this.configurationMap.get(Constants.ENDPOINT + "."
+ getPortName()) != null ? this.configurationMap
.get(Constants.ENDPOINT + "." + getPortName())
: (apiCallHandler.getEndPoint() != null ? apiCallHandler
.getEndPoint() : null);
if (endPoint != null && endPoint.trim().length() <= 0) {
endPoint = null;
}
return endPoint;
}
/*
* Returns a credential as configured in the application configuration
*/
private ICredential getCredentials() throws InvalidCredentialException,
MissingCredentialException {
ICredential returnCredential = null;
CredentialManager credentialManager = new CredentialManager(
this.configurationMap);
returnCredential = credentialManager.getCredentialObject(apiUserName);
if (accessToken != null && accessToken.trim().length() > 0) {
// Set third party authorization to token
// if token is sent as part of request call
ThirdPartyAuthorization tokenAuth = new TokenAuthorization(
accessToken, tokenSecret);
if (returnCredential instanceof SignatureCredential) {
SignatureCredential sigCred = (SignatureCredential) returnCredential;
sigCred.setThirdPartyAuthorization(tokenAuth);
} else if (returnCredential instanceof CertificateCredential) {
CertificateCredential certCred = (CertificateCredential) returnCredential;
certCred.setThirdPartyAuthorization(tokenAuth);
}
}
return returnCredential;
}
/*
* Returns default HTTP headers used in SOAP call
*/
private Map getDefaultHttpHeadersSOAP() {
Map returnMap = new HashMap();
returnMap.put(Constants.PAYPAL_REQUEST_DATA_FORMAT_HEADER,
Constants.PAYLOAD_FORMAT_SOAP);
returnMap.put(Constants.PAYPAL_RESPONSE_DATA_FORMAT_HEADER,
Constants.PAYLOAD_FORMAT_SOAP);
returnMap.put(Constants.PAYPAL_REQUEST_SOURCE_HEADER, sdkName + "-"
+ sdkVersion);
return returnMap;
}
/**
* Initialize {@link ICredential}
*/
private void initCredential() throws InvalidCredentialException,
MissingCredentialException {
if (credential == null) {
credential = getCredentials();
}
}
/**
* Gets Namespace specific to PayPal APIs
*/
private String getNamespaces() {
return "xmlns:ns=\"urn:ebay:api:PayPalAPI\" xmlns:ebl=\"urn:ebay:apis:eBLBaseComponents\" xmlns:cc=\"urn:ebay:apis:CoreComponentTypes\" xmlns:ed=\"urn:ebay:apis:EnhancedDataTypes\"";
}
/**
* Returns Payload after decoration
*/
private String getPayLoadUsingSOAPHeader(String payLoad, String namespace,
String header) {
String returnPayLoad = null;
String formattedPayLoad = processPayLoadForFormatting(payLoad);
returnPayLoad = MessageFormat.format(formattedPayLoad, new Object[] {
namespace, header });
return returnPayLoad;
}
/**
* Process the payload before using message formatting
*/
private String processPayLoadForFormatting(String payLoad) {
Matcher match = REGEX_PATTERN.matcher(payLoad);
StringBuffer sb = new StringBuffer();
while (match.find()) {
match.appendReplacement(sb, "'" + match.group());
}
match.appendTail(sb);
// Fix json strings in element values by replacing {
// by '{' and matching } by '}'
return sb.toString().replaceAll("(?