alma.acs.logging

Class LogParameterUtil

java.lang.Object

alma.acs.logging.LogParameterUtil

public class LogParameterUtil
extends java.lang.Object

Class that encapsulates access to log record parameters, and handling of a special Property-Map parameter. Some conventions are necessary because we "smuggle" some extra information from the plain-JDK loggers to the ACS-aware log dispatcher. The alternative would be to expose ACS custom loggers to applications, which seems too ugly for the benefit it provides.

The rules are:

• Parameters of type Map are interpreted as name-value pairs and show up in the XML log output as <Data Name="key">value</Data>
• Single-valued parameters show up in the XML log output as <Data Name="LoggedParameter">value</Data>
• There is a special properties Map parameter that contains the key isAcsPropertiesMap. Those values are recognized by the log formatter and result in special fields being set, instead of <Data/> elements being constructed. When adding this map as a log parameter, it should be created using method createPropertiesMap().

Note that this class is stateful: returned values come from the last given LogRecord, which can be set in the constructor or overwritten in setCurrentLogRecord(LogRecord).

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IS_ACS_PROPERTIES_MAP_KEYNAME
static java.lang.String	PARAM_HOSTNAME
static java.lang.String	PARAM_LINE
static java.lang.String	PARAM_PRIORITY
static java.lang.String	PARAM_PROCESSNAME
static java.lang.String	PARAM_SOURCEOBJECT
static java.lang.String	PARAM_STACK_ID
static java.lang.String	PARAM_STACK_LEVEL
static java.lang.String	PARAM_THREAD_NAME
static java.lang.String	PARAM_URI

Constructor Summary

Constructors

Constructor and Description
LogParameterUtil(java.util.logging.LogRecord currentLogRecord)

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,java.lang.Object>	createPropertiesMap() Creates a new special properties map.
long	extractLongProperty(java.lang.String name, long defaultValue) Extracts property with specified name of type long from the special properties map.
java.lang.String	extractStringProperty(java.lang.String name, java.lang.String defaultValue) Extracts property with specified name of type String from the special properties map.
java.util.List<java.lang.Object>	getNonSpecialPropertiesMapParameters() Returns parameters of the current log record which are different from the special Properties Map.
void	setCurrentLogRecord(java.util.logging.LogRecord logRecord) Sets the log record from which the other methods can extract information.

Methods inherited from class java.lang.Object

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

Field Detail

IS_ACS_PROPERTIES_MAP_KEYNAME

public static final java.lang.String IS_ACS_PROPERTIES_MAP_KEYNAME

See Also:

Constant Field Values

PARAM_THREAD_NAME

public static final java.lang.String PARAM_THREAD_NAME

See Also:

Constant Field Values

PARAM_LINE

public static final java.lang.String PARAM_LINE

See Also:

Constant Field Values

PARAM_HOSTNAME

public static final java.lang.String PARAM_HOSTNAME

See Also:

Constant Field Values

PARAM_STACK_ID

public static final java.lang.String PARAM_STACK_ID

See Also:

Constant Field Values

PARAM_STACK_LEVEL

public static final java.lang.String PARAM_STACK_LEVEL

See Also:

Constant Field Values

PARAM_PRIORITY

public static final java.lang.String PARAM_PRIORITY

See Also:

Constant Field Values

PARAM_URI

public static final java.lang.String PARAM_URI

See Also:

Constant Field Values

PARAM_PROCESSNAME

public static final java.lang.String PARAM_PROCESSNAME

See Also:

Constant Field Values

PARAM_SOURCEOBJECT

public static final java.lang.String PARAM_SOURCEOBJECT

See Also:

Constant Field Values

Constructor Detail

LogParameterUtil

public LogParameterUtil(java.util.logging.LogRecord currentLogRecord)

Method Detail

createPropertiesMap

public static java.util.Map<java.lang.String,java.lang.Object> createPropertiesMap()

Creates a new special properties map.

Returns:

setCurrentLogRecord

public void setCurrentLogRecord(java.util.logging.LogRecord logRecord)

Sets the log record from which the other methods can extract information. Also parses the special properties map and other parameters.

Parameters:

logRecord -

getNonSpecialPropertiesMapParameters

public java.util.List<java.lang.Object> getNonSpecialPropertiesMapParameters()

Returns parameters of the current log record which are different from the special Properties Map. These parameters may still be of type Map.

The returned list is "live", so don't muck with it.

Returns:

array of parameters, possibly empty, but never null.

extractLongProperty

public long extractLongProperty(java.lang.String name,
                                long defaultValue)

Extracts property with specified name of type long from the special properties map.

Parameters:

name - name of the property

defaultValue - value returned if failed to obtain property value

Returns:

value, defaultValue on failure

extractStringProperty

public java.lang.String extractStringProperty(java.lang.String name,
                                              java.lang.String defaultValue)

Extracts property with specified name of type String from the special properties map.

Parameters:

name - name of the property

defaultValue - value returned if failed to obtain property value

Returns:

value, defaultValue on failure