Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.log4j2
Class GFAppLog4j2Updater

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.application.GFAppCfgEventListener
      extended by com.genesyslab.platform.apptemplate.application.GFAppCfgOptionsEventListener
          extended by com.genesyslab.platform.apptemplate.application.GFAppCfgLogOptionsEventListener
              extended by com.genesyslab.platform.apptemplate.log4j2.GFAppLog4j2Updater
All Implemented Interfaces:
Action<GFAppCfgEvent>, Subscriber<GFAppCfgEvent>, java.util.EventListener

public class GFAppLog4j2Updater
extends GFAppCfgLogOptionsEventListener

Application logging configuration applier/updater for Log4j2.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.genesyslab.platform.apptemplate.application.GFAppCfgLogOptionsEventListener
GFAppCfgLogOptionsEventListener.TheAppLogOptionsFilter
 
Nested classes/interfaces inherited from class com.genesyslab.platform.apptemplate.application.GFAppCfgOptionsEventListener
GFAppCfgOptionsEventListener.TheAppConfigDataFilter
 
Field Summary
 
Fields inherited from class com.genesyslab.platform.apptemplate.application.GFAppCfgLogOptionsEventListener
LOG_EXT_SECTION_NAME, LOG_SECTION_NAME, THE_APP_LOG_OPTIONS_FILTER
 
Fields inherited from class com.genesyslab.platform.apptemplate.application.GFAppCfgOptionsEventListener
THE_APP_CONFIGDATA_FILTER
 
Constructor Summary
GFAppLog4j2Updater()
          Creates an instance of Log4j2 logging configuration updater.
 
Method Summary
protected  boolean applyLoggingOptions(GFApplicationContext appCtx, IGApplicationConfiguration appConfig, CfgDeltaApplication deltaApp, LmsMessageConveyor lmsMessages)
          Parses logging options of given application configuration and applies it to the Log4j2 logging framework.
 
Methods inherited from class com.genesyslab.platform.apptemplate.application.GFAppCfgLogOptionsEventListener
diffSection, getFilter, handle, logOptionsChanged, onAppConfigReceived, onAppConfigUpdated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GFAppLog4j2Updater

public GFAppLog4j2Updater()
Creates an instance of Log4j2 logging configuration updater.

Throws:
java.lang.IllegalArgumentException - if no Log4j2 API or Log4j2 CORE library available.
Method Detail

applyLoggingOptions

protected boolean applyLoggingOptions(GFApplicationContext appCtx,
                                      IGApplicationConfiguration appConfig,
                                      CfgDeltaApplication deltaApp,
                                      LmsMessageConveyor lmsMessages)
Parses logging options of given application configuration and applies it to the Log4j2 logging framework.

Overrides:
applyLoggingOptions in class GFAppCfgLogOptionsEventListener
Parameters:
appCtx - the application configuration managers context.
appConfig - the new application configuration to apply.
deltaApp - the application delta object caused the configuration update, or null.
lmsMessages - the LMS messages conveyor to update correspondent options to.
Returns:
true - if application logging configuration was updated with new configuration, false - if no changes were applied.

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.