readme changes and added staleconnecttion check

mahendya1002 · mahendya1002 · commit 3c2c610dcdf2 · 2020-04-29T14:40:20.000+05:30
diff --git a/README.md b/README.md
@@ -296,6 +296,24 @@ Version Cybersource-sdk-java 6.1.0 (Feb 24,2016)
 _______________________________
   1) SHA256 changes which are required to signed the request with SHA256.
 
+## Troubleshooting
+- If you get an exception **java.lang.SecurityException: JCE cannot authenticate the provider BC**. This could be because of
+  many reasons. bcprov*.jar is a signed jar if java fails to validate the signature, it throws this exception. Make sure
+  you run below java command to verify this signature.
+    jarsigner -verify bcprov-jdk15on-1.61.jar   
+  when above command fails it says "jar is unsigned. (signatures missing or not parsable)", this could be because of many
+  reasons. e.g 
+        1) When we unpack it and include in our own jar file. Including bcprov*.jar separately in the CLASSPATH should solve this issue.
+        2) May be changes in Oracle jar signer. If using Java SDK 1.6 or 1.7 with cybersource-sdk-java:6.2.7 and higher 
+           (ships with org.bouncycastle:bcprov-jdk15on:1.61). Upgrading version to bcprov-jdk15to18-1.63.jar should solve this issue.
+        3) If you are using some old version of JBOSS and have copied bcprov*.jar under $JBOSS_HOME/server/default/lib/. 
+            copying bcprov*.jar in $JBOSS_HOME/server/default/lib/ instead of $JBOSS_HOME/server/servername/lib/ should solve this issue.
+            
+- If you get an exception  **exception decrypting data - java.security.InvalidKeyException: Illegal key size**. 
+  It is recommended to download Unlimited Strength Jurisdiction Policy files from Oracle (US_export_policy.jar and local_policy.jar) 
+  for appropriate JAVA version. I meant if merchant are using java 6 then download these policy file only for java6. 
+  You need to copy security jars (US_export_policy.jar, local_policy.jar) in the $JAVA_HOME/jre/lib/security directory not in $JAVA_HOME/jre/lib/ext/).
+
 ## 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>.
diff --git a/java/src/main/java/com/cybersource/ws/client/MerchantConfig.java b/java/src/main/java/com/cybersource/ws/client/MerchantConfig.java
@@ -78,8 +78,8 @@ public class MerchantConfig {
     private boolean customHttpClassEnabled;
     private boolean certificateCacheEnabled; 
     private boolean merchantConfigCacheEnabled;
+    private boolean staleConnectionCheckEnabled;
     private boolean shutdownHookEnabled;
-    
     public String getcustomHttpClass() {
 		return customHttpClass;
 	}
@@ -381,6 +381,14 @@ public boolean isMerchantConfigCacheEnabled() {
         return merchantConfigCacheEnabled;
     }
 
+    /**
+     * Getter method for staleConnectionCheckEnabled
+     * @return boolean
+     */
+    public boolean isStaleConnectionCheckEnabled() {
+        return staleConnectionCheckEnabled;
+    }
+
     /**
      * Getter method for shutdownHookEnabled
      * @return boolean
@@ -534,52 +542,77 @@ public MerchantConfig(Properties _props, String _merchantID)
                 throw new ConfigException("maxConnections property is empty");
             } else {
                 maxConnections = getIntegerProperty(merchantID, "maxConnections");
+                if(maxConnections <= 0){
+                    throw new ConfigException("maxConnections property can't be 0 or negative");
+                }
             }
 
             if(StringUtils.isEmpty(getProperty(merchantID, "defaultMaxConnectionsPerRoute"))) {
                 throw new ConfigException("defaultMaxConnectionsPerRoute property is empty");
             } else {
                 defaultMaxConnectionsPerRoute = getIntegerProperty(merchantID, "defaultMaxConnectionsPerRoute");
+                if(defaultMaxConnectionsPerRoute <= 0){
+                    throw new ConfigException("defaultMaxConnectionsPerRoute property can't be 0 or negative");
+                }
             }
 
             if(StringUtils.isEmpty(getProperty(merchantID, "maxConnectionsPerRoute"))) {
                 throw new ConfigException("maxConnectionsPerRoute property is empty");
             } else {
                 maxConnectionsPerRoute = getIntegerProperty(merchantID, "maxConnectionsPerRoute");
+                if(maxConnectionsPerRoute <= 0){
+                    throw new ConfigException("maxConnectionsPerRoute property can't be 0 or negative");
+                }
             }
 
             if(StringUtils.isEmpty(getProperty(merchantID, "connectionRequestTimeoutMs"))) {
                 throw new ConfigException("connectionRequestTimeoutMs property is empty");
             } else {
                 connectionRequestTimeoutMs = getIntegerProperty(merchantID, "connectionRequestTimeoutMs");
+                if(connectionRequestTimeoutMs <= 0){
+                    throw new ConfigException("connectionRequestTimeoutMs property can't be 0 or negative");
+                }
             }
 
             if(StringUtils.isEmpty(getProperty(merchantID, "connectionTimeoutMs"))) {
                 throw new ConfigException("connectionTimeoutMs property is empty");
             } else {
                 connectionTimeoutMs = getIntegerProperty(merchantID, "connectionTimeoutMs");
+                if(connectionTimeoutMs <= 0){
+                    throw new ConfigException("connectionTimeoutMs property can't be 0 or negative");
+                }
             }
 
             if(StringUtils.isEmpty(getProperty(merchantID, "socketTimeoutMs"))) {
                 throw new ConfigException("socketTimeoutMs property is empty");
             } else {
                 socketTimeoutMs = getIntegerProperty(merchantID, "socketTimeoutMs");
+                if(socketTimeoutMs <= 0){
+                    throw new ConfigException("socketTimeoutMs property can't be 0 or negative");
+                }
             }
 
             if(StringUtils.isEmpty(getProperty(merchantID, "evictThreadSleepTimeMs"))) {
                 throw new ConfigException("evictThreadSleepTimeMs property is empty");
             } else {
                 evictThreadSleepTimeMs = getIntegerProperty(merchantID, "evictThreadSleepTimeMs");
+                if(evictThreadSleepTimeMs <= 0){
+                    throw new ConfigException("evictThreadSleepTimeMs property can't be 0 or negative");
+                }
             }
 
             if(StringUtils.isEmpty(getProperty(merchantID, "maxKeepAliveTimeMs"))) {
                 throw new ConfigException("maxKeepAliveTimeMs property is empty");
             } else {
                 maxKeepAliveTimeMs = getIntegerProperty(merchantID, "maxKeepAliveTimeMs");
+                if(maxKeepAliveTimeMs <= 0){
+                    throw new ConfigException("maxKeepAliveTimeMs property can't be 0 or negative");
+                }
             }
 
-            validateAfterInactivityMs = getIntegerProperty(merchantID, "validateAfterInactivityMs", 2000);
-            shutdownHookEnabled =getBooleanProperty(merchantID, "enabledShutdownHook", true);
+            validateAfterInactivityMs = getIntegerProperty(merchantID, "validateAfterInactivityMs", 0);
+            staleConnectionCheckEnabled = getBooleanProperty(merchantID, "staleConnectionCheckEnabled", true);
+            shutdownHookEnabled = getBooleanProperty(merchantID, "enabledShutdownHook", true);
         }
         
         allowRetry  = getBooleanProperty(merchantID, "allowRetry", true);
@@ -772,6 +805,7 @@ public String getLogString() {
             appendPair(sb, "evictThreadSleepTimeMs", evictThreadSleepTimeMs);
             appendPair(sb, "maxKeepAliveTimeMs", maxKeepAliveTimeMs);
             appendPair(sb, "validateAfterInactivityMs", validateAfterInactivityMs);
+            appendPair(sb, "staleConnectionCheckEnabled", staleConnectionCheckEnabled);
             appendPair(sb, "enabledShutdownHook", shutdownHookEnabled);
         }
         appendPair(sb, "timeout", timeout);
diff --git a/java/src/main/java/com/cybersource/ws/client/PoolingHttpClientConnection.java b/java/src/main/java/com/cybersource/ws/client/PoolingHttpClientConnection.java
@@ -32,6 +32,7 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
 
 import static com.cybersource.ws.client.Utility.*;
 
@@ -44,6 +45,7 @@ public class PoolingHttpClientConnection extends Connection {
     private HttpPost httpPost = null;
     private HttpClientContext httpContext = null;
     private CloseableHttpResponse httpResponse = null;
+
     private static CloseableHttpClient httpClient = null;
     private static IdleConnectionMonitorThread staleMonitorThread;
     private final static String STALE_CONNECTION_MONITOR_THREAD_NAME = "http-stale-connection-cleaner-thread";
@@ -107,6 +109,8 @@ protected void initHttpClient(MerchantConfig merchantConfig, PoolingHttpClientCo
         RequestConfig.Builder requestConfigBuilder = RequestConfig.custom()
                 .setSocketTimeout(merchantConfig.getSocketTimeoutMs())
                 .setConnectionRequestTimeout(merchantConfig.getConnectionRequestTimeoutMs())
+                //This we added to check every connection before leasing.
+                .setStaleConnectionCheckEnabled(merchantConfig.isStaleConnectionCheckEnabled())
                 .setConnectTimeout(merchantConfig.getConnectionTimeoutMs());
 
         HttpClientBuilder httpClientBuilder = HttpClients.custom()
@@ -209,6 +213,12 @@ public static void onShutdown() throws IOException {
         if (staleMonitorThread != null && staleMonitorThread.isAlive()) {
             staleMonitorThread.shutdown();
         }
+        //wait before shutdown.
+        try {
+            Thread.sleep(1000);
+        } catch (InterruptedException var4) {
+            Thread.currentThread().interrupt();
+        }
     }
 
     /**
@@ -323,22 +333,6 @@ public boolean retryRequest(IOException exception, int executionCount, HttpConte
                 return false;
             }
 
-            if (exception instanceof NoHttpResponseException) {
-                System.out.println("not retrying as it is NoHttpResponseException and request is sent");
-                return false;
-            }
-
-//            if (exception instanceof NoHttpResponseException) {
-//                System.out.println("retrying as it NoHttpResponseException and request is not sent");
-//                return true;
-//            }
-//
-//            if (exception instanceof java.net.SocketException &&  (exception.getMessage().equalsIgnoreCase("Connection reset") ||
-//                    exception.getLocalizedMessage().equalsIgnoreCase("Connection reset"))) {
-//
-//                System.out.println("retrying for connection reset");
-//                return true;
-//            }
             HttpClientContext httpClientContext = HttpClientContext.adapt(httpContext);
             if (!httpClientContext.isRequestSent()) {
                 try {
@@ -349,6 +343,12 @@ public boolean retryRequest(IOException exception, int executionCount, HttpConte
                 }
                 return true;
             }
+
+            if (exception instanceof NoHttpResponseException) {
+                System.out.println("not retrying as it is NoHttpResponseException and request is sent");
+                return false;
+            }
+
             return false;
         }
     }
diff --git a/samples/nvp/pom.xml b/samples/nvp/pom.xml
@@ -67,6 +67,15 @@
     </dependencies>
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.1</version>
+                <configuration>
+                    <source>1.6</source>
+                    <target>1.6</target>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>exec-maven-plugin</artifactId>
diff --git a/samples/xml/pom.xml b/samples/xml/pom.xml
@@ -67,6 +67,15 @@
     </dependencies>
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.1</version>
+                <configuration>
+                    <source>1.6</source>
+                    <target>1.6</target>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>exec-maven-plugin</artifactId>
diff --git a/zip/README b/zip/README
@@ -315,6 +315,24 @@ Version Cybersource-sdk-java 6.1.0 (Feb 24,2016)
 _______________________________
   1) SHA256 changes which are required to signed the request with SHA256.
 
+##Troubleshooting
+- If you get an exception **java.lang.SecurityException: JCE cannot authenticate the provider BC**. This could be because of
+  many reasons. bcprov*.jar is a signed jar if java fails to validate the signature, it throws this exception. Make sure
+  you run below java command to verify this signature.
+    jarsigner -verify bcprov-jdk15on-1.61.jar
+  when above command fails it says "jar is unsigned. (signatures missing or not parsable)", this could be because of many
+  reasons. e.g
+        1) When we unpack it and include in our own jar file. Including bcprov*.jar separately in the CLASSPATH should solve this issue.
+        2) May be changes in Oracle jar signer. If using Java SDK 1.6 or 1.7 with cybersource-sdk-java:6.2.7 and higher
+           (ships with org.bouncycastle:bcprov-jdk15on:1.61). Upgrading version to bcprov-jdk15to18-1.63.jar should solve this issue.
+        3) If you are using some old version of JBOSS and have copied bcprov*.jar under $JBOSS_HOME/server/default/lib/.
+            copying bcprov*.jar in $JBOSS_HOME/server/default/lib/ instead of $JBOSS_HOME/server/servername/lib/ should solve this issue.
+
+- If you get an exception  **exception decrypting data - java.security.InvalidKeyException: Illegal key size**.
+  It is recommended to download Unlimited Strength Jurisdiction Policy files from Oracle (US_export_policy.jar and local_policy.jar)
+  for appropriate JAVA version. I meant if merchant are using java 6 then download these policy file only for java6.
+  You need to copy security jars (US_export_policy.jar, local_policy.jar) in the $JAVA_HOME/jre/lib/security directory not in $JAVA_HOME/jre/lib/ext/).
+
 ##Documentation
 
 For more information about CyberSource services, see <http://www.cybersource.com/developers/documentation>
diff --git a/zip/pom.xml b/zip/pom.xml
@@ -15,6 +15,15 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.1</version>
+                <configuration>
+                    <source>1.6</source>
+                    <target>1.6</target>
+                </configuration>
+            </plugin>
             <plugin>
                 <artifactId>maven-assembly-plugin</artifactId>
                 <version>2.3</version>
