Package org.jboss.logmanager

Class LogContext

java.lang.Object

org.jboss.logmanager.LogContext

public final class LogContext
extends Object

A logging context, for producing isolated logging environments.

Method Summary

Modifier and Type	Method	Description
<V> V	attach(Logger.AttachmentKey<V> key, V value)	Attach an object to this log context under a given key.
<V> V	attachIfAbsent(Logger.AttachmentKey<V> key, V value)	Attach an object to this log context under a given key, if such an attachment does not already exist.
<V> V	detach(Logger.AttachmentKey<V> key)	Remove an attachment.
<V> V	getAttachment(String loggerName, Logger.AttachmentKey<V> key)	Get a logger attachment for a logger name, if it exists.
<V> V	getAttachment(Logger.AttachmentKey<V> key)	Get the attachment value for a given key, or null if there is no such attachment.
static LogContext	getInstance()	Get the system log context.
Level	getLevelForName(String name)	Get the level for a name.
static LogContext	getLogContext()
Logger	getLogger(String name)	Get a logger with the given name from this logging context.
Logger	getLoggerIfExists(String name)	Get a logger with the given name from this logging context, if a logger node exists at that location.
Enumeration<String>	getLoggerNames()	Returns an enumeration of the logger names that have been created.

Methods inherited from class java.lang.Object

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

Method Detail

getAttachment

public <V> V getAttachment(Logger.AttachmentKey<V> key)

Get the attachment value for a given key, or null if there is no such attachment. Log context attachments are placed on the root logger and can also be accessed there.

Type Parameters:

V - the attachment value type

Parameters:

key - the key

Returns:

the attachment, or null if there is none for this key

attach

public <V> V attach(Logger.AttachmentKey<V> key,
                    V value)
             throws SecurityException

Attach an object to this log context under a given key. A strong reference is maintained to the key and value for as long as this log context exists. Log context attachments are placed on the root logger and can also be accessed there.

Type Parameters:

V - the attachment value type

Parameters:

key - the attachment key

value - the attachment value

Returns:

the old attachment, if there was one

Throws:

SecurityException - if a security manager exists and if the caller does not have LoggingPermission(control)

attachIfAbsent

public <V> V attachIfAbsent(Logger.AttachmentKey<V> key,
                            V value)
                     throws SecurityException

Attach an object to this log context under a given key, if such an attachment does not already exist. A strong reference is maintained to the key and value for as long as this log context exists. Log context attachments are placed on the root logger and can also be accessed there.

Type Parameters:

V - the attachment value type

Parameters:

key - the attachment key

value - the attachment value

Returns:

the current attachment, if there is one, or null if the value was successfully attached

Throws:

SecurityException - if a security manager exists and if the caller does not have LoggingPermission(control)

detach

public <V> V detach(Logger.AttachmentKey<V> key)
             throws SecurityException

Remove an attachment. Log context attachments are placed on the root logger and can also be accessed there.

Type Parameters:

V - the attachment value type

Parameters:

key - the attachment key

Returns:

the old value, or null if there was none

Throws:

SecurityException - if a security manager exists and if the caller does not have LoggingPermission(control)

getLogContext

public static LogContext getLogContext()

getLogger

public Logger getLogger(String name)

Get a logger with the given name from this logging context.

Parameters:

name - the logger name

Returns:

the logger instance

See Also:

LogManager.getLogger(String)

getLoggerIfExists

public Logger getLoggerIfExists(String name)

Get a logger with the given name from this logging context, if a logger node exists at that location.

Parameters:

name - the logger name

Returns:

the logger instance, or null if no such logger node exists

getAttachment

public <V> V getAttachment(String loggerName,
                           Logger.AttachmentKey<V> key)

Get a logger attachment for a logger name, if it exists.

Type Parameters:

V - the attachment value type

Parameters:

loggerName - the logger name

key - the attachment key

Returns:

the attachment or null if the logger or the attachment does not exist

getLevelForName

public Level getLevelForName(String name)
                      throws IllegalArgumentException

Get the level for a name.

Parameters:

name - the name

Returns:

the level

Throws:

IllegalArgumentException - if the name is not known

getInstance

public static LogContext getInstance()

Get the system log context.

Returns:

the system log context

getLoggerNames

public Enumeration<String> getLoggerNames()

Returns an enumeration of the logger names that have been created. This does not return names of loggers that may have been garbage collected. Logger names added after the enumeration has been retrieved may also be added to the enumeration.

Returns:

an enumeration of the logger names

See Also:

LogManager.getLoggerNames()