org.apache.mina.filter.util

Class CommonEventFilter

java.lang.Object

org.apache.mina.core.filterchain.IoFilterAdapter

org.apache.mina.filter.util.CommonEventFilter

All Implemented Interfaces:

IoFilter

Direct Known Subclasses:

MdcInjectionFilter

public abstract class CommonEventFilter
extends IoFilterAdapter

Extend this class when you want to create a filter that wraps the same logic around all 11 IoEvents

Author:

Apache MINA Project

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.mina.core.filterchain.IoFilter

IoFilter.NextFilter

Constructor Summary

Constructors

Constructor and Description
CommonEventFilter()

Method Summary

Modifier and Type	Method and Description
void	event(IoFilter.NextFilter nextFilter, IoSession session, FilterEvent event) Propagate an event up to the IoHandler
void	exceptionCaught(IoFilter.NextFilter nextFilter, IoSession session, Throwable cause) Filters IoHandler.exceptionCaught(IoSession,Throwable) event.
protected abstract void	filter(IoFilterEvent event)
void	filterClose(IoFilter.NextFilter nextFilter, IoSession session) Filters IoSession.closeNow() or a IoSession.closeOnFlush() method invocations.
void	filterWrite(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest) Filters IoSession.write(Object) method invocation.
void	inputClosed(IoFilter.NextFilter nextFilter, IoSession session) Filters IoHandler.inputClosed(IoSession) event.
void	messageReceived(IoFilter.NextFilter nextFilter, IoSession session, Object message) Filters IoHandler.messageReceived(IoSession,Object) event.
void	messageSent(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest) Filters IoHandler.messageSent(IoSession,Object) event.
void	sessionClosed(IoFilter.NextFilter nextFilter, IoSession session) Filters IoHandler.sessionClosed(IoSession) event.
void	sessionCreated(IoFilter.NextFilter nextFilter, IoSession session) Filters IoHandler.sessionCreated(IoSession) event.
void	sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status) Filters IoHandler.sessionIdle(IoSession,IdleStatus) event.
void	sessionOpened(IoFilter.NextFilter nextFilter, IoSession session) Filters IoHandler.sessionOpened(IoSession) event.

Methods inherited from class org.apache.mina.core.filterchain.IoFilterAdapter

destroy, init, onPostAdd, onPostRemove, onPreAdd, onPreRemove, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonEventFilter

public CommonEventFilter()

Method Detail

filter

protected abstract void filter(IoFilterEvent event)
                        throws Exception

Throws:

Exception

event

public void event(IoFilter.NextFilter nextFilter,
                  IoSession session,
                  FilterEvent event)
           throws Exception

Propagate an event up to the IoHandler

Specified by:

event in interface IoFilter

Overrides:

event in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has to process this invocation

event - The event to propagate

Throws:

Exception - If an error occurred while processing the event

exceptionCaught

public final void exceptionCaught(IoFilter.NextFilter nextFilter,
                                  IoSession session,
                                  Throwable cause)
                           throws Exception

Filters IoHandler.exceptionCaught(IoSession,Throwable) event.

Specified by:

exceptionCaught in interface IoFilter

Overrides:

exceptionCaught in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

cause - The exception that cause this event to be received

Throws:

Exception - If an error occurred while processing the event

filterClose

public final void filterClose(IoFilter.NextFilter nextFilter,
                              IoSession session)
                       throws Exception

Filters IoSession.closeNow() or a IoSession.closeOnFlush() method invocations.

Specified by:

filterClose in interface IoFilter

Overrides:

filterClose in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has to process this method invocation

Throws:

Exception - If an error occurred while processing the event

filterWrite

public final void filterWrite(IoFilter.NextFilter nextFilter,
                              IoSession session,
                              WriteRequest writeRequest)
                       throws Exception

Filters IoSession.write(Object) method invocation.

Specified by:

filterWrite in interface IoFilter

Overrides:

filterWrite in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has to process this invocation

writeRequest - The WriteRequest to process

Throws:

Exception - If an error occurred while processing the event

inputClosed

public void inputClosed(IoFilter.NextFilter nextFilter,
                        IoSession session)
                 throws Exception

Filters IoHandler.inputClosed(IoSession) event.

Specified by:

inputClosed in interface IoFilter

Overrides:

inputClosed in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

Throws:

Exception - If an error occurred while processing the event

messageReceived

public final void messageReceived(IoFilter.NextFilter nextFilter,
                                  IoSession session,
                                  Object message)
                           throws Exception

Filters IoHandler.messageReceived(IoSession,Object) event.

Specified by:

messageReceived in interface IoFilter

Overrides:

messageReceived in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

message - The received message

Throws:

Exception - If an error occurred while processing the event

messageSent

public final void messageSent(IoFilter.NextFilter nextFilter,
                              IoSession session,
                              WriteRequest writeRequest)
                       throws Exception

Filters IoHandler.messageSent(IoSession,Object) event.

Specified by:

messageSent in interface IoFilter

Overrides:

messageSent in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

writeRequest - The WriteRequest that contains the sent message

Throws:

Exception - If an error occurred while processing the event

sessionClosed

public final void sessionClosed(IoFilter.NextFilter nextFilter,
                                IoSession session)
                         throws Exception

Filters IoHandler.sessionClosed(IoSession) event.

Specified by:

sessionClosed in interface IoFilter

Overrides:

sessionClosed in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

Throws:

Exception - If an error occurred while processing the event

sessionCreated

public final void sessionCreated(IoFilter.NextFilter nextFilter,
                                 IoSession session)
                          throws Exception

Filters IoHandler.sessionCreated(IoSession) event.

Specified by:

sessionCreated in interface IoFilter

Overrides:

sessionCreated in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

Throws:

Exception - If an error occurred while processing the event

sessionIdle

public final void sessionIdle(IoFilter.NextFilter nextFilter,
                              IoSession session,
                              IdleStatus status)
                       throws Exception

Filters IoHandler.sessionIdle(IoSession,IdleStatus) event.

Specified by:

sessionIdle in interface IoFilter

Overrides:

sessionIdle in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

status - The IdleStatus type

Throws:

Exception - If an error occurred while processing the event

sessionOpened

public final void sessionOpened(IoFilter.NextFilter nextFilter,
                                IoSession session)
                         throws Exception

Filters IoHandler.sessionOpened(IoSession) event.

Specified by:

sessionOpened in interface IoFilter

Overrides:

sessionOpened in class IoFilterAdapter

Parameters:

nextFilter - the IoFilter.NextFilter for this filter. You can reuse this object until this filter is removed from the chain.

session - The IoSession which has received this event

Throws:

Exception - If an error occurred while processing the event