Javadoc - for methods

Author: Mayuri-Kumar93

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

@@ -238,7 +238,12 @@ public static String maskIfNotSafe(int type, String field, String val) {
         return isSafe(type, field) ? val : mask(field, val);
     }
 
-    // the masking rules in this method were per Jason Hengels.
+    /**
+     * Mask the data.The masking rules in this method were per Jason Hengels.
+     * @param field
+     * @param val
+     * @return
+     */
     public static String mask(String field, String val) {
         int len = val != null ? val.length() : 0;
         if (len == 0) return "";

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

@@ -107,7 +107,7 @@ else if(merchantConfig.isCacertEnabled()){
     }
 
     /**
-     *Reads the Certificate or Public key  and Private from the P12 key .
+     * Reads the Certificate or Public key  and Private from the P12 key .
      * @param merchantConfig - Merchant Config details
      * @param logger - logger object
      * @throws SignException
@@ -176,8 +176,17 @@ private static void readAndStoreCertificateAndPrivateKey(MerchantConfig merchant
             throw new SignException(e);
         }
     }
-    
-    
+
+
+    /**
+     * Create signed encrypted document
+     * @param signedDoc
+     * @param merchantId
+     * @param logger
+     * @return Document
+     * @throws SignEncryptException
+     * @throws SignException
+     */
     public static Document handleMessageCreation(Document signedDoc, String merchantId, Logger logger) throws SignEncryptException, SignException{
 
         logger.log(Logger.LT_INFO, "Encrypting Signed doc ...");
@@ -225,7 +234,16 @@ public static Document handleMessageCreation(Document signedDoc, String merchant
         encrBuilder.prependToHeader(secHeader);
         return signedEncryptedDoc;
     }
-    
+
+    /**
+     * Create signed document
+     * @param workingDocument
+     * @param keyAlias
+     * @param password
+     * @param logger
+     * @return Document
+     * @throws SignException
+     */
     public static Document createSignedDoc(Document workingDocument,String keyAlias, String password,Logger logger) throws SignException {
 
         logger.log(Logger.LT_INFO, "Signing request...");
@@ -261,8 +279,15 @@ public static Document createSignedDoc(Document workingDocument,String keyAlias,
             throw new SignException(e.getMessage());
         }
     }
-    
-    
+
+
+    /**
+     * read jdk certificates from cacerts file
+     * @param merchantConfig
+     * @param logger
+     * @throws SignEncryptException
+     * @throws SignException
+     */
 	public static void readJdkCert(MerchantConfig merchantConfig, Logger logger)
 			throws SignEncryptException, SignException {
 		KeyStore keystore;

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

@@ -513,10 +513,20 @@ public static Element createElement(
         return (elem);
     }
 
+    /**
+     * get response issued time in seconds
+     * @param responseTime
+     * @return long
+     */
     public static long getResponseIssuedAtTimeInSecs(String responseTime) {
         return parseLong(responseTime, 0L);
     }
 
+    /**
+     * get response transit time in seconds
+     * @param issuedAtTimeSeconds
+     * @return long
+     */
     public static long getResponseTransitTimeSeconds(long issuedAtTimeSeconds) {
         if (issuedAtTimeSeconds > 0) {
             return (System.currentTimeMillis() / 1000) - issuedAtTimeSeconds;