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

Class TcpRequesterConnection

java.lang.Object

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

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

All Implemented Interfaces:

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

public class TcpRequesterConnection
extends AbstractSocketConnection
implements RequesterConnection

Implementation of RequesterConnection for establishing 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
TcpRequesterConnection(SocketConnectionSettings connectionSettings, SocketConnectionSettings localAddressSettings, TcpProtocol protocol, TcpClientSocketProperties socketProperties, SimpleSocketFactory socketFactory)

Method Summary

Modifier and Type	Method and Description
void	connect() Establish a connection ready to be used.
void	doDisconnect() Template method that does the concrete disconnection for the socket
TcpClient	getClient() Returns a new instance of SocketClient particular to this connection.
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
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

TcpRequesterConnection

public TcpRequesterConnection(SocketConnectionSettings connectionSettings,
                              SocketConnectionSettings localAddressSettings,
                              TcpProtocol protocol,
                              TcpClientSocketProperties socketProperties,
                              SimpleSocketFactory socketFactory)
                       throws org.mule.runtime.api.connection.ConnectionException

Throws:

org.mule.runtime.api.connection.ConnectionException

Method Detail

getClient

public TcpClient getClient()

Returns a new instance of SocketClient particular to this connection.

Specified by:

getClient in interface RequesterConnection

Returns:

a SocketClient that can SocketClient.read() and SocketClient#write(Object) through the socket.

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

Establish a connection ready to be used.

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