org.jcoderz.commons
Class TstLogMessage.TestAuditMessage

java.lang.Object
  org.jcoderz.commons.LogMessageInfoImpl
      org.jcoderz.commons.TstLogMessage
          org.jcoderz.commons.TstLogMessage.TestAuditMessage

All Implemented Interfaces:

Serializable, LogMessageInfo

Enclosing class:

TstLogMessage

public static final class TstLogMessage.TestAuditMessage
extends TstLogMessage
implements Serializable

This is a test audit event and should not be used in a production environment. .

This class holds the static data for the TEST_AUDIT_MESSAGE log message.

It holds the following parameters:

• Message: This is a test audit event and should not be used in a production environment.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.jcoderz.commons.TstLogMessage

TstLogMessage.TestAuditMessage, TstLogMessage.TestMessage

Field Summary

static int	INT_VALUE The unique integer value of the log message TEST_AUDIT_MESSAGE.
static Level	LOG_LEVEL The LogLevel to use.
static String	SYMBOL The unique symbolic String of the log message TEST_AUDIT_MESSAGE.

Fields inherited from class org.jcoderz.commons.TstLogMessage

TEST_AUDIT_MESSAGE, TEST_MESSAGE

Method Summary

static Loggable	addParameters(Loggable loggable) Adds the given message parameters to the loggable.
static AuditLogEvent	create(AuditPrincipal auditPrincipal) Creates the audit log event "This is a test audit event and should not be used in a production environment."
static AuditLogEvent	create(AuditPrincipal auditPrincipal, Throwable cause) Creates the audit log event "This is a test audit event and should not be used in a production environment."
static void	log(AuditPrincipal auditPrincipal) Logs the message "This is a test audit event and should not be used in a production environment."
static void	log(AuditPrincipal auditPrincipal, Throwable cause) Logs the message "This is a test audit event and should not be used in a production environment."

Methods inherited from class org.jcoderz.commons.TstLogMessage

fromInt, fromString

Methods inherited from class org.jcoderz.commons.LogMessageInfoImpl

formatMessage, getAppName, getAppNameAbbreviation, getBusinessImpact, getCategory, getGroupName, getGroupNameAbbreviation, getLogLevel, getMessagePattern, getParameterList, getSolution, getSymbol, toInt, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INT_VALUE

public static final int INT_VALUE

The unique integer value of the log message TEST_AUDIT_MESSAGE.

See Also:

Constant Field Values

SYMBOL

public static final String SYMBOL

The unique symbolic String of the log message TEST_AUDIT_MESSAGE.

See Also:

Constant Field Values

description

This is a test audit event and should not be used in a production environment.

LOG_LEVEL

public static final Level LOG_LEVEL

The LogLevel to use.

Method Detail

log

public static void log(AuditPrincipal auditPrincipal)

Logs the message "This is a test audit event and should not be used in a production environment." with the given parameters.

Parameters:

auditPrincipal - The audit principal that causes this log event.

log

public static void log(AuditPrincipal auditPrincipal,
                       Throwable cause)

Logs the message "This is a test audit event and should not be used in a production environment." with the given parameters.

Parameters:

auditPrincipal - The audit principal that causes this log event.

cause - the Throwable that causes this message to be logged.

create

public static AuditLogEvent create(AuditPrincipal auditPrincipal)

Creates the audit log event "This is a test audit event and should not be used in a production environment." with the given parameters.

Parameters:

auditPrincipal - The audit principal that causes this log event.

create

public static AuditLogEvent create(AuditPrincipal auditPrincipal,
                                   Throwable cause)

Creates the audit log event "This is a test audit event and should not be used in a production environment." with the given parameters.

Parameters:

auditPrincipal - The audit principal that causes this log event.

cause - the Throwable that causes this message to be logged.

addParameters

public static Loggable addParameters(Loggable loggable)

Adds the given message parameters to the loggable.

Parameters:

loggable - the loggable to initialize.

Returns:

the given initialized loggable.