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

Class CustomProtocol

java.lang.Object

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

All Implemented Interfaces:

TcpProtocol, org.mule.runtime.api.lifecycle.Initialisable

@XmlHints(allowTopLevelDefinition=true)
public class CustomProtocol
extends Object
implements TcpProtocol, org.mule.runtime.api.lifecycle.Initialisable

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
String	clazz Reference to full qualifier class name that should extend TcpProtocol that will be used as a custom protocol

Fields inherited from interface org.mule.runtime.api.lifecycle.Initialisable

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
CustomProtocol()

Method Summary

Modifier and Type	Method and Description
void	initialise()
InputStream	read(InputStream is) Reads the input stream and returns a whole message.
void	write(OutputStream os, Object data, String encoding) Write the specified message into the OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

clazz

@Parameter
 @Alias(value="class")
 @Summary(value="Full qualifier class name that must implement \'TcpProtocol\' that will be used as a custom protocol")
 @DisplayName(value="Protocol Class Name")
public String clazz

Reference to full qualifier class name that should extend TcpProtocol that will be used as a custom protocol

Constructor Detail

CustomProtocol

public CustomProtocol()

Method Detail

read

public InputStream read(InputStream is)
                 throws IOException

Description copied from interface: TcpProtocol

Reads the input stream and returns a whole message.

Specified by:

read in interface TcpProtocol

Parameters:

is - the input stream

Returns:

an InputStream containing a full message

Throws:

IOException - if an exception occurs

write

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

Description copied from interface: TcpProtocol

Write the specified message into the OutputStream.

Specified by:

write in interface TcpProtocol

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

initialise

public void initialise()
                throws org.mule.runtime.api.lifecycle.InitialisationException

Specified by:

initialise in interface org.mule.runtime.api.lifecycle.Initialisable

Throws:

org.mule.runtime.api.lifecycle.InitialisationException