Class ProtocolCodecFilter

java.lang.Object

org.apache.mina.core.filterchain.IoFilterAdapter

org.apache.mina.filter.codec.ProtocolCodecFilter

All Implemented Interfaces:

IoFilter

Direct Known Subclasses:

HttpClientCodec, HttpServerCodec

public class ProtocolCodecFilter
extends IoFilterAdapter

An IoFilter which translates binary or protocol specific data into message objects and vice versa using ProtocolCodecFactory, ProtocolEncoder, or ProtocolDecoder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	ProtocolCodecFilter.EncodedWriteRequest
private static class	ProtocolCodecFilter.ProtocolDecoderOutputImpl
private static class	ProtocolCodecFilter.ProtocolEncoderOutputImpl

Nested classes/interfaces inherited from interface IoFilter

IoFilter.NextFilter

Field Summary

Fields

Modifier and Type	Field	Description
private static final AttributeKey	DECODER
private static final AttributeKey	DECODER_OUT
private static final IoBuffer	EMPTY_BUFFER
private static final Class<?>[]	EMPTY_PARAMS
private static final AttributeKey	ENCODER
private static final AttributeKey	ENCODER_OUT
private final ProtocolCodecFactory	factory	The factory responsible for creating the encoder and decoder
private static final org.slf4j.Logger	LOGGER	A logger for this class

Constructor Summary

Constructors

Constructor	Description
ProtocolCodecFilter(Class<? extends ProtocolEncoder> encoderClass, Class<? extends ProtocolDecoder> decoderClass)	Creates a new instance of ProtocolCodecFilter, without any factory.
ProtocolCodecFilter(ProtocolCodecFactory factory)	Creates a new instance of ProtocolCodecFilter, associating a factory for the creation of the encoder and decoder.
ProtocolCodecFilter(ProtocolEncoder encoder, ProtocolDecoder decoder)	Creates a new instance of ProtocolCodecFilter, without any factory.

Method Summary

Modifier and Type	Method	Description
private void	disposeCodec(IoSession session)	Dispose the encoder, decoder, and the callback for the decoded messages.
private void	disposeDecoder(IoSession session)	Dispose the decoder, removing its instance from the session's attributes, and calling the associated dispose method.
private void	disposeDecoderOut(IoSession session)	Remove the decoder callback from the session's attributes.
private void	disposeEncoder(IoSession session)	Dispose the encoder, removing its instance from the session's attributes, and calling the associated dispose method.
void	filterWrite(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest)	Filters IoSession.write(Object) method invocation.
private ProtocolDecoderOutput	getDecoderOut(IoSession session, IoFilter.NextFilter nextFilter)	Return a reference to the decoder callback.
ProtocolEncoder	getEncoder(IoSession session)	Get the encoder instance from a given session.
private ProtocolEncoderOutput	getEncoderOut(IoSession session, IoFilter.NextFilter nextFilter, WriteRequest writeRequest)
void	messageReceived(IoFilter.NextFilter nextFilter, IoSession session, Object message)	Process the incoming message, calling the session decoder.
void	messageSent(IoFilter.NextFilter nextFilter, IoSession session, WriteRequest writeRequest)	Filters IoHandler.messageSent(IoSession,Object) event.
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	sessionClosed(IoFilter.NextFilter nextFilter, IoSession session)	Filters IoHandler.sessionClosed(IoSession) event.

Methods inherited from class IoFilterAdapter

destroy, event, exceptionCaught, filterClose, init, inputClosed, onPostAdd, onPreRemove, sessionCreated, sessionIdle, sessionOpened, toString

Methods inherited from class Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

A logger for this class

EMPTY_PARAMS

private static final Class<?>[] EMPTY_PARAMS

EMPTY_BUFFER

private static final IoBuffer EMPTY_BUFFER

ENCODER

private static final AttributeKey ENCODER

DECODER

private static final AttributeKey DECODER

DECODER_OUT

private static final AttributeKey DECODER_OUT

ENCODER_OUT

private static final AttributeKey ENCODER_OUT

factory

private final ProtocolCodecFactory factory

The factory responsible for creating the encoder and decoder

Constructor Details

ProtocolCodecFilter

public ProtocolCodecFilter(ProtocolCodecFactory factory)

Creates a new instance of ProtocolCodecFilter, associating a factory for the creation of the encoder and decoder.

Parameters:

factory - The associated factory

ProtocolCodecFilter

public ProtocolCodecFilter(ProtocolEncoder encoder,
 ProtocolDecoder decoder)

Creates a new instance of ProtocolCodecFilter, without any factory. The encoder/decoder factory will be created as an inner class, using the two parameters (encoder and decoder).

Parameters:

encoder - The class responsible for encoding the message

decoder - The class responsible for decoding the message

ProtocolCodecFilter

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

Creates a new instance of ProtocolCodecFilter, without any factory. The encoder/decoder factory will be created as an inner class, using the two parameters (encoder and decoder), which are class names. Instances for those classes will be created in this constructor.

Parameters:

encoderClass - The class responsible for encoding the message

decoderClass - The class responsible for decoding the message

Method Details

getEncoder

public ProtocolEncoder getEncoder(IoSession session)

Get the encoder instance from a given session.

Parameters:

session - The associated session we will get the encoder from

Returns:

The encoder instance, if any

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

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:

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

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:

Exception - If an error occurred while processing the event

messageReceived

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

Process the incoming message, calling the session decoder. As the incoming buffer might contains more than one messages, we have to loop until the decoder throws an exception. while ( buffer not empty ) try decode ( buffer ) catch break;

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 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

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

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

sessionClosed

public 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

disposeCodec

private void disposeCodec(IoSession session)

Dispose the encoder, decoder, and the callback for the decoded messages.

disposeEncoder

private void disposeEncoder(IoSession session)

Dispose the encoder, removing its instance from the session's attributes, and calling the associated dispose method.

disposeDecoder

private void disposeDecoder(IoSession session)

Dispose the decoder, removing its instance from the session's attributes, and calling the associated dispose method.

getDecoderOut

private ProtocolDecoderOutput getDecoderOut(IoSession session,
 IoFilter.NextFilter nextFilter)

Return a reference to the decoder callback. If it's not already created and stored into the session, we create a new instance.

getEncoderOut

private ProtocolEncoderOutput getEncoderOut(IoSession session,
 IoFilter.NextFilter nextFilter,
 WriteRequest writeRequest)

disposeDecoderOut

private void disposeDecoderOut(IoSession session)

Remove the decoder callback from the session's attributes.