net.sf.beep4j
Interface ChannelFilter

public interface ChannelFilter

A ChannelFilter is meant to be used to implement cross-cutting concerns, such as logging, message transformations, and security. Each channel can have 0 or more such filters that are arranged in a chain.

Author:

Simon Raess

Nested Class Summary

static interface

ChannelFilter.NextFilter Interface of the next filter in the chain.

Method Summary

void	filterChannelClosed(ChannelFilter.NextFilter next) Filters ChannelHandler.channelClosed().
void	filterChannelCloseRequested(ChannelFilter.NextFilter next, CloseChannelRequest request) Filters ChannelHandler.channelCloseRequested(CloseChannelRequest).
void	filterChannelOpened(ChannelFilter.NextFilter next, Channel channel) Filters ChannelHandler.channelOpened(Channel).
void	filterClose(ChannelFilter.NextFilter next) Filters Channel.close(CloseChannelCallback).
void	filterMessageReceived(ChannelFilter.NextFilter next, Message message, Reply responseHandler) Filters ChannelHandler.messageReceived(Message, Reply).
void	filterSendMessage(ChannelFilter.NextFilter next, java.lang.Object message, ReplyHandler listener) Filters Channel.sendMessage(Message, ReplyHandler).

Method Detail

filterSendMessage

void filterSendMessage(ChannelFilter.NextFilter next,
                       java.lang.Object message,
                       ReplyHandler listener)

Filters Channel.sendMessage(Message, ReplyHandler).

Parameters:

next - the next filter in the chain

message - the message that is to be sent

listener - the listener that processes the reply for this message

filterClose

void filterClose(ChannelFilter.NextFilter next)

Filters Channel.close(CloseChannelCallback).

Parameters:

next - the next filter in the chain

filterChannelOpened

void filterChannelOpened(ChannelFilter.NextFilter next,
                         Channel channel)

Filters ChannelHandler.channelOpened(Channel).

Parameters:

next - the next filter in the chain

channel - the channel that was opened

filterMessageReceived

void filterMessageReceived(ChannelFilter.NextFilter next,
                           Message message,
                           Reply responseHandler)

Filters ChannelHandler.messageReceived(Message, Reply).

Parameters:

next - the next filter in the chain

message - the message that is received

responseHandler - to be used to create the response for the received message

filterChannelCloseRequested

void filterChannelCloseRequested(ChannelFilter.NextFilter next,
                                 CloseChannelRequest request)

Filters ChannelHandler.channelCloseRequested(CloseChannelRequest).

Parameters:

next - the next filter in the chain

request - the close channel request

filterChannelClosed

void filterChannelClosed(ChannelFilter.NextFilter next)

Filters ChannelHandler.channelClosed().

Parameters:

next - the next filter in the chain