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

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

All Implemented Interfaces:

java.lang.Runnable, TcpConnection

Direct Known Subclasses:

TcpNetConnection, TcpNioConnection

public abstract class AbstractTcpConnection
extends java.lang.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 org.apache.commons.logging.Log

logger

Constructor Summary

AbstractTcpConnection(java.net.Socket socket, boolean server, boolean lookupHost)

Method Summary

void	afterSend(Message<?> message)
void	close() Closes this connection.
protected void	closeConnection(boolean isException) If we have been intercepted, propagate the close from the outermost interceptor; otherwise, just call close().
java.lang.String	getConnectionId()
org.springframework.core.serializer.Deserializer<?>	getDeserializer()
java.lang.String	getHostAddress()
java.lang.String	getHostName()
TcpListener	getListener()
TcpMessageMapper	getMapper()
TcpSender	getSender()
org.springframework.core.serializer.Serializer<?>	getSerializer()
long	incrementAndGetConnectionSequence()
protected boolean	isNoReadErrorOnClose()
boolean	isServer()
boolean	isSingleUse()
void	registerListener(TcpListener listener) Sets the listener that will receive incoming Messages.
void	registerSender(TcpSender sender) Registers a sender.
void	setDeserializer(org.springframework.core.serializer.Deserializer<?> deserializer)
void	setMapper(TcpMessageMapper mapper)
protected void	setNoReadErrorOnClose(boolean noReadErrorOnClose)
void	setSerializer(org.springframework.core.serializer.Serializer<?> serializer)
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

getPayload, getPort, isOpen, send

Methods inherited from interface java.lang.Runnable

run

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

AbstractTcpConnection

public AbstractTcpConnection(java.net.Socket socket,
                             boolean server,
                             boolean lookupHost)

Method Detail

afterSend

public void afterSend(Message<?> message)
               throws java.lang.Exception

Throws:

java.lang.Exception

close

public void close()

Closes this connection.

Specified by:

close in interface TcpConnection

closeConnection

protected void closeConnection(boolean isException)

If we have been intercepted, propagate the close from the outermost interceptor; otherwise, just call close().

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

getDeserializer

public org.springframework.core.serializer.Deserializer<?> getDeserializer()

Specified by:

getDeserializer in interface TcpConnection

Returns:

the deserializer

setDeserializer

public void setDeserializer(org.springframework.core.serializer.Deserializer<?> deserializer)

Specified by:

setDeserializer in interface TcpConnection

Parameters:

deserializer - the deserializer to set

getSerializer

public org.springframework.core.serializer.Serializer<?> getSerializer()

Specified by:

getSerializer in interface TcpConnection

Returns:

the serializer

setSerializer

public void setSerializer(org.springframework.core.serializer.Serializer<?> serializer)

Specified by:

setSerializer in interface TcpConnection

Parameters:

serializer - the serializer 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

getSender

public TcpSender getSender()

Returns:

the sender

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.

incrementAndGetConnectionSequence

public long incrementAndGetConnectionSequence()

Specified by:

incrementAndGetConnectionSequence in interface TcpConnection

Returns:

the next sequence number for a message received on this socket

getHostAddress

public java.lang.String getHostAddress()

Specified by:

getHostAddress in interface TcpConnection

Returns:

the host address

getHostName

public java.lang.String getHostName()

Specified by:

getHostName in interface TcpConnection

Returns:

the host name

getConnectionId

public java.lang.String getConnectionId()

Specified by:

getConnectionId in interface TcpConnection

Returns:

a string uniquely representing a connection.

isNoReadErrorOnClose

protected boolean isNoReadErrorOnClose()

setNoReadErrorOnClose

protected void setNoReadErrorOnClose(boolean noReadErrorOnClose)