Platform SDK Java 8.5 API Reference

com.genesyslab.platform.logging.runtime
Class Logger

java.lang.Object
  extended by com.genesyslab.platform.commons.log.AbstractLogEnabled
      extended by com.genesyslab.platform.logging.runtime.AbstractLogger
          extended by com.genesyslab.platform.logging.runtime.Logger
All Implemented Interfaces:
ILogEnabled, ILogger, LoggerEx, LoggerSupport, RootLogger, InternalRootLogger

public final class Logger
extends AbstractLogger
implements InternalRootLogger


Constructor Summary
Logger(java.lang.String name)
          Default constructor.
 
Method Summary
 void applyConfiguration(LogConfiguration configuration)
          This method should be called BEFORE any output.
 boolean canLogMessage(LogLevel level)
          Determines if given level is enough for logging in current configuration.
 void close()
          Call this method to stop the logger and close all the outputs.
 void doWrite(LogEntry entry)
           
 void doWrite(java.lang.String srcName, int messageId, java.lang.Object[] args)
           
 LogConfiguration getConfiguration()
          Returns the read-only current logger configuration.
 BaseTarget getConsoleTarget()
           
 FileHeaderProvider getFileHeaderProvider()
          The FileHeaderProvider is used for receiving the log files header.
 java.util.List<FileTarget> getFileTargets()
           
protected  InternalRootLogger getInternalLogger()
           
 boolean getIsEnabled()
          Shows if the logger is active and can perform write operations.
 ILogger getLogger()
           
 LoggerPolicy getLoggerPolicy()
          Gets LoggerPolicy of the logger.
 MessageTemplateManager getMessageTemplateManager()
           
 Protocol getNetworkProtocol()
          Please note: the instance of Logger does not control the lifetime or lifecycle of passed networkProtocol.
 SpooledNetworkTarget getNetworkTarget()
           
 boolean isEnabled()
          Shows if the logger is active and can perform write operations.
 void logMessage(java.lang.String srcName, java.lang.Object message, LogLevel level)
           
 void logMessage(java.lang.String srcName, java.lang.Object message, java.lang.Throwable exception, LogLevel level)
           
 void logMessage(java.lang.String srcName, java.lang.String formatString, java.lang.Object[] args, LogLevel level)
           
protected  void onEnableLogging(ILogger logger)
          Called when new logger is provided by user.
 void setConfiguration(LogConfigurationReadOnly logConf)
           
 void setConsoleTarget(BaseTarget target)
           
 void setDateTimeProvider(DateTimeProvider dateTimeProvider)
           
 void setEnabled(boolean value)
          Manage if the logger is active and can perform write operations.
 void setFileHeaderProvider(FileHeaderProvider value)
          The FileHeaderProvider is used for receiving the log files header.
 void setLoggerPolicy(LoggerPolicy value)
          Sets LoggerPolicy of the logger.
 void setMessageTemplateManager(MessageTemplateManager mtMgr)
           
 void setNetworkProtocol(Protocol value)
          Please note: The instance of Logger does not control the lifetime or lifecycle of the passed networkProtocol.
 void setNetworkTarget(SpooledNetworkTarget target)
           
 void setPotentiallyEnabledLevels(java.util.Set<LogLevel> levels)
           
 void setVerboseLevel(VerboseLevel level)
           
 
Methods inherited from class com.genesyslab.platform.logging.runtime.AbstractLogger
createChildLogger, createChildLoggerEx, debug, debug, debugFormat, error, error, errorFormat, fatalError, fatalError, fatalErrorFormat, getName, getRootLogger, info, info, infoFormat, isDebug, isError, isFatalError, isInfo, isWarn, warn, warn, warnFormat, write, write
 
Methods inherited from class com.genesyslab.platform.commons.log.AbstractLogEnabled
enableLogging
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.logging.LoggerEx
createChildLoggerEx, getName, getRootLogger, write, write
 
Methods inherited from interface com.genesyslab.platform.commons.log.ILogger
createChildLogger, debug, debug, debugFormat, error, error, errorFormat, fatalError, fatalError, fatalErrorFormat, info, info, infoFormat, isDebug, isError, isFatalError, isInfo, isWarn, warn, warn, warnFormat
 

Constructor Detail

Logger

public Logger(java.lang.String name)
       throws LoggerException
Default constructor. Creates the Logger which is configured for logging messages of verbose level VerboseLevel.TRACE and higher to the console. Configure the logger using applyConfiguration(LogConfiguration) for different behavior.

Throws:
LoggerException
Method Detail

getInternalLogger

protected InternalRootLogger getInternalLogger()
Specified by:
getInternalLogger in class AbstractLogger

onEnableLogging

protected void onEnableLogging(ILogger logger)
Called when new logger is provided by user.

Overrides:
onEnableLogging in class AbstractLogEnabled
Parameters:
logger - The new logger

getConsoleTarget

public BaseTarget getConsoleTarget()

setConsoleTarget

public void setConsoleTarget(BaseTarget target)

getNetworkTarget

public SpooledNetworkTarget getNetworkTarget()

setNetworkTarget

public void setNetworkTarget(SpooledNetworkTarget target)

getFileTargets

public java.util.List<FileTarget> getFileTargets()

setVerboseLevel

public void setVerboseLevel(VerboseLevel level)

setPotentiallyEnabledLevels

public void setPotentiallyEnabledLevels(java.util.Set<LogLevel> levels)

getNetworkProtocol

public Protocol getNetworkProtocol()
Please note: the instance of Logger does not control the lifetime or lifecycle of passed networkProtocol. It's the caller code concern to initialize the instance of networkProtocol and open it before passing. It's the caller code concern to save the old value of NetworkProtocol and close/dispose it after assignment.

Specified by:
getNetworkProtocol in interface LoggerSupport
Returns:
protocol connection to Genesys Message Server or null

setNetworkProtocol

public void setNetworkProtocol(Protocol value)
                        throws java.lang.Exception
Description copied from interface: LoggerSupport
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.

Specified by:
setNetworkProtocol in interface LoggerSupport
Throws:
java.lang.Exception

getFileHeaderProvider

public 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 for actual log files headers forming.

Specified by:
getFileHeaderProvider in interface LoggerSupport
Returns:
The FileHeaderProvider used for receiving the log files header

setFileHeaderProvider

public void setFileHeaderProvider(FileHeaderProvider value)
                           throws LoggerException
Description copied from interface: LoggerSupport
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.

Specified by:
setFileHeaderProvider in interface LoggerSupport
Throws:
LoggerException

getMessageTemplateManager

public MessageTemplateManager getMessageTemplateManager()

setMessageTemplateManager

public void setMessageTemplateManager(MessageTemplateManager mtMgr)

getConfiguration

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

Specified by:
getConfiguration in interface LoggerSupport
Returns:
current configuration

setConfiguration

public void setConfiguration(LogConfigurationReadOnly logConf)

getLoggerPolicy

public LoggerPolicy getLoggerPolicy()
Gets LoggerPolicy of the logger. At the moment the policy is used for receiving the LogCategory for the messages being formed. TBD - add other functionality.

Specified by:
getLoggerPolicy in interface LoggerSupport
Returns:
logger policy

setLoggerPolicy

public void setLoggerPolicy(LoggerPolicy value)
Sets LoggerPolicy of the logger. At the moment the policy is used for receiving the LogCategory for the messages being formed. TBD - add other functionality.

Specified by:
setLoggerPolicy in interface LoggerSupport
Parameters:
value - new logger policy

isEnabled

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

Returns:
True if logger is enabled and can process log entries

setEnabled

public void setEnabled(boolean value)
Manage if the logger is active and can perform write operations.

Parameters:
value - new value for logger enabling flag

applyConfiguration

public void applyConfiguration(LogConfiguration configuration)
                        throws LoggerException
This method should be called BEFORE any output.

Specified by:
applyConfiguration in interface LoggerSupport
Parameters:
configuration - new logging configuration
Throws:
LoggerException

close

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

Specified by:
close in interface LoggerSupport

setDateTimeProvider

public void setDateTimeProvider(DateTimeProvider dateTimeProvider)

canLogMessage

public boolean canLogMessage(LogLevel level)
Description copied from interface: LoggerEx
Determines if given level is enough for logging in current configuration.

Specified by:
canLogMessage in interface LoggerEx
Overrides:
canLogMessage in class AbstractLogger
Parameters:
level - log level to check
Returns:
true, if message is able to be printed with given level

getLogger

public ILogger getLogger()
Overrides:
getLogger in class AbstractLogEnabled

doWrite

public void doWrite(java.lang.String srcName,
                    int messageId,
                    java.lang.Object[] args)
Specified by:
doWrite in interface InternalRootLogger

doWrite

public void doWrite(LogEntry entry)
Specified by:
doWrite in interface InternalRootLogger

logMessage

public void logMessage(java.lang.String srcName,
                       java.lang.Object message,
                       LogLevel level)
Specified by:
logMessage in interface InternalRootLogger

logMessage

public void logMessage(java.lang.String srcName,
                       java.lang.Object message,
                       java.lang.Throwable exception,
                       LogLevel level)
Specified by:
logMessage in interface InternalRootLogger

logMessage

public void logMessage(java.lang.String srcName,
                       java.lang.String formatString,
                       java.lang.Object[] args,
                       LogLevel level)
Specified by:
logMessage in interface InternalRootLogger

getIsEnabled

public boolean getIsEnabled()
Description copied from interface: LoggerSupport
Shows if the logger is active and can perform write operations.

Specified by:
getIsEnabled in interface LoggerSupport

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.