@Deprecated public interface LogWriterI18n
Instances of this interface can be obtained by calling DistributedSystem.getLogWriter()
.
For any logged message the log file will contain:
A message always has a level. Logging levels are ordered. Enabling logging at a given level also enables logging at higher levels. The higher the level the more important and urgent the message.
The levels, in descending order, are:
severe
(highest value) is a message level indicating a serious failure. In
general severe
messages should describe events that are of considerable importance
and which will prevent normal program execution. They should be reasonably intelligible to end
users and to information managers.
error
In general error
messages should describe events that are of
considerable importance but will not prevent normal program execution. They should be reasonably
intelligible to end users and to information managers. They are weaker than severe
and stronger than warning
.
warning
is a message level indicating a potential problem. In general
warning
messages should describe events that will be of interest to end users or
information managers, or which indicate potential problems.
info
is a message level for informational messages. Typically info
messages should be reasonably significant and should make sense to end users and system
administrators.
config
is a message level for static configuration messages. config
messages are intended to provide a variety of static configuration information, to assist in
debugging problems that may be associated with particular configurations.
fine
is a message level providing tracing information. In general the
fine
level should be used for information that will be broadly interesting to
developers. This level is for the lowest volume, and most important, tracing messages.
finer
indicates a fairly detailed tracing message. Logging calls for entering,
returning, or throwing an exception are traced at the finer
level.
finest
(lowest value) indicates a highly detailed tracing message. In general
the finest
level should be used for the most voluminous detailed tracing messages.
For each level methods exist that will request a message, at that level, to be logged. These methods are all named after their level.
For each level a method exists that returns a boolean indicating if messages at that level will
currently be logged. The names of these methods are of the form:
levelEnabled
.
Modifier and Type | Method and Description |
---|---|
void |
config(StringId messageId)
Deprecated.
Writes a message to this writer.
|
void |
config(StringId messageId,
Object parameter)
Deprecated.
Writes a message to this writer.
|
void |
config(StringId messageId,
Object[] parameters)
Deprecated.
Writes a message to this writer.
|
void |
config(StringId messageId,
Object[] parameters,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
config(StringId messageId,
Object parameter,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
config(StringId messageId,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
config(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
configEnabled()
Deprecated.
|
LogWriter |
convertToLogWriter()
Deprecated.
A mechanism for accessing the abstraction layer used for a plain logger.
|
void |
entering(String sourceClass,
String sourceMethod)
Deprecated.
Log a method entry.
|
void |
error(StringId messageId)
Deprecated.
Writes a message to this writer.
|
void |
error(StringId messageId,
Object parameter)
Deprecated.
Writes a message to this writer.
|
void |
error(StringId messageId,
Object[] parameters)
Deprecated.
Writes a message to this writer.
|
void |
error(StringId messageId,
Object[] parameters,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
error(StringId messageId,
Object parameter,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
error(StringId messageId,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
error(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
errorEnabled()
Deprecated.
|
void |
exiting(String sourceClass,
String sourceMethod)
Deprecated.
Log a method return.
|
void |
fine(String msg)
Deprecated.
Writes a message to this writer.
|
void |
fine(String msg,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
fine(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
fineEnabled()
Deprecated.
|
void |
finer(String msg)
Deprecated.
Writes a message to this writer.
|
void |
finer(String msg,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
finer(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
finerEnabled()
Deprecated.
|
void |
finest(String msg)
Deprecated.
Writes a message to this writer.
|
void |
finest(String msg,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
finest(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
finestEnabled()
Deprecated.
|
Handler |
getHandler()
Deprecated.
Returns a 1.4 logging handler that can be used to direct application output to this GemFire
logger using the standard JDK logger APIs.
|
void |
info(StringId messageId)
Deprecated.
Writes a message to this writer.
|
void |
info(StringId messageId,
Object parameter)
Deprecated.
Writes a message to this writer.
|
void |
info(StringId messageId,
Object[] parameters)
Deprecated.
Writes a message to this writer.
|
void |
info(StringId messageId,
Object[] parameters,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
info(StringId messageId,
Object parameter,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
info(StringId messageId,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
info(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
infoEnabled()
Deprecated.
|
void |
severe(StringId messageId)
Deprecated.
Writes a message to this writer.
|
void |
severe(StringId messageId,
Object parameter)
Deprecated.
Writes a message to this writer.
|
void |
severe(StringId messageId,
Object[] parameters)
Deprecated.
Writes a message to this writer.
|
void |
severe(StringId messageId,
Object[] parameters,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
severe(StringId messageId,
Object parameter,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
severe(StringId messageId,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
severe(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
severeEnabled()
Deprecated.
|
void |
throwing(String sourceClass,
String sourceMethod,
Throwable thrown)
Deprecated.
Log throwing an exception.
|
void |
warning(StringId messageId)
Deprecated.
Writes a message to this writer.
|
void |
warning(StringId messageId,
Object parameter)
Deprecated.
Writes a message to this writer.
|
void |
warning(StringId messageId,
Object[] parameters)
Deprecated.
Writes a message to this writer.
|
void |
warning(StringId messageId,
Object[] parameters,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
warning(StringId messageId,
Object parameter,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
warning(StringId messageId,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
warning(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
warningEnabled()
Deprecated.
|
boolean severeEnabled()
void severe(Throwable throwable)
throwable
- the throwable to writevoid severe(StringId messageId, Object[] parameters, Throwable throwable)
messageId
- the message to writeparameters
- the parameters for the messagethrowable
- the throwable to writevoid severe(StringId messageId, Object parameter, Throwable throwable)
messageId
- the message to writeparameter
- the parameter for the messagethrowable
- the throwable to writevoid severe(StringId messageId, Throwable throwable)
messageId
- the message to writethrowable
- the throwable to writevoid severe(StringId messageId, Object[] parameters)
messageId
- the message to writeparameters
- the parameters for the messagevoid severe(StringId messageId, Object parameter)
messageId
- the message to writeparameter
- the parameter for the messagevoid severe(StringId messageId)
messageId
- the message to writeboolean errorEnabled()
void error(Throwable throwable)
throwable
- the throwable to writevoid error(StringId messageId, Object[] parameters, Throwable throwable)
messageId
- the message to writeparameters
- the parameters for the messagethrowable
- the throwable to writevoid error(StringId messageId, Object parameter, Throwable throwable)
messageId
- the message to writeparameter
- the parameter for the messagethrowable
- the throwable to writevoid error(StringId messageId, Throwable throwable)
messageId
- the message to writethrowable
- the throwable to writevoid error(StringId messageId, Object[] parameters)
messageId
- the message to writeparameters
- the parameters for the messagevoid error(StringId messageId, Object parameter)
messageId
- the message to writeparameter
- the parameter for the messagevoid error(StringId messageId)
messageId
- the message to writeboolean warningEnabled()
void warning(Throwable throwable)
throwable
- the throwable to writevoid warning(StringId messageId, Object[] parameters, Throwable throwable)
messageId
- the message to writeparameters
- the parameters for the messagethrowable
- the throwable to writevoid warning(StringId messageId, Object parameter, Throwable throwable)
messageId
- the message to writeparameter
- the parameter for the messagethrowable
- the throwable to writevoid warning(StringId messageId, Throwable throwable)
messageId
- the message to writethrowable
- the throwable to writevoid warning(StringId messageId, Object[] parameters)
messageId
- the message to writeparameters
- the parameters for the messagevoid warning(StringId messageId, Object parameter)
messageId
- the message to writeparameter
- the parameter for the messagevoid warning(StringId messageId)
messageId
- the message to writeboolean infoEnabled()
void info(Throwable throwable)
throwable
- the throwable to writevoid info(StringId messageId, Object[] parameters, Throwable throwable)
messageId
- the message to writeparameters
- the parameters for the messagethrowable
- the throwable to writevoid info(StringId messageId, Object parameter, Throwable throwable)
messageId
- the message to writeparameter
- the parameter for the messagethrowable
- the throwable to writevoid info(StringId messageId, Throwable throwable)
messageId
- the message to writethrowable
- the throwable to writevoid info(StringId messageId, Object[] parameters)
messageId
- the message to writeparameters
- the parameters for the messagevoid info(StringId messageId, Object parameter)
messageId
- the message to writeparameter
- the parameter for the messagevoid info(StringId messageId)
messageId
- the message to writeboolean configEnabled()
void config(Throwable throwable)
throwable
- the throwable to writevoid config(StringId messageId, Object[] parameters, Throwable throwable)
messageId
- the message to writeparameters
- the parameters for the messagethrowable
- the throwable to writevoid config(StringId messageId, Object parameter, Throwable throwable)
messageId
- the message to writeparameter
- the parameter for the messagethrowable
- the throwable to writevoid config(StringId messageId, Throwable throwable)
messageId
- the message to writethrowable
- the throwable to writevoid config(StringId messageId, Object[] parameters)
messageId
- the message to writeparameters
- the parameters for the messagevoid config(StringId messageId, Object parameter)
messageId
- the message to writeparameter
- the parameter for the messagevoid config(StringId messageId)
messageId
- the message to writeboolean fineEnabled()
void fine(String msg, Throwable throwable)
msg
- the message to logthrowable
- the throwable to logvoid fine(String msg)
msg
- the message to logvoid fine(Throwable throwable)
throwable
- the throwable to logboolean finerEnabled()
void finer(String msg, Throwable throwable)
msg
- the message to logthrowable
- the throwable to logvoid finer(String msg)
msg
- the message to logvoid finer(Throwable throwable)
throwable
- the throwable to logvoid entering(String sourceClass, String sourceMethod)
The logging is done using the finer
level. The string message will start with
"ENTRY"
and include the class and method names.
sourceClass
- Name of class that issued the logging request.sourceMethod
- Name of the method that issued the logging request.void exiting(String sourceClass, String sourceMethod)
The logging is done using the finer
level. The string message will start with
"RETURN"
and include the class and method names.
sourceClass
- Name of class that issued the logging request.sourceMethod
- Name of the method that issued the logging request.void throwing(String sourceClass, String sourceMethod, Throwable thrown)
Use to log that a method is terminating by throwing an exception. The logging is done using the
finer
level.
This is a convenience method that could be done instead by calling
finer(String, Throwable)
. The string message will start with "THROW"
and
include the class and method names.
sourceClass
- Name of class that issued the logging request.sourceMethod
- Name of the method that issued the logging request.thrown
- The Throwable that is being thrown.boolean finestEnabled()
void finest(String msg, Throwable throwable)
msg
- the message to logthrowable
- the throwable to logvoid finest(String msg)
msg
- the message to logvoid finest(Throwable throwable)
throwable
- the throwable to logHandler getHandler()