Platform SDK Java 8.5 API Reference

com.genesyslab.platform.logging
Interface LoggerSupport

All Known Subinterfaces:
InternalRootLogger, RootLogger
All Known Implementing Classes:
Logger

public interface LoggerSupport


Method Summary
 void applyConfiguration(LogConfiguration configuration)
          This method should be called BEFORE any output.
 void close()
          Call this method to stop the logger and close all the outputs.
 LogConfiguration getConfiguration()
          Returns the read-only current logger configuration.
 FileHeaderProvider getFileHeaderProvider()
          The FileHeaderProvider is used for receiving the log files header.
 boolean getIsEnabled()
          Shows if the logger is active and can perform write operations.
 LoggerPolicy getLoggerPolicy()
          Gets the LoggerPolicy of the logger.
 Protocol getNetworkProtocol()
          Please note: The instance of Logger does not control the lifetime or lifecycle of the passed networkProtocol.
 void setFileHeaderProvider(FileHeaderProvider fileHeaderProvider)
          The FileHeaderProvider is used for receiving the log files header.
 void setLoggerPolicy(LoggerPolicy loggerPolicy)
          Sets the LoggerPolicy of the logger.
 void setNetworkProtocol(Protocol protocol)
          Please note: The instance of Logger does not control the lifetime or lifecycle of the passed networkProtocol.
 

Method Detail

close

void close()
Call this method to stop the logger and close all the outputs.


getIsEnabled

boolean getIsEnabled()
Shows if the logger is active and can perform write operations.


getLoggerPolicy

LoggerPolicy getLoggerPolicy()
Gets the LoggerPolicy of the logger. At the moment the policy is used for receiving the LogCategory for the messages being formed. Other functionality may be added in future releases.


setLoggerPolicy

void setLoggerPolicy(LoggerPolicy loggerPolicy)
Sets the LoggerPolicy of the logger. At the moment the policy is used for receiving the LogCategory for the messages being formed. Other functionality may be added in future releases.


getFileHeaderProvider

FileHeaderProvider getFileHeaderProvider()
The FileHeaderProvider is used for receiving the log files header. Getter - returns the header provider itself. Setter - calls the Cloneable.Clone method and sets the clone of passed value. Please note: The clones of this instance will be used to form actual log file headers.


setFileHeaderProvider

void setFileHeaderProvider(FileHeaderProvider fileHeaderProvider)
                           throws LoggerException
The FileHeaderProvider is used for receiving the log files header. Getter - returns the header provider itself. Setter - calls the Cloneable.Clone method and sets the clone of passed value. Please note: The clones of this instance will be used to form actual log file headers.

Throws:
LoggerException

getConfiguration

LogConfiguration getConfiguration()
Returns the read-only current logger configuration.


applyConfiguration

void applyConfiguration(LogConfiguration configuration)
                        throws LoggerException
This method should be called BEFORE any output. Applies the logger configuration settings you specify.

Parameters:
configuration - The configuration to be applied.
Throws:
LoggerException

getNetworkProtocol

Protocol getNetworkProtocol()
Please note: The instance of Logger does not control the lifetime or lifecycle of the passed networkProtocol. The code calling this method is responsible for initializing and opening the instance of networkProtocol before passing it into this method. It is the responsibility of the code calling this method to save the old value of NetworkProtocol and properly close/dispose it after assignment.


setNetworkProtocol

void setNetworkProtocol(Protocol protocol)
                        throws java.lang.Exception
Please note: The instance of Logger does not control the lifetime or lifecycle of the passed networkProtocol. The code calling this method is responsible for initializing and opening the instance of networkProtocol before passing it into this method. It is the responsibility of the code calling this method to save the old value of NetworkProtocol and properly close/dispose it after assignment.

Throws:
java.lang.Exception

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.