Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.log
Interface ILogger

All Known Subinterfaces:
ILoggerEx, InternalRootLogger, LmsEventLogger, LoggerEx, RootLogger
All Known Implementing Classes:
AbstractLmsEventLogger, AbstractLogger, AbstractLogger, DirectLmsEventLogger, JavaUtilLoggerImpl, JulLmsEventLogger, LmsLoggerFactory.WrappedLogger, Log4j2LmsEventLogger, Log4J2LoggerImpl, Log4jLmsEventLogger, Log4JLoggerImpl, Logger, LoggerWraper, NullLoggerImpl, SilentLmsEventLogger, SimpleLmsEventLogger, SimpleLoggerImpl, Slf4jLmsEventLogger, Slf4JLoggerImpl

public interface ILogger

This is a facade for the Platform SDK Commons logging subsystem.
It offers a simplified interface that follows the inversion of control pattern and a simplified priority/level/severity abstraction.
Quick examples:

 log.debugFormat("Value is ''{0}''", new Integer(1));
 log.debugFormat("Value for index: [{0}] = {1}", new Object[] {ind, val});
For more details on message formatting, refer to MessageFormat class documentation.


Method Summary
 ILogger createChildLogger(java.lang.String name)
          Creates new child logger.
 void debug(java.lang.Object message)
          Logs a message at the DEBUG level.
 void debug(java.lang.Object message, java.lang.Throwable thr)
          Logs a message at the DEBUG level including the stack trace of the Throwable thr passed as parameter.
 void debugFormat(java.lang.String message, java.lang.Object args)
          Logs formatted debug message with optional arguments.
 void error(java.lang.Object message)
          Logs a message at the ERROR level.
 void error(java.lang.Object message, java.lang.Throwable thr)
          Logs a message at the ERROR level including the stack trace of the Throwable thr passed as parameter.
 void errorFormat(java.lang.String message, java.lang.Object args)
          Logs a message at the ERROR level.
To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 void fatalError(java.lang.Object message)
          Logs a message object with the FATAL ERROR level.
 void fatalError(java.lang.Object message, java.lang.Throwable thr)
          Logs a message at the FATAL ERROR level including the stack trace of the Throwable thr passed as parameter.
 void fatalErrorFormat(java.lang.String message, java.lang.Object args)
          Logs a message at the FATAL ERROR level.
To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 void info(java.lang.Object message)
          Logs a message at the INFO level.
 void info(java.lang.Object message, java.lang.Throwable thr)
          Logs a message at the INFO level including the stack trace of the Throwable thr passed as parameter.
 void infoFormat(java.lang.String message, java.lang.Object args)
          Logs a message at the INFO level.
To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 boolean isDebug()
          Checks whether this Logger is enabled for the DEBUG Level.
 boolean isError()
          Checks whether this Logger is enabled for the ERROR Level.
 boolean isFatalError()
          Checks whether this Logger is enabled for the FATAL ERROR level.
 boolean isInfo()
          Checks whether this Logger is enabled for the INFO Level.
 boolean isWarn()
          Checks whether this Logger is enabled for the WARNING Level.
 void warn(java.lang.Object message)
          Logs a message at the WARNING level.
 void warn(java.lang.Object message, java.lang.Throwable thr)
          Logs a message at the WARNING level including the stack trace of the Throwable thr passed as parameter.
 void warnFormat(java.lang.String message, java.lang.Object args)
          Logs a message at the WARNING level.
To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 

Method Detail

isDebug

boolean isDebug()
Checks whether this Logger is enabled for the DEBUG Level.

Returns:
boolean - true if this Logger is enabled for level DEBUG, false otherwise.

debug

void debug(java.lang.Object message)
Logs a message at the DEBUG level.

Parameters:
message - the message object to log.

debug

void debug(java.lang.Object message,
           java.lang.Throwable thr)
Logs a message at the DEBUG level including the stack trace of the Throwable thr passed as parameter.

Parameters:
message - the message object to log.
thr - the exception to log, including its stack trace.

debugFormat

void debugFormat(java.lang.String message,
                 java.lang.Object args)
Logs formatted debug message with optional arguments. To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 log.debugFormat("Value is ''{0}''", new Integer(1));
 log.debugFormat("Value for index: [{0}] = {1}", new Object[] {ind, val});

Parameters:
message - message with format tags
args - arguments for format
See Also:
MessageFormat

isInfo

boolean isInfo()
Checks whether this Logger is enabled for the INFO Level.

Returns:
boolean - true if this Logger is enabled for level INFO, false otherwise.

info

void info(java.lang.Object message)
Logs a message at the INFO level.

Parameters:
message - the message object to log.

info

void info(java.lang.Object message,
          java.lang.Throwable thr)
Logs a message at the INFO level including the stack trace of the Throwable thr passed as parameter.

Parameters:
message - the message object to log.
thr - the exception to log, including its stack trace.

infoFormat

void infoFormat(java.lang.String message,
                java.lang.Object args)
Logs a message at the INFO level.
To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 log.infoFormat("Value is ''{0}''", new Integer(1));
 log.infoFormat("Value for index: [{0}] = {1}", new Object[] {ind, val});

Parameters:
message - the message to log.
args - parameters to the message.
See Also:
MessageFormat

isError

boolean isError()
Checks whether this Logger is enabled for the ERROR Level.

Returns:
boolean - true if this Logger is enabled for level ERROR, false otherwise.

error

void error(java.lang.Object message)
Logs a message at the ERROR level.

Parameters:
message - the message object to log.

error

void error(java.lang.Object message,
           java.lang.Throwable thr)
Logs a message at the ERROR level including the stack trace of the Throwable thr passed as parameter.

Parameters:
message - the message object to log.
thr - the exception to log, including its stack trace.

errorFormat

void errorFormat(java.lang.String message,
                 java.lang.Object args)
Logs a message at the ERROR level.
To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 log.errorFormat("Value is ''{0}''", new Integer(1));
 log.errorFormat("Value for index: [{0}] = {1}", new Object[] {ind, val});

Parameters:
message - the message to log.
args - parameters to the message.
See Also:
MessageFormat

isFatalError

boolean isFatalError()
Checks whether this Logger is enabled for the FATAL ERROR level.

Note: Some of PSDK supported logging frameworks (namely "Slf4J" and "java.util.logging") do not support FATAL ERROR messages level.
So, in Slf4J logging adapter PSDK marks such messages with "PSDK_FATAL_MESSAGE" marker.
And in java.util.logging adapter this level is processed as ERROR (SEVERE).

Returns:
boolean - true if this Logger is enabled for level FATAL ERROR, false otherwise.

fatalError

void fatalError(java.lang.Object message)
Logs a message object with the FATAL ERROR level.

Note: Some of PSDK supported logging frameworks (namely "Slf4J" and "java.util.logging") do not support FATAL ERROR messages level.
So, in Slf4J logging adapter PSDK marks such messages with "PSDK_FATAL_MESSAGE" marker.
And in java.util.logging adapter this level is processed as ERROR (SEVERE).

Parameters:
message - the message to log.

fatalError

void fatalError(java.lang.Object message,
                java.lang.Throwable thr)
Logs a message at the FATAL ERROR level including the stack trace of the Throwable thr passed as parameter.

Note: Some of PSDK supported logging frameworks (namely "Slf4J" and "java.util.logging") do not support FATAL ERROR messages level.
So, in Slf4J logging adapter PSDK marks such messages with "PSDK_FATAL_MESSAGE" marker.
And in java.util.logging adapter this level is processed as ERROR (SEVERE).

Parameters:
message - the message object to log.
thr - the exception to log, including its stack trace.

fatalErrorFormat

void fatalErrorFormat(java.lang.String message,
                      java.lang.Object args)
Logs a message at the FATAL ERROR level.
To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 log.fatalErrorFormat("Value is ''{0}''", new Integer(1));
 log.fatalErrorFormat("Value for index: [{0}] = {1}", new Object[] {ind, val});

Note: Some of PSDK supported logging frameworks (namely "Slf4J" and "java.util.logging") do not support FATAL ERROR messages level.
So, in Slf4J logging adapter PSDK marks such messages with "PSDK_FATAL_MESSAGE" marker.
And in java.util.logging adapter this level is processed as ERROR (SEVERE).

Parameters:
message - the message to log.
args - parameters to the message.
See Also:
MessageFormat

isWarn

boolean isWarn()
Checks whether this Logger is enabled for the WARNING Level.

Returns:
boolean - true if this Logger is enabled for level WARNING, false otherwise.

warn

void warn(java.lang.Object message)
Logs a message at the WARNING level.

Parameters:
message - the message object to log.

warn

void warn(java.lang.Object message,
          java.lang.Throwable thr)
Logs a message at the WARNING level including the stack trace of the Throwable thr passed as parameter.

Parameters:
message - the message object to log.
thr - the exception to log, including its stack trace.

warnFormat

void warnFormat(java.lang.String message,
                java.lang.Object args)
Logs a message at the WARNING level.
To format log messages PSDK uses MessageFormat class.
Quick examples on the rules of formatting:
 log.warnFormat("Value is ''{0}''", new Integer(1));
 log.warnFormat("Value for index: [{0}] = {1}", new Object[] {ind, val});

Parameters:
message - the message to log.
args - parameters to the message.
See Also:
MessageFormat

createChildLogger

ILogger createChildLogger(java.lang.String name)
Creates new child logger. Name of a child logger usually looks like "[this-logger-name].[child-name]".

Parameters:
name - the child name for the new logger
Returns:
new ILogger instance

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.