Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.filtering.impl.configuration
Class FilterChainConfiguration

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.configuration.FilterChainConfiguration
All Implemented Interfaces:
MessageFilter

public class FilterChainConfiguration
extends java.lang.Object
implements MessageFilter

This class keeps filter chain FilterChain and it's settings that can be modified at runtime.


Constructor Summary
FilterChainConfiguration(int appDBID, int targetAppDBID)
          Creates FilterChainConfiguration object.
FilterChainConfiguration(int appDBID, int targetAppDBID, FilterContext context)
          Creates FilterChainConfiguration object.
 
Method Summary
 void applyFilterList(java.util.List<BaseFilter> filters)
          Registers new available filter objects for this chain.
 boolean canTrace()
          In addition to MessageFilter.isMessageAccepted(Message) which controls message content log, this option can enable or disable additional log entries like "New message#", "Complete message handling" and so on.
 void clear()
          Removes all filter instances.
 int getApplicationDBID()
          Returns DBID of the application, where filters are declared.
 java.util.List<BaseFilter> getFilterList()
          Returns the shallow copy of available filter instances list.
 int getTargetApplicationDBID()
          Returns DBID of the application, to which client protocol connected.
 boolean isMessageAccepted(Message message)
          This method uses internal FilterChain object with pre-configured Log Filters to evaluate if message can be logged.
 void resetContext()
          Clears filter context.
 void save()
          Applies changes, made in filter list or in filter definition, to the filter chain object.
 void setCanTrace(boolean value)
          Enables or disables tracing log entries like "New message# " and so on.
 boolean setEnabledFilters(java.util.List<FilterChainFactory.EntryConfiguration> entryList)
          Filter entry that should be used in this filter chain.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterChainConfiguration

public FilterChainConfiguration(int appDBID,
                                int targetAppDBID)
Creates FilterChainConfiguration object. The appDBID and targetAppDBID can be used to identify application configuration updates sent by Configuration Server.

Parameters:
appDBID - The application DBID where filters are declared.
targetAppDBID - The DBID of application to which DuplecChannel with assigned FilterChainConfiguration is connected.

FilterChainConfiguration

public FilterChainConfiguration(int appDBID,
                                int targetAppDBID,
                                FilterContext context)
Creates FilterChainConfiguration object. The appDBID and targetAppDBID should be used to identify application configuration updates sent by Configuration Server.

Parameters:
appDBID - The application DBID where filters are declared.
targetAppDBID - The DBID of application to which DuplecChannel with assigned FilterChainConfiguration is connected.
context - Filter context where filter variables or other data is stored.
Method Detail

getApplicationDBID

public int getApplicationDBID()
Returns DBID of the application, where filters are declared.

Returns:

getTargetApplicationDBID

public int getTargetApplicationDBID()
Returns DBID of the application, to which client protocol connected.

Returns:

getFilterList

public java.util.List<BaseFilter> getFilterList()
Returns the shallow copy of available filter instances list.

Returns:
list of filters

applyFilterList

public void applyFilterList(java.util.List<BaseFilter> filters)
Registers new available filter objects for this chain.

Parameters:
key - filter name
filter - filter object

setEnabledFilters

public boolean setEnabledFilters(java.util.List<FilterChainFactory.EntryConfiguration> entryList)
Filter entry that should be used in this filter chain.

Parameters:
entry - List of filter entries, assigned to the protocol
Returns:
Returns true if list was updated

save

public void save()
Applies changes, made in filter list or in filter definition, to the filter chain object.


clear

public void clear()
Removes all filter instances.


resetContext

public void resetContext()
Clears filter context.


isMessageAccepted

public boolean isMessageAccepted(Message message)
This method uses internal FilterChain object with pre-configured Log Filters to evaluate if message can be logged.

Specified by:
isMessageAccepted in interface MessageFilter
Parameters:
message - for filtering
Returns:
true if message is accepted by filter else return false.

setCanTrace

public void setCanTrace(boolean value)
Enables or disables tracing log entries like "New message# " and so on.

Parameters:
value -

canTrace

public boolean canTrace()
Description copied from interface: MessageFilter
In addition to MessageFilter.isMessageAccepted(Message) which controls message content log, this option can enable or disable additional log entries like "New message#", "Complete message handling" and so on.

Specified by:
canTrace in interface MessageFilter
Returns:
boolean value to disable or enable trace log entries.

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.