|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A filter which intercepts IoHandler
events like Servlet
filters. Filters can be used for these purposes:
Please NEVER implement your filters to wrap
IoSession
s. Users can cache the reference to the
session, which might malfunction if any filters are added or removed later.
IoFilter
s are activated only when they are inside IoFilterChain
.
When you add an IoFilter
to an IoFilterChain
:
init()
is invoked by ReferenceCountingIoFilter
if
the filter is added at the first time.#onPreAdd(IoFilterChain, String, NextFilter)
is invoked to notify
that the filter will be added to the chain.#onPostAdd(IoFilterChain, String, NextFilter)
is invoked to notify
that the filter is added to the chain.onPostAdd(IoFilterChain, String, org.apache.mina.common.IoFilter.NextFilter)
threw an exception. destroy()
is also invoked by
ReferenceCountingIoFilter
if the filter is the last filter which
was added to IoFilterChain
s.
When you remove an IoFilter
from an IoFilterChain
:
#onPreRemove(IoFilterChain, String, NextFilter)
is invoked to
notify that the filter will be removed from the chain.#onPostRemove(IoFilterChain, String, NextFilter)
is invoked to
notify that the filter is removed from the chain.destroy()
is invoked by ReferenceCountingIoFilter
if
the removed filter was the last one.
IoFilterAdapter
Nested Class Summary | |
static interface |
IoFilter.NextFilter
Represents the next IoFilter in IoFilterChain . |
static class |
IoFilter.WriteRequest
Represents write request fired by IoSession.write(Object) . |
Method Summary | |
void |
destroy()
Invoked by ReferenceCountingIoFilter when this filter
is not used by any IoFilterChain anymore, so you can destroy
shared resources. |
void |
exceptionCaught(IoFilter.NextFilter nextFilter,
IoSession session,
Throwable cause)
Filters IoHandler.exceptionCaught(IoSession,Throwable)
event. |
void |
filterClose(IoFilter.NextFilter nextFilter,
IoSession session)
Filters IoSession.close() method invocation. |
void |
filterWrite(IoFilter.NextFilter nextFilter,
IoSession session,
IoFilter.WriteRequest writeRequest)
Filters IoSession.write(Object) method invocation. |
void |
init()
Invoked by ReferenceCountingIoFilter when this filter
is added to a IoFilterChain at the first time, so you can
initialize shared resources. |
void |
messageReceived(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
Filters IoHandler.messageReceived(IoSession,Object)
event. |
void |
messageSent(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
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. |
Method Detail |
public void init() throws Exception
ReferenceCountingIoFilter
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 ReferenceCountingIoFilter
.
Exception
public void destroy() throws Exception
ReferenceCountingIoFilter
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 ReferenceCountingIoFilter
.
Exception
public void onPreAdd(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter) throws Exception
init()
is invoked.
parent
- the parent who called this methodname
- the name assigned to this filternextFilter
- the IoFilter.NextFilter
for this filter. You can reuse
this object until this filter is removed from the chain.
Exception
public void onPostAdd(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter) throws Exception
init()
is invoked.
parent
- the parent who called this methodname
- the name assigned to this filternextFilter
- the IoFilter.NextFilter
for this filter. You can reuse
this object until this filter is removed from the chain.
Exception
public void onPreRemove(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter) throws Exception
destroy()
is invoked.
parent
- the parent who called this methodname
- the name assigned to this filternextFilter
- the IoFilter.NextFilter
for this filter. You can reuse
this object until this filter is removed from the chain.
Exception
public void onPostRemove(IoFilterChain parent, String name, IoFilter.NextFilter nextFilter) throws Exception
destroy()
is invoked.
parent
- the parent who called this methodname
- the name assigned to this filternextFilter
- the IoFilter.NextFilter
for this filter. You can reuse
this object until this filter is removed from the chain.
Exception
public void sessionCreated(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
IoHandler.sessionCreated(IoSession)
event.
Exception
public void sessionOpened(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
IoHandler.sessionOpened(IoSession)
event.
Exception
public void sessionClosed(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
IoHandler.sessionClosed(IoSession)
event.
Exception
public void sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status) throws Exception
IoHandler.sessionIdle(IoSession,IdleStatus)
event.
Exception
public void exceptionCaught(IoFilter.NextFilter nextFilter, IoSession session, Throwable cause) throws Exception
IoHandler.exceptionCaught(IoSession,Throwable)
event.
Exception
public void messageReceived(IoFilter.NextFilter nextFilter, IoSession session, Object message) throws Exception
IoHandler.messageReceived(IoSession,Object)
event.
Exception
public void messageSent(IoFilter.NextFilter nextFilter, IoSession session, Object message) throws Exception
IoHandler.messageSent(IoSession,Object)
event.
Exception
public void filterClose(IoFilter.NextFilter nextFilter, IoSession session) throws Exception
IoSession.close()
method invocation.
Exception
public void filterWrite(IoFilter.NextFilter nextFilter, IoSession session, IoFilter.WriteRequest writeRequest) throws Exception
IoSession.write(Object)
method invocation.
Exception
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |