Merge pull request #82 from adkumar3/future

Custom HTTP Library

Author: shamirwasia

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.
 a. mvn clean  // Cleans the Project
 

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/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/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

@@ -32,6 +32,12 @@ 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