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

Class TcpListenerConnection

java.lang.Object

org.mule.extension.socket.api.connection.AbstractSocketConnection

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

All Implemented Interfaces:

ListenerConnection, SocketConnection, org.mule.runtime.api.lifecycle.Initialisable

public final class TcpListenerConnection
extends AbstractSocketConnection
implements ListenerConnection

Implementation of ListenerConnection for receiving TCP connections.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected TcpProtocol	protocol TcpProtocol

Fields inherited from class org.mule.extension.socket.api.connection.AbstractSocketConnection

connectionSettings, LOGGER, wasDisconnected

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

PHASE_NAME

Constructor Summary

Constructors

Constructor and Description
TcpListenerConnection(SocketConnectionSettings connectionSettings, TcpProtocol protocol, TcpServerSocketProperties socketProperties, SimpleServerSocketFactory serverSocketFactory)

Method Summary

Modifier and Type	Method and Description
void	connect() Configures the ServerSocket instance with the TcpServerSocketProperties parameters.
void	doDisconnect() Template method that does the concrete disconnection for the socket
protected InetSocketAddress	getSocketAddress(SocketConnectionSettings connectionSettings, boolean failOnUnresolvedHost) Creates an InetSocketAddress with the host and port information.
void	initialise() Injection of the ObjectSerializer is needed for TcpProtocol
SocketWorker	listen(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,SocketAttributes> callback) One worker is created per accepted connection.
org.mule.runtime.api.connection.ConnectionValidationResult	validate() Validates socket's connection

Methods inherited from class org.mule.extension.socket.api.connection.AbstractSocketConnection

disconnect

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.connection.SocketConnection

disconnect

Field Detail

protocol

protected final TcpProtocol protocol

TcpProtocol

Constructor Detail

TcpListenerConnection

public TcpListenerConnection(SocketConnectionSettings connectionSettings,
                             TcpProtocol protocol,
                             TcpServerSocketProperties socketProperties,
                             SimpleServerSocketFactory serverSocketFactory)
                      throws org.mule.runtime.api.connection.ConnectionException

Throws:

org.mule.runtime.api.connection.ConnectionException

Method Detail

listen

public SocketWorker listen(org.mule.runtime.extension.api.runtime.source.SourceCallback<InputStream,SocketAttributes> callback)
                    throws IOException,
                           org.mule.runtime.api.connection.ConnectionException

One worker is created per accepted connection.

The new Socket used for responding has the same TcpSocketProperties settings as the listener socket used in the Source.

Specified by:

listen in interface ListenerConnection

Parameters:

callback - used in the SocketWorker to deliver the new received messages

Returns:

a Runnable that will represent a new received connection. The Runnable should be scheduled with an Executor in it's own thread.

Throws:

org.mule.runtime.api.connection.ConnectionException - if the socket was close while blocked on DatagramSocket.receive(DatagramPacket) method and the close was not intentionally done by the AbstractSocketConnection.disconnect() method.

IOException - if the socket was close while blocked on DatagramSocket.receive(DatagramPacket) method.

doDisconnect

public void doDisconnect()

Description copied from class: AbstractSocketConnection

Template method that does the concrete disconnection for the socket

Specified by:

doDisconnect in class AbstractSocketConnection

connect

public void connect()
             throws org.mule.runtime.api.connection.ConnectionException

Configures the ServerSocket instance with the TcpServerSocketProperties parameters. It does not invoke ServerSocket.accept() because that would block the method causing an incompatible behaviour with the Source that uses this connection.

Specified by:

connect in interface SocketConnection

Throws:

org.mule.runtime.api.connection.ConnectionException - if the connection couldn't be established

validate

public org.mule.runtime.api.connection.ConnectionValidationResult validate()

Validates socket's connection

Specified by:

validate in interface SocketConnection

initialise

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

Injection of the ObjectSerializer is needed for TcpProtocol

Specified by:

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

Throws:

org.mule.runtime.api.lifecycle.InitialisationException

getSocketAddress

protected InetSocketAddress getSocketAddress(SocketConnectionSettings connectionSettings,
                                             boolean failOnUnresolvedHost)
                                      throws org.mule.runtime.api.connection.ConnectionException

Creates an InetSocketAddress with the host and port information.

Parameters:

failOnUnresolvedHost - whether a UnresolvableHostException should be thrown if the address couldn't be resolved.

Returns:

an InetSocketAddress configured with the host and port received

Throws:

org.mule.runtime.api.connection.ConnectionException