Class CompatibleObjectEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToByteEncoder<Serializable>

io.netty.handler.codec.serialization.CompatibleObjectEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

@Deprecated
public class CompatibleObjectEncoder
extends MessageToByteEncoder<Serializable>

Deprecated.

This class has been deprecated with no replacement, because serialization can be a security liability

An encoder which serializes a Java object into a ByteBuf (interoperability version).

This encoder is interoperable with the standard Java object streams such as ObjectInputStream and ObjectOutputStream.

Security: serialization can be a security liability, and should not be used without defining a list of classes that are allowed to be desirialized. Such a list can be specified with the jdk.serialFilter system property, for instance. See the serialization filtering article for more information.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Constructor Summary

Constructors

Constructor	Description
CompatibleObjectEncoder()	Deprecated. Creates a new instance with the reset interval of 16.
CompatibleObjectEncoder(int resetInterval)	Deprecated. Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	encode(ChannelHandlerContext ctx, Serializable msg, ByteBuf out)	Deprecated. Encode a message into a ByteBuf.
protected ObjectOutputStream	newObjectOutputStream(OutputStream out)	Deprecated. Creates a new ObjectOutputStream which wraps the specified OutputStream.

Methods inherited from class MessageToByteEncoder

acceptOutboundMessage, allocateBuffer, isPreferDirect, write

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
protected ByteBuf	allocateBuffer(ChannelHandlerContext ctx, Serializable msg, boolean preferDirect)	Allocate a ByteBuf which will be used as argument of MessageToByteEncoder.encode(ChannelHandlerContext, I, ByteBuf).
protected boolean	isPreferDirect()
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	read(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Deprecated. is part of ChannelInboundHandler
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

CompatibleObjectEncoder

public CompatibleObjectEncoder()

Deprecated.

Creates a new instance with the reset interval of 16.

CompatibleObjectEncoder

public CompatibleObjectEncoder(int resetInterval)

Deprecated.

Creates a new instance.

Parameters:

resetInterval - the number of objects between ObjectOutputStream.reset(). 0 will disable resetting the stream, but the remote peer will be at the risk of getting OutOfMemoryError in the long term.

Method Details

newObjectOutputStream

protected ObjectOutputStream newObjectOutputStream(OutputStream out)
                                            throws Exception

Deprecated.

Creates a new ObjectOutputStream which wraps the specified OutputStream. Override this method to use a subclass of the ObjectOutputStream.

Throws:

Exception

encode

protected void encode(ChannelHandlerContext ctx,
 Serializable msg,
 ByteBuf out)
               throws Exception

Deprecated.

Description copied from class: MessageToByteEncoder

Encode a message into a ByteBuf. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToByteEncoder<Serializable>

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

msg - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

Exception - is thrown if an error occurs