Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.lmslogger.impl
Class SimpleLmsEventLogger

java.lang.Object
  extended by com.genesyslab.platform.commons.log.AbstractLogger
      extended by com.genesyslab.platform.apptemplate.lmslogger.AbstractLmsEventLogger
          extended by com.genesyslab.platform.apptemplate.lmslogger.impl.SimpleLmsEventLogger
All Implemented Interfaces:
ILoggerEx, LmsEventLogger, ILogger

public class SimpleLmsEventLogger
extends AbstractLmsEventLogger

"Simple" implementation of LmsEventLogger.
It's to print LMS log messages to stdout.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.genesyslab.platform.commons.log.AbstractLogger
AbstractLogger.Level
 
Field Summary
protected  LogLevel logLevel
           
 
Fields inherited from class com.genesyslab.platform.apptemplate.lmslogger.AbstractLmsEventLogger
CTX_ATTRMAP_PREFIX, CTX_LMSATTR_CATEGORY, CTX_LMSATTR_ID, CTX_LMSATTR_LEVEL, CTX_LMSATTR_NAME, CTX_LMSATTR_PREFIX, DEFAULT_LMS_EVENT, lmsMessages, LOG_WRAPPER_FQCN, printAttributes
 
Fields inherited from interface com.genesyslab.platform.apptemplate.lmslogger.LmsEventLogger
STR_PSDK_LMS_ALARM_MESSAGE_MARKER, STR_PSDK_LMS_MESSAGE_MARKER
 
Constructor Summary
protected SimpleLmsEventLogger(LmsMessageConveyor imc, LogLevel logLevel)
           
 
Method Summary
 ILogger createChildLogger(java.lang.String name)
          Creates new child logger.
protected  void doLogEvent(LogCategory category, AbstractLogger.Level logLevel, LmsMessageTemplate key, java.lang.Object... args)
          Logs a localized message.
Specific LmsEventLogger class should implement this method to process log messages.
 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.
protected  void log(java.lang.Object message, java.lang.Throwable e, AbstractLogger.Level level)
           
protected  void logArgs(java.lang.String message, java.lang.Object args, AbstractLogger.Level level)
           
 
Methods inherited from class com.genesyslab.platform.apptemplate.lmslogger.AbstractLmsEventLogger
debug, debug, debug, debug, debug, error, error, error, error, error, fatal, fatal, fatal, fatalError, fatalError, fatalError, fatalError, getThrowableArg, info, info, info, info, info, log, log, log, log, trace, warn, warn, warn, warn, warn
 
Methods inherited from class com.genesyslab.platform.commons.log.AbstractLogger
debugFormat, errorFormat, fatalErrorFormat, formatMessage, infoFormat, warnFormat
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.commons.log.ILogger
debugFormat, errorFormat, fatalErrorFormat, infoFormat, warnFormat
 

Field Detail

logLevel

protected final LogLevel logLevel
Constructor Detail

SimpleLmsEventLogger

protected SimpleLmsEventLogger(LmsMessageConveyor imc,
                               LogLevel logLevel)
Method Detail

createChildLogger

public ILogger createChildLogger(java.lang.String name)
Description copied from interface: ILogger
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

isDebug

public boolean isDebug()
Description copied from interface: ILogger
Checks whether this Logger is enabled for the DEBUG Level.

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

isInfo

public boolean isInfo()
Description copied from interface: ILogger
Checks whether this Logger is enabled for the INFO Level.

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

isWarn

public boolean isWarn()
Description copied from interface: ILogger
Checks whether this Logger is enabled for the WARNING Level.

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

isError

public boolean isError()
Description copied from interface: ILogger
Checks whether this Logger is enabled for the ERROR Level.

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

isFatalError

public boolean isFatalError()
Description copied from interface: ILogger
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.

doLogEvent

protected void doLogEvent(LogCategory category,
                          AbstractLogger.Level logLevel,
                          LmsMessageTemplate key,
                          java.lang.Object... args)
Description copied from class: AbstractLmsEventLogger
Logs a localized message.
Specific LmsEventLogger class should implement this method to process log messages.

Specified by:
doLogEvent in class AbstractLmsEventLogger
Parameters:
category - the log event category.
logLevel - the PSDK log level value.
key - the key used for localization.
args - optional arguments.

log

protected void log(java.lang.Object message,
                   java.lang.Throwable e,
                   AbstractLogger.Level level)
Specified by:
log in class AbstractLogger

logArgs

protected void logArgs(java.lang.String message,
                       java.lang.Object args,
                       AbstractLogger.Level level)
Specified by:
logArgs in class AbstractLogger

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.