PolicyLogger (Policy Engine - Common Modules 1.1.0 API)

java.lang.Object
- org.openecomp.policy.common.logging.eelf.PolicyLogger

```
public class PolicyLogger
extends Object
```
PolicyLogger contains all the static methods for EELF logging

Field Summary

Fields
Modifier and Type	Field and Description
`static com.att.eelf.configuration.EELFLogger.Level`	`AUDIT_LEVEL`
`static String`	`CLASS_NAME`
`static com.att.eelf.configuration.EELFLogger.Level`	`DEBUG_LEVEL`
`static com.att.eelf.configuration.EELFLogger.Level`	`ERROR_LEVEL`
`static com.att.eelf.configuration.EELFLogger.Level`	`METRICS_LEVEL`

Constructor Summary

Constructors
Constructor and Description

PolicyLogger()

Constructors
Constructor and Description
`PolicyLogger()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`audit(Object arg0)` Records only one String message
`static void`	`audit(String className, Object arg0)` Records only one String message with its class name
`static void`	`creatAuditEventTrackingRecord(String eventId, String rule, String policyVersion)` Records the ending time of the event with its request Id as the key
`static void`	`creatAuditEventTrackingRecord(UUID eventId, String rule)` Records the ending time of the event with its request Id as the key
`static void`	`debug(MessageCodes msg, String... arguments)` Records a message with passed in message code and a list of string values
`static void`	`debug(MessageCodes msg, String className, Throwable arg0, String... arguments)` Records a message with passed in message code, class name, Throwable object, a list of string values
`static void`	`debug(MessageCodes msg, Throwable arg0, String... arguments)` Records a message with passed in message code, hrowable object, a list of string values
`static void`	`debug(Object arg0)` Records only one String message
`static void`	`debug(String arg0)` Records only one String message
`static void`	`debug(String className, String arg0)` Records only one String message with its class name
`static void`	`error(MessageCodes msg, String... arguments)` Records a message with passed in message code and a list of string values
`static void`	`error(MessageCodes msg, String className, Throwable arg0, String... arguments)` Records a message with passed in message code, class name, Throwable object, a list of string values
`static void`	`error(MessageCodes msg, Throwable arg0, String... arguments)` Records a message with passed in message code, Throwable object, a list of string values
`static void`	`error(Object arg0)` Records only one String message
`static void`	`error(String arg0)` Records only one String message
`static void`	`error(String className, String arg0)` Records only one String message with its class name
`static EventTrackInfo`	`getEventTracker()`
`static String`	`getTransId()` Returns current transaction Id used in MDC
`static void`	`info(MessageCodes msg, String... arguments)` Records the Info event with String [] arguments
`static void`	`info(MessageCodes msg, String className, String... arguments)` Records the Info event with String [] arguments
`static void`	`info(MessageCodes msg, String className, Throwable arg0, String... arguments)` Records a message with passed in message code, class name, Throwable object, a list of string values
`static void`	`info(MessageCodes msg, Throwable arg0, String... arguments)` Records a message with passed in message code, Throwable object, a list of string values
`static void`	`info(Object arg0)` Records only one String message
`static void`	`info(String arg0)` Records only one String message without its class name passed in
`static void`	`info(String className, String arg0)` Records only one String message with its class name
`static LoggerType`	`init(Properties properties)` Loads all the attributes from policyLogger.properties file
`static boolean`	`isAuditEnabled()` returns true for enabled, false for not enabled
`static boolean`	`isDebugEnabled()` returns true for enabled, false for not enabled
`static boolean`	`isErrorEnabled()` returns true for enabled, false for not enabled
`static boolean`	`isInfoEnabled()` returns true for enabled, false for not enabled
`static boolean`	`isInfoEnabled1()` returns true for enabled, false for not enabled
`static boolean`	`isOverrideLogbackLevel()` Returns true for overriding logback levels; returns false for not
`static boolean`	`isWarnEnabled()` returns true for enabled, false for not enabled
`static void`	`metrics(Object arg0)` Records the metrics event with a String message
`static void`	`metrics(String arg0)` Records the metrics event with a String message
`static void`	`metrics(String className, Object arg0)` Records the metrics event with a class name and a String message
`static void`	`metricsPrintln(String arg0)` Records the metrics event with a String message
`static void`	`postMDCInfoForEvent(Object o)` Sets transaction Id to MDC
`static String`	`postMDCInfoForEvent(String transId)` Populates MDC info
`static String`	`postMDCInfoForTriggeredRule(String transId)` Resets transaction Id in MDC for the rule triggered by this event
`static void`	`postMDCUUIDForTriggeredRule(Object o)` Resets transaction Id in MDC for the rule triggered by this event
`static void`	`recordAuditEventEnd(String eventId, String rule)` Records the ending time of the event with its request Id as the key
`static void`	`recordAuditEventEnd(String eventId, String rule, String policyVersion)` Records the ending time of the event with its request Id as the key
`static void`	`recordAuditEventEnd(UUID eventId, String rule)` Records the ending time of the event with its request Id as the key
`static void`	`recordAuditEventEnd(UUID eventId, String rule, String policyVersion)` Records the ending time of the event with its request Id as the key
`static void`	`recordAuditEventStart(String eventId)` Records the starting time of the event with its request Id as the key
`static void`	`recordAuditEventStart(UUID eventId)` Records the starting time of the event with its request Id as the key
`static void`	`recordAuditEventStartToEnd(String eventId, String rule, Instant startTime, Instant endTime, String policyVersion)` Records the audit with an event starting and ending times
`static void`	`recordMetricEvent(String arg0)` Records a String message for metrics logs
`static void`	`recordMetricEvent(String eventId, String arg1)` Records the metrics with an event Id and log message
`static void`	`recordMetricEvent(String eventId, String className, String arg1)` Records the metrics with an event Id, class name and log message
`static void`	`recordMetricEvent(UUID eventId, String arg1)` Records the metrics with an event Id and log message
`static void`	`setAuditLevel(String auditLevel)` Sets Audit OFF or ON
`static void`	`setDebugLevel(String debugLevel)` Sets Debug Level
`static void`	`setErrorLevel(String errorLevel)` Sets Error OFF or ON
`static void`	`setMetricsLevel(String metricsLevel)` Sets Metrics OFF or ON
`static void`	`setOverrideLogbackLevel(boolean odl)` Sets true for overriding logback levels; sets false for not
`static void`	`setServerInfo(String serverHost, String serverPort)` Sets server information to MDC
`static void`	`setTransId(String transId)` Sets transaction Id to MDC
`static void`	`trace(Object arg0)` Records only one String message
`static void`	`trace(String className, String arg0)` Records only one String message with its class name
`static void`	`warn(MessageCodes msg, String... arguments)` Records a message with passed in message code and a list of string values
`static void`	`warn(MessageCodes msg, String className, String... arguments)` Records a message with passed in message code, class name and a list of string values
`static void`	`warn(MessageCodes msg, String className, Throwable arg0, String... arguments)` Records a message with passed in message code, Throwable object, a list of string values
`static void`	`warn(MessageCodes msg, Throwable arg0, String... arguments)` Records a message with passed in message code, Throwable object, a list of string values
`static void`	`warn(Object arg0)` Records only one String message
`static void`	`warn(String arg0)` Records only one String message without its class name passed in
`static void`	`warn(String className, String arg0)` Records only one String message with its class name

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG_LEVEL

public static com.att.eelf.configuration.EELFLogger.Level DEBUG_LEVEL

AUDIT_LEVEL

public static com.att.eelf.configuration.EELFLogger.Level AUDIT_LEVEL

METRICS_LEVEL

public static com.att.eelf.configuration.EELFLogger.Level METRICS_LEVEL

ERROR_LEVEL

public static com.att.eelf.configuration.EELFLogger.Level ERROR_LEVEL

CLASS_NAME
```
public static String CLASS_NAME
```

Constructor Detail
- PolicyLogger
```
public PolicyLogger()
```

Method Detail

postMDCInfoForEvent
```
public static String postMDCInfoForEvent(String transId)
```
Populates MDC info

Parameters:

transId -

Returns:

String

setTransId
```
public static void setTransId(String transId)
```
Sets transaction Id to MDC

Parameters:

transId -

getTransId
```
public static String getTransId()
```
Returns current transaction Id used in MDC

Returns:

transId

postMDCInfoForEvent
```
public static void postMDCInfoForEvent(Object o)
```
Sets transaction Id to MDC

Parameters:

o -

postMDCInfoForTriggeredRule
```
public static String postMDCInfoForTriggeredRule(String transId)
```
Resets transaction Id in MDC for the rule triggered by this event

Parameters:

transId -

Returns:

String

postMDCUUIDForTriggeredRule
```
public static void postMDCUUIDForTriggeredRule(Object o)
```
Resets transaction Id in MDC for the rule triggered by this event

Parameters:

o -

info

public static void info(MessageCodes msg,
                        String... arguments)

Records the Info event with String [] arguments

Parameters:: msg -; arguments -

info

public static void info(MessageCodes msg,
                        String className,
                        String... arguments)

Records the Info event with String [] arguments

Parameters:: msg -; className -; arguments -

info

public static void info(String className,
                        String arg0)

Records only one String message with its class name

Parameters:: className -; arg0 -

info
```
public static void info(String arg0)
```
Records only one String message without its class name passed in

Parameters:

arg0 -

info
```
public static void info(Object arg0)
```
Records only one String message

Parameters:

arg0 -

info

public static void info(MessageCodes msg,
                        Throwable arg0,
                        String... arguments)

Records a message with passed in message code, Throwable object, a list of string values

Parameters:: msg -; arg0 -; arguments -

info

public static void info(MessageCodes msg,
                        String className,
                        Throwable arg0,
                        String... arguments)

Records a message with passed in message code, class name, Throwable object, a list of string values

Parameters:: msg -; className -; arg0 -; arguments -

warn

public static void warn(String className,
                        String arg0)

Records only one String message with its class name

Parameters:: arg0 - log message; className - class name

warn
```
public static void warn(Object arg0)
```
Records only one String message

Parameters:

arg0 -

warn
```
public static void warn(String arg0)
```
Records only one String message without its class name passed in

Parameters:

arg0 -

warn

public static void warn(MessageCodes msg,
                        String... arguments)

Records a message with passed in message code and a list of string values

Parameters:: msg -; arguments -

warn

public static void warn(MessageCodes msg,
                        String className,
                        String... arguments)

Records a message with passed in message code, class name and a list of string values

Parameters:: msg -; className -; arguments -

warn

public static void warn(MessageCodes msg,
                        Throwable arg0,
                        String... arguments)

Records a message with passed in message code, Throwable object, a list of string values

Parameters:: msg -; arg0 -; arguments -

warn

public static void warn(MessageCodes msg,
                        String className,
                        Throwable arg0,
                        String... arguments)

Records a message with passed in message code, Throwable object, a list of string values

Parameters:: msg -; className -; arg0 -; arguments -

error

public static void error(String className,
                         String arg0)

Records only one String message with its class name

Parameters:: className - class name; arg0 - log message

error
```
public static void error(String arg0)
```
Records only one String message

Parameters:

arg0 -

error
```
public static void error(Object arg0)
```
Records only one String message

Parameters:

arg0 -

error

public static void error(MessageCodes msg,
                         Throwable arg0,
                         String... arguments)

Records a message with passed in message code, Throwable object, a list of string values

Parameters:: msg -; arg0 -; arguments -

error

public static void error(MessageCodes msg,
                         String className,
                         Throwable arg0,
                         String... arguments)

Records a message with passed in message code, class name, Throwable object, a list of string values

Parameters:: msg -; className -; arg0 -; arguments -

error

public static void error(MessageCodes msg,
                         String... arguments)

Records a message with passed in message code and a list of string values

Parameters:: msg -; arguments -

debug

public static void debug(MessageCodes msg,
                         String... arguments)

Records a message with passed in message code and a list of string values

Parameters:: msg -; arguments -

debug

public static void debug(String className,
                         String arg0)

Records only one String message with its class name

Parameters:: className -; arg0 -

debug
```
public static void debug(String arg0)
```
Records only one String message

Parameters:

arg0 -

debug
```
public static void debug(Object arg0)
```
Records only one String message

Parameters:

arg0 -

audit

public static void audit(String className,
                         Object arg0)

Records only one String message with its class name

Parameters:: className -; arg0 -

audit
```
public static void audit(Object arg0)
```
Records only one String message

Parameters:

arg0 -

debug

public static void debug(MessageCodes msg,
                         Throwable arg0,
                         String... arguments)

Records a message with passed in message code, hrowable object, a list of string values

Parameters:: msg -; arg0 -; arguments -

debug

public static void debug(MessageCodes msg,
                         String className,
                         Throwable arg0,
                         String... arguments)

Records a message with passed in message code, class name, Throwable object, a list of string values

Parameters:: msg -; className -; arg0 -; arguments -

isDebugEnabled
```
public static boolean isDebugEnabled()
```
returns true for enabled, false for not enabled

isErrorEnabled
```
public static boolean isErrorEnabled()
```
returns true for enabled, false for not enabled

isWarnEnabled
```
public static boolean isWarnEnabled()
```
returns true for enabled, false for not enabled

isInfoEnabled1
```
public static boolean isInfoEnabled1()
```
returns true for enabled, false for not enabled

isAuditEnabled
```
public static boolean isAuditEnabled()
```
returns true for enabled, false for not enabled

isInfoEnabled
```
public static boolean isInfoEnabled()
```
returns true for enabled, false for not enabled

trace

public static void trace(String className,
                         String arg0)

Records only one String message with its class name

Parameters:: className -; arg0 -

trace
```
public static void trace(Object arg0)
```
Records only one String message

Parameters:

arg0 -

recordAuditEventStart
```
public static void recordAuditEventStart(String eventId)
```
Records the starting time of the event with its request Id as the key

Parameters:

eventId -

recordAuditEventStart
```
public static void recordAuditEventStart(UUID eventId)
```
Records the starting time of the event with its request Id as the key

Parameters:

eventId -