Use lombok annotations in IM and ONAP logging

Issue-ID: POLICY-3394
Change-Id: I25db6b4b13bad8754889eaedb93197cae7d27c4d
Signed-off-by: Jim Hahn <jrh3@att.com>

11 files changed, 75 insertions, 189 deletions

diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/OnapLoggingUtils.java b/common-logging/src/main/java/org/onap/policy/common/logging/OnapLoggingUtils.java
index 1550cc9b..842b4772 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/OnapLoggingUtils.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/OnapLoggingUtils.java
@@ -22,16 +22,15 @@ package org.onap.policy.common.logging;
 
 import com.google.re2j.Pattern;
 import javax.servlet.http.HttpServletRequest;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
 
-public class OnapLoggingUtils {
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class OnapLoggingUtils {
 
     private static final Pattern COMMA_PAT = Pattern.compile(",");
     private static final Pattern CURLS_PAT = Pattern.compile("[{][}]");
 
-    private OnapLoggingUtils() {
-        // Private constructor to prevent subclassing
-    }
-
     /**
      * Get the ONAPLoggingContext for a request.
      *
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/ErrorCodeMap.java b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/ErrorCodeMap.java
index 32bb6fec..9e461916 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/ErrorCodeMap.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/ErrorCodeMap.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP-Logging
  * ================================================================================
- * Copyright (C) 2020 2017-2018 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017-2018, 2020-2021 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,6 +21,8 @@
 package org.onap.policy.common.logging.eelf;
 
 import java.util.EnumMap;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
 
 /**
  * ErrorCodeMap contains a HashMap of ErrorCodeInfo (error code and error description).
@@ -32,7 +34,8 @@ import java.util.EnumMap;
  * 500 – business process errors
  * 900 – unknown errors
  */
-public class ErrorCodeMap {
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class ErrorCodeMap {
 
     private static final EnumMap<MessageCodes, ErrorCodeInfo> hm = new EnumMap<>(MessageCodes.class);
 
@@ -93,10 +96,6 @@ public class ErrorCodeMap {
         hm.put(MessageCodes.ERROR_AUDIT, new ErrorCodeInfo(ERROR_AUDIT, ERROR_AUDIT_DESCRIPTION));
     }
 
-    private ErrorCodeMap() {
-        // Private constructor to prevent subclassing
-    }
-
     public static ErrorCodeInfo getErrorCodeInfo(MessageCodes messageCode) {
         return hm.get(messageCode);
     }
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/EventData.java b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/EventData.java
index 02403992..87a96a19 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/EventData.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/EventData.java
@@ -21,7 +21,9 @@
 package org.onap.policy.common.logging.eelf;
 
 import java.time.Instant;
+import lombok.AllArgsConstructor;
 import lombok.Getter;
+import lombok.NoArgsConstructor;
 import lombok.Setter;
 
 /**
@@ -29,32 +31,14 @@ import lombok.Setter;
  */
 @Getter
 @Setter
+@NoArgsConstructor
+@AllArgsConstructor
 public class EventData {
 
     private String requestId = null;
     private Instant startTime = null;
     private Instant endTime = null;
 
-    // Default constructor takes no arguments.
-    // Is empty because instance variables are assigned
-    // their default values upon declaration.
-    public EventData() {
-        // See above comments for the reason this constructor is empty
-    }
-
-    /**
-     * Create an instance.
-     *
-     * @param requestId the request ID
-     * @param startTime the start time
-     * @param endTime the end time
-     */
-    public EventData(String requestId, Instant startTime, Instant endTime) {
-        this.requestId = requestId;
-        this.startTime = startTime;
-        this.endTime = endTime;
-    }
-
     @Override
     public String toString() {
         return requestId + " Starting Time : " + this.startTime + " Ending Time : " + this.endTime;
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/EventTrackInfo.java b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/EventTrackInfo.java
index 3e021169..f6f38d0d 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/EventTrackInfo.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/EventTrackInfo.java
@@ -22,12 +22,14 @@ package org.onap.policy.common.logging.eelf;
 
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
+import lombok.Getter;
 
 /**
  * EventTrackInfo contains a ConcurrentHashMap of EventData.
  */
 public class EventTrackInfo {
 
+    @Getter
     private final ConcurrentMap<String, EventData> eventInfo;
 
     /**
@@ -80,11 +82,4 @@ public class EventTrackInfo {
             eventInfo.remove(eventId);
         }
     }
-
-    /**
-     * Returns a ConcurrentHashMap of EventData.
-     */
-    public ConcurrentMap<String, EventData> getEventInfo() {
-        return eventInfo;
-    }
 }
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/OnapConfigProperties.java b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/OnapConfigProperties.java
index 47c027c2..d71ebe54 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/OnapConfigProperties.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/OnapConfigProperties.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP-Logging
  * ================================================================================
- * Copyright (C) 2017-2018, 2020 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017-2018, 2020-2021 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,8 +20,11 @@
 
 package org.onap.policy.common.logging.eelf;
 
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
 
-public class OnapConfigProperties {
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class OnapConfigProperties {
 
     /**
      * The Date-time of the start of a transaction.
@@ -81,8 +84,4 @@ public class OnapConfigProperties {
     public static final String SERVER_NAME = "ServerName";
 
     public static final String INVOCATION_ID = "InvocationID";
-
-    private OnapConfigProperties() {
-        // do nothing
-    }
 }
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/PolicyLogger.java b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/PolicyLogger.java
index 15659561..662ca764 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/eelf/PolicyLogger.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/eelf/PolicyLogger.java
@@ -61,6 +61,10 @@ import java.util.Timer;
 import java.util.UUID;
 import java.util.concurrent.ConcurrentMap;
 import java.util.function.Consumer;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
 import org.apache.commons.lang3.StringUtils;
 import org.onap.policy.common.logging.OnapLoggingUtils;
 import org.onap.policy.common.logging.flexlogger.LoggerType;
@@ -69,6 +73,7 @@ import org.slf4j.MDC;
 /**
  * PolicyLogger contains all the static methods for EELF logging.
  */
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
 public class PolicyLogger {
 
     private static EELFLogger errorLogger = EELFManager.getErrorLogger();
@@ -110,7 +115,9 @@ public class PolicyLogger {
     // size drops to this point, stop the Timer
     private static int stopCheckPoint = 2500;
 
-    private static boolean isOverrideLogbackLevel = false;
+    @Getter
+    @Setter
+    private static boolean overrideLogbackLevel = false;
 
     private static Level debugLevel = Level.INFO;
     private static Level auditLevel = Level.INFO;
@@ -133,10 +140,6 @@ public class PolicyLogger {
         }
     }
 
-    private PolicyLogger() {
-
-    }
-
     public static synchronized Level getDebugLevel() {
         return debugLevel;
     }
@@ -150,7 +153,7 @@ public class PolicyLogger {
      */
     public static synchronized void setDebugLevel(String newDebugLevel) {
 
-        if (isOverrideLogbackLevel) {
+        if (overrideLogbackLevel) {
             PolicyLogger.debugLevel = Level.valueOf(newDebugLevel);
             debugLogger.setLevel(debugLevel);
         }
@@ -170,7 +173,7 @@ public class PolicyLogger {
      */
     public static synchronized void setAuditLevel(String newAuditLevel) {
 
-        if (isOverrideLogbackLevel) {
+        if (overrideLogbackLevel) {
             if ("OFF".equalsIgnoreCase(newAuditLevel)) {
                 PolicyLogger.auditLevel = Level.OFF;
                 auditLogger.setLevel(auditLevel);
@@ -195,7 +198,7 @@ public class PolicyLogger {
      */
     public static synchronized void setMetricsLevel(String newMetricsLevel) {
 
-        if (isOverrideLogbackLevel) {
+        if (overrideLogbackLevel) {
             if ("OFF".equalsIgnoreCase(newMetricsLevel)) {
                 PolicyLogger.metricsLevel = Level.OFF;
                 metricsLogger.setLevel(metricsLevel);
@@ -221,7 +224,7 @@ public class PolicyLogger {
      */
     public static synchronized void setErrorLevel(String newErrorLevel) {
 
-        if (isOverrideLogbackLevel) {
+        if (overrideLogbackLevel) {
             if ("OFF".equalsIgnoreCase(newErrorLevel)) {
                 PolicyLogger.errorLevel = Level.OFF;
                 errorLogger.setLevel(errorLevel);
@@ -1373,10 +1376,10 @@ public class PolicyLogger {
     }
 
     private static void setOverrideLogbackLevels(Properties loggerProperties) {
-        final String overrideLogbackLevel = loggerProperties.getProperty("override.logback.level.setup");
+        final var overrideLogbackLevelText = loggerProperties.getProperty("override.logback.level.setup");
 
-        if (!StringUtils.isBlank(overrideLogbackLevel)) {
-            isOverrideLogbackLevel = "TRUE".equalsIgnoreCase(overrideLogbackLevel);
+        if (!StringUtils.isBlank(overrideLogbackLevelText)) {
+            overrideLogbackLevel = "TRUE".equalsIgnoreCase(overrideLogbackLevelText);
         }
     }
 
@@ -1395,24 +1398,6 @@ public class PolicyLogger {
         }
     }
 
-
-    /**
-     * Returns true for overriding logback levels; returns false for not.
-     */
-    public static boolean isOverrideLogbackLevel() {
-
-        return isOverrideLogbackLevel;
-    }
-
-    /**
-     * Sets true for overriding logback levels; sets false for not.
-     */
-    public static void setOverrideLogbackLevel(boolean odl) {
-
-        isOverrideLogbackLevel = odl;
-
-    }
-
     /**
      * Sets server information to MDC.
      */
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/DisplayUtils.java b/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/DisplayUtils.java
index 6cc5dc13..425c62a4 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/DisplayUtils.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/DisplayUtils.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP
  * ================================================================================
- * Copyright (C) 2019-2020 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2019-2021 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,16 +20,17 @@
 
 package org.onap.policy.common.logging.flexlogger;
 
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
 /**
  * Utilities to display messages. These are generally used while logging is being
  * configured, or when logging being directed to System.out. As a result, it directly
  * writes to System.out rather than to a logger.
  */
-public class DisplayUtils {
 
-    private DisplayUtils() {
-        // do nothing
-    }
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class DisplayUtils {
 
     /*
      * As the comment above says, these purposely write to System.out rather than a
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/EelfLogger.java b/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/EelfLogger.java
index 837a584f..0e0ef2bf 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/EelfLogger.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/EelfLogger.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP-Logging
  * ================================================================================
- * Copyright (C) 2017-2020 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017-2021 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@ package org.onap.policy.common.logging.flexlogger;
 import com.att.eelf.configuration.EELFLogger.Level;
 import java.io.Serializable;
 import java.util.UUID;
+import lombok.Getter;
 import org.onap.policy.common.logging.eelf.MessageCodes;
 import org.onap.policy.common.logging.eelf.PolicyLogger;
 
@@ -34,6 +35,7 @@ public class EelfLogger implements Logger, Serializable {
 
     private static final long serialVersionUID = 5385586713941277192L;
     private String className = "";
+    @Getter
     private String transId = UUID.randomUUID().toString();
 
     /**
@@ -135,14 +137,6 @@ public class EelfLogger implements Logger, Serializable {
     }
 
     /**
-     * Returns transaction Id for logging.
-     */
-    @Override
-    public String getTransId() {
-        return transId;
-    }
-
-    /**
      * Records a message.
      *
      * @param message the message
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/PropertyUtil.java b/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/PropertyUtil.java
index ccd6048c..ef6c2e95 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/PropertyUtil.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/PropertyUtil.java
@@ -32,23 +32,23 @@ import java.util.Properties;
 import java.util.Set;
 import java.util.Timer;
 import java.util.TimerTask;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
 
 /**
  * This class provides utilities to read properties from a properties file, and optionally get
  * notifications of future changes.
  */
-public class PropertyUtil {
+public final class PropertyUtil {
 
+
+    @NoArgsConstructor(access = AccessLevel.PRIVATE)
     protected static class LazyHolder {
         /**
          * Timer thread.  Will not be allocated by the JVM until it is first referenced.
          * This may be overridden by junit tests.
          */
         private static Timer timer = new Timer("PropertyUtil-Timer", true);
-
-        private LazyHolder() {
-            super();
-        }
     }
 
     // this table maps canonical file into a 'ListenerRegistration' instance
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/SystemOutLogger.java b/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/SystemOutLogger.java
index a059bd77..d16a1d7a 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/SystemOutLogger.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/flexlogger/SystemOutLogger.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP-Logging
  * ================================================================================
- * Copyright (C) 2017-2020 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017-2021 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -26,6 +26,7 @@ import com.att.eelf.configuration.EELFLogger.Level;
 import java.io.Serializable;
 import java.util.Arrays;
 import java.util.UUID;
+import lombok.Getter;
 import org.onap.policy.common.logging.OnapLoggingUtils;
 import org.onap.policy.common.logging.eelf.MessageCodes;
 import org.onap.policy.common.logging.eelf.PolicyLogger;
@@ -33,16 +34,17 @@ import org.onap.policy.common.logging.eelf.PolicyLogger;
 /**
  * SystemOutLogger implements all the methods of interface Logger by calling System.out.println
  */
+@Getter
 public class SystemOutLogger implements Logger, Serializable {
 
     private static final long serialVersionUID = 4956408061058933929L;
     private String className = "";
-    private boolean isDebugEnabled = true;
-    private boolean isInfoEnabled = true;
-    private boolean isWarnEnabled = true;
-    private boolean isErrorEnabled = true;
-    private boolean isAuditEnabled = true;
-    private boolean isMetricsEnabled = true;
+    private boolean debugEnabled = true;
+    private boolean infoEnabled = true;
+    private boolean warnEnabled = true;
+    private boolean errorEnabled = true;
+    private boolean auditEnabled = true;
+    private boolean metricsEnabled = true;
     private String transId = UUID.randomUUID().toString();
 
     /**
@@ -77,35 +79,35 @@ public class SystemOutLogger implements Logger, Serializable {
     private void initLevel() {
 
         if (PolicyLogger.getDebugLevel() == Level.DEBUG) {
-            isDebugEnabled = true;
-            isInfoEnabled = true;
-            isWarnEnabled = true;
+            debugEnabled = true;
+            infoEnabled = true;
+            warnEnabled = true;
         } else {
-            isDebugEnabled = false;
+            debugEnabled = false;
         }
 
         if (PolicyLogger.getDebugLevel() == Level.INFO) {
-            isInfoEnabled = true;
-            isWarnEnabled = true;
-            isDebugEnabled = false;
+            infoEnabled = true;
+            warnEnabled = true;
+            debugEnabled = false;
         }
 
         if (PolicyLogger.getDebugLevel() == Level.OFF) {
-            isInfoEnabled = false;
-            isWarnEnabled = false;
-            isDebugEnabled = false;
+            infoEnabled = false;
+            warnEnabled = false;
+            debugEnabled = false;
         }
 
         if (PolicyLogger.getErrorLevel() == Level.OFF) {
-            isErrorEnabled = false;
+            errorEnabled = false;
         }
 
         if (PolicyLogger.getAuditLevel() == Level.OFF) {
-            isAuditEnabled = false;
+            auditEnabled = false;
         }
 
         if (PolicyLogger.getMetricsLevel() == Level.OFF) {
-            isMetricsEnabled = false;
+            metricsEnabled = false;
         }
     }
 
@@ -120,15 +122,6 @@ public class SystemOutLogger implements Logger, Serializable {
     }
 
     /**
-     * Returns transaction Id.
-     */
-    @Override
-    public String getTransId() {
-
-        return transId;
-    }
-
-    /**
      * Records a message.
      *
      * @param message the message
@@ -345,68 +338,6 @@ public class SystemOutLogger implements Logger, Serializable {
     }
 
     /**
-     * Returns true for debug enabled, or false for not.
-     *
-     * @return boolean
-     */
-    @Override
-    public boolean isDebugEnabled() {
-        return isDebugEnabled;
-    }
-
-    /**
-     * Returns true for warn enabled, or false for not.
-     *
-     * @return boolean
-     */
-    @Override
-    public boolean isWarnEnabled() {
-        return isWarnEnabled;
-    }
-
-    /**
-     * Returns true for info enabled, or false for not.
-     *
-     * @return boolean
-     */
-    @Override
-    public boolean isInfoEnabled() {
-        return isInfoEnabled;
-    }
-
-    /**
-     * Returns true for error enabled, or false for not.
-     *
-     * @return boolean
-     */
-    @Override
-    public boolean isErrorEnabled() {
-        return isErrorEnabled;
-    }
-
-    /**
-     * Returns true for audit enabled, or false for not.
-     *
-     * @return boolean
-     */
-    @Override
-    public boolean isAuditEnabled() {
-
-        return isAuditEnabled;
-    }
-
-    /**
-     * Returns true for metrics enabled, or false for not.
-     *
-     * @return boolean
-     */
-    @Override
-    public boolean isMetricsEnabled() {
-
-        return isMetricsEnabled;
-    }
-
-    /**
      * Records an audit message.
      *
      * @param message the message
diff --git a/common-logging/src/main/java/org/onap/policy/common/logging/nsa/LoggingContextFactory.java b/common-logging/src/main/java/org/onap/policy/common/logging/nsa/LoggingContextFactory.java
index ee64306f..eb2b318e 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/nsa/LoggingContextFactory.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/nsa/LoggingContextFactory.java
@@ -2,7 +2,7 @@
  * ============LICENSE_START=======================================================
  * ONAP-Logging
  * ================================================================================
- * Copyright (C) 2017-2019 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2017-2019, 2021 AT&T Intellectual Property. All rights reserved.
  * ================================================================================
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,6 +20,8 @@
 
 package org.onap.policy.common.logging.nsa;
 
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
 import org.onap.policy.common.logging.nsa.impl.SharedContext;
 import org.onap.policy.common.logging.nsa.impl.Slf4jLoggingContext;
 
@@ -27,6 +29,7 @@ import org.onap.policy.common.logging.nsa.impl.Slf4jLoggingContext;
  * A factory for setting up a LoggingContext.
  *
  */
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
 public class LoggingContextFactory {
     public static class Builder {
 
@@ -47,8 +50,4 @@ public class LoggingContextFactory {
             return forShared ? new SharedContext(baseContext) : new Slf4jLoggingContext(baseContext);
         }
     }
-
-    private LoggingContextFactory() {
-        // do nothing
-    }
 }