summaryrefslogtreecommitdiffstats
path: root/eelf-logger/eelf-logger-api
diff options
context:
space:
mode:
authorKai <lukai@chinamobile.com>2020-07-10 18:05:46 +0800
committerKai <lukai@chinamobile.com>2020-07-15 10:03:34 +0800
commit0688c66229fe1bfb1d7d8920705b019d5cfeb17f (patch)
tree717656f8ceae006223a395da3737400627e19de9 /eelf-logger/eelf-logger-api
parentddb9b0f7e578aefd06ee9e3f01d810b0b9034f3a (diff)
TCAGen2 java upgrade
Issue-ID: DCAEGEN2-2285 Signed-off-by: Kai Lu <lukai@chinamobile.com> Change-Id: I1a7b3db68141ed8648fe47865f39dea22f0d999c
Diffstat (limited to 'eelf-logger/eelf-logger-api')
-rw-r--r--eelf-logger/eelf-logger-api/pom.xml2
-rw-r--r--eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/AppLogInfo.java2
-rw-r--r--eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ErrorLogInfo.java53
-rw-r--r--eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/NagiosAlertLevel.java35
-rw-r--r--eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ResponseLogInfo.java61
-rw-r--r--eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/AuditLog.java4
-rw-r--r--eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/ErrorLog.java2
-rw-r--r--eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/MetricLog.java4
8 files changed, 87 insertions, 76 deletions
diff --git a/eelf-logger/eelf-logger-api/pom.xml b/eelf-logger/eelf-logger-api/pom.xml
index 2817cf1..5157e81 100644
--- a/eelf-logger/eelf-logger-api/pom.xml
+++ b/eelf-logger/eelf-logger-api/pom.xml
@@ -27,7 +27,7 @@
<parent>
<groupId>org.onap.dcaegen2.analytics.tca-gen2</groupId>
<artifactId>eelf-logger</artifactId>
- <version>1.1.0-SNAPSHOT</version>
+ <version>1.2.0-SNAPSHOT</version>
</parent>
<artifactId>eelf-logger-api</artifactId>
diff --git a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/AppLogInfo.java b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/AppLogInfo.java
index bdce8d1..1acf7a7 100644
--- a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/AppLogInfo.java
+++ b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/AppLogInfo.java
@@ -29,7 +29,7 @@ public interface AppLogInfo extends LogInfo {
/**
* Required field contains UUID which identifies this service instance inside an inventory management system
- * (e.g. A&AI) to reference/manage this service as a unit
+ * to reference/manage this service as a unit
*
* @return remote VM Name or service the request is acting upon.
*/
diff --git a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ErrorLogInfo.java b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ErrorLogInfo.java
index 876037c..af70c89 100644
--- a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ErrorLogInfo.java
+++ b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ErrorLogInfo.java
@@ -30,36 +30,29 @@ public interface ErrorLogInfo extends LogInfo {
/**
* Required field contains an error code representing the error condition. The codes can be chose by
* the logging application but they should adhere to the guidelines embodied in the table below:
- * <table summary="Error Codes" cellspacing=0 border=1>
- * <tr>
- * <td style=min-width:50px>Error type</td>
- * <td style=min-width:50px>Notes</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>100</td>
- * <td style=min-width:50px>Permission errors</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>200</td>
- * <td style=min-width:50px>Availability errors/Timeouts</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>300</td>
- * <td style=min-width:50px>Data errors</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>400</td>
- * <td style=min-width:50px>Schema errors</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>500</td>
- * <td style=min-width:50px>Business process errors</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>900</td>
- * <td style=min-width:50px>Unknown Errors</td>
- * </tr>
- * </table>
+ *
+ * <div style="display: flex">
+ * <div style="border-left: 2px solid black; border-right: 2px solid black;">
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Error Type</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">100</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">200</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">300</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">400</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">500</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">
+ * 900</p>
+ * </div>
+ * <div style="border-right: 2px solid black;">
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Notes</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Permission errors</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Availability errors/Timeouts</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Data errors</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Schema errors</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Business process errors</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">
+ * Unknown Errors</p>
+ * </div>
+ * </div>
*
* @return error Code
*/
diff --git a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/NagiosAlertLevel.java b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/NagiosAlertLevel.java
index 3da5fc3..81e0369 100644
--- a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/NagiosAlertLevel.java
+++ b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/NagiosAlertLevel.java
@@ -21,14 +21,33 @@ package org.onap.dcae.utils.eelf.logger.api.info;
/**
* Enum for Nagios monitoring/alerting codes as per table below.
- * <p>
- * <table cellspacing=0 border=1>
- * <tr><th>Return Code</th><th>Service State</th><th>Host State</th></tr>
- * <tr><td>0</td><td>OK</td><td>UP</td></tr>
- * <tr><td>1</td><td>WARNING</td><td>UP or DOWN/UNREACHABLE*</td></tr>
- * <tr><td>2</td><td>CRITICAL</td><td>DOWN/UNREACHABLE</td></tr>
- * <tr><td>3</td><td>UNKNOWN</td><td>DOWN/UNREACHABLE</td></tr>
- * </table>
+ *
+ *
+ * <div style="display: flex">
+ * <div style="border-left: 2px solid black; border-right: 2px solid black;">
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Return Code</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">0</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">1</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">2</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">3</p>
+ * </div>
+ * <div style="border-right: 2px solid black;">
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Service State</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">OK</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">WARNING</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">CRITICAL</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">
+ * UNKNOWN</p>
+ * </div>
+ * <div style="border-right: 2px solid black;">
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Host State</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">UP</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">UP or DOWN/UNREACHABLE*</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">DOWN/UNREACHABLE</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">
+ * DOWN/UNREACHABLE</p>
+ * </div>
+ * </div>
*
* @author Rajiv Singla
*/
diff --git a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ResponseLogInfo.java b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ResponseLogInfo.java
index 1929e7f..ad09f3d 100644
--- a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ResponseLogInfo.java
+++ b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ResponseLogInfo.java
@@ -30,43 +30,32 @@ public interface ResponseLogInfo extends LogInfo {
* Required field contains application-specific response codes. While error codes are
* application-specific, they
* should conform categories mentioned in table below in order to provide consistency
- * <p>
- * <table cellspacing=0 border=1>
- * <tr>
- * <th style=min-width:50px><b>Error type</b></th>
- * <th style=min-width:50px><b>Notes</b></th>
- * </tr>
- * <tr>
- * <td style=min-width:50px>0</td>
- * <td style=min-width:50px>Success</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>100</td>
- * <td style=min-width:50px>Permission errors</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>200</td>
- * <td style=min-width:50px>Availability errors/Timeouts</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>300</td>
- * <td style=min-width:50px>Data errors</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>400</td>
- * <td style=min-width:50px>Schema errors</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>500</td>
- * <td style=min-width:50px>Business process errors</td>
- * </tr>
- * <tr>
- * <td style=min-width:50px>900</td>
- * <td style=min-width:50px>Unknown Errors</td>
- * </tr>
- * </table>
+ * <div style="display: flex">
+ * <div style="border-left: 2px solid black; border-right: 2px solid black;">
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Error Type</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">0</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">100</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">200</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">300</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">400</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">500</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">
+ * 900</p>
+ * </div>
+ * <div style="border-right: 2px solid black;">
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Notes</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Success</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Permission errors</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Availability errors/Timeouts</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Data errors</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Schema errors</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;">Business process errors</p>
+ * <p style="margin: 0;padding: 0 1px 0;border-top: 2px solid black;border-bottom: 2px solid black;">
+ * Unknown Errors</p>
+ * </div>
+ * </div>
*
- * @return application-specific error code
+ * @return error Code
*/
Integer getResponseCode();
diff --git a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/AuditLog.java b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/AuditLog.java
index 952176e..df33941 100644
--- a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/AuditLog.java
+++ b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/AuditLog.java
@@ -59,6 +59,7 @@ public interface AuditLog {
*
* @param message log message
* @param auditLogSpec audit log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void info(String message, AuditLogSpec auditLogSpec, OptionalLogSpec optionalLogSpec, String... args);
@@ -78,6 +79,7 @@ public interface AuditLog {
*
* @param message log message
* @param auditLogSpec audit log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void warn(String message, AuditLogSpec auditLogSpec, OptionalLogSpec optionalLogSpec, String... args);
@@ -96,6 +98,7 @@ public interface AuditLog {
*
* @param message log message
* @param auditLogSpec audit log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void error(String message, AuditLogSpec auditLogSpec, OptionalLogSpec optionalLogSpec, String... args);
@@ -114,6 +117,7 @@ public interface AuditLog {
*
* @param message log message
* @param auditLogSpec audit log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void fatal(String message, AuditLogSpec auditLogSpec, OptionalLogSpec optionalLogSpec, String... args);
diff --git a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/ErrorLog.java b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/ErrorLog.java
index 6b27755..900eebf 100644
--- a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/ErrorLog.java
+++ b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/ErrorLog.java
@@ -57,6 +57,7 @@ public interface ErrorLog {
*
* @param message log message
* @param errorLogSpec error log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void error(String message, ErrorLogSpec errorLogSpec, OptionalLogSpec optionalLogSpec, String... args);
@@ -76,6 +77,7 @@ public interface ErrorLog {
*
* @param message log message
* @param errorLogSpec error log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void warn(String message, ErrorLogSpec errorLogSpec, OptionalLogSpec optionalLogSpec, String... args);
diff --git a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/MetricLog.java b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/MetricLog.java
index ebc33ca..508f791 100644
--- a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/MetricLog.java
+++ b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/MetricLog.java
@@ -59,6 +59,7 @@ public interface MetricLog {
*
* @param message log message
* @param metricLogSpec metric log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void info(String message, MetricLogSpec metricLogSpec, OptionalLogSpec optionalLogSpec, String... args);
@@ -78,6 +79,7 @@ public interface MetricLog {
*
* @param message log message
* @param metricLogSpec metric log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void warn(String message, MetricLogSpec metricLogSpec, OptionalLogSpec optionalLogSpec, String... args);
@@ -96,6 +98,7 @@ public interface MetricLog {
*
* @param message log message
* @param metricLogSpec metric log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void error(String message, MetricLogSpec metricLogSpec, OptionalLogSpec optionalLogSpec, String... args);
@@ -114,6 +117,7 @@ public interface MetricLog {
*
* @param message log message
* @param metricLogSpec metric log spec
+ * @param optionalLogSpec optional log spec
* @param args argument values for log message interpolation
*/
void fatal(String message, MetricLogSpec metricLogSpec, OptionalLogSpec optionalLogSpec, String... args);