org.springframework.integration.ip.tcp.serializer

Class ByteArrayStxEtxSerializer

java.lang.Object

org.springframework.integration.ip.tcp.serializer.AbstractByteArraySerializer

org.springframework.integration.ip.tcp.serializer.AbstractPooledBufferByteArraySerializer

org.springframework.integration.ip.tcp.serializer.ByteArrayStxEtxSerializer

All Implemented Interfaces:

Aware, ApplicationEventPublisherAware, Deserializer<byte[]>, Serializer<byte[]>

public class ByteArrayStxEtxSerializer
extends AbstractPooledBufferByteArraySerializer

Reads data in an InputStream to a byte[]; data must be prefixed by <stx> and terminated by <etx> (not included in resulting byte[]). Writes a byte[] to an OutputStream prefixed by <stx> terminated by <etx>

Since:

2.0

Author:

Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field and Description
static int	ETX
static ByteArrayStxEtxSerializer	INSTANCE A single reusable instance.
static int	STX

Fields inherited from class org.springframework.integration.ip.tcp.serializer.AbstractByteArraySerializer

DEFAULT_MAX_MESSAGE_SIZE, logger

Constructor Summary

Constructors

Constructor and Description
ByteArrayStxEtxSerializer()

Method Summary

Modifier and Type	Method and Description
byte[]	doDeserialize(InputStream inputStream, byte[] buffer) Reads the data in the inputStream to a byte[].
void	serialize(byte[] bytes, OutputStream outputStream) Writes the byte[] to the stream, prefixed by an ASCII STX character and terminated with an ASCII ETX character.

Methods inherited from class org.springframework.integration.ip.tcp.serializer.AbstractPooledBufferByteArraySerializer

copyToSizedArray, deserialize, setPoolSize, setPoolWaitTimeout

Methods inherited from class org.springframework.integration.ip.tcp.serializer.AbstractByteArraySerializer

checkClosure, getMaxMessageSize, publishEvent, setApplicationEventPublisher, setMaxMessageSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.core.serializer.Serializer

serializeToByteArray

Methods inherited from interface org.springframework.core.serializer.Deserializer

deserializeFromByteArray

Field Detail

INSTANCE

public static final ByteArrayStxEtxSerializer INSTANCE

A single reusable instance.

STX

public static final int STX

See Also:

Constant Field Values

ETX

public static final int ETX

See Also:

Constant Field Values

Constructor Detail

ByteArrayStxEtxSerializer

public ByteArrayStxEtxSerializer()

Method Detail

doDeserialize

public byte[] doDeserialize(InputStream inputStream,
                            byte[] buffer)
                     throws IOException

Reads the data in the inputStream to a byte[]. Data must be prefixed with an ASCII STX character, and terminated with an ASCII ETX character. Throws a SoftEndOfStreamException if the stream is closed immediately before the STX (i.e. no data is in the process of being read).

Specified by:

doDeserialize in class AbstractPooledBufferByteArraySerializer

Parameters:

inputStream - the input stream.

buffer - the raw working buffer (maxMessageSize).

Returns:

the decoded bytes.

Throws:

IOException - an io exception.

serialize

public void serialize(byte[] bytes,
                      OutputStream outputStream)
               throws IOException

Writes the byte[] to the stream, prefixed by an ASCII STX character and terminated with an ASCII ETX character.

Throws:

IOException