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

Class SafeProtocol

java.lang.Object

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

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

All Implemented Interfaces:

TcpProtocol

@XmlHints(allowTopLevelDefinition=true)
public class SafeProtocol
extends AbstractByteProtocol

This protocol is an application level TcpProtocol and precedes every message with a cookie. It should probably not be used in production. Should probably change to LengthProtocol. Both sender and receiver must use the same protocol.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	COOKIE

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
SafeProtocol()

Method Summary

Modifier and Type	Method and Description
InputStream	read(InputStream inputStream) Reads the actual data only after assuring that the cookie was preceding the message.
void	setObjectSerializer(ObjectSerializer objectSerializer)
void	write(OutputStream os, Object data, String encoding) Write the specified message into the OutputStream.

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

copy, copy, nullIfEmptyArray, safeRead, safeRead, writeByteArray

Methods inherited from class java.lang.Object

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

Field Detail

COOKIE

public static final String COOKIE

See Also:

Constant Field Values

Constructor Detail

SafeProtocol

public SafeProtocol()

Method Detail

read

public InputStream read(InputStream inputStream)
                 throws IOException

Reads the actual data only after assuring that the cookie was preceding the message.

Parameters:

inputStream -

Returns:

null if the cookie could not be successfully received.

Throws:

IOException

write

public void write(OutputStream os,
                  Object data,
                  String encoding)
           throws IOException

Write the specified message into the OutputStream.

Parameters:

os - the OutputStream in which the data is going to be written

data - data to be written

encoding - in which the data will be serialized if its type is String

Throws:

IOException - if an exception occurs

setObjectSerializer

@Inject
public void setObjectSerializer(ObjectSerializer objectSerializer)

Overrides:

setObjectSerializer in class AbstractByteProtocol