JavaDoc -> added javadoc for methods in client files

Author: Mayuri-Kumar93

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

@@ -312,6 +312,13 @@ static String mapToString(Map src, boolean mask, int type) {
        return Utility.mapToString(src, mask, type);
     }
 
+    /**
+     * Get Merchant Config object based on request and properties
+     * @param request
+     * @param props
+     * @return MerchantConfig
+     * @throws ConfigException
+     */
     static private MerchantConfig getMerchantConfigObject(Map<String, String> request, Properties props) throws ConfigException {
         MerchantConfig mc;
         String merchantID = request.get(MERCHANT_ID);
@@ -328,6 +335,12 @@ static private MerchantConfig getMerchantConfigObject(Map<String, String> reques
         return mc;
     }
 
+    /**
+     * Get Merchant Id from request, If merchantId is null, get it from properties
+     * @param request
+     * @param props
+     * @return String
+     */
     private static String getMerchantId(Map<String, String> request, Properties props) {
         String merchantID = request.get(MERCHANT_ID);
         if (merchantID == null) {
@@ -338,6 +351,12 @@ private static String getMerchantId(Map<String, String> request, Properties prop
         return merchantID;
     }
 
+    /**
+     * get KeyAlias from property, If keyAlias is null, return merchant Id
+     * @param request
+     * @param props
+     * @return String
+     */
     private static String getKeyForInstanceMap(Map<String, String> request, Properties props) {
         String keyAlias = props.getProperty(KEY_ALIAS);
         if(keyAlias != null) {
@@ -347,6 +366,14 @@ private static String getKeyForInstanceMap(Map<String, String> request, Properti
         return getMerchantId(request, props);
     }
 
+    /**
+     * Get Merchant config instance from concurrent hash map in memory cache .
+     * If it is empty, it will create new merchant config object and put it in map for reuse.
+     * @param request
+     * @param props
+     * @return MerchantConfig
+     * @throws ConfigException
+     */
     private static MerchantConfig getInstanceMap(Map<String, String> request, Properties props) throws ConfigException {
         String midOrKeyAlias = getKeyForInstanceMap(request, props);
 

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

@@ -399,6 +399,15 @@ private static Document soapWrapAndSign(
         return resultDocument ;
     }
 
+    /**
+     * Wraps the given Map object in SOAP envelope
+     * @param doc
+     * @param mc
+     * @param builder
+     * @param logger
+     * @return Document
+     * @throws SignException
+     */
     private static Document soapWrap(Document doc, MerchantConfig mc, DocumentBuilder builder, LoggerWrapper logger) throws SignException{
     	// look for the requestMessage element
         Element requestMessage
@@ -420,6 +429,14 @@ private static Document soapWrap(Document doc, MerchantConfig mc, DocumentBuilde
         return wrappedDoc;
     }
 
+    /**
+     * Convert Document to String
+     * @param doc
+     * @return String
+     * @throws TransformerConfigurationException
+     * @throws TransformerException
+     * @throws IOException
+     */
     private static String documentToString(Document doc)
             throws TransformerConfigurationException, TransformerException,
             IOException {
@@ -434,6 +451,13 @@ private static String documentToString(Document doc)
         }
     }
 
+    /**
+     * Tranform document to byte array output stream
+     * @param doc
+     * @return ByteArrayOutputStream
+     * @throws TransformerConfigurationException
+     * @throws TransformerException
+     */
     private static ByteArrayOutputStream makeStream(Document doc)
             throws TransformerConfigurationException, TransformerException {
         TransformerFactory tf = TransformerFactory.newInstance();
@@ -489,7 +513,13 @@ private static Document soapUnwrap(
         return (unwrappedDoc);
     }
 
-
+    /**
+     * Get Merchant Config object based on request and properties
+     * @param request
+     * @param props
+     * @return MerchantConfig
+     * @throws ConfigException
+     */
     static private MerchantConfig getMerchantConfigObject(Document request, Properties props) throws ConfigException {
         MerchantConfig mc;
         String merchantID = Utility.getElementText(request, ELEM_MERCHANT_ID, "*");
@@ -506,7 +536,12 @@ static private MerchantConfig getMerchantConfigObject(Document request, Properti
         System.out.println("merchant config object got created");
         return mc;
     }
-
+    /**
+     * Get Merchant Id from request, If merchantId is null, get it from properties
+     * @param request
+     * @param props
+     * @return String
+     */
     private static String getMerchantId(Document request, Properties props) {
         String merchantID = Utility.getElementText(request, ELEM_MERCHANT_ID, "*");
         if (merchantID == null) {
@@ -517,6 +552,12 @@ private static String getMerchantId(Document request, Properties props) {
         return merchantID;
     }
 
+    /**
+     * get KeyAlias from property, If keyAlias is null, return merchant Id
+     * @param request
+     * @param props
+     * @return String
+     */
     private static String getKeyForInstanceMap(Document request, Properties props) {
         String keyAlias = props.getProperty(KEY_ALIAS);
         if(keyAlias != null) {
@@ -525,7 +566,14 @@ private static String getKeyForInstanceMap(Document request, Properties props) {
 
         return getMerchantId(request, props);
     }
-
+    /**
+     * Get Merchant config instance from concurrent hash map in memory cache .
+     * If it is empty, it will create new merchant config object and put it in map for reuse.
+     * @param request
+     * @param props
+     * @return MerchantConfig
+     * @throws ConfigException
+     */
     private static MerchantConfig getInstanceMap(Document request, Properties props) throws ConfigException {
         String midOrKeyAlias = getKeyForInstanceMap(request, props);