Package org.jboss.logmanager
Class LogContext
- java.lang.Object
-
- org.jboss.logmanager.LogContext
-
- All Implemented Interfaces:
Protectable
public final class LogContext extends java.lang.Object implements Protectable
A logging context, for producing isolated logging environments.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
LogContext.LazyHolder
This lazy holder class is required to prevent a problem due to a LogContext instance being constructed before the class init is complete.private static interface
LogContext.LevelRef
private static class
LogContext.StrongLevelRef
private static class
LogContext.WeakLevelRef
-
Field Summary
Fields Modifier and Type Field Description (package private) static java.security.Permission
CONTROL_PERMISSION
(package private) static java.security.Permission
CREATE_CONTEXT_PERMISSION
static LogContextSelector
DEFAULT_LOG_CONTEXT_SELECTOR
The default log context selector, which always returns the system log context.private java.lang.ThreadLocal<java.lang.Boolean>
granted
private java.util.concurrent.atomic.AtomicReference<java.util.Map<java.lang.String,LogContext.LevelRef>>
levelMapReference
private static LogContextSelector
logContextSelector
private java.util.concurrent.ConcurrentSkipListMap<java.lang.String,java.util.concurrent.atomic.AtomicInteger>
loggerNames
private java.util.logging.LoggingMXBean
mxBean
private java.lang.Object
protectKey
private static java.util.concurrent.atomic.AtomicReferenceFieldUpdater<LogContext,java.lang.Object>
protectKeyUpdater
private LoggerNode
rootLogger
(package private) static java.security.Permission
SET_CONTEXT_SELECTOR_PERMISSION
private boolean
strong
private static LogContext
SYSTEM_CONTEXT
(package private) java.lang.Object
treeLock
This lock is taken any time a change is made which affects multiple nodes in the hierarchy.
-
Constructor Summary
Constructors Constructor Description LogContext(boolean strong)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static java.lang.SecurityException
accessDenied()
(package private) static void
checkAccess(LogContext logContext)
(package private) static void
checkSecurityAccess()
static LogContext
create()
Create a new log context.static LogContext
create(boolean strong)
Create a new log context.(package private) java.util.concurrent.ConcurrentMap<java.lang.String,LoggerNode>
createChildMap()
protected void
decrementRef(java.lang.String name)
void
disableAccess()
Disable previous access to the object for modifications on the current thread.void
enableAccess(java.lang.Object protectKey)
Enable access to the object for modifications on the current thread.<V> V
getAttachment(java.lang.String loggerName, Logger.AttachmentKey<V> key)
Get a logger attachment for a logger name, if it exists.java.util.logging.Level
getLevelForName(java.lang.String name)
Get the level for a name.static LogContext
getLogContext()
Get the currently active log context.Logger
getLogger(java.lang.String name)
Get a logger with the given name from this logging context.Logger
getLoggerIfExists(java.lang.String name)
Get a logger with the given name from this logging context, if a logger node exists at that location.java.util.Enumeration<java.lang.String>
getLoggerNames()
Returns an enumeration of the logger names that have been created.java.util.logging.LoggingMXBean
getLoggingMXBean()
Get theLoggingMXBean
associated with this log context.(package private) LoggerNode
getRootLoggerNode()
static LogContext
getSystemLogContext()
Get the system log context.protected void
incrementRef(java.lang.String name)
void
protect(java.lang.Object protectionKey)
Protect this object from modifications.void
registerLevel(java.util.logging.Level level)
Register a level instance with this log context.static void
setLogContextSelector(LogContextSelector newSelector)
Set a new log context selector.void
unprotect(java.lang.Object protectionKey)
Allows the object to be modified if theprotectionKey
matches the key used toprotect
the object.void
unregisterLevel(java.util.logging.Level level)
Unregister a previously registered level.
-
-
-
Field Detail
-
SYSTEM_CONTEXT
private static final LogContext SYSTEM_CONTEXT
-
CREATE_CONTEXT_PERMISSION
static final java.security.Permission CREATE_CONTEXT_PERMISSION
-
SET_CONTEXT_SELECTOR_PERMISSION
static final java.security.Permission SET_CONTEXT_SELECTOR_PERMISSION
-
CONTROL_PERMISSION
static final java.security.Permission CONTROL_PERMISSION
-
rootLogger
private final LoggerNode rootLogger
-
mxBean
private final java.util.logging.LoggingMXBean mxBean
-
strong
private final boolean strong
-
loggerNames
private final java.util.concurrent.ConcurrentSkipListMap<java.lang.String,java.util.concurrent.atomic.AtomicInteger> loggerNames
-
protectKey
private volatile java.lang.Object protectKey
-
granted
private final java.lang.ThreadLocal<java.lang.Boolean> granted
-
protectKeyUpdater
private static final java.util.concurrent.atomic.AtomicReferenceFieldUpdater<LogContext,java.lang.Object> protectKeyUpdater
-
levelMapReference
private final java.util.concurrent.atomic.AtomicReference<java.util.Map<java.lang.String,LogContext.LevelRef>> levelMapReference
-
treeLock
final java.lang.Object treeLock
This lock is taken any time a change is made which affects multiple nodes in the hierarchy.
-
DEFAULT_LOG_CONTEXT_SELECTOR
public static final LogContextSelector DEFAULT_LOG_CONTEXT_SELECTOR
The default log context selector, which always returns the system log context.
-
logContextSelector
private static volatile LogContextSelector logContextSelector
-
-
Method Detail
-
create
public static LogContext create(boolean strong)
Create a new log context. If a security manager is installed, the caller must have the"createLogContext"
RuntimePermission
to invoke this method.- Parameters:
strong
-true
if the context should use strong references,false
to use (default) weak references for automatic logger GC- Returns:
- a new log context
-
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(java.lang.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(java.lang.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(java.lang.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 namekey
- the attachment key- Returns:
- the attachment or
null
if the logger or the attachment does not exist
-
getLoggingMXBean
public java.util.logging.LoggingMXBean getLoggingMXBean()
Get theLoggingMXBean
associated with this log context.- Returns:
- the
LoggingMXBean
instance
-
getLevelForName
public java.util.logging.Level getLevelForName(java.lang.String name) throws java.lang.IllegalArgumentException
Get the level for a name.- Parameters:
name
- the name- Returns:
- the level
- Throws:
java.lang.IllegalArgumentException
- if the name is not known
-
registerLevel
public void registerLevel(java.util.logging.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(java.util.logging.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(java.lang.Object protectionKey) throws java.lang.SecurityException
Description copied from interface:Protectable
Protect this object from modifications.- Specified by:
protect
in interfaceProtectable
- Parameters:
protectionKey
- the key used to protect the object.- Throws:
java.lang.SecurityException
- if the object is already protected.
-
unprotect
public void unprotect(java.lang.Object protectionKey) throws java.lang.SecurityException
Description copied from interface:Protectable
Allows the object to be modified if theprotectionKey
matches the key used toprotect
the object.- Specified by:
unprotect
in interfaceProtectable
- Parameters:
protectionKey
- the key used to protect the object.- Throws:
java.lang.SecurityException
- if the object is protected and the key doesn't match.
-
enableAccess
public void enableAccess(java.lang.Object protectKey) throws java.lang.SecurityException
Description copied from interface:Protectable
Enable access to the object for modifications on the current thread.- Specified by:
enableAccess
in interfaceProtectable
- Parameters:
protectKey
- the key used toprotect
modifications.- Throws:
java.lang.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 interfaceProtectable
-
getLoggerNames
public java.util.Enumeration<java.lang.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()
-
incrementRef
protected void incrementRef(java.lang.String name)
-
decrementRef
protected void decrementRef(java.lang.String name)
-
accessDenied
private static java.lang.SecurityException accessDenied()
-
checkSecurityAccess
static void checkSecurityAccess()
-
checkAccess
static void checkAccess(LogContext logContext)
-
getRootLoggerNode
LoggerNode getRootLoggerNode()
-
createChildMap
java.util.concurrent.ConcurrentMap<java.lang.String,LoggerNode> createChildMap()
-
-