org.mule.extension.socket.api.connection.tcp.protocol

Class LengthProtocol

java.lang.Object

org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol

org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol

org.mule.extension.socket.api.connection.tcp.protocol.LengthProtocol

All Implemented Interfaces:

TcpProtocol

Direct Known Subclasses:

CustomClassLoadingLengthProtocol

@XmlHints(allowTopLevelDefinition=true)
public class LengthProtocol
extends DirectProtocol

This protocol is an application level TcpProtocol that can be used to transfer large amounts of data without risking some data to be loss. The protocol is defined by sending / reading an integer (the packet length) and then the data to be transferred.

Note that use of this protocol must be symmetric - both the sending and receiving connectors must use the same protocol.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	LENGTH_EXCEEDED

Fields inherited from class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol

bufferSize, UNLIMITED

Fields inherited from class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol

EOF, NO_MAX_LENGTH, NO_STREAM, objectSerializer, rethrowExceptionOnRead, STREAM_OK, streamOk

Constructor Summary

Constructors

Constructor and Description
LengthProtocol()
LengthProtocol(int maxMessageLength)

Method Summary

Modifier and Type	Method and Description
protected boolean	isRepeat(int len, int available) Read all four bytes for initial integer (limit is set in read)
InputStream	read(InputStream socketIs) It consumes the socket InputStream according to this#consume(InputStream) and then wraps the result into a ByteArrayInputStream.
protected void	writeByteArray(OutputStream outputStream, byte[] data) It first writes the an int representing the length of the data to be written, and then writes the actual data.

Methods inherited from class org.mule.extension.socket.api.connection.tcp.protocol.DirectProtocol

consume, remaining, write

Methods inherited from class org.mule.extension.socket.api.connection.tcp.protocol.AbstractByteProtocol

copy, copy, nullIfEmptyArray, safeRead, safeRead, setObjectSerializer

Methods inherited from class java.lang.Object

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

Field Detail

LENGTH_EXCEEDED

public static final String LENGTH_EXCEEDED

See Also:

Constant Field Values

Constructor Detail

LengthProtocol

public LengthProtocol()

LengthProtocol

public LengthProtocol(int maxMessageLength)

Method Detail

read

public InputStream read(InputStream socketIs)
                 throws IOException

It consumes the socket InputStream according to this#consume(InputStream) and then wraps the result into a ByteArrayInputStream.

Specified by:

read in interface TcpProtocol

Overrides:

read in class DirectProtocol

Parameters:

socketIs -

Returns:

null if this#consume(InputStream) throws an IOException and rethrowExceptionOnRead is not set

Throws:

IOException - is thrown if rethrowExceptionOnRead is set

writeByteArray

protected void writeByteArray(OutputStream outputStream,
                              byte[] data)
                       throws IOException

It first writes the an int representing the length of the data to be written, and then writes the actual data.

Overrides:

writeByteArray in class AbstractByteProtocol

Parameters:

outputStream - in which the data will be written

data - to be written

Throws:

LengthExceededException - if the length of the message to be written exceeds the maxMessageLength set

IOException

isRepeat

protected boolean isRepeat(int len,
                           int available)

Read all four bytes for initial integer (limit is set in read)

Overrides:

isRepeat in class DirectProtocol

Parameters:

len - Amount transferred last call (-1 on EOF or socket error)

available - Amount available

Returns:

true if the transfer should continue