org.springframework.integration.ip.tcp.connection
Class AbstractTcpConnection

java.lang.Object
  org.springframework.integration.ip.tcp.connection.AbstractTcpConnection

All Implemented Interfaces:

Runnable, TcpConnection

Direct Known Subclasses:

TcpNetConnection, TcpNioConnection

public abstract class AbstractTcpConnection
extends Object
implements TcpConnection

Base class for TcpConnections. TcpConnections are established by client connection factories (outgoing) or server connection factories (incoming).

Since:

2.0

Author:

Gary Russell

Field Summary

protected String	connectionId
protected org.springframework.commons.serializer.InputStreamingConverter	inputConverter
protected TcpListener	listener
protected org.apache.commons.logging.Log	logger
protected TcpMessageMapper	mapper
protected org.springframework.commons.serializer.OutputStreamingConverter	outputConverter
protected TcpSender	sender
protected boolean	server
protected boolean	singleUse

Constructor Summary

AbstractTcpConnection(boolean server)

Method Summary

void	close() Closes this connection.
org.springframework.commons.serializer.InputStreamingConverter<?>	getInputConverter()
TcpListener	getListener()
TcpMessageMapper	getMapper()
org.springframework.commons.serializer.OutputStreamingConverter<?>	getOutputConverter()
boolean	isServer()
boolean	isSingleUse()
void	registerListener(TcpListener listener) Sets the listener that will receive incoming Messages.
void	registerSender(TcpSender sender) Registers a sender.
void	setInputConverter(org.springframework.commons.serializer.InputStreamingConverter<?> inputConverter)
void	setMapper(TcpMessageMapper mapper)
void	setOutputConverter(org.springframework.commons.serializer.OutputStreamingConverter<?> outputConverter)
void	setSingleUse(boolean singleUse) When true, the socket is used once and discarded.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.ip.tcp.connection.TcpConnection

getConnectionId, getHostAddress, getHostName, getPayload, getPort, isOpen, send

Methods inherited from interface java.lang.Runnable

run

Field Detail

logger

protected org.apache.commons.logging.Log logger

inputConverter

protected org.springframework.commons.serializer.InputStreamingConverter inputConverter

outputConverter

protected org.springframework.commons.serializer.OutputStreamingConverter outputConverter

mapper

protected TcpMessageMapper mapper

listener

protected TcpListener listener

sender

protected TcpSender sender

singleUse

protected boolean singleUse

server

protected final boolean server

connectionId

protected String connectionId

Constructor Detail

AbstractTcpConnection

public AbstractTcpConnection(boolean server)

Method Detail

close

public void close()

Closes this connection.

Specified by:

close in interface TcpConnection

getMapper

public TcpMessageMapper getMapper()

Returns:

the mapper

setMapper

public void setMapper(TcpMessageMapper mapper)

Specified by:

setMapper in interface TcpConnection

Parameters:

mapper - the mapper to set

getInputConverter

public org.springframework.commons.serializer.InputStreamingConverter<?> getInputConverter()

Specified by:

getInputConverter in interface TcpConnection

Returns:

the input converter

setInputConverter

public void setInputConverter(org.springframework.commons.serializer.InputStreamingConverter<?> inputConverter)

Specified by:

setInputConverter in interface TcpConnection

Parameters:

inputConverter - the input converter to set

getOutputConverter

public org.springframework.commons.serializer.OutputStreamingConverter<?> getOutputConverter()

Specified by:

getOutputConverter in interface TcpConnection

Returns:

the output converter

setOutputConverter

public void setOutputConverter(org.springframework.commons.serializer.OutputStreamingConverter<?> outputConverter)

Specified by:

setOutputConverter in interface TcpConnection

Parameters:

outputConverter - the output converter to set

registerListener

public void registerListener(TcpListener listener)

Description copied from interface: TcpConnection

Sets the listener that will receive incoming Messages.

Specified by:

registerListener in interface TcpConnection

Parameters:

listener - the listener to set

registerSender

public void registerSender(TcpSender sender)

Description copied from interface: TcpConnection

Registers a sender. Used on server side sockets so a sender can determine which connection to send a reply to.

Specified by:

registerSender in interface TcpConnection

Parameters:

sender - the sender to set

getListener

public TcpListener getListener()

Specified by:

getListener in interface TcpConnection

Returns:

the listener

setSingleUse

public void setSingleUse(boolean singleUse)

Description copied from interface: TcpConnection

When true, the socket is used once and discarded.

Specified by:

setSingleUse in interface TcpConnection

Parameters:

singleUse - true if this socket is to used once and discarded.

isSingleUse

public boolean isSingleUse()

Specified by:

isSingleUse in interface TcpConnection

Returns:

True if connection is used once.

isServer

public boolean isServer()

Specified by:

isServer in interface TcpConnection

Returns:

True if connection is used once.