Fix upcoming checkstyle issues 58/114658/1
authorPamela Dragosh <pdragosh@research.att.com>
Fri, 6 Nov 2020 13:14:51 +0000 (08:14 -0500)
committerPamela Dragosh <pdragosh@research.att.com>
Fri, 6 Nov 2020 13:14:55 +0000 (08:14 -0500)
When we upgrade to oparent, these will fail as oparent upgrades
to 8.37 of puppycrawl which fixes a few bugs that should have
flagged these previously.

Issue-ID: POLICY-2887
Change-Id: I5618ce67d84e94321f884ed6d929c05fc33a0b3d
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
common-logging/src/main/java/org/onap/policy/common/logging/OnapLoggingUtils.java
utils/src/main/java/org/onap/policy/common/utils/security/CryptoUtils.java

index 369e77a..b7c93c6 100644 (file)
@@ -65,7 +65,7 @@ public class OnapLoggingUtils {
      * if last argument is throwable/exception, pass it as argument to logger.
      * @param format message format can contains text and {}
      * @param arguments output arguments
-     * @return
+     * @return the formatted message as a String
      */
     public static String formatMessage(String format, Object...arguments) {
         if (arguments.length <= 0 || arguments[0] == null) {
index 1a9483a..50e85d9 100644 (file)
@@ -71,7 +71,7 @@ public class CryptoUtils implements CryptoCoder {
     /**
      * CryptoUtils - encryption tool constructor.
      * @param secretKeySpec
-     *  AES supports 128, 192 or 256-bit long key size, it can be plain text or generated with key generator
+     *     AES supports 128, 192 or 256-bit long key size, it can be plain text or generated with key generator
      */
     public CryptoUtils(SecretKeySpec secretKeySpec) {
         this.secretKeySpec = secretKeySpec;
@@ -89,7 +89,7 @@ public class CryptoUtils implements CryptoCoder {
      * <p>Final result is to put in properties file is: IV + Outcome of openssl command
      *
      * @param value
-     *  The plain text string
+     *     The plain text string
      * @return The encrypted String
      */
     @Override
@@ -100,9 +100,9 @@ public class CryptoUtils implements CryptoCoder {
     /**
      * Encrypt a value based on the Policy Encryption Key.
      * @param value
-     *  The plain text string
+     *     The plain text string
      * @param secretKey
-     *  The secret key
+     *     The secret key
      * @return The encrypted String
      */
     public static String encrypt(String value, String secretKey) {
@@ -139,7 +139,7 @@ public class CryptoUtils implements CryptoCoder {
      * -K PrivateHexKey -iv 16BytesIVFromEncryptedString
      *
      * @param value
-     *  The encrypted string that must be decrypted using the Policy Encryption Key
+     *     The encrypted string that must be decrypted using the Policy Encryption Key
      * @return The String decrypted if string begin with 'enc:'
      */
     @Override
@@ -151,9 +151,9 @@ public class CryptoUtils implements CryptoCoder {
      * Decrypt a value based on the Policy Encryption Key if string begin with 'enc:'.
      *
      * @param value
-     *  The encrypted string that must be decrypted using the Policy Encryption Key
+     *     The encrypted string that must be decrypted using the Policy Encryption Key
      * @param secretKey
-     *  The secret key
+     *     The secret key
      * @return The String decrypted if string begin with 'enc:'
      */
     public static String decrypt(String value, String secretKey) {
@@ -227,7 +227,7 @@ public class CryptoUtils implements CryptoCoder {
      * Check if string is encrypted by verify if string prefix with 'enc:'.
      *
      * @param value
-     *  The encrypted string or plain text value
+     *     The encrypted string or plain text value
      * @return boolean value indicate if string prefix with enc: or not
      */
     public static boolean isEncrypted(String value) {