Platform SDK Java 8.5 API Reference

Package com.genesyslab.platform.apptemplate.configuration.log

Dedicated package for CME Application Logging Options configuration support.

See:
          Description

Class Summary
CustomLoggerExtConfig Platform SDK specific extended logging configuration option for applying of custom properties on loggers configuration.
It represents single logger configuration record in "log-extended" section of CME Application Options.
ExpirationConfig This class is used for configuring the expiration of log files (and log segments).
GAppLogExtOptions Parser of "log-extended" section of CME Application objects' Options.
GAppLoggingOptions Parser of "log" section of CME Application objects' Options.
GFileTargetDescriptor Base logging target description extension for file logging target type to support filename property.
LogOptionsDescriptions Consolidated container for the Genesys Common Log Options descriptions.
LogOptionsDescriptions.OptionDescriptor<OptionValueType> A property descriptor class to represent information about particular property in "log" section of CME Application "Options".
SegmentationConfig Describes the rule of segmentation of log files.
TargetDescriptor Base class for description of a configured logging target.
 

Enum Summary
ExpirationConfig.ExpirationStrategy Describes the possible type of log file expiration strategy.
MessageFormat Describes the format of log string to be written to log files with GLmsLayout.
SegmentationConfig.SegmentationStrategy Describes type of segmentation.
TargetType Enumeration of logging target types, which are supported by PSDK AppTemplate Application Block.
It reflects possible values in the "Log Output Options": "all", "debug", "trace", "interaction", "standard", and "alarm".
TimeFormat Describes the way of time string formatting.
TimeUsage This enumeration describes which time will be used for timestamping the messages: local or UTC time.
VerboseLevel The verbose level for logger.
 

Package com.genesyslab.platform.apptemplate.configuration.log Description

Dedicated package for CME Application Logging Options configuration support.

Application logging configuration options are located in "log" and "log-extended" sections of "Options" property of correspondent CME Application object. Its values are defined as string type values in a KeyValueCollections.
The logging configuration helper classes are to parse the application logging options and expose them as a set of typified properties.

Simple initialization example:

 IGApplicationConfiguration appConfiguration = ...;
 GAppLoggingOptions logOpts = new GAppLoggingOptions(appConfiguration, null);
 
This configuration may be used for initialization of specific logging framework configuration.
AppTemplate AB contains configuration helper for Log4j2 logging framework.
And it allows creation of custom configuration helper for some other logging framework.

See Also:
IGApplicationConfiguration, GApplicationConfiguration, GCOMApplicationConfiguration, CfgApplication, ConfService

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.