org.lateralnz.messaging
Class AbstractMessageHandler

java.lang.Object
  org.lateralnz.messaging.AbstractMessageHandler

All Implemented Interfaces:

java.io.Serializable, Constants, MessageHandler

Direct Known Subclasses:

BroadcastMessageHandler, DNMessageHandler, LRMPMessageHandler

public abstract class AbstractMessageHandler
extends java.lang.Object
implements MessageHandler, Constants, java.io.Serializable

an abstract message handler that implements the supporting regex methods

See Also:

Serialized Form

Field Summary

protected java.net.InetAddress	addr
protected java.util.Map	listeners
protected int	port

Fields inherited from interface org.lateralnz.common.util.Constants

AMPERSAND, AND, APPLICATION_X_WWW_FORM_URLENCODED, ASTERISK, AT, BACK_SLASH, CHAR_LEFT_CHEV, CHAR_RIGHT_CHEV, COLON, COMMA, CRLF, DASH, DELETE, DOLLAR, DOT, DOT_CLASS, DOT_JAVA, EIGHT, EMPTY, EQUALS, FALSE, FILE_SEPARATOR, FIVE, FORWARD_SLASH, FOUR, FULLSTOP, HASH, HAT, INSERT, LEFT_BRACE, LEFT_BRACKET, LEFT_CHEV, MAX_LEN_APPCODE, MAX_LEN_APPGROUP, MAX_LEN_MSGCODE, MAX_LEN_MSGTEXT, MINUS_ONE, N, NEWLINE, NINE, NO, NULL_STRING, OFF, ON, ONE, ONE_DAY, ONE_HOUR, ONE_MINUTE, ONE_WEEK, PATH_SEPARATOR, PERCENT, PIPE, PLUS, QUESTION_MARK, QUOTE, REQUIRED, REQUIRES_NEW, RETURN, RIGHT_BRACE, RIGHT_BRACKET, RIGHT_CHEV, SELECT, SEMICOLON, SEVEN, SINGLE_QUOTE, SIX, SPACE, SQ_LEFT_BRACKET, SQ_RIGHT_BRACKET, SUPPORTS, TEXT_HTML, TEXT_PLAIN, TEXT_XML, THREE, TRUE, TWO, UNDERSCORE, UPDATE, UTF_8, Y, YES, ZERO

Constructor Summary

AbstractMessageHandler()

Method Summary

void	addListener(java.lang.String group, MessageListener listener) add a message listener to this handler.
void	notifyListeners(Message msg)
void	setAddress(java.net.InetAddress addr, int port) the inet address this handler is running against
void	setAllowedGroupRegex(java.lang.String regex, int priority) a regular expression describing the group(s) that are allowed to send messages.
void	setDisallowedGroupRegex(java.lang.String regex, int priority) a regular expression describing the group(s) that are -not- allowed to send messages
boolean	willTransmit(java.lang.String group) returns whether transmission will be allowed for a group based upon the allowed/disallowed regular expressions.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lateralnz.messaging.MessageHandler

send

Field Detail

listeners

protected java.util.Map listeners

addr

protected java.net.InetAddress addr

port

protected int port

Constructor Detail

AbstractMessageHandler

public AbstractMessageHandler()

Method Detail

addListener

public void addListener(java.lang.String group,
                        MessageListener listener)

Description copied from interface: MessageHandler

add a message listener to this handler.

Specified by:

addListener in interface MessageHandler

Parameters:

group - the group of messages that a listener is interested in receiving

listener - the message listener object

notifyListeners

public void notifyListeners(Message msg)

setAddress

public void setAddress(java.net.InetAddress addr,
                       int port)

the inet address this handler is running against

setAllowedGroupRegex

public void setAllowedGroupRegex(java.lang.String regex,
                                 int priority)

Description copied from interface: MessageHandler

a regular expression describing the group(s) that are allowed to send messages. A priority is also included which, if higher than the disallowed ex

Specified by:

setAllowedGroupRegex in interface MessageHandler

Parameters:

regex - a regular expression

priority - what priority the allowed expression has over the disallowed group

setDisallowedGroupRegex

public void setDisallowedGroupRegex(java.lang.String regex,
                                    int priority)

Description copied from interface: MessageHandler

a regular expression describing the group(s) that are -not- allowed to send messages

Specified by:

setDisallowedGroupRegex in interface MessageHandler

Parameters:

regex - a regular expression

priority - what priority the disallowed expression has over the allowed group

willTransmit

public boolean willTransmit(java.lang.String group)

Description copied from interface: MessageHandler

returns whether transmission will be allowed for a group based upon the allowed/disallowed regular expressions.

Specified by:

willTransmit in interface MessageHandler

Parameters:

group - the group to test