| org.apache.wsrp4j.log.Logger
All known Subclasses: org.apache.wsrp4j.log.LoggerImpl,
Logger | public interface Logger (Code) | | Logger defines the methods which are used to create logging messages.
Logging levels are:
ERROR
- A serious failure in the execution of the application
WARN
- An abnormal condition has been detected. The user may have to take action, but the
running code is able to handle this condition without ultimately failing.
INFO
- A condition that is worth noting but that does not require the user to perform
an action.
TRACE_LOW
- A low-detail trace message.
TRACE_MEDIUM
- A medium-detail trace message.
TRACE_HIGH
- A high-detail trace message.
Plain-text messages can be logged through the text(...) methods. These
messages are generally hard-coded into the application.
These methods should only be used for logging trace data.
In addition, the following specialized methods are available to log trace information.
Each of these trace methods is a convenience to the application programmer:
entry
- Logs entry into a method.
exit
- Logs exit from a method.
stackTrace
- Logs the call stack.
For performance reasons the method isLogging(int logLevel) should be used
to check if a given logging level is written at all to the output. The method should
be used for the log message level entries, but is absolutely required to be called for
trace messages to avoid unnecessary round-trips and object creation.
|
Field Summary | |
final public static int | ERROR Defines an error message.
Use this type to inform the user of a serious failure in the execution of the application. | final public static int | INFO Defines an informational message.
Use this type to indicate conditions that are worth noting but that do not require a
user to take any precautions or perform an action. | final public static int | TRACE_HIGH Defines a high-detail trace message. | final public static int | TRACE_LOW Defines a low-detail trace message. | final public static int | TRACE_MEDIUM Defines a medium-detail trace message. | final public static int | WARN Defines a warning message.
Use this type to inform a user that an abnormal condition has been detected. |
Method Summary | |
public void | entry(int logLevel, String loggingMethod) Logs entry into a method. | public void | entry(int logLevel, String loggingMethod, Object parm1) Logs entry into a method. | public void | entry(int logLevel, String loggingMethod, Object[] parms) Logs entry into a method. | public void | exit(int logLevel, String loggingMethod) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, byte retValue) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, short retValue) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, int retValue) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, long retValue) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, float retValue) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, double retValue) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, char retValue) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, boolean retValue) Logs exit from a method. | public void | exit(int logLevel, String loggingMethod, Object retValue) Logs exit from a method. | public boolean | isLogging(int logLevel) Determines if this logger is logging data for a given log level or not.
Parameters: logLevel - The log level to be checked. | public void | stackTrace(int logLevel, String loggingMethod, String text) Logs the call stack. | public void | text(int logLevel, String loggingMethod, String text) Logs a text message with no parameters. | public void | text(int logLevel, String loggingMethod, String text, Object parm1) Logs a text message with one parameter. | public void | text(int logLevel, String loggingMethod, String text, Object[] parms) Logs a text message with an array of parameters. | public void | text(int logLevel, String loggingMethod, Throwable t, String text) Logs a text message with no parameters. | public void | text(int logLevel, String loggingMethod, Throwable t, String text, Object[] parms) Logs a text message with an array of parameters. |
ERROR | final public static int ERROR(Code) | | Defines an error message.
Use this type to inform the user of a serious failure in the execution of the application.
|
INFO | final public static int INFO(Code) | | Defines an informational message.
Use this type to indicate conditions that are worth noting but that do not require a
user to take any precautions or perform an action. Do not use this log level for
repeating events.
An informational message is less severe than a warning message.
|
TRACE_HIGH | final public static int TRACE_HIGH(Code) | | Defines a high-detail trace message.
|
TRACE_LOW | final public static int TRACE_LOW(Code) | | Defines a low-detail trace message.
|
TRACE_MEDIUM | final public static int TRACE_MEDIUM(Code) | | Defines a medium-detail trace message.
|
WARN | final public static int WARN(Code) | | Defines a warning message.
Use this type to inform a user that an abnormal condition has been detected. The user
may have to take action, but the running code is able to handle this condition without
ultimately failing.
A warning message is less severe than an error message.
|
entry | public void entry(int logLevel, String loggingMethod)(Code) | | Logs entry into a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. |
entry | public void entry(int logLevel, String loggingMethod, Object parm1)(Code) | | Logs entry into a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: parm1 - An element to be displayed as trace data. |
entry | public void entry(int logLevel, String loggingMethod, Object[] parms)(Code) | | Logs entry into a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: parms - An array of parameters passed to the method. |
exit | public void exit(int logLevel, String loggingMethod)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. |
exit | public void exit(int logLevel, String loggingMethod, byte retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
exit | public void exit(int logLevel, String loggingMethod, short retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
exit | public void exit(int logLevel, String loggingMethod, int retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
exit | public void exit(int logLevel, String loggingMethod, long retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
exit | public void exit(int logLevel, String loggingMethod, float retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
exit | public void exit(int logLevel, String loggingMethod, double retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
exit | public void exit(int logLevel, String loggingMethod, char retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
exit | public void exit(int logLevel, String loggingMethod, boolean retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
exit | public void exit(int logLevel, String loggingMethod, Object retValue)(Code) | | Logs exit from a method.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: retValue - The returned value. |
isLogging | public boolean isLogging(int logLevel)(Code) | | Determines if this logger is logging data for a given log level or not.
Parameters: logLevel - The log level to be checked. true when the object is logging the log level;false otherwise. |
stackTrace | public void stackTrace(int logLevel, String loggingMethod, String text)(Code) | | Logs the call stack.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: text - The message text. |
text | public void text(int logLevel, String loggingMethod, String text)(Code) | | Logs a text message with no parameters.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: text - The message text. |
text | public void text(int logLevel, String loggingMethod, String text, Object parm1)(Code) | | Logs a text message with one parameter.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: text - The message text. Parameters: parm1 - An element to be displayed with the message. |
text | public void text(int logLevel, String loggingMethod, String text, Object[] parms)(Code) | | Logs a text message with an array of parameters.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: text - The message text. Parameters: parms - An array of elements to be displayed with the message. |
text | public void text(int logLevel, String loggingMethod, Throwable t, String text)(Code) | | Logs a text message with no parameters.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: t - The throwable that is cause for this log entry. Parameters: text - The message text. |
text | public void text(int logLevel, String loggingMethod, Throwable t, String text, Object[] parms)(Code) | | Logs a text message with an array of parameters.
Parameters: logLevel - The level of the log entry. Parameters: loggingMethod - The name of the logging method. Parameters: t - The throwable that is cause for this log entry. Parameters: text - The message text. Parameters: parms - An array of elements to be displayed with the message. |
|
|