Merge pull request #59 from CyberSource/future

Future

Author: shamirwasia

README.md

@@ -1,6 +1,6 @@
 #CyberSource Simple Order API for Java
 
-[![Build Status](https://travis-ci.org/CyberSource/cybersource-sdk-java.png?branch=master)]
+[![Build Status](https://travis-ci.org/CyberSource/cybersource-sdk-java.png?branch=future)]
 (https://travis-ci.org/CyberSource/cybersource-sdk-java)
 
 ##Package Managers
@@ -11,7 +11,7 @@ To install the cybersource-sdk-java from central repository,add dependency to yo
         <dependency>
             <groupId>com.cybersource</groupId>
             <artifactId>cybersource-sdk-java</artifactId>
-            <version>6.2.3</version>
+            <version>6.2.4</version>
         </dependency> 
 ````
  Run mvn install, to install dependency
@@ -20,7 +20,7 @@ To install the cybersource-sdk-java from central repository,add dependency to yo
 Add the dependency to your build.gradle
 ````
 dependencies {
-    compile 'com.cybersource:cybersource-sdk-java:6.2.3'
+    compile 'com.cybersource:cybersource-sdk-java:6.2.4'
     }
 ````
 ##Requirements
@@ -85,8 +85,12 @@ You do not need to download and build the source to use the SDK but if you want
        By default, it is set to true.
        
     h. "serverURL" config parameter will take precedence over sendToProduction and sendToAkamai config parameters. By default the "serverURL" configuration is commented out. 
+    
+    i. 	"allowRetry" config parameter will only work for HttpClient. Set allowRetry config parameter to "true" to enable retry mechanism and set merchant specific values for the retry.
+    	Set integer values for config parameter numberOfRetries & retryInterval. Retry Interval is time delay for next retry in seconds. number of retry parameter should be set between
+    	1 to 5 any other value will throw an Error Message. Refer to the "Retry Pattern" section below.
         
-    i. Please refer to the accompanying documentation for the other optional properties that you may wish to specify.
+    j. Please refer to the accompanying documentation for the other optional properties that you may wish to specify.
 
 
 4. Build this project using Maven.
@@ -175,6 +179,15 @@ We have two ways to test, One is using maven tool and other is to download the z
 	Cryptography Algorithms
 		CyberSource utilizes the following algorithms for this implementation. While others may work, the following are validated and recommended. SSL is used for transport security even with encrypted messages. CyberSource asymmetric keys are RSA 2048 keys and therefore your cryptography API should support 2048 bit RSA keys and signatures create with them. The messages are encrypted with a temporary derived key which is used per message. This derived key is AES 256 bit and utilizes CBC blocking mode for encryption. The derived key is encrypted with the recipient ( CyberSource ) public key. The key exchange algorithm used is RSA-OAEP.
 
+##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'. 
+	
+	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.
+
 ##Third Party jars
 	1.) org.apache.ws.security.wss4j:1.6.19
 	    The Apache WSS4J project provides a Java implementation of the primary security standards for Web Services, namely the OASIS Web Services Security (WS-Security) specifications    
@@ -197,14 +210,11 @@ We have two ways to test, One is using maven tool and other is to download the z
 	6.) commons-logging:commons-logging:jar:1.1.1
 		This is getting downloaded as compile time dependency of wss4j:1.6.19.Apache Commons Logging is a thin adapter allowing configurable bridging to other, well known logging 
 		systems.
-		
-	7.) org.slf4j:slf4j-api:1.7.21 and org.slf4j:slf4j-jcl:1.7.21 . 
-	    slf4j-api is getting used as a dependency for wss4j. Modified to latest version.
 
-	8.) junit:junit:4.12
+	7.) junit:junit:4.12
 		JUnit is a unit testing framework for Java.
 
-	9.) org.mockito:mockito-all:1.10.19
+	8.) org.mockito:mockito-all:1.10.19
 		Mock objects library for java  
 
 ##Documentation

java/pom.xml

@@ -201,16 +201,6 @@
             <artifactId>wss4j</artifactId>
             <version>1.6.19</version>
         </dependency>     
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-api</artifactId>
-            <version>1.7.21</version>
-        </dependency>
-        <dependency>
-            <groupId>org.slf4j</groupId>
-            <artifactId>slf4j-jcl</artifactId>
-            <version>1.7.21</version>
-        </dependency>
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>

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

@@ -118,8 +118,10 @@ public static Map runTransaction(
 
             con = Connection.getInstance(mc, builder, logger);
             Document wrappedReply = con.post(signedDoc);
-
-            return (soapUnwrap(wrappedReply, mc, logger));
+            Map<String, String> replyMap = soapUnwrap(wrappedReply, mc, logger);
+            logger.log(Logger.LT_INFO, "Client, End of runTransaction Call   ",false);
+            
+            return replyMap;
         } catch (IOException e) {
             throw new ClientException(
                     e, con != null && con.isRequestSent(), logger);
@@ -178,51 +180,50 @@ private static Document soapWrapAndSign(
         boolean logSignedData = mc.getLogSignedData();
         if (!logSignedData) {
             logger.log(
-                    Logger.LT_REQUEST,
-                    mapToString(request, true, PCI.REQUEST));
+            		Logger.LT_REQUEST,
+            		"UUID   >  "+(mc.getUniqueKey()).toString() + "\n" +
+            		"Input request is" + "\n" +
+            		"======================================= \n"
+            		+ mapToString(request, true, PCI.REQUEST));
+        }
+        
+        Document wrappedDoc = soapWrap(request, mc, builder,logger);
+        logger.log(Logger.LT_INFO, "Client, End of soapWrap   ",true); 
+        
+        Document resultDocument = null;
+        SecurityUtil.loadMerchantP12File(mc,logger);
+        logger.log(Logger.LT_INFO, "Client, End of loadMerchantP12File   ", true);       
+        
+        // sign Document object
+        resultDocument = SecurityUtil.createSignedDoc(wrappedDoc, mc.getMerchantID(), mc.getKeyPassword(), logger);
+        logger.log(Logger.LT_INFO, "Client, End of createSignedDoc   ", true);
+
+        if ( mc.getUseSignAndEncrypted() ) {
+        	// Encrypt signed Document
+            resultDocument = SecurityUtil.handleMessageCreation(resultDocument, mc.getMerchantID(), logger);
+            logger.log(Logger.LT_INFO, "Client, End of handleMessageCreation   ", true);
         }
+        if (logSignedData) {
+           logger.log(Logger.LT_REQUEST,Utility.nodeToString(resultDocument, PCI.REQUEST));
+        	//logger.log(Logger.LT_REQUEST,XMLUtils.PrettyDocumentToString(resultDocument));
+        }
+
+        return resultDocument ;
+    }
 
-        // wrap in SOAP envelope
+    private static Document soapWrap(Map request, MerchantConfig mc, DocumentBuilder builder, LoggerWrapper logger) throws SAXException, IOException{
+    	// wrap in SOAP envelope
         Object[] arguments
                 = {mc.getEffectiveNamespaceURI(),
                 mapToString(request, false, PCI.REQUEST)};
         String xmlString = MessageFormat.format(SOAP_ENVELOPE1, arguments);
-     // load XML string into a Document object
+        // load XML string into a Document object
         StringReader sr = new StringReader( xmlString );
         Document wrappedDoc = builder.parse( new InputSource( sr ) );
-        sr.close();
-
-        Document resultDocument = null;
-        long timeNow = System.currentTimeMillis();
-        logger.log(Logger.LT_INFO, "Client, Start of getInstance Call, Timer Start in ms	" + timeNow + "For merchant " + mc.getMerchantID());
-        
-        SignedAndEncryptedMessageHandler handler = SignedAndEncryptedMessageHandler.getInstance(mc,logger);
-        
-        long endTime = System.currentTimeMillis();
-        logger.log(Logger.LT_INFO, "Client, End of getInstance Call, time taken in ms	" + (endTime-timeNow) + "For merchant " + mc.getMerchantID());
-        
-        // 3/7/2016 change to support encrypted messages as well as signed - jeaton
-        if ( !mc.getUseSignAndEncrypted() ) {
-            // sign Document object
-            logger.log(Logger.LT_INFO, "Signing request...");
-            resultDocument = handler.createSignedDoc(wrappedDoc,mc.getMerchantID(),mc.getKeyPassword(),null);
-            if (logSignedData) {
-                logger.log(Logger.LT_REQUEST,
-                        Utility.nodeToString(resultDocument, PCI.REQUEST));
-            }
-        } else {
-            logger.log(Logger.LT_INFO, "Signing and encrypting request...");
-            resultDocument = handler.handleMessageCreation(wrappedDoc,mc.getMerchantID(),mc.getKeyPassword());
-            if (logSignedData) {
-                logger.log(Logger.LT_REQUEST,XMLUtils.PrettyDocumentToString(resultDocument));
-            }
-        }
-        
-        //System.out.println(XMLUtils.PrettyDocumentToString(resultDocument));
-        return resultDocument ;
+        sr.close(); 
+        return wrappedDoc;
     }
-
-
+    
     /**
      * Extracts the content of the SOAP body from the given Document object
      * inside a SOAP envelope.

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

@@ -107,6 +107,7 @@ public Document post(Document request)
 
     }
 
+
     /**
      * Validate the Http response for any faults returned from the server. 
      * @throws FaultException

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

@@ -189,7 +189,9 @@ private static String documentToString(Document doc)
      */
     private class MyRetryHandler implements HttpMethodRetryHandler {
 
-        //
+    	long retryWaitInterval=mc.getRetryInterval();
+ 	   	int maxRetries= mc.getNumberOfRetries();
+ 	   	
         // I copied this code from
         // http://jakarta.apache.org/commons/httpclient/exception-handling.html#HTTP%20transport%20safety
         // and changed the NoHttpResponseException case to
@@ -198,7 +200,7 @@ public boolean retryMethod(
                 final HttpMethod method,
                 final IOException exception,
                 int executionCount) {
-            if (executionCount > 5) {
+            if (executionCount > maxRetries) {
                 // Do not retry if over max retry count
                 return false;
             }
@@ -210,6 +212,13 @@ public boolean retryMethod(
             if (!method.isRequestSent()) {
                 // Retry if the request has not been sent fully or
                 // if it's OK to retry methods that have been sent
+            	try {
+         	        Thread.sleep(retryWaitInterval);
+         	        logger.log( Logger.LT_INFO+" Retrying Request -- ",mc.getUniqueKey().toString()+ " Retry Count -- "+executionCount);
+                 } catch (InterruptedException e) {
+         	        // TODO Auto-generated catch block
+         	        e.printStackTrace();
+                 }
                 return true;
             }
             // otherwise do not retry

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

@@ -22,19 +22,19 @@
 public class Identity { 
 
    //Our p12 files do not contain an alias as a normal name, its the common name and serial number
-   private String name = null;
+   private String name;
 
    // we need to create alias for our keystores, it looks like "serialNumber=4032987129910179089277,CN=jasoneatoncorp"
-   private String keyAlias = null;
+   private String keyAlias;
 
    // for an unknown reason the serial number of the certificate is set incorrectly, we must parse it from DN
-   private String serialNumber = null;
+   private String serialNumber;
 
-   private X509Certificate x509Cert =null;
+   private X509Certificate x509Cert;
 
-   private PrivateKey privateKey = null;
+   private PrivateKey privateKey;
 
-   private MerchantConfig merchantConfig = null;
+   private MerchantConfig merchantConfig;
 
    private static final String SERVER_ALIAS = "CyberSource_SJC_US";