Package org.jboss.logmanager
Class Logger
- java.lang.Object
-
- java.util.logging.Logger
-
- org.jboss.logmanager.Logger
-
- All Implemented Interfaces:
Serializable
public final class Logger extends Logger implements Serializable
An actual logger instance. This is the end-user interface into the logging system.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Logger.AttachmentKey<V>
An attachment key instance.
-
Field Summary
-
Fields inherited from class java.util.logging.Logger
global, GLOBAL_LOGGER_NAME
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addHandler(Handler handler)
<V> V
attach(Logger.AttachmentKey<V> key, V value)
Attach an object to this logger under a given key.<V> V
attachIfAbsent(Logger.AttachmentKey<V> key, V value)
Attach an object to this logger under a given key, if such an attachment does not already exist.Handler[]
clearHandlers()
A convenience method to atomically get and clear all handlers.boolean
compareAndSetHandlers(Handler[] expected, Handler[] newHandlers)
Atomically compare and set the handler list for this logger.void
config(String msg)
<V> V
detach(Logger.AttachmentKey<V> key)
Remove an attachment.void
entering(String sourceClass, String sourceMethod)
void
entering(String sourceClass, String sourceMethod, Object param1)
void
entering(String sourceClass, String sourceMethod, Object[] params)
void
exiting(String sourceClass, String sourceMethod)
void
exiting(String sourceClass, String sourceMethod, Object result)
protected void
finalize()
void
fine(String msg)
void
finer(String msg)
void
finest(String msg)
Handler[]
getAndSetHandlers(Handler[] handlers)
Atomically get and set the handler list for this logger.<V> V
getAttachment(Logger.AttachmentKey<V> key)
Get the attachment value for a given key, ornull
if there is no such attachment.int
getEffectiveLevel()
Get the effective numerical log level, inherited from the parent.Filter
getFilter()
Handler[]
getHandlers()
Level
getLevel()
LogContext
getLogContext()
Get the log context to which this logger belongs.static Logger
getLogger(String name)
Static logger factory method which returns a JBoss LogManager logger.static Logger
getLogger(String name, String bundleName)
Static logger factory method which returns a JBoss LogManager logger.Logger
getParent()
boolean
getUseParentFilters()
Indicates whether or not this logger inherits filters from it's parent logger.boolean
getUseParentHandlers()
void
info(String msg)
boolean
isLoggable(Level level)
void
log(String fqcn, Level level, String message, String bundleName, ExtLogRecord.FormatStyle style, Object[] params, Throwable t)
SPI interface method to log a message at a given level, with a specific resource bundle.void
log(String fqcn, Level level, String message, Throwable t)
SPI interface method to log a message at a given level.void
log(String fqcn, Level level, String message, ExtLogRecord.FormatStyle style, Object[] params, Throwable t)
SPI interface method to log a message at a given level.void
log(Level level, String msg)
void
log(Level level, String msg, Object param1)
void
log(Level level, String msg, Object[] params)
void
log(Level level, String msg, Throwable thrown)
void
log(LogRecord record)
void
logp(Level level, String sourceClass, String sourceMethod, String msg)
void
logp(Level level, String sourceClass, String sourceMethod, String msg, Object param1)
void
logp(Level level, String sourceClass, String sourceMethod, String msg, Object[] params)
void
logp(Level level, String sourceClass, String sourceMethod, String msg, Throwable thrown)
void
logRaw(LogRecord record)
Do the logging with no level checks (they've already been done).void
logRaw(ExtLogRecord record)
Do the logging with no level checks (they've already been done).void
logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg)
void
logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Object param1)
void
logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Object[] params)
void
logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Throwable thrown)
void
removeHandler(Handler handler)
void
setFilter(Filter filter)
void
setHandlers(Handler[] handlers)
A convenience method to atomically replace the handler list for this logger.void
setLevel(Level newLevel)
This implementation grabs a lock, so that only one thread may update the log level of any logger at a time, in order to allow readers to never block (though there is a window where retrieving the log level reflects an older effective level than the actual level).void
setLevelName(String newLevelName)
Set the log level by name.void
setParent(Logger parent)
Not allowed. This method may never be called.void
setUseParentFilters(boolean useParentFilter)
Specify whether or not filters should be inherited from parent loggers.void
setUseParentHandlers(boolean useParentHandlers)
void
severe(String msg)
void
throwing(String sourceClass, String sourceMethod, Throwable thrown)
String
toString()
void
warning(String msg)
protected Object
writeReplace()
-
Methods inherited from class java.util.logging.Logger
config, fine, finer, finest, getAnonymousLogger, getAnonymousLogger, getGlobal, getName, getResourceBundle, getResourceBundleName, info, log, log, logp, logp, logrb, logrb, logrb, logrb, setResourceBundle, severe, warning
-
-
-
-
Method Detail
-
getLogger
public static Logger getLogger(String name)
Static logger factory method which returns a JBoss LogManager logger.- Parameters:
name
- the logger name- Returns:
- the logger
-
getLogger
public static Logger getLogger(String name, String bundleName)
Static logger factory method which returns a JBoss LogManager logger.- Parameters:
name
- the logger namebundleName
- the bundle name- Returns:
- the logger
-
writeReplace
protected final Object writeReplace() throws ObjectStreamException
- Throws:
ObjectStreamException
-
setFilter
public void setFilter(Filter filter) throws SecurityException
- Overrides:
setFilter
in classLogger
- Throws:
SecurityException
-
setLevel
public void setLevel(Level newLevel) throws SecurityException
This implementation grabs a lock, so that only one thread may update the log level of any logger at a time, in order to allow readers to never block (though there is a window where retrieving the log level reflects an older effective level than the actual level).- Overrides:
setLevel
in classLogger
- Throws:
SecurityException
-
setLevelName
public void setLevelName(String newLevelName) throws SecurityException
Set the log level by name. Uses the parent logging context's name registry; otherwise behaves identically tosetLevel(Level)
.- Parameters:
newLevelName
- the name of the level to set- Throws:
SecurityException
- if a security manager exists and if the caller does not have LoggingPermission("control")
-
getEffectiveLevel
public int getEffectiveLevel()
Get the effective numerical log level, inherited from the parent.- Returns:
- the effective level
-
isLoggable
public boolean isLoggable(Level level)
- Overrides:
isLoggable
in classLogger
-
getAttachment
public <V> V getAttachment(Logger.AttachmentKey<V> key)
Get the attachment value for a given key, ornull
if there is no such attachment.- 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 logger under a given key. A strong reference is maintained to the key and value for as long as this logger exists.- Type Parameters:
V
- the attachment value type- Parameters:
key
- the attachment keyvalue
- the attachment value- Returns:
- the old attachment, if there was one
- Throws:
SecurityException
- if a security manager exists and if the caller does not haveLoggingPermission(control)
-
attachIfAbsent
public <V> V attachIfAbsent(Logger.AttachmentKey<V> key, V value) throws SecurityException
Attach an object to this logger 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 logger exists.- Type Parameters:
V
- the attachment value type- Parameters:
key
- the attachment keyvalue
- 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 haveLoggingPermission(control)
-
detach
public <V> V detach(Logger.AttachmentKey<V> key) throws SecurityException
Remove an attachment.- 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 haveLoggingPermission(control)
-
addHandler
public void addHandler(Handler handler) throws SecurityException
- Overrides:
addHandler
in classLogger
- Throws:
SecurityException
-
removeHandler
public void removeHandler(Handler handler) throws SecurityException
- Overrides:
removeHandler
in classLogger
- Throws:
SecurityException
-
getHandlers
public Handler[] getHandlers()
- Overrides:
getHandlers
in classLogger
-
setHandlers
public void setHandlers(Handler[] handlers) throws SecurityException
A convenience method to atomically replace the handler list for this logger.- Parameters:
handlers
- the new handlers- Throws:
SecurityException
- if a security manager exists and if the caller does not haveLoggingPermission(control)
-
getAndSetHandlers
public Handler[] getAndSetHandlers(Handler[] handlers) throws SecurityException
Atomically get and set the handler list for this logger.- Parameters:
handlers
- the new handler set- Returns:
- the old handler set
- Throws:
SecurityException
- if a security manager exists and if the caller does not haveLoggingPermission(control)
-
compareAndSetHandlers
public boolean compareAndSetHandlers(Handler[] expected, Handler[] newHandlers) throws SecurityException
Atomically compare and set the handler list for this logger.- Parameters:
expected
- the expected list of handlersnewHandlers
- the replacement list of handlers- Returns:
true
if the handler list was updated orfalse
if the current handlers did not match the expected handlers list- Throws:
SecurityException
- if a security manager exists and if the caller does not haveLoggingPermission(control)
-
clearHandlers
public Handler[] clearHandlers() throws SecurityException
A convenience method to atomically get and clear all handlers.- Throws:
SecurityException
- if a security manager exists and if the caller does not haveLoggingPermission(control)
-
setUseParentHandlers
public void setUseParentHandlers(boolean useParentHandlers)
- Overrides:
setUseParentHandlers
in classLogger
-
getUseParentHandlers
public boolean getUseParentHandlers()
- Overrides:
getUseParentHandlers
in classLogger
-
setUseParentFilters
public void setUseParentFilters(boolean useParentFilter)
Specify whether or not filters should be inherited from parent loggers.Setting this value to
false
has the same behaviour as Logger.- Parameters:
useParentFilter
-true
to inherit a parents filter, otherwisefalse
-
getUseParentFilters
public boolean getUseParentFilters()
Indicates whether or not this logger inherits filters from it's parent logger.- Returns:
true
if filters are inherited, otherwisefalse
-
setParent
public void setParent(Logger parent)
Not allowed. This method may never be called.- Overrides:
setParent
in classLogger
- Throws:
SecurityException
- always
-
getLogContext
public LogContext getLogContext()
Get the log context to which this logger belongs.- Returns:
- the log context
-
logp
public void logp(Level level, String sourceClass, String sourceMethod, String msg, Object param1)
-
logp
public void logp(Level level, String sourceClass, String sourceMethod, String msg, Object[] params)
-
logp
public void logp(Level level, String sourceClass, String sourceMethod, String msg, Throwable thrown)
-
logrb
public void logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg)
-
logrb
public void logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Object param1)
-
logrb
public void logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Object[] params)
-
logrb
public void logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msg, Throwable thrown)
-
log
public void log(String fqcn, Level level, String message, String bundleName, ExtLogRecord.FormatStyle style, Object[] params, Throwable t)
SPI interface method to log a message at a given level, with a specific resource bundle.- Parameters:
fqcn
- the fully qualified class name of the first logger classlevel
- the level to log atmessage
- the messagebundleName
- the resource bundle namestyle
- the message format styleparams
- the log parameterst
- the throwable, if any
-
log
public void log(String fqcn, Level level, String message, ExtLogRecord.FormatStyle style, Object[] params, Throwable t)
SPI interface method to log a message at a given level.- Parameters:
fqcn
- the fully qualified class name of the first logger classlevel
- the level to log atmessage
- the messagestyle
- the message format styleparams
- the log parameterst
- the throwable, if any
-
log
public void log(String fqcn, Level level, String message, Throwable t)
SPI interface method to log a message at a given level.- Parameters:
fqcn
- the fully qualified class name of the first logger classlevel
- the level to log atmessage
- the messaget
- the throwable, if any
-
logRaw
public void logRaw(ExtLogRecord record)
Do the logging with no level checks (they've already been done).- Parameters:
record
- the extended log record
-
logRaw
public void logRaw(LogRecord record)
Do the logging with no level checks (they've already been done). Creates an extended log record if the provided record is not one.- Parameters:
record
- the log record
-
-