org.jcoderz.commons
Interface LogMessageInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

CfgLogMessage, CfgLogMessage.ConfigurationFactoryFailed, CfgLogMessage.ConfigurationInitializationFailed, CfgLogMessage.ConfigurationTypeConversionFailed, CfgLogMessage.ConfigurationValueNotFound, CfgLogMessage.ConfigurationValueRead, CmnLogMessage, CmnLogMessage.EntityNotFound, ConLogMessage, ConLogMessage.ConnectionRequestFailed, ConLogMessage.ConnectionResponseFailed, ConLogMessage.ConnectionTimeoutError, ConLogMessage.CreatingConnectorFailed, ConLogMessage.InitializingSslFailed, LogMessageInfoImpl, RteLogMessage, RteLogMessage.ArgumentFractionDigitsViolation, RteLogMessage.ArgumentMalformed, RteLogMessage.ArgumentMaxLengthViolation, RteLogMessage.ArgumentMaxValueViolation, RteLogMessage.ArgumentMinLengthViolation, RteLogMessage.ArgumentMinValueViolation, RteLogMessage.ArgumentPatternViolation, RteLogMessage.AssertionFailed, RteLogMessage.DatabaseAccessFailed, RteLogMessage.DatabaseIntegrityError, RteLogMessage.ExceptionCreated, RteLogMessage.InconsistentDatabase, RteLogMessage.InternalError, RteLogMessage.RemoteCallFailure, RteLogMessage.RuntimeExceptionCreated, RteLogMessage.UnexpectedException, TssLogMessage, TssLogMessage.FunnyRuntime, TssLogMessage.ImpliedParameters, TssLogMessage.ImpliedParameters2, TssLogMessage.ImpliedParameters3, TssLogMessage.ImpliedParametersLog, TssLogMessage.ImpliedParametersLog2, TssLogMessage.ImpliedParametersLog3, TstLogMessage, TstLogMessage.TestAuditMessage, TstLogMessage.TestMessage

public interface LogMessageInfo
extends Serializable

Interface for the log message info data structure. Implementations for this type are expected to be generated from MessageInfo xml files. Data in here is bound to the Message and not to specific log events.

Author:

Andreas Mandel

Method Summary

StringBuffer	formatMessage(Map parameters, StringBuffer buffer) Fills the detail message into the given string buffer with it's parameters substituted.
String	getAppName() Returns the application name as string.
String	getAppNameAbbreviation() Returns the application name abbreviation as string.
BusinessImpact	getBusinessImpact() Returns the possible business impact of the event that triggered this message to be dumped.
Category	getCategory() Returns the category of the event that triggered this message to be dumped.
String	getGroupName() Returns the group name as string.
String	getGroupNameAbbreviation() Returns the group name abbreviation as string.
Level	getLogLevel() Returns the log level that should be used (by default) for this message.
String	getMessagePattern() Returns the message pattern used to create detailed messages for this message type.
List	getParameterList() Returns a List of Strings containing the name of the parameters that are used by this message.
String	getSolution() Returns a string describing the possible solution for this message.
String	getSymbol() Returns the symbolic name for this log message info.
int	toInt() Returns the integer code representation of this log message info.

Method Detail

getSymbol

String getSymbol()

Returns the symbolic name for this log message info.

Returns:

the symbolic name for this log message info.

toInt

int toInt()

Returns the integer code representation of this log message info. This should be logged in hexadecimal form for increasing human readability.

Returns:

integer code of this log message info.

getLogLevel

Level getLogLevel()

Returns the log level that should be used (by default) for this message.

Returns:

the log level that should be used (by default) for this message.

getMessagePattern

String getMessagePattern()

Returns the message pattern used to create detailed messages for this message type. The string can contain parameters as described for MessageFormat. The order of the parameters is given by the parameter list getParameterList().

Returns:

the detailed message for this message type with no parameters substituted.

formatMessage

StringBuffer formatMessage(Map parameters,
                           StringBuffer buffer)

Fills the detail message into the given string buffer with it's parameters substituted.

Parameters:

parameters - The map of parameters to be substituted.

buffer - the StringBuffer to be filled.

Returns:

the buffer argument.

getSolution

String getSolution()

Returns a string describing the possible solution for this message. This might also contain a descriptive text about the reason.

Returns:

a string describing the possible solution for this message.

getBusinessImpact

BusinessImpact getBusinessImpact()

Returns the possible business impact of the event that triggered this message to be dumped.

Returns:

the possible business impact of the event that triggered this message to be dumped.

getCategory

Category getCategory()

Returns the category of the event that triggered this message to be dumped.

Returns:

the category of the event that triggered this message to be dumped.

getParameterList

List getParameterList()

Returns a List of Strings containing the name of the parameters that are used by this message. The order of the parameter must accord to the parameters used in the message pattern.

Returns:

list of possible parameter names (Strings).

getAppName

String getAppName()

Returns the application name as string.

Returns:

the application name as string.

getAppNameAbbreviation

String getAppNameAbbreviation()

Returns the application name abbreviation as string.

Returns:

the application name abbreviation as string.

getGroupName

String getGroupName()

Returns the group name as string.

Returns:

the group name as string.

getGroupNameAbbreviation

String getGroupNameAbbreviation()

Returns the group name abbreviation as string.

Returns:

the group name abbreviation as string.