hm.binkley.util.logging.osi

Enum SupportLoggers

java.lang.Object

java.lang.Enum<SupportLoggers>

hm.binkley.util.logging.osi.SupportLoggers

All Implemented Interfaces:

Serializable, Comparable<SupportLoggers>

public enum SupportLoggers
extends Enum<SupportLoggers>

SupportLoggers are custom MarkedLoggers for specialized use. Methods create new marked loggers with the enum names as markers.

There is one factory method variant for each style of logger creation:

getLogger(Class)

Creates a new underlying logger from a class

getLogger(String)

Creates a new underlying logger from a logger name

getLogger(Logger)

Reuses an existing underlying logger

Applications should configure logback or other logging system by marker:

ALERT

Send alerts for system issues

APPLICATION

Logs normally following logback configuration

AUDIT

Records an audit trail, typically to a database

TRACE

A tracing logger for method entry and exit

Author:

B. K. Oxley (binkley)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALERT Marks "ALERT" loggers for system issues.
APPLICATION Unmarked loggers for normal logging.
AUDIT Marks "AUDIT" loggers to record an audit trail, typically to a database.
TRACE Trace loggers (XLogger for debugging.

Method Summary

Modifier and Type	Method and Description
org.slf4j.Logger	getLogger(Class<?> logger) Creates a new marked logger for the given logger.
org.slf4j.Logger	getLogger(org.slf4j.Logger logger) Creates a new marked logger for the given logger.
org.slf4j.Logger	getLogger(String logger) Creates a new marked logger for the given logger.
static org.slf4j.ext.XLogger	trace(Class<?> logger) Redundant method for TRACE returning XLogger.
static org.slf4j.ext.XLogger	trace(String logger) Redundant method for TRACE returning XLogger.
static SupportLoggers	valueOf(String name) Returns the enum constant of this type with the specified name.
static SupportLoggers[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ALERT

public static final SupportLoggers ALERT

Marks "ALERT" loggers for system issues. Rejects logging at less than WARN level (throws IllegalStateException).

APPLICATION

public static final SupportLoggers APPLICATION

Unmarked loggers for normal logging.

AUDIT

public static final SupportLoggers AUDIT

Marks "AUDIT" loggers to record an audit trail, typically to a database. Rejects logging less than INFO level (throws IllegalStateException).

TRACE

public static final SupportLoggers TRACE

Trace loggers (XLogger for debugging.

Method Detail

values

public static SupportLoggers[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SupportLoggers c : SupportLoggers.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SupportLoggers valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

trace

@Nonnull
public static org.slf4j.ext.XLogger trace(@Nonnull
                                                    Class<?> logger)

Redundant method for TRACE returning XLogger.

Parameters:

logger - the logger class, never missing

Returns:

the XLogger, never missing

Pending:

Java needs anonymous instance covariant returns to avoid casting

trace

@Nonnull
public static org.slf4j.ext.XLogger trace(@Nonnull
                                                    String logger)

Redundant method for TRACE returning XLogger.

Parameters:

logger - the logger name, never missing

Returns:

the XLogger, never missing

Pending:

Java needs anonymous instance covariant returns to avoid casting

getLogger

@Nonnull
public org.slf4j.Logger getLogger(@Nonnull
                                            Class<?> logger)

Creates a new marked logger for the given logger.

Parameters:

logger - the underlying class, never missing

Returns:

the wrapping marked logger, never missing

getLogger

@Nonnull
public org.slf4j.Logger getLogger(@Nonnull
                                            String logger)

Creates a new marked logger for the given logger.

Parameters:

logger - the underlying logger name, never missing

Returns:

the wrapping marked logger, never missing

getLogger

@Nonnull
public org.slf4j.Logger getLogger(@Nonnull
                                            org.slf4j.Logger logger)

Creates a new marked logger for the given logger.

Parameters:

logger - the underlying SLF4j logger, never missing

Returns:

the wrapping marked logger, never missing