Platform SDK Java 8.5 API Reference

com.genesyslab.platform.logging.configuration
Class TargetConfigurationImpl

java.lang.Object
  extended by com.genesyslab.platform.logging.configuration.TargetConfigurationImpl
All Implemented Interfaces:
TargetConfiguration, TargetConfigurationExt
Direct Known Subclasses:
FileConfigurationImpl, NetworkTargetConfigurationImpl

public class TargetConfigurationImpl
extends java.lang.Object
implements TargetConfiguration, TargetConfigurationExt

Provides the description of options which are common for all output targets.


Constructor Summary
TargetConfigurationImpl(boolean enabled, VerboseLevel level, java.lang.String filter, MessageHeaderFormat msgHdrformat)
          Constructor.
TargetConfigurationImpl(boolean enabled, VerboseLevel level, java.lang.String filter, MessageHeaderFormat msgHdrformat, java.lang.String msgHdrDelim)
          Constructor.
 
Method Summary
 java.lang.String getFilter()
           
 java.lang.String getMessageHeaderDelimiter()
          Describes the values delimiter char for ShortDSV format.
 MessageHeaderFormat getMessageHeaderFormat()
          Describes the way of formatting the log message header.
 VerboseLevel getVerbose()
          The minimal level of message that can be logged to output.
 boolean isEnabled()
          Gets/sets the enabled status of output.
 boolean isReadOnly()
          True if object is used for reading information only.
 void setEnabled(boolean enabled)
          Sets the enabled status of target.
 void setFilter(java.lang.String filter)
           
 void setMessageHeaderDelimiter(java.lang.String delimiter)
          Describes the values delimiter char for ShortDSV format.
 void setMessageHeaderFormat(MessageHeaderFormat value)
           
 void setVerbose(VerboseLevel level)
          Gets the minimal level of message, which can be logged into the output.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TargetConfigurationImpl

public TargetConfigurationImpl(boolean enabled,
                               VerboseLevel level,
                               java.lang.String filter,
                               MessageHeaderFormat msgHdrformat)
Constructor.

Parameters:
enabled - The value for TargetConfigurationImpl.isEnabled()
level - The minimum verbose level of message which is supported by output
filter - Filter by source name
msgHdrformat - Format type of messages, see MessageHeaderFormat

TargetConfigurationImpl

public TargetConfigurationImpl(boolean enabled,
                               VerboseLevel level,
                               java.lang.String filter,
                               MessageHeaderFormat msgHdrformat,
                               java.lang.String msgHdrDelim)
Constructor.

Parameters:
enabled - The value for TargetConfigurationImpl.isEnabled()
level - The minimum verbose level of message which is supported by output
filter - Filter by source name
msgHdrformat - Format type of messages, see MessageHeaderFormat
msgHdrDelim - Message header delimiter
Method Detail

isEnabled

public boolean isEnabled()
Gets/sets the enabled status of output. If true then the output is enabled. If 'false' then no output is possible (regardless of TargetConfigurationImpl.getVerbose() setting).

Specified by:
isEnabled in interface TargetConfiguration

setEnabled

public void setEnabled(boolean enabled)
Description copied from interface: TargetConfiguration
Sets the enabled status of target. If true - the output into target being described is enabled. If 'false' - no output is possible (regardless of Verbose).

Specified by:
setEnabled in interface TargetConfiguration

getVerbose

public VerboseLevel getVerbose()
The minimal level of message that can be logged to output.

Specified by:
getVerbose in interface TargetConfiguration

setVerbose

public void setVerbose(VerboseLevel level)
Description copied from interface: TargetConfiguration
Gets the minimal level of message, which can be logged into the output.

Specified by:
setVerbose in interface TargetConfiguration

isReadOnly

public boolean isReadOnly()
True if object is used for reading information only.

Specified by:
isReadOnly in interface TargetConfiguration

getFilter

public java.lang.String getFilter()
Specified by:
getFilter in interface TargetConfiguration

setFilter

public void setFilter(java.lang.String filter)
Specified by:
setFilter in interface TargetConfiguration

toString

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

getMessageHeaderFormat

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

Specified by:
getMessageHeaderFormat in interface TargetConfiguration

setMessageHeaderFormat

public void setMessageHeaderFormat(MessageHeaderFormat value)
Specified by:
setMessageHeaderFormat in interface TargetConfiguration

getMessageHeaderDelimiter

public java.lang.String getMessageHeaderDelimiter()
Description copied from interface: TargetConfigurationExt
Describes the values delimiter char for ShortDSV format.

Specified by:
getMessageHeaderDelimiter in interface TargetConfigurationExt
Returns:
delimiter value.

setMessageHeaderDelimiter

public void setMessageHeaderDelimiter(java.lang.String delimiter)
Description copied from interface: TargetConfigurationExt
Describes the values delimiter char for ShortDSV format.

Specified by:
setMessageHeaderDelimiter in interface TargetConfigurationExt
Parameters:
delimiter - new delimiter value.

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.