Platform SDK Java 8.5 API Reference

Package com.genesyslab.platform.apptemplate.lmslogger

This package provides support of Genesys LMS files and LMS events logging.

See:
          Description

Interface Summary
ILoggerEx Extension of PSDK Common logging interface with methods named in style of common logging interfaces like Log4j2.
LmsEventLogger Facade interface for LMS Events logging.
It allows applications to generate LMS Events with or without specific LMS templates enumerations.
LmsMessageTemplate Interface for representation of a GCTI LMS event entry.
 

Class Summary
AbstractLmsEventLogger Abstract base class with common methods implementation of LmsEventLogger interface.
LmsEnumGenerator Platform SDK AppTemplate AB Code generation Tool for LMS enumerations.
LmsFileHeader LMS file header information containing the same fields as the header of LMS file does.
LmsLoggerFactory Abstract factory class for LMS event loggers.
It's the entry point of the LMS logging functionality.
LmsLoggerFactory.AbstractFactoryBuilder<F extends LmsLoggerFactory,B extends LmsLoggerFactory.AbstractFactoryBuilder<F,B>>  
LmsLoggerFactory.WrappedLogger The LmsEventLogger wrapper to be implicitly used by applications.
It makes possible automatic reconfiguration of LMS events logging without recreation of applications' loggers instances.
LmsLoggerFactory.WrappedLoggerFactory The LmsLoggerFactory wrapper to provide application with wrapped LmsEventLogger's.
LmsMessageConveyor Container of LMS events templates with correspondent LMS file(s) localization.
LmsMessageConveyor.Builder Builder for LmsMessageConveyor component.
LmsMessageConveyor.UnknownLmsEvent Internal class to represent "unknown" LMS log events.
 

Enum Summary
LmsLogLevel Log levels enumeration declarations specific for Genesys Message Server and Genesys LMS files specifications.
 

Exception Summary
LmsLoadException Exception representing errors in LMS file reading or parsing.
 

Annotation Types Summary
LmsEnumType Annotation that identifies a Class as a generated Platform SDK AppTemplate LmsEnum.
 

Package com.genesyslab.platform.apptemplate.lmslogger Description

This package provides support of Genesys LMS files and LMS events logging.

Simple usage:

 class SampleClass {

     protected final static LmsEventLogger LOG = LmsLoggerFactory.getLogger(SampleClass.class);

     public void method() {
         // Use logger to generate event:
         LOG.log(LogCategory.Application, CommonLmsEnum.GCTI_LOAD_RESOURCE, "users.db", "no such file");
             // => "Unable to load resource 'users.db', error code 'no such file'"

         // or, for event GCTI_CFG_APP[6053, STANDARD, "Configuration for application obtained"]:
         LOG.log(CommonLmsEnum.GCTI_CFG_APP);
           // or
         LOG.log(6053); // => "Configuration for application obtained"

         // or "plain" logging methods:
         try {
             LOG.debug("Starting cache load...");
             // ... do something ...
         } catch (final Exception exception) {
             LOG.error("Failed to load cache", exception);
         }
 .....
 
With direct initialization of LmsLoggerFactory singleton and LmsMessageConveyor:
 // Initialize logger factory:
 LmsMessageConveyor lmsConveyor = new LmsMessageConveyor(CommonLmsEnum.class, MyAppLmsEnum.class);
 lmsConveyor.loadConfiguration("common.lms");
 LmsLoggerFactory.createInstance(lmsConveyor);

 // Create logger instance:
 LmsEventLogger lmsLog = LmsLoggerFactory.getLogger("MyApplication");

 // Use logger to generate event:
 lmsLog.log(LogCategory.Application, CommonLmsEnum.GCTI_LOAD_RESOURCE, "users.db", "no such file");

 // or, for event GCTI_CFG_APP[6053, STANDARD, "Configuration for application obtained"]:
 lmsLog.log(CommonLmsEnum.GCTI_CFG_APP);
 

See Also:
LmsMessageConveyor, LmsLoggerFactory, LmsEventLogger, CommonLmsEnum

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.