sync

Author: mahendya1002

README.md

@@ -66,6 +66,7 @@ You do not need to download and build the source to use the SDK but if you want
     - If `useHttpClientWithConnectionPool` parameter is set to true (default is false), then poolingHttpClientConnection will be enabled
      - In case of poolingHttpConnection, we are initializing connection manager and httpclient once, If any change in value in between the application is running, it will not reflect. need to restart it. 
      - Refer to the [PoolingHttpClient Shutdown](README.md#poolinghttpclientshutdown) section below.
+    - If`enabledShutdownHook` is true (default is true), enables JVM runtime shutdown hook and execute our shutdown api. This is applicable only when useHttpClientWithConnectionPool is true.
     - Below properties are specific to poolinghttpclient connection, If it is not added in properties file, it will throw config exception.
       Note : Below default values used in properties files are based on our testing application factors such as TPS, CPU, JVM, OS etc
       Before using these values in actual real time application, please consider all real time factors. Refer this link for more detailed explanation.
@@ -166,7 +167,7 @@ try {
 
 ## PoolingHttpClientShutdown
 In case of PoolingHttpClient Connection, we need to close the connection manager, http client and idle connection cleaner thread when application got shutdown abruptly or gracefully.
-JVM runtime addShutdownHook method will be initialized.
+If `enabledShutdownHook` is true, then JVM runtime addShutdownHook method will be initialized.
 Shutdown Hooks are a special construct that allows developers to plug in a piece of code to be executed when the JVM is shutting down. This comes in handy in cases where we need to do special clean up operations in case the VM is shutting down.
 private void addShutdownHook() {
         Runtime.getRuntime().addShutdownHook(this.createShutdownHookThread());
@@ -227,6 +228,7 @@ _______________________________
   2)Added PoolingHttpClientConnection implementation
   3)Changed retry interval from second to millisecond
   4)Added one more request header "v-c-client-computetime" to calculate time taken to send request to cybersource
+  
 
 Version Cybersource-sdk-java 6.2.9 (APR,2020)
 _______________________________

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

@@ -51,6 +51,8 @@ public class PoolingHttpClientConnectionIT {
         }
     }
 
+    private String message= "pooling httpclient is disabled";
+
     @Before
     public void start(){
         Properties merchantProperties = new Properties();
@@ -68,12 +70,15 @@ public void start(){
             builder = Utility.newDocumentBuilder();
             request = Utility.readRequest(merchantProperties, requestFilename);
             mc = new MerchantConfig(merchantProperties, null);
-            String merchantID = mc.getMerchantID();
-            String nsURI = mc.getEffectiveNamespaceURI();
-            setMerchantID(request, merchantID, nsURI);
-            logger = new LoggerWrapper(null, true, true, mc);
-
-            con = new PoolingHttpClientConnection(mc, builder, logger);
+            if(mc.getUseHttpClientWithConnectionPool()) {
+                String merchantID = mc.getMerchantID();
+                String nsURI = mc.getEffectiveNamespaceURI();
+                setMerchantID(request, merchantID, nsURI);
+                logger = new LoggerWrapper(null, true, true, mc);
+                con = new PoolingHttpClientConnection(mc, builder, logger);
+            } else {
+                Assert.assertEquals("pooling httpclient is disabled", message);
+            }
         } catch (ParserConfigurationException e) {
             e.printStackTrace();
         } catch (ConfigException e) {
@@ -88,7 +93,11 @@ public void start(){
      */
     @Test
     public void testGetInstance(){
-        Assert.assertNotNull(con);
+        if(mc.getUseHttpClientWithConnectionPool()) {
+            Assert.assertNotNull(con);
+        } else {
+            Assert.assertNull(con);
+        }
     }
 
     /**
@@ -97,26 +106,30 @@ public void testGetInstance(){
     @Test
     public void testPostRequest(){
         try {
-            Element requestMessage
-                    = Utility.getElement(
-                    request, "requestMessage", mc.getEffectiveNamespaceURI());
-            Document wrappedDoc = builder.newDocument();
+            if(mc.getUseHttpClientWithConnectionPool()) {
+                Element requestMessage
+                        = Utility.getElement(
+                        request, "requestMessage", mc.getEffectiveNamespaceURI());
+                Document wrappedDoc = builder.newDocument();
 
-            wrappedDoc.appendChild(
-                    wrappedDoc.importNode(soapEnvelope.getFirstChild(), true));
+                wrappedDoc.appendChild(
+                        wrappedDoc.importNode(soapEnvelope.getFirstChild(), true));
 
-            if (requestMessage != null) {
-                wrappedDoc.getFirstChild().getFirstChild().appendChild(
-                        wrappedDoc.importNode(requestMessage, true));
+                if (requestMessage != null) {
+                    wrappedDoc.getFirstChild().getFirstChild().appendChild(
+                            wrappedDoc.importNode(requestMessage, true));
+                }
+                SecurityUtil.loadMerchantP12File(mc,logger);
+                signedDoc = SecurityUtil.createSignedDoc(wrappedDoc, mc.getKeyAlias(), mc.getKeyPassword(), logger);
+                Document wrappedReply = con.post(signedDoc, requestSentTime);
+                Assert.assertNotNull(wrappedReply);
+                //test the http response code
+                Assert.assertEquals(200, con.getHttpResponseCode());
+                //test the http request sent or not
+                Assert.assertEquals(true, con.isRequestSent());
+            } else {
+                Assert.assertEquals("pooling httpclient is disabled", message);
             }
-            SecurityUtil.loadMerchantP12File(mc,logger);
-            signedDoc = SecurityUtil.createSignedDoc(wrappedDoc, mc.getKeyAlias(), mc.getKeyPassword(), logger);
-            Document wrappedReply = con.post(signedDoc, requestSentTime);
-            Assert.assertNotNull(wrappedReply);
-            //test the http response code
-            Assert.assertEquals(200, con.getHttpResponseCode());
-            //test the http request sent or not
-            Assert.assertEquals(true, con.isRequestSent());
 
         } catch (ClientException e) {
             e.printStackTrace();

java/src/test/resources/test_cybs.properties

@@ -11,7 +11,7 @@ targetAPIVersion=1.139
 # the serverURL config is commented out.
 sendToProduction=false
 sendToAkamai=false
-serverURL=http://ratelimiter.ic3.com:9198
+#serverURL=http://ratelimiter.ic3.com:9198
 
 
 #To enable HttpClientConnection
@@ -20,6 +20,7 @@ useHttpClient=false
 useHttpClientWithConnectionPool=false
 # Following configure parameters will only work with useHttpClientWithConnectionPool=true
 # Optional parameters, default values configured in application
+enabledShutdownHook=true
 maxConnections=200
 defaultMaxConnectionsPerRoute=200
 maxConnectionsPerRoute=200

samples/nvp/cybs.properties

@@ -21,6 +21,7 @@ useHttpClient=false
 useHttpClientWithConnectionPool=false
 # Following configure parameters will only work with useHttpClientWithConnectionPool=true
 # Optional parameters, default values configured in application
+enabledShutdownHook=true
 maxConnections=200
 defaultMaxConnectionsPerRoute=200
 maxConnectionsPerRoute=200

samples/xml/cybs.properties

@@ -21,6 +21,7 @@ useHttpClient=false
 useHttpClientWithConnectionPool=false
 # Following configure parameters will only work with useHttpClientWithConnectionPool=true
 # Optional parameters, default values configured in application
+enabledShutdownHook=true
 maxConnections=200
 defaultMaxConnectionsPerRoute=200
 maxConnectionsPerRoute=200

zip/README

@@ -75,9 +75,11 @@ Refer to our Developer's Guide for details <http://apps.cybersource.com/library/
 
     l. If "useHttpClientWithConnectionPool" parameter is set to true (default is false), then poolingHttpClientConnection will be enabled.
          - In case of poolingHttpConnection, we are initializing connection manager and httpclient once, If any change in value in between the application is running, it will not reflect. need to restart it.
+
+    m. If "enabledShutdownHook" is set to true (default is true), enables JVM runtime shutdown hook and execute our shutdown api. This is applicable only when useHttpClientWithConnectionPool is true.
          - Refer to the "PoolingHttpClientShutdown" section below.
 
-    m. Below properties are specific to poolinghttpclient connection, If it is not added in properties file, it will throw config exception.
+    n. Below properties are specific to poolinghttpclient connection, If it is not added in properties file, it will throw config exception.
          Note : Below default values used in properties files are based on our testing application factors such as TPS, CPU, JVM, OS etc
          Before using these values in actual real time application, please consider all real time factors. Refer this link for more detailed explanation.
          - `maxConnections` set the maximum number of total open connections. default value is 200
@@ -89,10 +91,10 @@ Refer to our Developer's Guide for details <http://apps.cybersource.com/library/
          - `evictThreadSleepTimeMs` amount of time in milliseconds between sweeps by the idle connection evictor thread. default value is 3000
          - `maxKeepAliveTimeMs` maximum amount of time in milliseconds that a connaection can be idle before it is evicted from the pool. default value is 30000
 
-    n. If "merchantConfigCacheEnabled" is set to true (default value is false) it will cache the merchantConfig object based on keyAlias/merchantID
+    o. If "merchantConfigCacheEnabled" is set to true (default value is false) it will cache the merchantConfig object based on keyAlias/merchantID
          - If cache enabled is true, for single merchant id, if you change any properties after first initialization, it will not reflect.
 
-    o. Please refer to the accompanying documentation for the other optional properties that you may wish to specify.
+    p. Please refer to the accompanying documentation for the other optional properties that you may wish to specify.
 
 ##Testing the Client
 1.) Unzip the downloaded zip file into a directory of your choice.  It will create a directory called
@@ -148,7 +150,7 @@ try {
 
 ##PoolingHttpClientShutdown
 In case of PoolingHttpClient Connection, we need to close the connection manager, http client and idle connection cleaner thread when application got shutdown abruptly or gracefully.
-JVM runtime addshutdown hook method will be initialized.
+If "enabledShutdownHook" is true, then JVM runtime addShutdownHook method will be initialized.
 Shutdown Hooks are a special construct that allows developers to plug in a piece of code to be executed when the JVM is shutting down. This comes in handy in cases where we need to do special clean up operations in case the VM is shutting down.
 private void addShutdownHook() {
         Runtime.getRuntime().addShutdownHook(this.createShutdownHookThread());