LogContext (JBoss Application Server: Build 7.1.2.Final API)

java.lang.Object
- org.jboss.logmanager.LogContext

All Implemented Interfaces:

Protectable
```
public final class LogContext
extends Object
implements Protectable
```
A logging context, for producing isolated logging environments.

Field Summary

Fields
Modifier and Type Field and Description

static LogContextSelector DEFAULT_LOG_CONTEXT_SELECTOR
The default log context selector, which always returns the system log context.

Fields
Modifier and Type	Field and Description
`static LogContextSelector`	`DEFAULT_LOG_CONTEXT_SELECTOR` The default log context selector, which always returns the system log context.

Method Summary

Methods
Modifier and Type	Method and Description
`static LogContext`	`create()` Create a new log context.
`void`	`disableAccess()` Disable previous access to the object for modifications on the current thread.
`void`	`enableAccess(Object protectKey)` Enable access to the object for modifications on the current thread.
`<V> V`	`getAttachment(String loggerName, Logger.AttachmentKey<V> key)` Get a logger attachment for a logger name, if it exists.
`Level`	`getLevelForName(String name)` Get the level for a name.
`static LogContext`	`getLogContext()` Get the currently active log context.
`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.
`LoggingMXBean`	`getLoggingMXBean()` Get the `LoggingMXBean` associated with this log context.
`static LogContext`	`getSystemLogContext()` Get the system log context.
`void`	`protect(Object protectionKey)` Protect this object from modifications.
`void`	`registerLevel(Level level)` Register a level instance with this log context.
`static void`	`setLogContextSelector(LogContextSelector newSelector)` Set a new log context selector.
`void`	`unprotect(Object protectionKey)` Allows the object to be modified if the `protectionKey` matches the key used to `protect` the object.
`void`	`unregisterLevel(Level level)` Unregister a previously registered level.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOG_CONTEXT_SELECTOR
```
public static final LogContextSelector DEFAULT_LOG_CONTEXT_SELECTOR
```
    The default log context selector, which always returns the system log context.
- Method Detail
  - create
```
public static LogContext create()
```
    Create a new log context. If a security manager is installed, the caller must have the "createLogContext" RuntimePermission to invoke this method.
    
    Returns:
    a new log context
  - 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
  - getLoggingMXBean
```
public LoggingMXBean getLoggingMXBean()
```
    Get the LoggingMXBean associated with this log context.
    
    Returns:
    the LoggingMXBean instance
  - 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
  - registerLevel
```
public void registerLevel(Level level)
```
    Register a level instance with this log context. The level can then be looked up by name. Only a weak reference to the level instance will be kept. Any previous level registration for the given level's name will be overwritten.
    
    Parameters:
    level - the level to register
  - unregisterLevel
```
public void unregisterLevel(Level level)
```
    Unregister a previously registered level. Log levels that are not registered may still be used, they just will not be findable by name.
    
    Parameters:
    level - the level to unregister
  - getSystemLogContext
```
public static LogContext getSystemLogContext()
```
    Get the system log context.
    
    Returns:
    the system log context
  - getLogContext
```
public static LogContext getLogContext()
```
    Get the currently active log context.
    
    Returns:
    the currently active log context
  - setLogContextSelector
```
public static void setLogContextSelector(LogContextSelector newSelector)
```
    Set a new log context selector. If a security manager is installed, the caller must have the "setLogContextSelector" RuntimePermission to invoke this method.
    
    Parameters:
    newSelector - the new selector.
  - protect
```
public void protect(Object protectionKey)
             throws SecurityException
```
    Description copied from interface: Protectable
    
    Protect this object from modifications.
    
    Specified by:
    
    protect in interface Protectable
    
    Parameters:
    protectionKey - the key used to protect the object.
    
    Throws:
    
    SecurityException - if the object is already protected.
  - unprotect
```
public void unprotect(Object protectionKey)
               throws SecurityException
```
    Description copied from interface: Protectable
    
    Allows the object to be modified if the protectionKey matches the key used to protect the object.
    
    Specified by:
    
    unprotect in interface Protectable
    
    Parameters:
    protectionKey - the key used to protect the object.
    
    Throws:
    
    SecurityException - if the object is protected and the key doesn't match.
  - enableAccess
```
public void enableAccess(Object protectKey)
                  throws SecurityException
```
    Description copied from interface: Protectable
    
    Enable access to the object for modifications on the current thread.
    
    Specified by:
    
    enableAccess in interface Protectable
    
    Parameters:
    protectKey - the key used to protect modifications.
    
    Throws:
    
    SecurityException
  - disableAccess
```
public void disableAccess()
```
    Description copied from interface: Protectable
    
    Disable previous access to the object for modifications on the current thread.
    
    Specified by:
    
    disableAccess in interface Protectable

Class LogContext

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOG_CONTEXT_SELECTOR

Method Detail

create

getLogger

getLoggerIfExists

getAttachment

getLoggingMXBean

getLevelForName

registerLevel

unregisterLevel

getSystemLogContext

getLogContext

setLogContextSelector

protect

unprotect

enableAccess

disableAccess