Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.lmslogger
Interface LmsEventLogger

All Superinterfaces:
ILogger, ILoggerEx
All Known Implementing Classes:
AbstractLmsEventLogger, DirectLmsEventLogger, JulLmsEventLogger, LmsLoggerFactory.WrappedLogger, Log4j2LmsEventLogger, Log4jLmsEventLogger, SilentLmsEventLogger, SimpleLmsEventLogger, Slf4jLmsEventLogger

public interface LmsEventLogger
extends ILoggerEx

Facade interface for LMS Events logging.
It allows applications to generate LMS Events with or without specific LMS templates enumerations.

 lmsLogger.log(CommonLmsEnum.GCTI_LOAD_RESOURCE, rcName, errCode);
 lmsLogger.log(LogCategory.Application, CommonLmsEnum.GCTI_LOAD_RESOURCE, rcName, errCode);

 // or:
 lmsLogger.log(2002, rcName, errCode); // 2002 corresponds to CommonLmsEnum.GCTI_LOAD_RESOURCE
 lmsLogger.log(LogCategory.Application, 2002, rcName, errCode);
 

See Also:
LmsLoggerFactory, LmsLoggerFactory.getLogger(Class), LmsLoggerFactory.getLogger(String)

Field Summary
static java.lang.String STR_PSDK_LMS_ALARM_MESSAGE_MARKER
          Log marker for LMS Alarm level messages events.
It is supposed that LMS Alarm message logged by a LmsLogger may bear this marker.
static java.lang.String STR_PSDK_LMS_MESSAGE_MARKER
          Log marker for LMS messages events.
It is supposed that every LMS message logged by a LmsLogger will bear this marker.
 
Method Summary
 void debug(LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as a debug message.
 void debug(LogCategory category, LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as a debug message.
 void error(LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as an error message.
 void error(LogCategory category, LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as an error message.
 void fatal(LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as a fatal error message.
 void fatal(LogCategory category, LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as a fatal error message.
 void fatalError(LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as a fatal error message.
 void fatalError(LogCategory category, LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as a fatal error message.
 void info(LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as an info message.
 void info(LogCategory category, LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as an info message.
 void log(int key, java.lang.Object... args)
          Logs a localized message.
Its usage may look like:
 void log(LmsMessageTemplate key, java.lang.Object... args)
          Logs a localized message.
Its usage may look like:
 void log(LogCategory category, int key, java.lang.Object... args)
          Logs a localized message.
Its usage may look like:
 void log(LogCategory category, LmsMessageTemplate key, java.lang.Object... args)
          Logs a localized message.
Its usage may look like:
 void warn(LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as a warning message.
 void warn(LogCategory category, LmsMessageTemplate key, java.lang.Object... args)
          Logs localized LMS event as a warning message.
 
Methods inherited from interface com.genesyslab.platform.apptemplate.lmslogger.ILoggerEx
debug, error, fatal, info, trace, warn
 
Methods inherited from interface com.genesyslab.platform.commons.log.ILogger
createChildLogger, debug, debug, debugFormat, error, error, errorFormat, fatalError, fatalError, fatalErrorFormat, info, info, infoFormat, isDebug, isError, isFatalError, isInfo, isWarn, warn, warn, warnFormat
 

Field Detail

STR_PSDK_LMS_MESSAGE_MARKER

static final java.lang.String STR_PSDK_LMS_MESSAGE_MARKER
Log marker for LMS messages events.
It is supposed that every LMS message logged by a LmsLogger will bear this marker. It allows marker-aware implementations to perform additional processing on localized messages.

See Also:
Constant Field Values

STR_PSDK_LMS_ALARM_MESSAGE_MARKER

static final java.lang.String STR_PSDK_LMS_ALARM_MESSAGE_MARKER
Log marker for LMS Alarm level messages events.
It is supposed that LMS Alarm message logged by a LmsLogger may bear this marker. It allows marker-aware implementations to perform additional processing on localized messages.

See Also:
Constant Field Values
Method Detail

log

void log(LogCategory category,
         LmsMessageTemplate key,
         java.lang.Object... args)
Logs a localized message.
Its usage may look like:
 lmsLogger.log(LogCategory.Application, CommonLmsEnum.GCTI_APP_STARTED);
 lmsLogger.log(LogCategory.Application, CommonLmsEnum.GCTI_LOAD_RESOURCE, rcName, errCode);
 

Parameters:
category - the log event category.
key - the key used for localization.
args - optional arguments.

log

void log(LogCategory category,
         int key,
         java.lang.Object... args)
Logs a localized message.
Its usage may look like:
 lmsLogger.log(LogCategory.Application, 5060);                  // CommonLmsEnum.GCTI_APP_STARTED
 lmsLogger.log(LogCategory.Application, 2002, rcName, errCode); // CommonLmsEnum.GCTI_LOAD_RESOURCE
 

Parameters:
category - the log event category.
key - the key used for localization.
args - optional arguments.

log

void log(LmsMessageTemplate key,
         java.lang.Object... args)
Logs a localized message.
Its usage may look like:
 lmsLogger.log(CommonLmsEnum.GCTI_APP_STARTED);
 lmsLogger.log(CommonLmsEnum.GCTI_LOAD_RESOURCE, rcName, errCode);
 

Parameters:
key - the key used for localization.
args - optional arguments.

log

void log(int key,
         java.lang.Object... args)
Logs a localized message.
Its usage may look like:
 lmsLogger.log(5060);                  // CommonLmsEnum.GCTI_APP_STARTED
 lmsLogger.log(2002, rcName, errCode); // CommonLmsEnum.GCTI_LOAD_RESOURCE
 

Parameters:
key - the key used for localization.
args - optional arguments.

debug

void debug(LogCategory category,
           LmsMessageTemplate key,
           java.lang.Object... args)
Logs localized LMS event as a debug message.

Note: "Debug" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".debug(...)" method call.
So, common logging functionality will have these events as "debug", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
category - the log event category.
key - the key used for localization.
args - optional arguments.

debug

void debug(LmsMessageTemplate key,
           java.lang.Object... args)
Logs localized LMS event as a debug message.

Note: "Debug" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".debug(...)" method call.
So, common logging functionality will have these events as "debug", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
key - the key used for localization.
args - optional arguments.

info

void info(LogCategory category,
          LmsMessageTemplate key,
          java.lang.Object... args)
Logs localized LMS event as an info message.

Note: "Info" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".info(...)" method call.
So, common logging functionality will have these events as "info", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
category - the log event category.
key - the key used for localization.
args - optional arguments.

info

void info(LmsMessageTemplate key,
          java.lang.Object... args)
Logs localized LMS event as an info message.

Note: "Info" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".info(...)" method call.
So, common logging functionality will have these events as "info", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
key - the key used for localization.
args - optional arguments.

warn

void warn(LogCategory category,
          LmsMessageTemplate key,
          java.lang.Object... args)
Logs localized LMS event as a warning message.

Note: "Warn" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".warn(...)" method call.
So, common logging functionality will have these events as "warn", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
category - the log event category.
key - the key used for localization.
args - optional arguments.

warn

void warn(LmsMessageTemplate key,
          java.lang.Object... args)
Logs localized LMS event as a warning message.

Note: "Warn" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".warn(...)" method call.
So, common logging functionality will have these events as "warn", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
key - the key used for localization.
args - optional arguments.

error

void error(LogCategory category,
           LmsMessageTemplate key,
           java.lang.Object... args)
Logs localized LMS event as an error message.

Note: "Error" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".error(...)" method call.
So, common logging functionality will have these events as "error", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
category - the log event category.
key - the key used for localization.
args - optional arguments.

error

void error(LmsMessageTemplate key,
           java.lang.Object... args)
Logs localized LMS event as an error message.

Note: "Error" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".error(...)" method call.
So, common logging functionality will have these events as "error", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
key - the key used for localization.
args - optional arguments.

fatal

void fatal(LogCategory category,
           LmsMessageTemplate key,
           java.lang.Object... args)
Logs localized LMS event as a fatal error message.

Note: "Fatal error" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".fatal(...)" method call.
So, common logging functionality will have these events as "fatal", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
category - the log event category.
key - the key used for localization.
args - optional arguments.

fatal

void fatal(LmsMessageTemplate key,
           java.lang.Object... args)
Logs localized LMS event as a fatal error message.

Note: "Fatal error" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".fatal(...)" method call.
So, common logging functionality will have these events as "fatal", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
key - the key used for localization.
args - optional arguments.

fatalError

void fatalError(LogCategory category,
                LmsMessageTemplate key,
                java.lang.Object... args)
Logs localized LMS event as a fatal error message.

Note: "Fatal error" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".fatal(...)" method call.
So, common logging functionality will have these events as "fatal", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
category - the log event category.
key - the key used for localization.
args - optional arguments.

fatalError

void fatalError(LmsMessageTemplate key,
                java.lang.Object... args)
Logs localized LMS event as a fatal error message.

Note: "Fatal error" level of this method does not affect LMS events level (LmsMessageTemplate.getLevel()) logged with this method.
LmsEventLogger applies LMS localization and pass this call to actual underlying log system as ".fatal(...)" method call.
So, common logging functionality will have these events as "fatal", but in case of Message Server appender, or Log4j2 GLmsLayout, there will be value of LmsMessageTemplate.getLevel().

Parameters:
key - the key used for localization.
args - optional arguments.

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.