public Class ObjectEncoder

Class Inheritance

extends MessageToByteEncoder<Serializable>

java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelOutboundHandlerAdapter
io.netty.handler.codec.MessageToByteEncoder
io.netty.handler.codec.serialization.ObjectEncoder

Annotations

@Deprecated
@Sharable

Imports

io.netty.buffer.ByteBuf, .ByteBufOutputStream, io.netty.channel.ChannelHandler.Sharable, .ChannelHandlerContext, io.netty.handler.codec.MessageToByteEncoder, java.io.ObjectInputStream, .ObjectOutputStream, .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.

Please note that the serialized form this encoder produces is not compatible with the standard ObjectInputStream. Please use ObjectDecoder or ObjectDecoderInputStream to ensure the interoperability with this encoder.

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.

Field Summary

Modifier and Type	Field and Description
private static final byte[]	LENGTH_PLACEHOLDER

Constructor Summary

Access	Constructor and Description
public	ObjectEncoder()

Method Summary

Modifier and Type	Method and Description
protected void	encode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to ctx, Serializable the message to encode msg, ByteBuf the `ByteBuf` into which the encoded message will be written out) Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode. Encode a message into a `ByteBuf`.

Inherited from io.netty.handler.codec.MessageToByteEncoder:: acceptOutboundMessage allocateBuffer isPreferDirect write

Field Detail

LENGTH_PLACEHOLDER	back to summary
private static final byte[] LENGTH_PLACEHOLDER

Constructor Detail

ObjectEncoder	back to summary
public ObjectEncoder()

Method Detail

encode back to summary

encode	back to summary
protected void encode(ChannelHandlerContext ctx, Serializable msg, ByteBuf out) throws Exception Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode. Doc from io.netty.handler.codec.MessageToByteEncoder.encode. Encode a message into a `ByteBuf`. This method will be called for each written message that can be handled by this encoder. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToByteEncoder` belongs to msg:Serializable the message to encode out:ByteBuf the `ByteBuf` into which the encoded message will be written Annotations @Override Exceptions Exception: is thrown if an error occurs

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

Implements abstract io.netty.handler.codec.MessageToByteEncoder.encode.

Doc from io.netty.handler.codec.MessageToByteEncoder.encode.

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

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToByteEncoder belongs to
msg:Serializable: the message to encode
out:ByteBuf: the ByteBuf into which the encoded message will be written

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs