Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.filtering.impl
Class FilterChain

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.FilterChain
All Implemented Interfaces:
MessageFilter, java.lang.Cloneable

public final class FilterChain
extends java.lang.Object
implements MessageFilter, java.lang.Cloneable

This class represents composition of message filters.


Nested Class Summary
static class FilterChain.FilterChainEntry
           
static class FilterChain.FilterResult
           
 
Constructor Summary
FilterChain()
          Creates instance of FilterChain.
FilterChain(FilterContext context)
          Creates instance of FilterChain with specified context.
 
Method Summary
 void applyFilters(java.util.ArrayList<FilterChain.FilterChainEntry> newFilters)
          Applies new filters (the old filters will be replaced).
 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.
 FilterContext getContext()
          Gets filter context.
 java.util.ArrayList<BaseFilter> getFilters()
          Gets ArrayList of filters.
 boolean isMessageAccepted(Message message)
          Evaluates whether message is accepted by filter.
 void removeAllFilters()
          Removes all filters.
 boolean setCanTrace(boolean value)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilterChain

public FilterChain()
            throws java.lang.NullPointerException
Creates instance of FilterChain.

Throws:
java.lang.NullPointerException

FilterChain

public FilterChain(FilterContext context)
            throws java.lang.NullPointerException
Creates instance of FilterChain with specified context.

Parameters:
context - filter context stores filter variables.
Throws:
java.lang.NullPointerException - if context argument is null.
Method Detail

getContext

public FilterContext getContext()
Gets filter context.

Returns:
filter context.

isMessageAccepted

public boolean isMessageAccepted(Message message)
Evaluates whether message is accepted by filter.

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

applyFilters

public void applyFilters(java.util.ArrayList<FilterChain.FilterChainEntry> newFilters)
                  throws java.lang.NullPointerException
Applies new filters (the old filters will be replaced).

Parameters:
entries - new list of filters.
Throws:
java.lang.NullPointerException - if argument filters is null.

getFilters

public java.util.ArrayList<BaseFilter> getFilters()
Gets ArrayList of filters.

Returns:
filters.

removeAllFilters

public void removeAllFilters()
Removes all filters.


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.

setCanTrace

public boolean setCanTrace(boolean 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.