org.lateralnz.messaging
Interface MessageHandler

All Known Implementing Classes:

AbstractMessageHandler, BroadcastMessageHandler, DNMessageHandler, LRMPMessageHandler, MulticastMessageHandler

public interface MessageHandler

Method Summary

void	addListener(java.lang.String group, MessageListener listener) add a message listener to this handler.
void	send(Message msg) send a message
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.

Method Detail

addListener

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

add a message listener to this handler.

Parameters:

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

listener - the message listener object

willTransmit

boolean willTransmit(java.lang.String group)

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

Parameters:

group - the group to test

send

void send(Message msg)
          throws java.io.IOException

send a message

Parameters:

msg - the message object to send

Throws:

java.io.IOException

setAllowedGroupRegex

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

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

Parameters:

regex - a regular expression

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

setDisallowedGroupRegex

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

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

Parameters:

regex - a regular expression

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