Platform SDK Java 8.5 API Reference

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

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.filtering.impl.BaseFilter
All Implemented Interfaces:
java.lang.Cloneable
Direct Known Subclasses:
DefaultFilter, FilterGroup

public abstract class BaseFilter
extends java.lang.Object
implements java.lang.Cloneable

Base class for filters that can be processed by a FilterChain


Constructor Summary
BaseFilter(java.lang.String key)
          Creates message filter.
 
Method Summary
 java.lang.Object clone()
          Clones this message filter.
protected  void doRegister(FilterContext context)
          Registers filter variables and so on.
protected  void doUnregister(FilterContext context)
          Unregisters filter variables and so on.
 java.lang.String getKey()
          Gets filter name.
abstract  boolean isMessageAccepted(Message message, FilterContext context)
          Evaluates whether message is accepted by filter.
 boolean isRegistered()
           
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseFilter

public BaseFilter(java.lang.String key)
Creates message filter.

Parameters:
key - message filter key.
Method Detail

getKey

public java.lang.String getKey()
Gets filter name.


isMessageAccepted

public abstract boolean isMessageAccepted(Message message,
                                          FilterContext context)
Evaluates whether message is accepted by filter.

Parameters:
message - The message to evaluate
context - Filter context, where data for message evaluation, like filter variables, can be stored.
Returns:
true if message should be accepted else - false.

clone

public java.lang.Object clone()
Clones this message filter.

Overrides:
clone in class java.lang.Object
Returns:
clone of this message filter.

isRegistered

public boolean isRegistered()

doRegister

protected void doRegister(FilterContext context)
Registers filter variables and so on.

Parameters:
context - filter context.

doUnregister

protected void doUnregister(FilterContext context)
Unregisters filter variables and so on.

Parameters:
context - filter context.

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.