Merge pull request #58 from mahendya/future

RetryPattern config for http client

Author: shamirwasia

README.md

@@ -86,8 +86,9 @@ You do not need to download and build the source to use the SDK but if you want
        
     h. "serverURL" config parameter will take precedence over sendToProduction and sendToAkamai config parameters. By default the "serverURL" configuration is commented out. 
 
-    i. Set allowRetry config parameter to "true/false" to enable retry mechanism. By default, allowRetry is set to true.
-       Set integer values for config parameter numberOfRetries &  retryInterval to configure the retry behavior. Refer to the "Retry Pattern" section below.
+    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.
         
     j. Please refer to the accompanying documentation for the other optional properties that you may wish to specify.
 
@@ -180,10 +181,12 @@ We have two ways to test, One is using maven tool and other is to download the z
 
 ##RETRY PATTERN
 
-	Retry Pattern Allows to retry sending a failed request. To Enable or disable retry mechanism set the allowRetry config parameter to "true or false". 
-	By default, allowRetry is set to true. The system will retry the failed request multiple times as configured in the config parameter 'numberOfRetries'. 
-	numberOfRetries (Number of retries) should be set between 1 to 3. By default numberOfRetries will be set to 1. User can set a delay in between the retry 
-	attempts using the config parameter 'retryInterval'. The default value for this parameter is 10 which means a delay of 10 seconds between the retry attempts.
+	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

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

@@ -180,8 +180,11 @@ 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);

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

@@ -91,33 +91,22 @@ abstract InputStream getResponseErrorStream()
      */
     public Document post(Document request)
             throws ClientException, FaultException {
-    	for (int i=0; i<=mc.getNumberOfRetries(); i++) {
-			try {
-				postDocument(request);
-				break;
-			} catch (IOException e) {
-				logger.log(Logger.LT_INFO, "Attempt to post document failed. Number of retry attempts made " + i);
-				if(i==mc.getNumberOfRetries()) throw new ClientException(e, isRequestSent(), logger);
-				try {
-					Thread.sleep((long) mc.getRetryInterval());
-				}catch (InterruptedException ex) {
-					logger.log(Logger.LT_INFO, "Waiting for the next attempt to made after " +mc.getRetryInterval() );
-				} 
-			} catch (TransformerConfigurationException e) {
-				throw new ClientException(e, isRequestSent(), logger);
-			} catch (TransformerException e) {
-				throw new ClientException(e, isRequestSent(), logger);
-			}
-			
-		} 
-		checkForFault();
-   		try {
-			return parseReceivedDocument();
-		}catch (IOException e) {
-			throw new ClientException(e, isRequestSent(), logger);
-		}catch (SAXException e) {
-			throw new ClientException(e, isRequestSent(), logger);
-		}}
+        try {
+            postDocument(request);
+            checkForFault();
+            return (parseReceivedDocument());
+        } catch (IOException e) {
+            throw new ClientException(e, isRequestSent(), logger);
+        } catch (TransformerConfigurationException e) {
+            throw new ClientException(e, isRequestSent(), logger);
+        } catch (TransformerException e) {
+            throw new ClientException(e, isRequestSent(), logger);
+        } catch (SAXException e) {
+            throw new ClientException(e, isRequestSent(), logger);
+        }
+
+    }
+
 
     /**
      * Validate the Http response for any faults returned from the server. 

java/src/main/java/com/cybersource/ws/client/HttpClientConnection.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/MerchantConfig.java

@@ -21,6 +21,7 @@
 import java.io.File;
 import java.text.MessageFormat;
 import java.util.Properties;
+import java.util.UUID;
 
 /**
  * An internal class used by the clients to hold and derive the properties
@@ -34,7 +35,8 @@ public class MerchantConfig {
 
     private final static int DEFAULT_TIMEOUT = 130;
     private final static int DEFAULT_PROXY_PORT = 8080;
-
+    private UUID uniqueKey=UUID.randomUUID(); 
+    
     private final Properties props;
 
     private final String merchantID;
@@ -66,10 +68,10 @@ public class MerchantConfig {
     private String effectivePassword;
     private  boolean useSignAndEncrypted;
 
-    // Retry configuration
-    private int numberOfRetries = 0 ;
-    //In milliseconds
-    private int retryInterval= 10 * 1000;
+    //Retry Pattern
+    private int numberOfRetries = 0;   
+    private long retryInterval  = 0;
+    private boolean allowRetry=true;
 
 
     // getter methods
@@ -300,13 +302,14 @@ public MerchantConfig(Properties _props, String _merchantID)
 
         useSignAndEncrypted = getBooleanProperty(merchantID, "useSignAndEncrypted", false);
 
-        boolean allowRetry = getBooleanProperty(merchantID, "allowRetry", true);
-        if(allowRetry){
-        	numberOfRetries = getIntegerProperty(merchantID, "numberOfRetries", 1);
-            retryInterval = getIntegerProperty(merchantID, "retryInterval", 10) * 1000;
-        	if( numberOfRetries < 1 || numberOfRetries > 3 || retryInterval <= 0){
-        		throw new ConfigException("Invalid value of numberOfRetries and/or retryInterval");
-        	}
+        allowRetry  = getBooleanProperty(merchantID, "allowRetry", true);
+        if (useHttpClient && allowRetry) {
+            numberOfRetries = getIntegerProperty(merchantID, "numberOfRetries", 5);
+            if(numberOfRetries>0)
+          	  retryInterval = getIntegerProperty(merchantID, "retryInterval", 5) *1000;
+            if( numberOfRetries < 1 || numberOfRetries > 5 || retryInterval < 0){
+                throw new ConfigException("Invalid value of numberOfRetries and/or retryInterval");
+            }
         }
    }
 
@@ -458,6 +461,11 @@ public String getLogString() {
         appendPair(sb, "logFilename", logFilename);
         appendPair(sb, "logMaximumSize", logMaximumSize);
         appendPair(sb, "useHttpClient", useHttpClient);
+        if(useHttpClient){
+            appendPair(sb, "allowRetry", allowRetry);
+            appendPair(sb, "RetryCount", numberOfRetries);
+            appendPair(sb, "RetryInterval", retryInterval);
+        }
         appendPair(sb, "timeout", timeout);
         if (proxyHost != null) {
             appendPair(sb, "proxyHost", proxyHost);
@@ -470,11 +478,14 @@ public String getLogString() {
             }
         }
         appendPair(sb, "useSignAndEncrypted", useSignAndEncrypted);
-        appendPair(sb, "numberOfRetries", numberOfRetries);
-        appendPair(sb, "retryInterval", retryInterval);
         return (sb.toString());
     }
 
+	private void appendPair(StringBuffer sb, String key, long retryInterval2) {
+		appendPair(sb, key, String.valueOf(retryInterval2));
+
+	}
+	
     private static void appendPair(StringBuffer sb, String key, boolean value) {
         appendPair(sb, key, String.valueOf(value));
     }
@@ -522,12 +533,24 @@ private int getIntegerProperty(
         }
     }
 
-    public int getNumberOfRetries() {
+	public UUID getUniqueKey() {
+		return uniqueKey;
+	}
+
+	public int getNumberOfRetries() {
 		return numberOfRetries;
 	}
 
-    public int getRetryInterval() {
+	public long getRetryInterval() {
 		return retryInterval;
 	}
 
+	public boolean isAllowRetry() {
+		return allowRetry;
+	}
+
+	public void setAllowRetry(boolean allowRetry) {
+		this.allowRetry = allowRetry;
+	}
+
 }

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

@@ -330,7 +330,10 @@ private static Document soapWrapAndSign(
 
     	if (!logSignedData) {
             logger.log(Logger.LT_REQUEST,
-                    Utility.nodeToString(doc, PCI.REQUEST));
+            		"UUID   >  "+(mc.getUniqueKey()).toString() + "\n" +
+            		"Input request is" + "\n" +
+            		"======================================= \n"
+                    + Utility.nodeToString(doc, PCI.REQUEST));
         }
 
         Document wrappedDoc = soapWrap(doc, mc, builder, logger);

java/src/main/resources/cybs.properties

@@ -15,19 +15,21 @@ sendToAkamai=<-- Set it to true for Akamai -->
 
 #useHttpClient=false
 
+# Following configure parameters will only work with useHttpClient=true
+# "allow retry" property toggle value "true/false" to turn on /off the auto request retry. 
+# Number of retries is the number of attempts made to send the request. 
+# Retry interval is the wait time in between the attempts to send the request.
+# Retry count configuration, interval unit is in seconds.
+# Default values are for allowRetry=true, numberOfRetries=5 and retryInterval=5 seconds.
+allowRetry=true
+numberOfRetries=5
+retryInterval=5
+
 # Mechanism to differentiate whether Payload is encrypted or not
 useSignAndEncrypted=<-- Set it to true for MLE[MessageLevelEncryption] -->
 
 timeout=1000
 
-# allowRetry flag can be set to true to enable retry. numberOfRetries is the number of attempts made to send 
-# the request. retryInterval is the wait time in between the attempts to send the request.
-# Retry count configuration, interval unit is in seconds.
-# Default values for allowRetry=true, numberOfRetries=1 and retryInterval=10seconds.
-allowRetry=true
-numberOfRetries=1
-retryInterval=10
-
 # logging should normally be disabled in production as it would slow down the
 # processing.  Enable it only when troubleshooting an issue.
 enableLog=true

java/src/test/java/com/cybersource/ws/client/RetryIT.java

@@ -13,6 +13,7 @@
 public class RetryIT{
 
 	private static final String SERVER_URL = "https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor";
+	private static final String WRONG_SERVER_URL = "https://ics2wstest123.ic3.com/commerce/1.x/transactionProcessor";
 	private MerchantConfig mc;
 	private Properties props;
 
@@ -32,15 +33,17 @@ public void setUp() throws Exception
 		mc = new MerchantConfig(props, null);
 
 	}
-
+	
 	@Test 
-	public void checkRetry() throws Exception
+	public void checkRetryConfigValuesForHttpClient() throws Exception
 	{
 		String errMsg="Invalid value of numberOfRetries and/or retryInterval";
 		// request  fails as number of retry value is incorrect
+		props.setProperty("useHttpClient", "true");
 		props.setProperty("allowRetry", "true");
 		props.setProperty("numberOfRetries", "10");
 		props.setProperty("retryInterval", "10");
+		props.setProperty("serverURL",SERVER_URL);
 		// request 1 Should fail as the number of retry attempt is exceeding 3
 		try{
 			Client.runTransaction(new HashMap(), props);
@@ -52,10 +55,31 @@ public void checkRetry() throws Exception
 	}  
 
 	@Test 
-	public void checkNegative() throws Exception
+	public void checkRetryConfigValuesForNonHttpClient() throws Exception
+	{
+		// In this case retry should not be active as it is non http client. transaction should be successful.
+		String errMsg="Invalid value of numberOfRetries and/or retryInterval";
+		props.setProperty("useHttpClient", "false");
+		props.setProperty("allowRetry", "true");
+		props.setProperty("numberOfRetries", "10");
+		props.setProperty("retryInterval", "10");
+		props.setProperty("serverURL",WRONG_SERVER_URL);
+
+		try{
+			Map<String, String> replyMap = Client.runTransaction(new HashMap(), props);
+		}
+		catch(ClientException e){
+			assertNotEquals(errMsg, e.getMessage());
+		}
+
+	}
+	
+	@Test 
+	public void checkNegativeForHttp() throws Exception
 	{
 		String errMsg="Invalid value of numberOfRetries and/or retryInterval";
 		// request  fails as number of retry and retry interval values are in negative
+		props.setProperty("useHttpClient", "true");
 		props.setProperty("allowRetry", "true");
 		props.setProperty("numberOfRetries", "-10");
 		props.setProperty("retryInterval", "-10");
@@ -68,21 +92,16 @@ public void checkNegative() throws Exception
 			assertEquals(errMsg, e.getMessage());
 		}
 	}
+	
 	@Test 
 	public void retryDisabled() throws Exception{
 		// request should work as the Allow Retry is set to false other values will be ignored
+		props.setProperty("useHttpClient", "true");
 		props.setProperty("allowRetry", "false");
 		props.setProperty("numberOfRetries", "-10");
 		props.setProperty("retryInterval", "-10");
 		Map reply = Client.runTransaction(new HashMap(), props);
 		assertNotNull(reply.get("requestID"));
 
 	}
-	
-	@Test 
-	public void checkDefaultRetryValueIfRetryEnabled() throws Exception{
-		assertEquals(1, mc.getNumberOfRetries());
-		assertEquals(10*1000, mc.getRetryInterval());
-	}
-
 }

java/src/test/resources/test_cybs.properties

@@ -15,19 +15,21 @@ sendToAkamai=true
 
 #useHttpClient=false
 
+# Following configure parameters will only work with useHttpClient=true
+# "allow retry" property toggle value "true/false" to turn on /off the auto request retry. 
+# Number of retries is the number of attempts made to send the request. 
+# Retry interval is the wait time in between the attempts to send the request.
+# Retry count configuration, interval unit is in seconds.
+# Default values are for allowRetry=true, numberOfRetries=5 and retryInterval=5 seconds.
+allowRetry=true
+numberOfRetries=5
+retryInterval=5
+
 # Mechanism to differentiate whether Payload is encrypted or not
 useSignAndEncrypted=false
 
 timeout=1000
 
-# allowRetry flag can be set to true to enable retry. numberOfRetries is the number of attempts made to send 
-# the request. retryInterval is the wait time in between the attempts to send the request.
-# Retry count configuration, interval unit is in seconds.
-# Default values for allowRetry=true, numberOfRetries=1 and retryInterval=10seconds.
-allowRetry=true
-numberOfRetries=1
-retryInterval=10
-
 # logging should normally be disabled in production as it would slow down the
 # processing.  Enable it only when troubleshooting an issue.
 enableLog=true