code review comments and code reviews fixes

Author: mahendya1002

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

@@ -40,7 +40,7 @@
 import static com.cybersource.ws.client.Utility.*;
 
 /**
- * Class containing runTransaction() methods that accept the requests in the
+ * Containing runTransaction() methods that accept the requests in the
  * form of a Map object.
  */
 public class Client {
@@ -62,7 +62,7 @@ public class Client {
      * @throws FaultException  if a fault occurs.
      * @throws ClientException if any other exception occurs.
      */
-    public static Map runTransaction(Map<String,String> request, Properties props)
+    public static Map<String,String> runTransaction(Map<String,String> request, Properties props)
             throws FaultException, ClientException {
         return (runTransaction(
                 request, props, null, true, true));
@@ -248,8 +248,18 @@ private static Document soapWrapAndSign(
         return resultDocument ;
     }
 
+
+    /**
+     * Wraps the given Map object in SOAP envelope.
+     *
+     * @param request Map object containing the request.
+     * @param mc      MerchantConfig object.
+     * @param builder	    DocumentBuilder object.
+     * @return document.
+     * @throws IOException   if reading from string fails.
+     * @throws SAXException
+     */
     private static Document soapWrap(Map request, MerchantConfig mc, DocumentBuilder builder) throws SAXException, IOException{
-    	// wrap in SOAP envelope
         Object[] arguments
                 = {mc.getEffectiveNamespaceURI(),
                 mapToString(request, false, PCI.REQUEST)};
@@ -277,7 +287,6 @@ private static HashMap<String, String> soapUnwrap(
 
         boolean logSignedData = mc.getLogSignedData();
 
-
         if (logSignedData) {
             logger.log(Logger.LT_REPLY,
                     Utility.nodeToString(doc, PCI.REPLY));

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

@@ -21,7 +21,8 @@
 import java.net.HttpURLConnection;
 
 /**
- * Exception class used by both Basic and XML clients.
+ * Used by both Basic and XML clients.
+ * All exceptions other than faults are wrapped in ClientException.
  */
 public class ClientException
         extends Exception {
@@ -31,7 +32,6 @@ public class ClientException
     private String httpError = null;
 
     /**
-     * Constructor.
      *
      * @param _innerException the actual exception that occurred.
      * @param logger          used to log the exception details.
@@ -43,7 +43,6 @@ public ClientException(
     }
 
     /**
-     * Constructor.
      *
      * @param _innerException the actual exception that occurred.
      * @param _critical       flag that tells whether or not the exception
@@ -59,7 +58,6 @@ public ClientException(
     }
 
     /**
-     * Constructor.
      *
      * @param _httpStatusCode HTTP status code
      * @param logger          used to log the exception details.
@@ -72,7 +70,6 @@ public ClientException(int _httpStatusCode, Logger logger) {
     }
 
     /**
-     * Constructor.
      *
      * @param _httpStatusCode HTTP status code
      * @param _httpError      Additional HTTP error information; may be null.
@@ -86,7 +83,6 @@ public ClientException(
     }
 
     /**
-     * Constructor.
      *
      * @param _httpStatusCode HTTP status code
      * @param _httpError      Additional HTTP error information; may be null.

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

@@ -26,7 +26,6 @@
  */
 public class ConfigException extends Exception {
     /**
-     * Constructor.
      *
      * @param message exception message.
      */

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

@@ -1,20 +1,20 @@
 /*
-* Copyright 2003-2014 CyberSource Corporation
-*
-* THE SOFTWARE AND THE DOCUMENTATION ARE PROVIDED ON AN "AS IS" AND "AS
-* AVAILABLE" BASIS WITH NO WARRANTY.  YOU AGREE THAT YOUR USE OF THE SOFTWARE AND THE
-* DOCUMENTATION IS AT YOUR SOLE RISK AND YOU ARE SOLELY RESPONSIBLE FOR ANY DAMAGE TO YOUR
-* COMPUTER SYSTEM OR OTHER DEVICE OR LOSS OF DATA THAT RESULTS FROM SUCH USE. TO THE FULLEST
-* EXTENT PERMISSIBLE UNDER APPLICABLE LAW, CYBERSOURCE AND ITS AFFILIATES EXPRESSLY DISCLAIM ALL
-* WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, WITH RESPECT TO THE SOFTWARE AND THE
-* DOCUMENTATION, INCLUDING ALL WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
-* SATISFACTORY QUALITY, ACCURACY, TITLE AND NON-INFRINGEMENT, AND ANY WARRANTIES THAT MAY ARISE
-* OUT OF COURSE OF PERFORMANCE, COURSE OF DEALING OR USAGE OF TRADE.  NEITHER CYBERSOURCE NOR
-* ITS AFFILIATES WARRANT THAT THE FUNCTIONS OR INFORMATION CONTAINED IN THE SOFTWARE OR THE
-* DOCUMENTATION WILL MEET ANY REQUIREMENTS OR NEEDS YOU MAY HAVE, OR THAT THE SOFTWARE OR
-* DOCUMENTATION WILL OPERATE ERROR FREE, OR THAT THE SOFTWARE OR DOCUMENTATION IS COMPATIBLE
-* WITH ANY PARTICULAR OPERATING SYSTEM.
-*/
+ * Copyright 2003-2014 CyberSource Corporation
+ *
+ * THE SOFTWARE AND THE DOCUMENTATION ARE PROVIDED ON AN "AS IS" AND "AS
+ * AVAILABLE" BASIS WITH NO WARRANTY.  YOU AGREE THAT YOUR USE OF THE SOFTWARE AND THE
+ * DOCUMENTATION IS AT YOUR SOLE RISK AND YOU ARE SOLELY RESPONSIBLE FOR ANY DAMAGE TO YOUR
+ * COMPUTER SYSTEM OR OTHER DEVICE OR LOSS OF DATA THAT RESULTS FROM SUCH USE. TO THE FULLEST
+ * EXTENT PERMISSIBLE UNDER APPLICABLE LAW, CYBERSOURCE AND ITS AFFILIATES EXPRESSLY DISCLAIM ALL
+ * WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, WITH RESPECT TO THE SOFTWARE AND THE
+ * DOCUMENTATION, INCLUDING ALL WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE,
+ * SATISFACTORY QUALITY, ACCURACY, TITLE AND NON-INFRINGEMENT, AND ANY WARRANTIES THAT MAY ARISE
+ * OUT OF COURSE OF PERFORMANCE, COURSE OF DEALING OR USAGE OF TRADE.  NEITHER CYBERSOURCE NOR
+ * ITS AFFILIATES WARRANT THAT THE FUNCTIONS OR INFORMATION CONTAINED IN THE SOFTWARE OR THE
+ * DOCUMENTATION WILL MEET ANY REQUIREMENTS OR NEEDS YOU MAY HAVE, OR THAT THE SOFTWARE OR
+ * DOCUMENTATION WILL OPERATE ERROR FREE, OR THAT THE SOFTWARE OR DOCUMENTATION IS COMPATIBLE
+ * WITH ANY PARTICULAR OPERATING SYSTEM.
+ */
 
 package com.cybersource.ws.client;
 
@@ -38,33 +38,32 @@
 
 
 /**
- * Connection class is a factory class for creating an instance for HttpClientConnection or
+ * It is a factory class for creating an instance for HttpClientConnection or
  * JDKHttpURLConnection or PoolingHttpClientConnection.
- *
- * @author sunagara
  */
 abstract public class Connection {
     final MerchantConfig mc;
     private final DocumentBuilder builder;
     final LoggerWrapper logger;
-    
-   /**
-    * Constructor.
-    * 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) {
+
+    /**
+     * 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;
         this.logger = logger;
     }
 
     /**
      * Get connection instance based on properties
+     *
      * @param mc
      * @param builder
      * @param logger
@@ -73,30 +72,33 @@ protected Connection(MerchantConfig mc, DocumentBuilder builder,
      */
     public static Connection getInstance(
             MerchantConfig mc, DocumentBuilder builder, LoggerWrapper logger) throws ClientException {
-        if (mc.getUseHttpClient()) {
-            return new HttpClientConnection(mc, builder, logger);
-        } else if (mc.getUseHttpClientWithConnectionPool()) {
+        if (mc.getUseHttpClientWithConnectionPool()) {
             return new PoolingHttpClientConnection(mc, builder, logger);
+        } else if (mc.getUseHttpClient()) {
+            return new HttpClientConnection(mc, builder, logger);
         } else {
             // HttpClient is not set in properties file then JDKHttpURLConnection class instance.
             return new JDKHttpURLConnection(mc, builder, logger);
         }
     }
 
     /**
-     * Abstract method to check is request sent or not
+     * method to check is request sent or not
+     *
      * @return boolean
      */
     abstract public boolean isRequestSent();
 
     /**
-     * Abstract method to release the connection related objects
+     * method to release the connection related objects
+     *
      * @throws ClientException
      */
     abstract public void release() throws ClientException;
 
     /**
-     * Abstract method to post request
+     * method to post request
+     *
      * @param request
      * @param startTime
      * @throws IOException
@@ -111,23 +113,20 @@ abstract void postDocument(Document request, long startTime)
             ProtocolException;
 
     /**
-     * Abstract method to get http response code
      * @return int
      * @throws IOException
      */
     abstract int getHttpResponseCode()
             throws IOException;
 
     /**
-     * Abstract method to get response stream
      * @return InputStream
      * @throws IOException
      */
     abstract InputStream getResponseStream()
             throws IOException;
 
     /**
-     * Abstract method to get response error stream
      * @return InputStram
      * @throws IOException
      */
@@ -136,6 +135,7 @@ abstract InputStream getResponseErrorStream()
 
     /**
      * Post the request document and validate the response for any faults from the Server.
+     *
      * @param request - Request document
      * @return - Response XML as Document object.
      * @throws ClientException
@@ -162,7 +162,8 @@ public Document post(Document request, long startTime)
 
 
     /**
-     * Validate the Http response for any faults returned from the server. 
+     * Validate the Http response for any faults returned from the server.
+     *
      * @throws FaultException
      * @throws ClientException
      */
@@ -230,7 +231,8 @@ private void checkForFault()
     }
 
     /**
-     * Method helps to parse/read the response xml into Document object.
+     * Helps to parse/read the response xml into Document object.
+     *
      * @return - returns a Document object
      * @throws IOException
      * @throws SAXException
@@ -246,7 +248,8 @@ private Document parseReceivedDocument()
 
     /**
      * Converts the Document object into ByteArrayStream.
-     * @param doc  - Document object
+     *
+     * @param doc - Document object
      * @return ByteArrayStream
      * @throws TransformerConfigurationException
      * @throws TransformerException
@@ -263,15 +266,9 @@ static ByteArrayOutputStream makeStream(Document doc)
         return baos;
     }
 
-    /**
-     * Log Request Headers
-     */
-    	abstract public void logRequestHeaders();
+    abstract public void logRequestHeaders();
 
-    /**
-     * Log Response Headers
-     */
-    	abstract public void logResponseHeaders();
+    abstract public void logResponseHeaders();
 }
 
 

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

@@ -30,7 +30,6 @@
 /**
  * Helps in creating the Proxy and adding Proxy credentials to JDKHttpURLConnection.
  *
- * @author sunagara
  */
 public class ConnectionHelper {