Interface Logger
- All Superinterfaces:
org.slf4j.Logger
- All Known Implementing Classes:
JSR47Logger_impl
,Log4jLogger_impl
,Logger_common_impl
,Logger_impl
,Slf4jLogger_impl
Logger
is a component used to log messages. This interface defines the standard
way for UIMA components to produce log output.
In the UIMA SDK, this interface is implemented using the Java logger as a back end.
The back end may be changed to Apache Log4j 2 by specifying
-Dorg.apache.uima.logger.class=org.apache.uima.util.impl.Log4jLogger_impl
and
including the log4j 2 JARs in the classpath.
If you want to configure the logger, for example to specify the location of the log file and the logging level, you use whatever back end logger implementation specifies, or use that logger's APIs. should use the standard Java logger properties or the java.util.logging APIs. See the section "Specifying the Logging Configuration" in the Annotator and Analysis Engine Developer's Guide chapter of the UIMA documentation for more information.
Version 3 augments this API with methods to do UIMA-Resource-bundle-based internationalization, separate from logging, so the String result can be used with various back end loggers.
Version 3 augments isLoggable to include the Marker.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.slf4j.Marker
static final org.slf4j.Marker
Fields inherited from interface org.slf4j.Logger
ROOT_LOGGER_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
void
void
void
void
void
void
void
void
void
void
void
default Logger
getLimitedLogger
(int limit) void
void
void
void
void
boolean
This is true if the name of the logger corresponds to a class which implements AnalysisComponent_ImplBase, which includes basic Annotators, plus Cas Multipliers and CPP components.boolean
isLoggable
(Level level) Checks if the argument level is greater or equal to the specified levelboolean
isLoggable
(Level level, org.slf4j.Marker marker) Checks if this logger is enabled for this level and this markervoid
Deprecated.use new function with log levelvoid
Deprecated.use new function with log levelvoid
Generic logging method intended for logging wrappers.void
Logs a message.void
Logs a message with one parametervoid
Logs a message with an arbitrary number of parametersvoid
Logs a message and a throwable objectvoid
logException
(Exception aException) Deprecated.use new function with log levelvoid
Logs a message with a message key.void
logrb
(Level level, String sourceClass, String sourceMethod, String bundleName, String msgKey, Object param1) Logs a message with a message key and one parameter.void
logrb
(Level level, String sourceClass, String sourceMethod, String bundleName, String msgKey, Object[] params) Logs a message with a message key and an arbitrary number of parameters.void
logrb
(Level level, String sourceClass, String sourceMethod, String bundleName, String msgKey, Throwable thrown) Logs a message with a message key and a throwable object.Get an internationalized message from a resource bundle by key name, substituting the parameters.default String
void
Sets the level of messages that will be logged by this logger.void
setOutputStream
(OutputStream aStream) Deprecated.use external configuration possibilityvoid
setOutputStream
(PrintStream aStream) Deprecated.use external configuration possibilityvoid
setResourceManager
(ResourceManager resourceManager) Deprecated.When a logger is used within UIMA, the resource manager is picked up from theUimaContextHolder
and if none is available, then the class loader set on theThread.getContextClassLoader()
is used.void
void
void
void
void
void
void
void
void
void
void
void
Methods inherited from interface org.slf4j.Logger
debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, error, error, error, error, error, error, error, error, error, error, getName, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isErrorEnabled, isErrorEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn
-
Field Details
-
UIMA_MARKER_CONFIG
static final org.slf4j.Marker UIMA_MARKER_CONFIG -
UIMA_MARKER_FINEST
static final org.slf4j.Marker UIMA_MARKER_FINEST
-
-
Method Details
-
log
Deprecated.use new function with log levelLogs a message.- Parameters:
aMessage
- the message to be logged with message level INFO- To be removed in version:
- 4.0.0
-
log
@Deprecated(since="2.3.1") void log(String aResourceBundleName, String aMessageKey, Object[] aArguments) Deprecated.use new function with log levelLogs an internationalized message.- Parameters:
aResourceBundleName
- base name of resource bundleaMessageKey
- key of message to localize with message level INFOaArguments
- arguments to message (may be null if none)- To be removed in version:
- 4.0.0
-
logException
Deprecated.use new function with log levelLogs an exception- Parameters:
aException
- the exception to be logged with message level INFO- To be removed in version:
- 4.0.0
-
setOutputStream
Deprecated.use external configuration possibilitySets the output stream to which log messages will go. Setting the output stream tonull
will disable the logger.- Parameters:
aStream
-PrintStream
to which log messages will be printed- To be removed in version:
- 4.0.0
-
setOutputStream
Deprecated.use external configuration possibilitySets the output stream to which log messages will go. Setting the output stream tonull
will disable the logger.- Parameters:
aStream
-OutputStream
to which log messages will be printed- To be removed in version:
- 4.0.0
-
log
Logs a message.- Parameters:
level
- message levelaMessage
- the message to be logged
-
log
Logs a message with one parameter- Parameters:
level
- message levelaMessage
- the message to be loggedparam1
- message parameter
-
log
Logs a message with an arbitrary number of parameters- Parameters:
level
- message levelaMessage
- the message to be loggedparams
- message parameter array
-
log
Logs a message and a throwable object- Parameters:
level
- message levelaMessage
- the message to be loggedthrown
- throwable object
-
logrb
Logs a message with a message key. The real message is extracted from a resource bundle.- Parameters:
level
- message levelsourceClass
- source class namesourceMethod
- source method namebundleName
- resource bundlemsgKey
- message key
-
logrb
void logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msgKey, Object param1) Logs a message with a message key and one parameter. The real message is extracted from a resource bundle.- Parameters:
level
- message levelsourceClass
- source class namesourceMethod
- source method namebundleName
- resource bundlemsgKey
- message keyparam1
- message parameter
-
logrb
void logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msgKey, Object[] params) Logs a message with a message key and an arbitrary number of parameters. The real message is extracted from a resource bundle.- Parameters:
level
- message levelsourceClass
- source class namesourceMethod
- source method namebundleName
- resource bundlemsgKey
- message keyparams
- message parameter array with an arbitrary number of parameters
-
logrb
void logrb(Level level, String sourceClass, String sourceMethod, String bundleName, String msgKey, Throwable thrown) Logs a message with a message key and a throwable object. The real message is extracted from a resource bundle.- Parameters:
level
- message levelsourceClass
- source class namesourceMethod
- source method namebundleName
- resource bundlemsgKey
- message keythrown
- throwable object
-
log
Generic logging method intended for logging wrappers.- Parameters:
wrapperFQCN
- fully qualified class name of the wrapperlevel
- message levelmessage
- messagethrown
- throwable object
-
isLoggable
Checks if the argument level is greater or equal to the specified level- Parameters:
level
- message level- Returns:
- boolean - true if the argument level is greater or equal to the specified level
-
isLoggable
Checks if this logger is enabled for this level and this marker- Parameters:
level
- the level to testmarker
- null or the marker to test- Returns:
- true if the level is greater or equal to the specified level and the marker matches
-
setLevel
Sets the level of messages that will be logged by this logger. Note that if you callUIMAFramework.getLogger().setLevel(level)
, this will only change the logging level for messages produced by the UIMA framework. It will NOT change the logging level for messages produced by annotators. To change the logging level for an annotator, useUIMAFramework.getLogger(YourAnnotatorClass.class).setLevel(level)
.If you need more flexibility it configuring the logger, consider using the standard Java logger properties file or the java.util.logging APIs.
- Parameters:
level
- message level
-
setResourceManager
Deprecated.When a logger is used within UIMA, the resource manager is picked up from theUimaContextHolder
and if none is available, then the class loader set on theThread.getContextClassLoader()
is used. Thus, setting a resource manager for loading message localizations should not be required. Setting a resource manager anyway can lead to resource being registered in the resource manager to not be garbage collected in a timely manner. Also, the logger is shared globally and in a multi-threaded/multi-classloader scenario, it is likely that different threads overwrite each others logger resource manager making it likely that in any given thread the wrong resource manager is used by the logger.Sets the ResourceManager to use for message localization. This method is intended for use by the framework, not by user code.- Parameters:
resourceManager
- A resource manager instance whose extension ClassLoader (if any) will be used for message localization by this logger.- To be removed in version:
- 4.0.0
-
rb
Get an internationalized message from a resource bundle by key name, substituting the parameters. This should be called via a Supplier to avoid computing this until needed- Parameters:
resourceBundle
- -key
- -params
- -- Returns:
- the internationalized message
-
rb_ue
-
isAnnotatorLogger
boolean isAnnotatorLogger()This is true if the name of the logger corresponds to a class which implements AnalysisComponent_ImplBase, which includes basic Annotators, plus Cas Multipliers and CPP components.- Returns:
- true if this logger is an Annotator logger.
-
getLimitedLogger
- Parameters:
limit
- the limit- Returns:
- a copy of the logger with the throttling limit set, or the same logger if no change
-
debug
- Parameters:
msgSupplier
- A function, which when called, produces the desired log message
-
debug
- Parameters:
msgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
debug
- Parameters:
marker
- the marker data specific to this log statementmessage
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
debug
- Parameters:
message
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
debug
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log message
-
debug
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
error
- Parameters:
msgSupplier
- A function, which when called, produces the desired log message
-
error
- Parameters:
msgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
error
- Parameters:
marker
- the marker data specific to this log statementmessage
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
error
- Parameters:
message
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
error
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log message
-
error
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
info
- Parameters:
msgSupplier
- A function, which when called, produces the desired log message
-
info
- Parameters:
msgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
info
- Parameters:
marker
- the marker data specific to this log statementmessage
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
info
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log message
-
info
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
trace
- Parameters:
msgSupplier
- A function, which when called, produces the desired log message
-
trace
- Parameters:
msgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
trace
- Parameters:
marker
- the marker data specific to this log statementmessage
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
trace
- Parameters:
message
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
trace
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log message
-
trace
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
warn
- Parameters:
msgSupplier
- A function, which when called, produces the desired log message
-
warn
- Parameters:
msgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-
warn
- Parameters:
marker
- the marker data specific to this log statementmessage
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
warn
- Parameters:
message
- the message to logparamSuppliers
- An array of functions, which when called, produce the desired log message parameters.
-
warn
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log message
-
warn
- Parameters:
marker
- the marker data specific to this log statementmsgSupplier
- A function, which when called, produces the desired log messagethrowable
- the exception to log
-