alma.acs.logging

Class AcsLogLevel

java.lang.Object

java.util.logging.Level

alma.acs.logging.AcsLogLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AcsLogLevel>

public class AcsLogLevel
extends java.util.logging.Level
implements java.lang.Comparable<AcsLogLevel>

Defines ACS specific logging levels. Also provides non-ACS level, which includes set of standard logging and possibly other vendor levels, to ACS level mapping. Maps Java-specific levels to ACS specific levels.

Although an OFF level is not mentioned in the Acs documentation, it is included for the purpose of dealing with bad levels as well as of blocking logging.

Author:

Matej Sekoranja (matej.sekoranja@cosylab.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static AcsLogLevel	ALERT A condition that should be corrected immediately, such as a corrupted system database.
static AcsLogLevel	CRITICAL Critical conditions, such as hard device errors.
static AcsLogLevel	DEBUG Messages that contain information normally of use only when debugging a program.
static AcsLogLevel	DELOUSE A lower level than DEBUG, just to allow finer tuning.
static AcsLogLevel	EMERGENCY A panic condition.
static AcsLogLevel	ERROR Error messages.
static AcsLogLevel	INFO Informational messages.
static AcsLogLevel	NOTICE Conditions that are not error conditions, but that may require special handling.
static AcsLogLevel	OFF Level not to be used for actual logging, but to set log levels for filtering.
static AcsLogLevel	TRACE Messages indicating function-calling sequence.
static AcsLogLevel	WARNING Warning messages.

Fields inherited from class java.util.logging.Level

ALL, CONFIG, FINE, FINER, FINEST, SEVERE

Constructor Summary

Constructors

Constructor and Description
AcsLogLevel(java.lang.String name, int value, AcsLogLevelDefinition acsCoreLevel) Create a named Level with a given integer value.

Method Summary

Modifier and Type	Method and Description
int	compareTo(AcsLogLevel l) Compares the level with the specified level for order.
static AcsLogLevel	fromAcsCoreLevel(AcsLogLevelDefinition acsCoreLevel) Converts an ACS core log level (small integer as defined in ACS IDL) to the largest matching AcsLogLevel.
AcsLogLevelDefinition	getAcsLevel() Returns the corresponding ACS core level, which is a small positive integer defined as "priority" in the ACS logging and archiving architecture document and coded in IDL (see alma.AcsLogging.alma.LogLevels.WARNING_NAME and similar constants).
java.lang.String	getEntryName() Returns the ACS XML level entryName.
static java.util.logging.Level	getLowestMatchingJdkLevel(AcsLogLevelDefinition acsCoreLevel) Converts an ACS core log level (small integer as defined in ACS IDL) to the lowest matching AcsLogLevel or JDK Level.
static AcsLogLevel	getNativeLevel(java.util.logging.Level level) Maps any (JDK or ACS) level to an ACS native level.

Methods inherited from class java.util.logging.Level

equals, getLocalizedName, getName, getResourceBundleName, hashCode, intValue, parse, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

TRACE

public static final AcsLogLevel TRACE

Messages indicating function-calling sequence.

DELOUSE

public static final AcsLogLevel DELOUSE

A lower level than DEBUG, just to allow finer tuning. Generally same meaning. See COMP-3749.

DEBUG

public static final AcsLogLevel DEBUG

Messages that contain information normally of use only when debugging a program. Java levels FINE and CONFIG map to this DEBUG level.

INFO

public static final AcsLogLevel INFO

Informational messages.

NOTICE

public static final AcsLogLevel NOTICE

Conditions that are not error conditions, but that may require special handling. TODO: use something like 850 instead of 801 to allow other levels between INFO and NOTICE

WARNING

public static final AcsLogLevel WARNING

Warning messages.

ERROR

public static final AcsLogLevel ERROR

Error messages. TODO: use something like 930 instead of 901 to allow other levels between ERROR and WARNING

CRITICAL

public static final AcsLogLevel CRITICAL

Critical conditions, such as hard device errors. TODO: use something like 960 instead of 902 to allow other levels between CRITICAL and ERROR

ALERT

public static final AcsLogLevel ALERT

A condition that should be corrected immediately, such as a corrupted system database. TODO: use something like 980 instead of 903 to allow other levels between ERROR and ALERT

EMERGENCY

public static final AcsLogLevel EMERGENCY

A panic condition. This is normally broadcast to all users.

OFF

public static final AcsLogLevel OFF

Level not to be used for actual logging, but to set log levels for filtering. Overwrites/hides Level.OFF.

Constructor Detail

AcsLogLevel

public AcsLogLevel(java.lang.String name,
                   int value,
                   AcsLogLevelDefinition acsCoreLevel)

Create a named Level with a given integer value.

Parameters:

name - the name of the Level, for example "INFO".

value - an integer value for the level.

Method Detail

fromAcsCoreLevel

public static AcsLogLevel fromAcsCoreLevel(AcsLogLevelDefinition acsCoreLevel)

Converts an ACS core log level (small integer as defined in ACS IDL) to the largest matching AcsLogLevel.

getLowestMatchingJdkLevel

public static java.util.logging.Level getLowestMatchingJdkLevel(AcsLogLevelDefinition acsCoreLevel)

Converts an ACS core log level (small integer as defined in ACS IDL) to the lowest matching AcsLogLevel or JDK Level.

Note the difference to fromAcsCoreLevel(AcsLogLevelDefinition):

• If more than one JDK-style log level gets mapped to the given core level, then the lowest of these levels gets returned. This method is therefore suitable to compute JDK log levels for filtering when logs with all matching JDK levels should be allowed.
• Currently this method is implemented with hard-wired levels, which means that user-defined subclasses of AcsLogLevel are not considered. (As of ACS 8.x, there is no known usage of custom log levels. Supporting them for this method would require to keep a list similar to known that includes all JDK Level and AcsLogLevel objects.)

getAcsLevel

public AcsLogLevelDefinition getAcsLevel()

Returns the corresponding ACS core level, which is a small positive integer defined as "priority" in the ACS logging and archiving architecture document and coded in IDL (see alma.AcsLogging.alma.LogLevels.WARNING_NAME and similar constants).

This level is different from the JDK-style level, which can be any integer.

Returns:

ACS core level

getEntryName

public java.lang.String getEntryName()

Returns the ACS XML level entryName.

Returns:

ACS XML level entryName

compareTo

public int compareTo(AcsLogLevel l)

Compares the level with the specified level for order.

Specified by:

compareTo in interface java.lang.Comparable<AcsLogLevel>

See Also:

Comparable.compareTo(Object)

getNativeLevel

public static AcsLogLevel getNativeLevel(java.util.logging.Level level)

Maps any (JDK or ACS) level to an ACS native level.

Note that for some strange historical reason, the ACS log level is called "native" here, to confuse those who think that JDK levels would be native...

Parameters:

level - any level

Returns:

native level, can be null if no native level is found or if level==Level.OFF