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

Class AbstractByteProtocol

java.lang.Object

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

All Implemented Interfaces:

TcpProtocol

Direct Known Subclasses:

DirectProtocol, SafeProtocol, XmlMessageProtocol

public abstract class AbstractByteProtocol
extends Object
implements TcpProtocol

This Abstract class has been introduced so as to have the byte protocols (i.e. the protocols that had only a single write method taking just an array of bytes as a parameter) to inherit from since they will all behave the same, i.e. if the object is serializable, serialize it into an array of bytes and write it.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	EOF
protected static int	NO_MAX_LENGTH
static boolean	NO_STREAM
protected ObjectSerializer	objectSerializer
protected boolean	rethrowExceptionOnRead Indicates if the exception should be rethrown if there is a failure while reading
static boolean	STREAM_OK
protected boolean	streamOk

Constructor Summary

Constructors

Constructor and Description
AbstractByteProtocol(boolean streamOk)

Method Summary

Modifier and Type	Method and Description
protected int	copy(InputStream source, byte[] buffer, OutputStream dest) Make a single transfer from source to dest via a byte array buffer
protected int	copy(InputStream source, byte[] buffer, OutputStream dest, int size) Make a single transfer from source to dest via a byte array buffer
protected InputStream	nullIfEmptyArray(byte[] bytes)
protected int	safeRead(InputStream is, byte[] buffer)
protected int	safeRead(InputStream is, byte[] buffer, int size) Manage non-blocking reads and handle errors
void	setObjectSerializer(ObjectSerializer objectSerializer)
protected void	writeByteArray(OutputStream os, byte[] data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.extension.socket.api.socket.tcp.TcpProtocol

read, write

Field Detail

EOF

protected static final int EOF

NO_MAX_LENGTH

protected static final int NO_MAX_LENGTH

STREAM_OK

public static final boolean STREAM_OK

See Also:

Constant Field Values

streamOk

protected final boolean streamOk

NO_STREAM

public static final boolean NO_STREAM

See Also:

Constant Field Values

objectSerializer

@Inject
protected ObjectSerializer objectSerializer

rethrowExceptionOnRead

@Parameter
 @Optional(defaultValue="false")
protected boolean rethrowExceptionOnRead

Indicates if the exception should be rethrown if there is a failure while reading

Constructor Detail

AbstractByteProtocol

public AbstractByteProtocol(boolean streamOk)

Method Detail

writeByteArray

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

Throws:

IOException

safeRead

protected int safeRead(InputStream is,
                       byte[] buffer)
                throws IOException

Throws:

IOException

safeRead

protected int safeRead(InputStream is,
                       byte[] buffer,
                       int size)
                throws IOException

Manage non-blocking reads and handle errors

Parameters:

is - The input stream to read from

buffer - The buffer to read into

size - The amount of data (upper bound) to read

Returns:

The amount of data read (always non-zero, -1 on EOF or socket exception)

Throws:

IOException - other than socket exceptions

copy

protected int copy(InputStream source,
                   byte[] buffer,
                   OutputStream dest)
            throws IOException

Make a single transfer from source to dest via a byte array buffer

Parameters:

source - Source of data

buffer - Buffer array for transfer

dest - Destination of data

Returns:

Amount of data transferred, or -1 on eof or socket error

Throws:

IOException - On non-socket error

copy

protected int copy(InputStream source,
                   byte[] buffer,
                   OutputStream dest,
                   int size)
            throws IOException

Make a single transfer from source to dest via a byte array buffer

Parameters:

source - Source of data

buffer - Buffer array for transfer

dest - Destination of data

size - The amount of data (upper bound) to read

Returns:

Amount of data transferred, or -1 on eof or socket error

Throws:

IOException - On non-socket error

setObjectSerializer

public void setObjectSerializer(ObjectSerializer objectSerializer)

nullIfEmptyArray

protected InputStream nullIfEmptyArray(byte[] bytes)