Merge pull request #93 from CyberSource/future

PR from future to master

Author: SumiteshRS

.travis.yml

@@ -1,5 +1,7 @@
 language: java
+"dist": "precise"
 jdk:
+  - oraclejdk8
   - oraclejdk7
   - openjdk7
-  - openjdk6
+  - openjdk6

README.md

@@ -66,7 +66,10 @@ You do not need to download and build the source to use the SDK but if you want
       - Number of retry parameter should be set between 1 to 5. Any other value will throw an Error Message.
       - Refer to the [Retry Pattern](README.md#retry-pattern) section below.
     - Please refer to the accompanying documentation for the other optional properties that you may wish to specify.
-
+    - Set customHttpClassEnabled to true to make use of Custom Http Library. 
+      - Enter the custom class name in customHttpClass field. Provide the full package name along with the class name.
+        example customHttpClass= <packagename.customHttpClass>
+      - The custom HTTP Class must have a three argument constructor which accepts MerchantConfig, DocumentBuilder and LoggerWrapper as argument. Then it should call the constructor of the parent class.
 - Build this project using Maven.
   - `mvn clean` - Cleans the Project
   - `mvn install` - Builds the project and creates a jar file of client SDK. Includes running all unit tests and integration tests
@@ -93,6 +96,7 @@ Unix or Linux:	runSample.sh <service_name>
 - If you make any changes to the `RunSample.java` sample, you must rebuild the sample before using it. Use the `compileSample` batch file or shell script provided in the sample directory.
 
 ### Using samples and maven tool
+
 - Clone/Download the code from GitHub.
 - Choosing which sample to test:
   - If you want to test Name-Value Pair, `cd` to the `cybersource-sdk-java-master/samples/nvp` directory.
@@ -106,17 +110,17 @@ Unix or Linux:	runSample.sh <service_name>
 ## JKS creation
 
 - To convert the p12 file to JKS follow the steps mentioned below.
-  - These commands will take out all the certs from the p12 file. 
-```
-openssl pkcs12 -in <Merchant_ID>.p12 -nocerts -out <Merchant_ID>.key
-openssl pkcs12 -in <Merchant_ID>.p12 -clcerts -nokeys -out  <Merchant_ID>.crt
-openssl pkcs12 -in <Merchant_ID>.p12 -cacerts -nokeys -out CyberSourceCertAuth.crt
-openssl pkcs12 -in <Merchant_ID>.p12 -cacerts -nokeys -out CyberSource_SJC_US.crt
-```
-- Create a new p12. Here `Identity.p12` is the new p12 file
+  - These commands will take out all the certs from the p12 file. 
+  1. `openssl pkcs12 -in <Merchant_ID>.p12 -nocerts -out <Merchant_ID>.key`
+  2. `openssl pkcs12 -in <Merchant_ID>.p12 -clcerts -nokeys -out  <Merchant_ID>.crt`
+  3. `openssl pkcs12 -in <Merchant_ID>.p12 -cacerts -nokeys -out CyberSourceCertAuth.crt`
+  4. `openssl pkcs12 -in <Merchant_ID>.p12 -cacerts -nokeys -out CyberSource_SJC_US.crt`
+
+- Create a new p12. Here Identity.p12 is the new p12 file
 ```
 openssl pkcs12 -export -certfile CyberSourceCertAuth.crt -in <Merchant_ID>.crt -inkey <Merchant_ID>.key -out identity.p12 -name "<Merchant_ID>"
 ```
+
 - Create JKS from p12 using keytool
 ```
 keytool -importkeystore -destkeystore <Your_keystore_name> -deststorepass <your_password> -srckeystore identity.p12 -srcstoretype PKCS12 -srcstorepass <Merchant_ID>
@@ -127,11 +131,11 @@ keytool -importcert -trustcacerts -file CyberSource_SJC_US.crt -alias CyberSourc
 ```
 - List the entries of your keystore
 ```
-keytool -list -v -keystore <Your_keystore_name>
+keytool -list -v -keystore <Your_keystore_name>`
 ```
 - It should have two entries.
   - The first entry should contain a chain of two certificates - `CyberSourceCertAuth` and <Merchant_ID> with alias name <Merchant_ID>
-  - Second entry should be for `CyberSource_SJC_US` certificate with alias name as `CyberSource_SJC_US`
+  - Second entry should be for `CyberSource_SJC_US` certificate with alias name as CyberSource_SJC_US
 
 ## Message Level Encryption
 CyberSource supports Message Level Encryption (MLE) for Simple Order API. Message level encryption conforms to the SOAP Security 1.0 specification published by the OASIS standards group. 
@@ -151,7 +155,7 @@ CyberSource supports Message Level Encryption (MLE) for Simple Order API. Messag
 ## Retry Pattern
 
 Retry Pattern allows to retry sending a failed request and it will only work with `useHttpClient=true`. `allowRetry` flag enables the retry mechanism. 
-- Set the value of `allowRetry` parameter to "TRUE/FALSE". Then the system will retry the failed request as many times as configured by the merchant in the config parameter 'numberOfRetries'.
+  - Set the value of `allowRetry` parameter to "TRUE/FALSE". Then the system will retry the failed request as many times as configured by the merchant in the config parameter 'numberOfRetries'.
   - numberOfRetries parameter value should be set between 0 to 5. By default the value for numberOfRetries will be 5. User can set a delay in between the retry attempts.
   - Config parameter for this property is 'retryInterval' in `cybs.property` file. The default value for 'retryInterval' parameter is 5 which means a delay of 5 seconds.
 
@@ -175,7 +179,49 @@ Retry Pattern allows to retry sending a failed request and it will only work wit
     9. org.mockito:mockito-all:1.10.19
       Mock objects library for java  
 
+## Changes
+
+Version Cybersource-sdk-java 6.2.5 (OCT,2017)
+_______________________________
+  1) Merchant cert to be read from JAVA key store. Flag is added to enable reading cert from Java keystore.
+  2) Added Custom HttpClient feature. Merchants can use there own http client instead of defaults which comes with SDK.
+  3) Http Client connection reuse issue.
+  4) Changed clientLibrary version to 6.2.5; in 6.2.4 release it was missed. So, in 6.2.4 release, clientLibrary version was      pointing to 6.2.3.
+_______________________________  
+Version Cybersource-sdk-java 6.2.4 (Dec 15, 2016)
+_______________________________
+  1) RetryPattern config for http client.
+  2) Code review comments.
+  3) Added timers to log the method execution time.
+  4) Sample added to support other services.
+_______________________________
+Version Cybersource-sdk-java 6.2.3 (Oct 17, 2016)
+_______________________________
+  1) Fixed performance issue; in case of multiple merchantIDs, p12 was getting loaded for every request.
+  2) p12 will be loaded once per merchantId.
+_______________________________
+Version Cybersource-sdk-java 6.2.2 (Sep 15, 2016)
+_______________________________
+  1)Upgraded 3rd party dependencies jars including wss4j.
+_______________________________
+Version Cybersource-sdk-java 6.2.1 (Aug 4, 2016)
+_______________________________
+  1) AkamaiSureroute config parameter introduced
+  2) i18n fix for NVP sample.            
+  3) In `Sample/cybs.properties` file, `targetAPIVersion` changed to latest 1.129.
+_______________________________
+Version Cybersource-sdk-java 6.2.0 (Jul 28, 2016)
+_______________________________
+  1) MLE[Message Level Encryption] is enabled.
+  2) published zip file with samples and packaged compiled cybersoruce-sdk-java jar file.
+  3) `Bouncycastle` jar issue; changed scope from provided to default"scope"
+_______________________________
+Version Cybersource-sdk-java 6.1.0 (Feb 24,2016)
+_______________________________
+  1) SHA256 changes which are required to signed the request with SHA256.
+
 ## Documentation
 - For more information about CyberSource services, see <http://www.cybersource.com/developers/documentation>.
 - For all other support needs, see <http://www.cybersource.com/support>.
 
+

java/src/main/java/com/cybersource/ws/client/Client.java

@@ -34,6 +34,7 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.StringReader;
+import java.lang.reflect.InvocationTargetException;
 import java.security.KeyStore;
 import java.security.cert.PKIXParameters;
 import java.security.cert.TrustAnchor;
@@ -90,14 +91,16 @@ public static Map runTransaction(Map<String,String> request, Properties props)
      * @throws FaultException  if a fault occurs.
      * @throws ClientException if any other exception occurs.
      */
-    public static Map runTransaction(
+    @SuppressWarnings("unchecked")
+	public static Map runTransaction(
             Map<String, String> request, Properties props,
             Logger _logger, boolean prepare, boolean logTranStart)
             throws FaultException, ClientException {
         MerchantConfig mc;
         LoggerWrapper logger = null;
         Connection con = null;
 
+
         try {
             setVersionInformation(request);
 
@@ -122,8 +125,39 @@ public static Map runTransaction(
 //          FileWriter writer = new FileWriter(new File("signedDoc.xml"));
 //          writer.write(XMLUtils.PrettyDocumentToString(signedDoc));
 //          writer.close();
-            
-            con = Connection.getInstance(mc, builder, logger);
+            if(mc.isCustomHttpClassEnabled()){
+				Class<Connection> customConnectionClass;
+				try {
+					customConnectionClass = (Class<Connection>) Class.forName(mc.getcustomHttpClass());
+					Class[] constructor_Args = new Class[] {com.cybersource.ws.client.MerchantConfig.class, javax.xml.parsers.DocumentBuilder.class, com.cybersource.ws.client.LoggerWrapper.class}; 
+					con=customConnectionClass.getDeclaredConstructor(constructor_Args).newInstance(mc, builder, logger);
+
+				} catch (InstantiationException e) {
+					logger.log(Logger.LT_INFO, "Failed to Instantiate the class "+e);
+					throw new ClientException(e, false, null);
+				} catch (IllegalAccessException e) {
+					logger.log(Logger.LT_INFO, "Could not Access the method invoked "+e);
+					throw new ClientException(e, false, null);
+				} catch (ClassNotFoundException e) {
+					logger.log(Logger.LT_INFO, "Could not load the custom HTTP class ");
+					throw new ClientException(e, false, null);
+				} catch (IllegalArgumentException e) {
+					logger.log(Logger.LT_INFO, "Method invoked with Illegal Argument list  "+e);
+					throw new ClientException(e, false, null);
+				} catch (SecurityException e) {
+					logger.log(Logger.LT_INFO, "Security Exception "+e);
+					throw new ClientException(e, false, null);
+				} catch (InvocationTargetException e) {
+					logger.log(Logger.LT_INFO, "Exception occured while calling the method "+e);
+					throw new ClientException(e, false, null);
+				} catch (NoSuchMethodException e) {
+					logger.log(Logger.LT_INFO, "Method not found ");
+					throw new ClientException(e, false, null);
+				}  	
+            }
+            else{
+            	con = Connection.getInstance(mc, builder, logger);
+            }
             Document wrappedReply = con.post(signedDoc);
             Map<String, String> replyMap = soapUnwrap(wrappedReply, mc, logger);
             logger.log(Logger.LT_INFO, "Client, End of runTransaction Call   ",false);

java/src/main/java/com/cybersource/ws/client/Connection.java

@@ -47,8 +47,15 @@ abstract class Connection {
     final MerchantConfig mc;
     private final DocumentBuilder builder;
     final LoggerWrapper logger;
-
-    Connection(MerchantConfig mc, DocumentBuilder builder,
+    
+   /**
+    * It initializes three arguments MerchantConfig, DocumentBuilder and Logger
+    * Any class extending this class must implement three argument constructor
+    * @param mc
+    * @param builder
+    * @param logger
+ */
+protected Connection(MerchantConfig mc, DocumentBuilder builder,
                LoggerWrapper logger) {
         this.mc = mc;
         this.builder = builder;

java/src/main/java/com/cybersource/ws/client/HttpClientConnection.java

@@ -60,7 +60,13 @@ void postDocument(Document request)
             throws IOException, TransformerConfigurationException,
             TransformerException, MalformedURLException,
             ProtocolException {
-        HttpClient httpClient = new HttpClient();
+    	
+    	/*
+    	 * SimpleHttpConnectionManager(boolean alwaysClose) : 
+    	 * alwaysClose - if set true, the connection manager will always close connections upon release.
+    	 */
+    	
+        HttpClient httpClient = new HttpClient(new SimpleHttpConnectionManager(true));
         setTimeout(httpClient, mc.getTimeout() * 1000);
         setProxy(httpClient);
 

java/src/main/java/com/cybersource/ws/client/MerchantConfig.java

@@ -64,14 +64,14 @@ public class MerchantConfig {
     private String proxyUser;
     private String proxyPassword;
     private String cacertPassword;
-    private String useClientHttpFactory;
-    private boolean useClientHttpFactoryFlag;
+    private String customHttpClass;
+    private boolean customHttpClassEnabled;
 
-    public String getUseClientHttpFactory() {
-		return useClientHttpFactory;
+    public String getcustomHttpClass() {
+		return customHttpClass;
 	}
-    public boolean getUseClientHttpFactoryFlag() {
-		return useClientHttpFactoryFlag;
+    public boolean isCustomHttpClassEnabled() {
+		return customHttpClassEnabled;
 	}
 	// computed values
     private String effectiveServerURL;
@@ -261,7 +261,7 @@ public MerchantConfig(Properties _props, String _merchantID)
         logFilename = getProperty(merchantID, "logFilename");
         logMaximumSize = getIntegerProperty(merchantID, "logMaximumSize", 10);
         useHttpClient = getBooleanProperty(merchantID, "useHttpClient", ConnectionHelper.getDefaultUseHttpClient());
-        useClientHttpFactory = getProperty(merchantID, "useClientHttpFactory");
+        customHttpClass = getProperty(merchantID, "customHttpClass");
         timeout = getIntegerProperty(merchantID, "timeout", DEFAULT_TIMEOUT);
         proxyHost = getProperty(merchantID, "proxyHost");
         proxyPort = getIntegerProperty(merchantID, "proxyPort", DEFAULT_PROXY_PORT);
@@ -270,7 +270,7 @@ public MerchantConfig(Properties _props, String _merchantID)
         enableJdkCert = getBooleanProperty(merchantID, "enableJdkCert", false);
         enableCacert=getBooleanProperty(merchantID, "enableCacert", false);
         cacertPassword=getProperty(merchantID,"cacertPassword","changeit");
-        useClientHttpFactoryFlag=getBooleanProperty(merchantID,"useClientHttpFactoryFlag",false);
+        customHttpClassEnabled=getBooleanProperty(merchantID,"customHttpClassEnabled",false);
         // compute and store effective namespace URI
 
         if (namespaceURI == null && targetAPIVersion == null) {
@@ -473,8 +473,8 @@ public String getLogString() {
         appendPair(sb, "logDirectory", logDirectory);
         appendPair(sb, "logFilename", logFilename);
         appendPair(sb, "logMaximumSize", logMaximumSize);
-        appendPair(sb, "useClientHttpFactory", useClientHttpFactory);
-        appendPair(sb, "useClientHttpFactoryFlag", useClientHttpFactoryFlag);
+        appendPair(sb, "customHttpClass", customHttpClass);
+        appendPair(sb, "customHttpClassEnabled", customHttpClassEnabled);
         appendPair(sb, "useHttpClient", useHttpClient);
         appendPair(sb, "enableJdkCert", enableJdkCert);
         appendPair(sb, "enableCacert", enableCacert);

java/src/main/java/com/cybersource/ws/client/Utility.java

@@ -48,7 +48,7 @@ private Utility() {
     /**
      * Version number of this release.
      */
-    public static final String VERSION = "6.2.3";
+    public static final String VERSION = "6.2.5";
 
     /**
      * If in the Request map, a key called "_has_escapes" is present and is set

java/src/main/java/com/cybersource/ws/client/XMLClient.java

@@ -35,6 +35,7 @@
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.StringReader;
+import java.lang.reflect.InvocationTargetException;
 import java.util.Properties;
 
 /**
@@ -64,7 +65,8 @@ public class XMLClient {
 
     private static Document soapEnvelope;
     private static Exception initException = null;
-    
+
+
     static {
         try {
             // load the SOAP envelope document.
@@ -137,7 +139,8 @@ public static Document runTransaction(Document request, Properties props)
      * @throws FaultException  if a fault occurs.
      * @throws ClientException if any other exception occurs.
      */
-    public static Document runTransaction(
+    @SuppressWarnings("unchecked")
+	public static Document runTransaction(
             Document request, Properties props,
             Logger _logger, boolean prepare, boolean logTranStart)
             throws FaultException, ClientException {
@@ -177,8 +180,39 @@ public static Document runTransaction(
 
             Document signedDoc
                     = soapWrapAndSign(request, mc, builder, logger);
-
-            con = Connection.getInstance(mc, builder, logger);
+            if(mc.isCustomHttpClassEnabled()){
+				Class<Connection> customConnectionClass;
+				try {
+					customConnectionClass = (Class<Connection>) Class.forName(mc.getcustomHttpClass());
+					Class[] constructor_Args = new Class[] {com.cybersource.ws.client.MerchantConfig.class, javax.xml.parsers.DocumentBuilder.class, com.cybersource.ws.client.LoggerWrapper.class}; 
+					con=customConnectionClass.getDeclaredConstructor(constructor_Args).newInstance(mc, builder, logger);
+
+				} catch (InstantiationException e) {
+					logger.log(Logger.LT_INFO, "Failed to Instantiate the class "+e);
+					throw new ClientException(e, false, null);
+				} catch (IllegalAccessException e) {
+					logger.log(Logger.LT_INFO, "Could not Access the method invoked "+e);
+					throw new ClientException(e, false, null);
+				} catch (ClassNotFoundException e) {
+					logger.log(Logger.LT_INFO, "Could not load the custom HTTP class ");
+					throw new ClientException(e, false, null);
+				} catch (IllegalArgumentException e) {
+					logger.log(Logger.LT_INFO, "Method invoked with Illegal Argument list  "+e);
+					throw new ClientException(e, false, null);
+				} catch (SecurityException e) {
+					logger.log(Logger.LT_INFO, "Security Exception "+e);
+					throw new ClientException(e, false, null);
+				} catch (InvocationTargetException e) {
+					logger.log(Logger.LT_INFO, "Exception occured while calling the method "+e);
+					throw new ClientException(e, false, null);
+				} catch (NoSuchMethodException e) {
+					logger.log(Logger.LT_INFO, "Method not found ");
+					throw new ClientException(e, false, null);
+				}    	
+            }
+            else{
+            	con = Connection.getInstance(mc, builder, logger);
+            }
             Document wrappedReply = con.post(signedDoc);
 
             Document doc = soapUnwrap(wrappedReply, mc, builder, logger);

java/src/main/resources/cybs.properties

@@ -15,11 +15,6 @@ sendToProduction=false
 sendToAkamai=true
 #serverURL=https://ics2wstesta.ic3.com/commerce/1.x/transactionProcessor
 
-#To use your own Http library set useClientHttpFactoryFlag to true
-# set useClientHttpFactory field with the class name which has Http implementation
-#useClientHttpFactory=AmazonHttpConnection
-#useClientHttpFactoryFlag=true
-
 #useHttpClient=false
 
 # Following configure parameters will only work with useHttpClient=true
@@ -32,6 +27,11 @@ allowRetry=true
 numberOfRetries=5
 retryInterval=5
 
+#To use your own Http library set customHttpClassEnabled to true
+# set customHttpClass field with the class name which has Http implementation. Provide the full class with package name.
+#customHttpClassEnabled=
+#customHttpClass=
+
 # If This property is set to true then the p12 certificate must be stored in JKS format
 # program will read it from there. If it is set to false then the certificate will be read from 
 # the location specified above from the key directory location
@@ -42,6 +42,7 @@ enableJdkCert=false
 enableCacert=false
 # Enter the password for cacert file. Default password for JDK cacert is changeit
 cacertPassword=
+
 # Mechanism to differentiate whether Payload is encrypted or not
 useSignAndEncrypted=false