Platform SDK Java 8.5 API Reference

com.genesyslab.platform.logging.runtime.configuration
Class FileConfigurationReadOnly

java.lang.Object
  extended by com.genesyslab.platform.logging.runtime.configuration.TargetConfigurationReadOnly
      extended by com.genesyslab.platform.logging.runtime.configuration.FileConfigurationReadOnly
All Implemented Interfaces:
FileConfiguration, TargetConfiguration, TargetConfigurationExt

public final class FileConfigurationReadOnly
extends TargetConfigurationReadOnly
implements FileConfiguration


Constructor Summary
FileConfigurationReadOnly(FileConfiguration configuration)
           
 
Method Summary
 java.lang.String getEncoding()
          Describes the encoding to be used while writing the file.
 ExpirationConfiguration getExpiration()
          Describes the expiration rule for file.
 java.lang.String getFile()
          Describes the log file path.
 MessageHeaderFormat getMessageHeaderFormat()
          Describes the way of formatting the log message header.
 SegmentationConfiguration getSegmentation()
          Describes the segmentation of file.
 TimeFormat getTimeFormat()
          Describes the time formatting (Configuration.TimeFormat) for log file.
 void setEncoding(java.lang.String encoding)
           
 void setExpiration(ExpirationConfiguration ex)
           
 void setFile(java.lang.String file)
           
 void setMessageHeaderFormat(MessageHeaderFormat format)
           
 void setSegmentation(SegmentationConfiguration config)
           
 void setTimeFormat(TimeFormat time)
           
 java.lang.String toString()
           
 
Methods inherited from class com.genesyslab.platform.logging.runtime.configuration.TargetConfigurationReadOnly
getFilter, getMessageHeaderDelimiter, getVerbose, isEnabled, isReadOnly, setEnabled, setFilter, setMessageHeaderDelimiter, setVerbose
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.logging.configuration.TargetConfiguration
getFilter, getVerbose, isEnabled, isReadOnly, setEnabled, setFilter, setVerbose
 

Constructor Detail

FileConfigurationReadOnly

public FileConfigurationReadOnly(FileConfiguration configuration)
Method Detail

getFile

public java.lang.String getFile()
Describes the log file path.

Specified by:
getFile in interface FileConfiguration
Returns:
the log file path

setFile

public void setFile(java.lang.String file)
Specified by:
setFile in interface FileConfiguration

getTimeFormat

public TimeFormat getTimeFormat()
Describes the time formatting (Configuration.TimeFormat) for log file.

Specified by:
getTimeFormat in interface FileConfiguration

setTimeFormat

public void setTimeFormat(TimeFormat time)
Specified by:
setTimeFormat in interface FileConfiguration

getMessageHeaderFormat

public MessageHeaderFormat getMessageHeaderFormat()
Describes the way of formatting the log message header. See Configuration.MessageHeaderFormat for more info.

Specified by:
getMessageHeaderFormat in interface TargetConfiguration
Overrides:
getMessageHeaderFormat in class TargetConfigurationReadOnly

setMessageHeaderFormat

public void setMessageHeaderFormat(MessageHeaderFormat format)
Specified by:
setMessageHeaderFormat in interface TargetConfiguration
Overrides:
setMessageHeaderFormat in class TargetConfigurationReadOnly

getSegmentation

public SegmentationConfiguration getSegmentation()
Describes the segmentation of file.

Specified by:
getSegmentation in interface FileConfiguration

setSegmentation

public void setSegmentation(SegmentationConfiguration config)
Specified by:
setSegmentation in interface FileConfiguration

getExpiration

public ExpirationConfiguration getExpiration()
Describes the expiration rule for file.

Specified by:
getExpiration in interface FileConfiguration

setExpiration

public void setExpiration(ExpirationConfiguration ex)
Specified by:
setExpiration in interface FileConfiguration

getEncoding

public java.lang.String getEncoding()
Describes the encoding to be used while writing the file. if null - the VM default encoding will be used.

Specified by:
getEncoding in interface FileConfiguration
Returns:
encoding

setEncoding

public void setEncoding(java.lang.String encoding)
Specified by:
setEncoding in interface FileConfiguration

toString

public java.lang.String toString()
Overrides:
toString in class TargetConfigurationReadOnly

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.