org.qbroker.jms

Class MessageFilter

java.lang.Object

org.qbroker.jms.MessageFilter

All Implemented Interfaces:

Filter<javax.jms.Message>

public class MessageFilter
extends java.lang.Object
implements Filter<javax.jms.Message>

MessageFilter is a client side filter with an internal formatter. The method of evaluate() returns true if the filter matches the message. Otherwise, it returns false. The method of format is to format the message with the internal formatter. To skip loading the internal formatter, please make sure ClassName defined.

As to formatter, you can define TemplateMap and/or SubstitutionMap in the property Map. It will update the maps and try to reuse the objects already created.

Author:

yannanlu@yahoo.com

Field Summary

Fields

Modifier and Type	Field and Description
static int	RESET_ALL
static int	RESET_MAP
static int	RESET_NONE
static int	RESET_SOME

Constructor Summary

Constructors

Constructor and Description
MessageFilter(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
boolean	checkBody()
boolean	checkHeader()
void	clear()
boolean	evaluate(long tm, javax.jms.Message message) returns true if the filter matching with the event or false otherwise
boolean	evaluate(javax.jms.Message message, java.lang.String msgStr) It applies the Perl5 pattern match on the message and returns true if the filter gets a hit or false otherwise.
boolean	evaluate(java.lang.String msgStr) evaluates the msgStr as the message body only
protected void	finalize()
int	format(javax.jms.Message message, byte[] buffer) formats the message with the predefined formatter and returns number of fields modified upon success.
static java.util.Map<java.lang.String,java.lang.Object>[]	getPatternMaps(java.lang.String name, java.util.Map ph, org.apache.oro.text.regex.Perl5Compiler pc) returns an array of Map with a group of patterns in each of them
static org.apache.oro.text.regex.Pattern[][]	getPatterns(java.lang.String name, java.util.Map ph, org.apache.oro.text.regex.Perl5Compiler pc) returns an array of pattern groups with the name from property Map
boolean	hasFormatter()
static MessageFilter[]	initFilters(java.util.Map ph)
boolean	updatedBody()

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RESET_NONE

public static final int RESET_NONE

See Also:

Constant Field Values

RESET_SOME

public static final int RESET_SOME

See Also:

Constant Field Values

RESET_ALL

public static final int RESET_ALL

See Also:

Constant Field Values

RESET_MAP

public static final int RESET_MAP

See Also:

Constant Field Values

Constructor Detail

MessageFilter

public MessageFilter(java.util.Map props)

Method Detail

getPatterns

public static org.apache.oro.text.regex.Pattern[][] getPatterns(java.lang.String name,
                                                                java.util.Map ph,
                                                                org.apache.oro.text.regex.Perl5Compiler pc)
                                                         throws org.apache.oro.text.regex.MalformedPatternException

returns an array of pattern groups with the name from property Map

Throws:

org.apache.oro.text.regex.MalformedPatternException

getPatternMaps

public static java.util.Map<java.lang.String,java.lang.Object>[] getPatternMaps(java.lang.String name,
                                                                                java.util.Map ph,
                                                                                org.apache.oro.text.regex.Perl5Compiler pc)
                                                                         throws org.apache.oro.text.regex.MalformedPatternException

returns an array of Map with a group of patterns in each of them

Throws:

org.apache.oro.text.regex.MalformedPatternException

evaluate

public boolean evaluate(long tm,
                        javax.jms.Message message)

Description copied from interface: Filter

returns true if the filter matching with the event or false otherwise

Specified by:

evaluate in interface Filter<javax.jms.Message>

evaluate

public boolean evaluate(javax.jms.Message message,
                        java.lang.String msgStr)
                 throws javax.jms.JMSException

It applies the Perl5 pattern match on the message and returns true if the filter gets a hit or false otherwise. In case there are patterns for message body, it requires the content of the message body ready.

Throws:

javax.jms.JMSException

evaluate

public boolean evaluate(java.lang.String msgStr)

evaluates the msgStr as the message body only

format

public int format(javax.jms.Message message,
                  byte[] buffer)
           throws javax.jms.JMSException

formats the message with the predefined formatter and returns number of fields modified upon success.

Throws:

javax.jms.JMSException

initFilters

public static MessageFilter[] initFilters(java.util.Map ph)

checkHeader

public boolean checkHeader()

checkBody

public boolean checkBody()

updatedBody

public boolean updatedBody()

hasFormatter

public boolean hasFormatter()

clear

public void clear()

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object