Platform SDK Java 8.5 API Reference

Package com.genesyslab.platform.apptemplate.application

This package provides helper components for connectivity with Genesys Configuration Framework.

See:
          Description

Interface Summary
GFAppCfgEvent Interface describing event on Genesys CME application configuration manager.
GFApplicationContext The application runtime context interface provided by the application configuration manager (GFApplicationConfigurationManager).
 

Class Summary
AbstractManagerBuilder<M extends GFApplicationConfigurationManager,B extends AbstractManagerBuilder<M,B>> Abstract base class for application configuration manager builders.
GFAppCfgEventListener  
GFAppCfgLogOptionsEventListener Abstract base class for appliance and update of the application logging framework configuration by incoming application configuration from the application configuration manager (GFApplicationConfigurationManager).
GFAppCfgLogOptionsEventListener.TheAppLogOptionsFilter  
GFAppCfgOptionsEventListener  
GFAppCfgOptionsEventListener.TheAppConfigDataFilter  
GFApplicationConfigurationManager The Application Configuration Management component facade class.
GFApplicationConfigurationManager.ManagerBuilder Dedicated builder for basic implementation of application configuration manager.
 

Enum Summary
GFAppCfgEvent.AppCfgEventType Enumeration with possible types of Genesys CME application configuration manager events.
 

Package com.genesyslab.platform.apptemplate.application Description

This package provides helper components for connectivity with Genesys Configuration Framework.

CME application configuration monitoring may be done with GFApplicationConfigurationManager.
It manages Configuration Server connection, the application configuration reading, and its update notifications.
It also checks availability of Log4j2 logging framework, and automatically enables its configuration by the Genesys CME application logging options.

The shortest way to get an application configured for logging in accordance to the application "log" section may look like:

 GFApplicationConfigurationManager appManager =
         GFApplicationConfigurationManager.newBuilder()
         .withCSEndpoint(new Endpoint("CS-primary", csHost1, csPort1))
         .withCSEndpoint(new Endpoint("CS-backup", csHost2, csPort2))
         .withClientId(clientType, clientName)
         .withUserId(csUsername, csPassword)
         .build();

 // If the application uses options other than the logging related, it may
 // register own handler for appliance of the configuration:
 appManager.register(new GFAppCfgOptionsEventListener() {
     public void handle(final GFAppCfgEvent event) {
         Log.getLogger(getClass()).info(
                 "The application configuration options received: " + event);
         // Initialize or update own application options from 'event.getAppConfig()'
     }});

 appManager.init();

 // Do the application work...

 // On the application exit:
 appManager.done();
 

See Also:
GFApplicationConfigurationManager

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.