org.apache.mina.filter.codec
Class ProtocolCodecFilter
java.lang.Object
org.apache.mina.common.IoFilterAdapter
org.apache.mina.filter.codec.ProtocolCodecFilter
- All Implemented Interfaces:
- IoFilter
public class ProtocolCodecFilter
- extends IoFilterAdapter
An IoFilter
which translates binary or protocol specific data into
message object and vice versa using ProtocolCodecFactory
,
ProtocolEncoder
, or ProtocolDecoder
.
- Version:
- $Rev: 447596 $, $Date: 2006-09-19 00:14:42 +0200 (Tue, 19 Sep 2006) $
- Author:
- The Apache Directory Project (mina-dev@directory.apache.org)
Method Summary |
void |
filterWrite(IoFilter.NextFilter nextFilter,
IoSession session,
IoFilter.WriteRequest writeRequest)
Filters IoSession.write(Object) method invocation. |
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 |
onPreAdd(IoFilterChain parent,
String name,
IoFilter.NextFilter nextFilter)
Invoked before this filter is added to the specified parent. |
void |
sessionClosed(IoFilter.NextFilter nextFilter,
IoSession session)
Filters IoHandler.sessionClosed(IoSession) event. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
ENCODER
public static final String ENCODER
DECODER
public static final String DECODER
ProtocolCodecFilter
public ProtocolCodecFilter(ProtocolCodecFactory factory)
ProtocolCodecFilter
public ProtocolCodecFilter(ProtocolEncoder encoder,
ProtocolDecoder decoder)
ProtocolCodecFilter
public ProtocolCodecFilter(Class encoderClass,
Class decoderClass)
onPreAdd
public void onPreAdd(IoFilterChain parent,
String name,
IoFilter.NextFilter nextFilter)
throws Exception
- Description copied from interface:
IoFilter
- 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
- Overrides:
onPreAdd
in class IoFilterAdapter
- Parameters:
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.
- Throws:
Exception
messageReceived
public void messageReceived(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
throws Exception
- Description copied from interface:
IoFilter
- Filters
IoHandler.messageReceived(IoSession,Object)
event.
- Specified by:
messageReceived
in interface IoFilter
- Overrides:
messageReceived
in class IoFilterAdapter
- Throws:
Exception
messageSent
public void messageSent(IoFilter.NextFilter nextFilter,
IoSession session,
Object message)
throws Exception
- Description copied from interface:
IoFilter
- Filters
IoHandler.messageSent(IoSession,Object)
event.
- Specified by:
messageSent
in interface IoFilter
- Overrides:
messageSent
in class IoFilterAdapter
- Throws:
Exception
filterWrite
public void filterWrite(IoFilter.NextFilter nextFilter,
IoSession session,
IoFilter.WriteRequest writeRequest)
throws Exception
- Description copied from interface:
IoFilter
- Filters
IoSession.write(Object)
method invocation.
- Specified by:
filterWrite
in interface IoFilter
- Overrides:
filterWrite
in class IoFilterAdapter
- Throws:
Exception
sessionClosed
public void sessionClosed(IoFilter.NextFilter nextFilter,
IoSession session)
throws Exception
- Description copied from interface:
IoFilter
- Filters
IoHandler.sessionClosed(IoSession)
event.
- Specified by:
sessionClosed
in interface IoFilter
- Overrides:
sessionClosed
in class IoFilterAdapter
- Throws:
Exception