summaryrefslogtreecommitdiffstats
path: root/common-logging/src/main
diff options
context:
space:
mode:
authorliamfallon <liam.fallon@est.tech>2019-12-04 10:24:58 +0000
committerliamfallon <liam.fallon@est.tech>2019-12-06 15:23:38 +0000
commit3073f50c525e47b0f0c4343330a9456faabeae78 (patch)
tree9061d3e2db3e1da2641af5509f82617b0bb35ca1 /common-logging/src/main
parentc2dc5169d9cb7941939ba1fd65afcf14d515386b (diff)
Minor changes for new Eclipse checkstyle checks
The laest Eclipse checkstyle version 8.26.0 does more thorough checking and identified a number of small issues in the apex-pdp codebase. This review fixes those issues. logging pattern in logback.xml files amended to be less than 120 characters. Test case added for checking parameter is valid. Issue-ID: POLICY-2204 Change-Id: Id7293e44b56c225afc6290e1c599603e9ebedb19 Signed-off-by: liamfallon <liam.fallon@est.tech>
Diffstat (limited to 'common-logging/src/main')
-rw-r--r--common-logging/src/main/java/org/onap/policy/common/logging/OnapLoggingUtils.java7
-rw-r--r--common-logging/src/main/java/org/onap/policy/common/logging/eelf/ErrorCodeMap.java52
-rw-r--r--common-logging/src/main/java/org/onap/policy/common/logging/nsa/impl/Slf4jLoggingContext.java8
-rw-r--r--common-logging/src/main/resources/org/onap/policy/common/logging/eelf/Resources.properties105
4 files changed, 86 insertions, 86 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 dddd3c4d..6c0879ea 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
@@ -24,7 +24,9 @@ import javax.servlet.http.HttpServletRequest;
public class OnapLoggingUtils {
- private OnapLoggingUtils() {}
+ private OnapLoggingUtils() {
+ // Private constructor to prevent subclassing
+ }
/**
* Get the ONAPLoggingContext for a request.
@@ -34,7 +36,7 @@ public class OnapLoggingUtils {
* @return the ONAPLoggingContext
*/
public static OnapLoggingContext getLoggingContextForRequest(HttpServletRequest request,
- OnapLoggingContext baseContext) {
+ OnapLoggingContext baseContext) {
OnapLoggingContext requestContext = new OnapLoggingContext(baseContext);
if (request.getLocalAddr() != null) { // may be null in junit tests
requestContext.setServerIpAddress(request.getLocalAddr());
@@ -58,5 +60,4 @@ public class OnapLoggingUtils {
return requestContext;
}
-
}
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 4ae4068c..fab0415b 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
@@ -7,9 +7,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -29,56 +29,50 @@ public class ErrorCodeMap {
private static final EnumMap<MessageCodes, ErrorCodeInfo> hm = new EnumMap<>(MessageCodes.class);
+ private static final String CHECK_ERROR_MESSAGE = " Please check the error message for detail information";
+
private static final String ERROR_PERMISSIONS = "POLICY-100E";
- private static final String ERROR_PERMISSIONS_DESCRIPTION =
- "This is a Permissions Error. Please check the error message for detail information";
+ private static final String ERROR_PERMISSIONS_DESCRIPTION = "This is a Permissions Error." + CHECK_ERROR_MESSAGE;
private static final String ERROR_SCHEMA_INVALID = "POLICY-400E";
- private static final String ERROR_SCHEMA_INVALID_DESCRIPTION =
- "This is an Invalid Schema Error. Please check the error message for detail information";
+ private static final String ERROR_SCHEMA_INVALID_DESCRIPTION = "This is an Invalid Schema Error."
+ + CHECK_ERROR_MESSAGE;
private static final String UPDATE_ERROR = "POLICY-502E";
- private static final String UPDATE_ERROR_DESCRIPTION =
- "This is an updating error. Please check the error message for detail information";
+ private static final String UPDATE_ERROR_DESCRIPTION = "This is an updating error." + CHECK_ERROR_MESSAGE;
private static final String EXCEPTION_ERROR_CODE = "POLICY-503E";
- private static final String EXCEPTION_ERROR_DESCRIPTION =
- "This is an exception error message during the process. Please check the error message for detail "
- + "information";
+ private static final String EXCEPTION_ERROR_DESCRIPTION = "This is an exception error message during the process."
+ + CHECK_ERROR_MESSAGE;
private static final String MISS_PROPERTY_ERROR = "POLICY-504E";
- private static final String MISS_PROPERTY_ERROR_DESCRIPTION =
- "This is an error of missing properties. Please check the error message for detail information";
+ private static final String MISS_PROPERTY_ERROR_DESCRIPTION = "This is an error of missing properties."
+ + CHECK_ERROR_MESSAGE;
private static final String GENERAL_ERROR_CODE = "POLICY-515E";
- private static final String GENERAL_ERROR_DESCRIPTION =
- "This is a general error message during the process. Please check the error message for detail information";
+ private static final String GENERAL_ERROR_DESCRIPTION = "This is a general error message during the process."
+ + CHECK_ERROR_MESSAGE;
private static final String ERROR_SYSTEM_ERROR = "POLICY-516E";
- private static final String ERROR_SYSTEM_ERROR_DESCRIPTION =
- "This is a System Error. Please check the error message for detail information";
+ private static final String ERROR_SYSTEM_ERROR_DESCRIPTION = "This is a System Error." + CHECK_ERROR_MESSAGE;
private static final String ERROR_DATA_ISSUE = "POLICY-517E";
- private static final String ERROR_DATA_ISSUE_DESCRIPTION =
- "This is a Data Issue Error. Please check the error message for detail information";
+ private static final String ERROR_DATA_ISSUE_DESCRIPTION = "This is a Data Issue Error." + CHECK_ERROR_MESSAGE;
private static final String ERROR_PROCESS_FLOW = "POLICY-518E";
- private static final String ERROR_PROCESS_FLOW_DESCRIPTION =
- "This is a Process Flow Error. Please check the error message for detail information";
+ private static final String ERROR_PROCESS_FLOW_DESCRIPTION = "This is a Process Flow Error." + CHECK_ERROR_MESSAGE;
private static final String ERROR_UNKNOWN = "POLICY-519E";
- private static final String ERROR_UNKNOWN_DESCRIPTION =
- "This is an Unknown Error. Please check the error message for detail information";
+ private static final String ERROR_UNKNOWN_DESCRIPTION = "This is an Unknown Error." + CHECK_ERROR_MESSAGE;
private static final String ERROR_AUDIT = "POLICY-520E";
- private static final String ERROR_AUDIT_DESCRIPTION =
- "This is an audit Error. Please check the error message for detail information";
+ private static final String ERROR_AUDIT_DESCRIPTION = "This is an audit Error." + CHECK_ERROR_MESSAGE;
static {
hm.put(MessageCodes.EXCEPTION_ERROR, new ErrorCodeInfo(EXCEPTION_ERROR_CODE, EXCEPTION_ERROR_DESCRIPTION));
hm.put(MessageCodes.GENERAL_ERROR, new ErrorCodeInfo(GENERAL_ERROR_CODE, GENERAL_ERROR_DESCRIPTION));
hm.put(MessageCodes.MISS_PROPERTY_ERROR,
- new ErrorCodeInfo(MISS_PROPERTY_ERROR, MISS_PROPERTY_ERROR_DESCRIPTION));
+ new ErrorCodeInfo(MISS_PROPERTY_ERROR, MISS_PROPERTY_ERROR_DESCRIPTION));
hm.put(MessageCodes.UPDATE_ERROR, new ErrorCodeInfo(UPDATE_ERROR, UPDATE_ERROR_DESCRIPTION));
hm.put(MessageCodes.ERROR_SYSTEM_ERROR, new ErrorCodeInfo(ERROR_SYSTEM_ERROR, ERROR_SYSTEM_ERROR_DESCRIPTION));
hm.put(MessageCodes.ERROR_DATA_ISSUE, new ErrorCodeInfo(ERROR_DATA_ISSUE, ERROR_DATA_ISSUE_DESCRIPTION));
@@ -86,12 +80,14 @@ public class ErrorCodeMap {
hm.put(MessageCodes.ERROR_DATA_ISSUE, new ErrorCodeInfo(ERROR_DATA_ISSUE, ERROR_DATA_ISSUE_DESCRIPTION));
hm.put(MessageCodes.ERROR_PROCESS_FLOW, new ErrorCodeInfo(ERROR_PROCESS_FLOW, ERROR_PROCESS_FLOW_DESCRIPTION));
hm.put(MessageCodes.ERROR_SCHEMA_INVALID,
- new ErrorCodeInfo(ERROR_SCHEMA_INVALID, ERROR_SCHEMA_INVALID_DESCRIPTION));
+ new ErrorCodeInfo(ERROR_SCHEMA_INVALID, ERROR_SCHEMA_INVALID_DESCRIPTION));
hm.put(MessageCodes.ERROR_UNKNOWN, new ErrorCodeInfo(ERROR_UNKNOWN, ERROR_UNKNOWN_DESCRIPTION));
hm.put(MessageCodes.ERROR_AUDIT, new ErrorCodeInfo(ERROR_AUDIT, ERROR_AUDIT_DESCRIPTION));
}
- private ErrorCodeMap() {}
+ 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/nsa/impl/Slf4jLoggingContext.java b/common-logging/src/main/java/org/onap/policy/common/logging/nsa/impl/Slf4jLoggingContext.java
index 80bb2383..33e9f637 100644
--- a/common-logging/src/main/java/org/onap/policy/common/logging/nsa/impl/Slf4jLoggingContext.java
+++ b/common-logging/src/main/java/org/onap/policy/common/logging/nsa/impl/Slf4jLoggingContext.java
@@ -7,9 +7,9 @@
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -28,7 +28,9 @@ import org.slf4j.MDC;
*
*/
public class Slf4jLoggingContext implements LoggingContext {
- public Slf4jLoggingContext(LoggingContext base) {}
+ public Slf4jLoggingContext(LoggingContext base) {
+ // Default constructor
+ }
@Override
public void put(String key, String value) {
diff --git a/common-logging/src/main/resources/org/onap/policy/common/logging/eelf/Resources.properties b/common-logging/src/main/resources/org/onap/policy/common/logging/eelf/Resources.properties
index 47480d01..4f2c3f6d 100644
--- a/common-logging/src/main/resources/org/onap/policy/common/logging/eelf/Resources.properties
+++ b/common-logging/src/main/resources/org/onap/policy/common/logging/eelf/Resources.properties
@@ -7,9 +7,9 @@
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
-#
+#
# http://www.apache.org/licenses/LICENSE-2.0
-#
+#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -56,138 +56,139 @@ GENERAL_WARNING=\
POLICY-501W|\
WARNING: {0}|\
Please check other logs for more information|\
- General warning
+ General warning
UPDATE_ERROR=\
POLICY-502E|\
ERROR: Could not update {0}|\
Please check other logs for more information|\
- Exception caught during server management
-
+ Exception caught during server management
+
EXCEPTION_ERROR=\
POLICY-503E|\
ERROR: Error Message: {0}|\
Please check other logs for more information|\
Exception caught during server management
-
+
MISS_PROPERTY_ERROR=\
POLICY-504E|\
ERROR: {0} property not set in {1}.properties|\
Please check other logs for more information|\
- Exception caught during server management
-
+ Exception caught during server management
+
BAD_TYPE_WARNING=\
POLICY-505W|\
WARNING: Bad types for Double Metric: {0} path: {1}|\
Please check other logs for more information|\
- General warning
-
+ General warning
+
MISS_PROPERTY_INFO=\
POLICY-506I|\
INFO: report: {0} not set|\
No resolution needed|\
General flow processing info
-
+
RULE_AUDIT_EXEC_INFO=\
POLICY-507I|\
Service Name: {0}:Executing rule: {1}|\
No resolution needed|\
- Executing method
+ Executing method
RULE_AUDIT_BEGIN_INFO=\
POLICY-508I|\
Service Name: {0}:Entering rule: {1}|\
No resolution needed|\
Entering method
-
+
RULE_AUDIT_END_INFO=\
POLICY-509I|\
Service Name: {0}:Exiting rule: {1}|\
No resolution needed|\
- Exiting method
-
+ Exiting method
+
RULE_METRICS_INFO=\
POLICY-510I|\
Service Name: {0}:Executing method: {1}|\
No resolution needed|\
- Generate information for Metric events
+ Generate information for Metric events
UEB_AUDIT_EXEC_INFO=\
POLICY-511I|\
Service Name: {0}:Executing UEB: {1}|\
No resolution needed|\
- Executing method
+ Executing method
UEB_AUDIT_BEGIN_INFO=\
POLICY-512I|\
Service Name: {0}:Entering UEB: {1}|\
No resolution needed|\
Entering method
-
+
UEB_AUDIT_END_INFO=\
POLICY-513I|\
Service Name: {0}:Exiting UEB: {1}|\
No resolution needed|\
- Exiting method
-
-
-
+ Exiting method
+
+
+
RULE_AUDIT_START_END_INFO=\
POLICY-514I|\
- Service Name: {0}:Executing rule:{1}:Starting Time:{2}:Ending Time:{3}:Executing Time:{4}:Policy version:{5}|\
+ Service Name: \
+ {0}:Executing rule:{1}:Starting Time:{2}:Ending Time:{3}:Executing Time:{4}:Policy version:{5}|\
No resolution needed|\
- Executing method
-
+ Executing method
+
GENERAL_ERROR=\
POLICY-515E|\
ERROR: {0}|\
Please check other logs for more information|\
- error caught during server management
-
+ error caught during server management
+
ERROR_SYSTEM_ERROR=\
POLICY-516E|\
ERROR: {0}|\
Please check other logs for more information|\
- error caught during server management
-
+ error caught during server management
+
ERROR_DATA_ISSUE=\
POLICY-517E|\
ERROR: {0}|\
Please check other logs for more information|\
- error caught during server management
-
+ error caught during server management
+
ERROR_PERMISSIONS=\
POLICY-100E|\
ERROR: {0}|\
Please check other logs for more information|\
- error caught during server management
-
+ error caught during server management
+
ERROR_PROCESS_FLOW=\
POLICY-518E|\
ERROR: {0}|\
Please check other logs for more information|\
- error caught during server management
-
+ error caught during server management
+
ERROR_SCHEMA_INVALID=\
POLICY-400E|\
ERROR: {0}|\
Please check other logs for more information|\
- error caught during server management
-
+ error caught during server management
+
ERROR_UNKNOWN=\
POLICY-519E|\
ERROR: {0}|\
Please check other logs for more information|\
- error caught during server management
-
+ error caught during server management
+
ERROR_AUDIT=\
POLICY-520E|\
ERROR: {0}|\
Please check other logs for more information|\
- error caught during audit process
+ error caught during audit process
########################################################################
########################################################################
-########################################################################
+########################################################################
#---------------- The message codes below should not be used anymore since 1607 release -----------------------------
MESSAGE_SAMPLE_NOARGS=\
@@ -195,7 +196,7 @@ MESSAGE_SAMPLE_NOARGS=\
App1 message text sample1|\
App1 resolution text sample1|\
App1 description text sample1
-
+
MESSAGE_SAMPLE_ONEARGUMENT=\
APP3456I|\
App1 msg smpl w arg: {0}|\
@@ -206,40 +207,40 @@ AUDIT_MESSAGE_ONEARGUMENT=\
AUD0000I|\
Audit msg: {0}|\
Audit resolution text sample2|\
- Audit description text sample2
-
+ Audit description text sample2
+
ERROR_MESSAGE_ONEARGUMENT=\
ERR0000E|\
Error msg: {0}|\
Error resolution text sample2|\
- Error description text sample2
-
+ Error description text sample2
+
METRICS_MESSAGE_ONEARGUMENT=\
MET0000I|\
Metrics msg: {0}|\
Metrics resolution text sample2|\
- Metrics description text sample2
-
+ Metrics description text sample2
+
DUBUG_MESSAGE_ONEARGUMENT=\
DEB0000I|\
Debug msg: {0}|\
Debug resolution text sample2|\
- Debug description text sample2
+ Debug description text sample2
MESSAGE_SAMPLE_TWOARGUMENTS=\
APP4567I|\
App1 message text sample with argument {0} and {1}|\
App1 resolution text sample3|\
App1 description text sample3
-
+
MESSAGE_SAMPLE_EXCEPTION=\
APP6789E|\
App1 message text sample4|\
App1 resolution text sample4|\
App1 description text sample4
-
+
MESSAGE_SAMPLE_EXCEPTION_ONEARGUMENT=\
APP6790E|\
This is the text exception in method {0}|\
App1 resolution text sample5|\
App1 description text sample5
-
+