Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.commons.broker
Class MessageFilter

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.commons.PredicateBase<Message>
      extended by com.genesyslab.platform.applicationblocks.commons.broker.MessageFilter
All Implemented Interfaces:
Predicate<Message>
Direct Known Subclasses:
MessageIdFilter, MessageNameFilter, MessageRangeFilter

Deprecated. Message Broker Application Block is deprecated. Use setMessageHandler(handler) to handle incoming messages asynchronously.

@Deprecated
public class MessageFilter
extends PredicateBase<Message>

MessageFilter class is designed for filtering messages using protocol description and endpoint name as evaluation criteria.


Constructor Summary
MessageFilter()
          Deprecated. Creates an instance of MessageFilter class.
MessageFilter(boolean isNegated)
          Deprecated. Creates an instance of MessageFilter class.
MessageFilter(boolean isNegated, ProtocolDescription theProtocolDescription)
          Deprecated. Creates an instance of MessageFilter class.
MessageFilter(boolean isNegated, ProtocolDescription theProtocolDescription, java.lang.String theEndpointName)
          Deprecated. Creates an instance of MessageFilter class.
MessageFilter(int protocolId)
          Deprecated. Creates an instance of MessageFilter class.
MessageFilter(ProtocolDescription theProtocolDescription)
          Deprecated. Creates an instance of MessageFilter class.
MessageFilter(ProtocolDescription theProtocolDescription, java.lang.String theEndpointName)
          Deprecated. Creates an instance of MessageFilter class.
 
Method Summary
protected  boolean evaluate(Message message)
          Deprecated. Evaluates a message using protocol description, endpoint name, and protocolId as criteria.
 java.lang.String getEndpointName()
          Deprecated. Gets endpoint name.
 ProtocolDescription getProtocolDescription()
          Deprecated. Gets the protocol description.
 java.lang.Integer getProtocolId()
          Deprecated. Gets the value of the protocol's unique identifier.
 void setEndpointName(java.lang.String theEndpointName)
          Deprecated. Sets endpoint name for filtering.
 void setProtocolDescription(ProtocolDescription theProtocolDescription)
          Deprecated. Sets protocol description for filtering.
 void setProtocolId(java.lang.Integer theProtocolId)
          Deprecated. Sets the value of the protocol's unique identifier.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.commons.PredicateBase
invoke, isNegated, setNegated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MessageFilter

public MessageFilter(boolean isNegated,
                     ProtocolDescription theProtocolDescription,
                     java.lang.String theEndpointName)
Deprecated. 
Creates an instance of MessageFilter class.

Parameters:
isNegated - If true - the predicate is considered as negated: an analog of the logical 'NOT' operation
theProtocolDescription - Description of protocol
theEndpointName - Name of endpoint

MessageFilter

public MessageFilter(ProtocolDescription theProtocolDescription,
                     java.lang.String theEndpointName)
Deprecated. 
Creates an instance of MessageFilter class.

Parameters:
theProtocolDescription - Description of protocol
theEndpointName - Name of endpoint

MessageFilter

public MessageFilter(boolean isNegated,
                     ProtocolDescription theProtocolDescription)
Deprecated. 
Creates an instance of MessageFilter class.

Parameters:
isNegated - If true - the predicate is considered as negated: an analog of the logical 'NOT' operation
theProtocolDescription - Description of protocol

MessageFilter

public MessageFilter(ProtocolDescription theProtocolDescription)
Deprecated. 
Creates an instance of MessageFilter class.

Parameters:
theProtocolDescription - Description of protocol

MessageFilter

public MessageFilter(int protocolId)
Deprecated. 
Creates an instance of MessageFilter class.

Parameters:
protocolId - The protocol's unique identifier as specified by its ProtocolId property

MessageFilter

public MessageFilter(boolean isNegated)
Deprecated. 
Creates an instance of MessageFilter class.

Parameters:
isNegated - If true - the predicate is considered as negated: an analog of the logical 'NOT' operation

MessageFilter

public MessageFilter()
Deprecated. 
Creates an instance of MessageFilter class.

Method Detail

getProtocolDescription

public ProtocolDescription getProtocolDescription()
Deprecated. 
Gets the protocol description.

Returns:
protocol description or null

setProtocolDescription

public void setProtocolDescription(ProtocolDescription theProtocolDescription)
Deprecated. 
Sets protocol description for filtering.

Parameters:
theProtocolDescription - new value for protocol description or null

getEndpointName

public java.lang.String getEndpointName()
Deprecated. 
Gets endpoint name.

Returns:
endpoint name or null

setEndpointName

public void setEndpointName(java.lang.String theEndpointName)
Deprecated. 
Sets endpoint name for filtering.

Parameters:
theEndpointName - new value for endpoint name or null

getProtocolId

public java.lang.Integer getProtocolId()
Deprecated. 
Gets the value of the protocol's unique identifier.


setProtocolId

public void setProtocolId(java.lang.Integer theProtocolId)
Deprecated. 
Sets the value of the protocol's unique identifier.

Parameters:
theProtocolId - new value for protocolId or null

evaluate

protected boolean evaluate(Message message)
Deprecated. 
Evaluates a message using protocol description, endpoint name, and protocolId as criteria. The filter is evaluated as an "and" comparison of those of the above attributes which have been assigned a value. For example, if the protocol description and endpoint are specified while protocolId isn't, protocolId will be ignored in the evaluation and this method will return true if both the endpoint and protocol description match the values in IMessage.

Specified by:
evaluate in class PredicateBase<Message>
Parameters:
message - A message targeted for evaluation
Returns:
true if the filter's properties match their counterparts in Message, otherwise returns false

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.