Package org.apache.mina.core.filterchain

Class IoFilterAdapter

java.lang.Object

org.apache.mina.core.filterchain.IoFilterAdapter

All Implemented Interfaces:

IoFilter

Direct Known Subclasses:

AbstractStreamWriteFilter, BlacklistFilter, BufferedWriteFilter, CommonEventFilter, ConnectionThrottleFilter, ErrorGeneratingFilter, ExecutorFilter, KeepAliveFilter, LoggingFilter, NoopFilter, ProfilerTimerFilter, ProtocolCodecFilter, ProxyFilter, ReferenceCountingFilter, SaslFilter, SessionAttributeInitializingFilter, SslFilter, WriteRequestFilter

public class IoFilterAdapter
extends Object
implements IoFilter

An adapter class for IoFilter. You can extend this class and selectively override required event filter methods only. All methods forwards events to the next filter by default.

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	Description
IoFilterAdapter()

Method Summary

Modifier and Type	Method	Description
void	destroy()	Invoked by ReferenceCountingFilter when this filter is not used by any IoFilterChain anymore, so you can destroy shared resources.
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.
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	init()	Invoked by ReferenceCountingFilter when this filter is added to a IoFilterChain at the first time, so you can initialize shared resources.
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	onPostAdd(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter)	Invoked after this filter is added to the specified parent.
void	onPostRemove(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter)	Invoked after this filter is removed from the specified parent.
void	onPreAdd(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter)	Invoked before this filter is added to the specified parent.
void	onPreRemove(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter)	Invoked before this filter is removed from the specified parent.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IoFilterAdapter

public IoFilterAdapter()

Method Detail

init

public void init()
          throws Exception

Invoked by ReferenceCountingFilter when this filter is added to a IoFilterChain at the first time, so you can initialize shared resources. Please note that this method is never called if you don't wrap a filter with ReferenceCountingFilter.

Specified by:

init in interface IoFilter

Throws:

Exception - If an error occurred while processing the event

destroy

public void destroy()
             throws Exception

Invoked by ReferenceCountingFilter when this filter is not used by any IoFilterChain anymore, so you can destroy shared resources. Please note that this method is never called if you don't wrap a filter with ReferenceCountingFilter.

Specified by:

destroy in interface IoFilter

Throws:

Exception - If an error occurred while processing the event

onPreAdd

public void onPreAdd(IoFilterChain parent,
                     String name,
                     IoFilter.NextFilter nextFilter)
              throws Exception

Invoked before this filter is added to the specified parent. Please note that this method can be invoked more than once if this filter is added to more than one parents. This method is not invoked before IoFilter.init() is invoked.

Specified by:

onPreAdd in interface IoFilter

Parameters:

parent - the parent who called this method

name - the name assigned to this filter

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

Throws:

Exception - If an error occurred while processing the event

onPostAdd

public void onPostAdd(IoFilterChain parent,
                      String name,
                      IoFilter.NextFilter nextFilter)
               throws Exception

Invoked after this filter is added to the specified parent. Please note that this method can be invoked more than once if this filter is added to more than one parents. This method is not invoked before IoFilter.init() is invoked.

Specified by:

onPostAdd in interface IoFilter

Parameters:

parent - the parent who called this method

name - the name assigned to this filter

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

Throws:

Exception - If an error occurred while processing the event

onPreRemove

public void onPreRemove(IoFilterChain parent,
                        String name,
                        IoFilter.NextFilter nextFilter)
                 throws Exception

Invoked before this filter is removed from the specified parent. Please note that this method can be invoked more than once if this filter is removed from more than one parents. This method is always invoked before IoFilter.destroy() is invoked.

Specified by:

onPreRemove in interface IoFilter

Parameters:

parent - the parent who called this method

name - the name assigned to this filter

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

Throws:

Exception - If an error occurred while processing the event

onPostRemove

public void onPostRemove(IoFilterChain parent,
                         String name,
                         IoFilter.NextFilter nextFilter)
                  throws Exception

Invoked after this filter is removed from the specified parent. Please note that this method can be invoked more than once if this filter is removed from more than one parents. This method is always invoked before IoFilter.destroy() is invoked.

Specified by:

onPostRemove in interface IoFilter

Parameters:

parent - the parent who called this method

name - the name assigned to this filter

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

Throws:

Exception - If an error occurred while processing the event

sessionCreated

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

Filters IoHandler.sessionCreated(IoSession) event.

Specified by:

sessionCreated in interface IoFilter

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

sessionOpened

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

Filters IoHandler.sessionOpened(IoSession) event.

Specified by:

sessionOpened in interface IoFilter

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

sessionClosed

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

Filters IoHandler.sessionClosed(IoSession) event.

Specified by:

sessionClosed in interface IoFilter

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 void sessionIdle(IoFilter.NextFilter nextFilter,
                        IoSession session,
                        IdleStatus status)
                 throws Exception

Filters IoHandler.sessionIdle(IoSession,IdleStatus) event.

Specified by:

sessionIdle in interface IoFilter

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

exceptionCaught

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

Filters IoHandler.exceptionCaught(IoSession,Throwable) event.

Specified by:

exceptionCaught in interface IoFilter

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

messageReceived

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

Filters IoHandler.messageReceived(IoSession,Object) event.

Specified by:

messageReceived in interface IoFilter

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 void messageSent(IoFilter.NextFilter nextFilter,
                        IoSession session,
                        WriteRequest writeRequest)
                 throws Exception

Filters IoHandler.messageSent(IoSession,Object) event.

Specified by:

messageSent in interface IoFilter

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

filterWrite

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

Filters IoSession.write(Object) method invocation.

Specified by:

filterWrite in interface IoFilter

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

filterClose

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

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

Specified by:

filterClose in interface IoFilter

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

inputClosed

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

Filters IoHandler.inputClosed(IoSession) event.

Specified by:

inputClosed in interface IoFilter

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

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

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

toString

public String toString()

Overrides:

toString in class Object