Platform SDK Java 8.5 API Reference

com.genesyslab.platform.logging.configuration
Class NetworkTargetConfigurationImpl

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

public final class NetworkTargetConfigurationImpl
extends TargetConfigurationImpl
implements NetworkTargetConfiguration


Constructor Summary
NetworkTargetConfigurationImpl(boolean isEnabled, VerboseLevel verbose, Buffering buffering, int bufferCapacity, java.lang.String spoolFile, java.lang.Long expire, java.lang.String filter, MessageHeaderFormat fmt)
          Constructor.
NetworkTargetConfigurationImpl(boolean isEnabled, VerboseLevel verbose, Buffering buffering, int bufferCapacity, java.lang.String spoolFile, java.lang.Long expire, java.lang.String filter, MessageHeaderFormat fmt, java.lang.String hdrDelim)
          Constructor.
NetworkTargetConfigurationImpl(boolean isEnabled, VerboseLevel verbose, java.lang.String filter)
           
NetworkTargetConfigurationImpl(NetworkTargetConfiguration configuration)
           
 
Method Summary
 Buffering getBuffering()
          This property configures the options of buffering usage.
 java.lang.Long getExpire()
          The expiration term for messages in the queue.
 int getInMemoryBufferCapacity()
          This property sets the capacity of in-memory buffers.
 java.lang.String getSpoolFile()
          The name of the spool file.
 void setBuffering(Buffering value)
           
 void setExpire(java.lang.Long value)
           
 void setInMemoryBufferCapacity(int value)
           
 void setSpoolFile(java.lang.String value)
           
 java.lang.String toString()
           
 
Methods inherited from class com.genesyslab.platform.logging.configuration.TargetConfigurationImpl
getFilter, getMessageHeaderDelimiter, getMessageHeaderFormat, getVerbose, isEnabled, isReadOnly, setEnabled, setFilter, setMessageHeaderDelimiter, setMessageHeaderFormat, 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, getMessageHeaderFormat, getVerbose, isEnabled, isReadOnly, setEnabled, setFilter, setMessageHeaderFormat, setVerbose
 

Constructor Detail

NetworkTargetConfigurationImpl

public NetworkTargetConfigurationImpl(boolean isEnabled,
                                      VerboseLevel verbose,
                                      java.lang.String filter)

NetworkTargetConfigurationImpl

public NetworkTargetConfigurationImpl(boolean isEnabled,
                                      VerboseLevel verbose,
                                      Buffering buffering,
                                      int bufferCapacity,
                                      java.lang.String spoolFile,
                                      java.lang.Long expire,
                                      java.lang.String filter,
                                      MessageHeaderFormat fmt)
Constructor.

Parameters:
isEnabled - Value for TargetConfiguration.getVerbose()
buffering - Value for Buffering
bufferCapacity - buffer capacity
spoolFile - file name
expire - Expire
filter - Filter by source name

NetworkTargetConfigurationImpl

public NetworkTargetConfigurationImpl(boolean isEnabled,
                                      VerboseLevel verbose,
                                      Buffering buffering,
                                      int bufferCapacity,
                                      java.lang.String spoolFile,
                                      java.lang.Long expire,
                                      java.lang.String filter,
                                      MessageHeaderFormat fmt,
                                      java.lang.String hdrDelim)
Constructor.

Parameters:
isEnabled - value for TargetConfiguration.getVerbose()
buffering - value for Buffering
bufferCapacity - buffer capacity
spoolFile - file name
expire - expire
filter - filter by source name
fmt - Message header format
hdrDelim - delimiter for SHORT_DSV Message header format

NetworkTargetConfigurationImpl

public NetworkTargetConfigurationImpl(NetworkTargetConfiguration configuration)
Method Detail

getBuffering

public Buffering getBuffering()
This property configures the options of buffering usage. If the buffering is enabled, the SpoolFile property must be set to valid spool file name.

Specified by:
getBuffering in interface NetworkTargetConfiguration

setBuffering

public void setBuffering(Buffering value)
Specified by:
setBuffering in interface NetworkTargetConfiguration

getInMemoryBufferCapacity

public int getInMemoryBufferCapacity()
This property sets the capacity of in-memory buffers. The in-memory buffers are used for putting messages in the queue (put-buffer) and for taking messages from the queue (get-buffer). The value of this property is the maximum capacity of above mentioned get- and put- buffers.

Specified by:
getInMemoryBufferCapacity in interface NetworkTargetConfiguration

setInMemoryBufferCapacity

public void setInMemoryBufferCapacity(int value)
Specified by:
setInMemoryBufferCapacity in interface NetworkTargetConfiguration

getSpoolFile

public java.lang.String getSpoolFile()
The name of the spool file. Actual spool file name will be 'SpoolFile'.'queue id'.'Timestamp'.qsp

Specified by:
getSpoolFile in interface NetworkTargetConfiguration

setSpoolFile

public void setSpoolFile(java.lang.String value)
Specified by:
setSpoolFile in interface NetworkTargetConfiguration

getExpire

public java.lang.Long getExpire()
The expiration term for messages in the queue. When message's age becomes more than specified by this property the message can be removed due to expiration. Minimal allowed value - 1 hour. Please note, that the expired message is not guaranteed to be removed - it will be in the buffer till the age-check and can be sent to message server before age - check occurs.

Specified by:
getExpire in interface NetworkTargetConfiguration

setExpire

public void setExpire(java.lang.Long value)
Specified by:
setExpire in interface NetworkTargetConfiguration

toString

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

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.