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.

Nested Class Summary

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

IoFilter.NextFilter, IoFilter.WriteRequest

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DECODER
static java.lang.String	ENCODER

Constructor Summary

Constructors

Constructor and Description
ProtocolCodecFilter(java.lang.Class<? extends ProtocolEncoder> encoderClass, java.lang.Class<? extends ProtocolDecoder> decoderClass)
ProtocolCodecFilter(ProtocolCodecFactory factory)
ProtocolCodecFilter(ProtocolEncoder encoder, ProtocolDecoder decoder)

Method Summary

Methods

Modifier and Type	Method and Description
void	filterWrite(IoFilter.NextFilter nextFilter, IoSession session, IoFilter.WriteRequest writeRequest) Filters IoSession.write(Object) method invocation.
void	messageReceived(IoFilter.NextFilter nextFilter, IoSession session, java.lang.Object message) Filters IoHandler.messageReceived(IoSession,Object) event.
void	messageSent(IoFilter.NextFilter nextFilter, IoSession session, java.lang.Object message) Filters IoHandler.messageSent(IoSession,Object) event.
void	onPostRemove(IoFilterChain parent, java.lang.String name, IoFilter.NextFilter nextFilter) Invoked after this filter is removed from the specified parent.
void	onPreAdd(IoFilterChain parent, java.lang.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 org.apache.mina.common.IoFilterAdapter

destroy, exceptionCaught, filterClose, init, onPostAdd, onPreRemove, sessionCreated, sessionIdle, sessionOpened

Methods inherited from class java.lang.Object

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

Field Detail

ENCODER

public static final java.lang.String ENCODER

DECODER

public static final java.lang.String DECODER

Constructor Detail

ProtocolCodecFilter

public ProtocolCodecFilter(ProtocolCodecFactory factory)

ProtocolCodecFilter

public ProtocolCodecFilter(ProtocolEncoder encoder,
                   ProtocolDecoder decoder)

ProtocolCodecFilter

public ProtocolCodecFilter(java.lang.Class<? extends ProtocolEncoder> encoderClass,
                   java.lang.Class<? extends ProtocolDecoder> decoderClass)

Method Detail

onPreAdd

public void onPreAdd(IoFilterChain parent,
            java.lang.String name,
            IoFilter.NextFilter nextFilter)
              throws java.lang.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 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:

java.lang.Exception

onPostRemove

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

Description copied from interface: IoFilter

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

Overrides:

onPostRemove in class IoFilterAdapter

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:

java.lang.Exception

messageReceived

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

Description copied from interface: IoFilter

Filters IoHandler.messageReceived(IoSession,Object) event.

Specified by:

messageReceived in interface IoFilter

Overrides:

messageReceived in class IoFilterAdapter

Throws:

java.lang.Exception

messageSent

public void messageSent(IoFilter.NextFilter nextFilter,
               IoSession session,
               java.lang.Object message)
                 throws java.lang.Exception

Description copied from interface: IoFilter

Filters IoHandler.messageSent(IoSession,Object) event.

Specified by:

messageSent in interface IoFilter

Overrides:

messageSent in class IoFilterAdapter

Throws:

java.lang.Exception

filterWrite

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

Description copied from interface: IoFilter

Filters IoSession.write(Object) method invocation.

Specified by:

filterWrite in interface IoFilter

Overrides:

filterWrite in class IoFilterAdapter

Throws:

java.lang.Exception

sessionClosed

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

Description copied from interface: IoFilter

Filters IoHandler.sessionClosed(IoSession) event.

Specified by:

sessionClosed in interface IoFilter

Overrides:

sessionClosed in class IoFilterAdapter

Throws:

java.lang.Exception