AbstractConnectionFactory (Spring Integration 5.2.3.RELEASE API)

java.lang.Object
- org.springframework.integration.context.IntegrationObjectSupport
- - org.springframework.integration.ip.tcp.connection.AbstractConnectionFactory

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, ExpressionCapable, ConnectionFactory, NamedComponent

Direct Known Subclasses:

AbstractClientConnectionFactory, AbstractServerConnectionFactory
```
public abstract class AbstractConnectionFactory
extends IntegrationObjectSupport
implements ConnectionFactory, ApplicationEventPublisherAware
```
Base class for all connection factories.

Since:

2.0

Author:

Gary Russell, Artem Bilan

Field Summary

Fields
Modifier and Type Field and Description

protected static int DEFAULT_REPLY_TIMEOUT

protected Object lifecycleMonitor
- Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport
  EXPRESSION_PARSER, logger

Fields
Modifier and Type	Field and Description
`protected static int`	`DEFAULT_REPLY_TIMEOUT`
`protected Object`	`lifecycleMonitor`

Constructor Summary

Constructors
Constructor and Description

AbstractConnectionFactory(int port)

AbstractConnectionFactory(String host, int port)

Constructors
Constructor and Description
`AbstractConnectionFactory(int port)`
`AbstractConnectionFactory(String host, int port)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addConnection(TcpConnectionSupport connection)`
`protected void`	`checkActive()`
`boolean`	`closeConnection(String connectionId)` Close a connection with the specified connection id.
`protected void`	`delayRead(Selector selector, long now, SelectionKey key)`
`protected void`	`doAccept(Selector selector, ServerSocketChannel server, long now)`
`ApplicationEventPublisher`	`getApplicationEventPublisher()`
`protected BlockingQueue<org.springframework.integration.ip.tcp.connection.AbstractConnectionFactory.PendingIO>`	`getDelayedReads()`
`Deserializer<?>`	`getDeserializer()`
`String`	`getHost()`
`protected Object`	`getLifecycleMonitor()`
`TcpListener`	`getListener()`
`TcpMessageMapper`	`getMapper()`
`List<String>`	`getOpenConnectionIds()` Returns a list of (currently) open `TcpConnection` connection ids; allows, for example, broadcast operations to all open connections.
`int`	`getPort()`
`protected long`	`getReadDelay()`
`TcpSender`	`getSender()`
`Serializer<?>`	`getSerializer()`
`int`	`getSoLinger()`
`int`	`getSoReceiveBufferSize()`
`int`	`getSoSendBufferSize()`
`int`	`getSoTimeout()`
`int`	`getSoTrafficClass()`
`protected Integer`	`getSslHandshakeTimeout()`
`protected Executor`	`getTaskExecutor()` Creates a taskExecutor (if one was not provided).
`protected TcpSocketSupport`	`getTcpSocketSupport()`
`protected void`	`harvestClosedConnections()` Cleans up this.connections by removing any closed connections.
`protected boolean`	`isActive()`
`boolean`	`isLookupHost()`
`boolean`	`isRunning()`
`boolean`	`isSingleUse()`
`boolean`	`isSoKeepAlive()`
`boolean`	`isSoTcpNoDelay()`
`protected void`	`onInit()` Subclasses may implement this for initialization logic.
`protected void`	`processNioSelections(int selectionCount, Selector selector, ServerSocketChannel server, Map<SocketChannel,TcpNioConnection> connectionMap)` Times out any expired connections then, if `selectionCount > 0`, processes the selected keys.
`void`	`registerListener(TcpListener listenerToRegister)` Registers a TcpListener to receive messages after the payload has been converted from the input data.
`void`	`registerSender(TcpSender senderToRegister)` Registers a TcpSender; for server sockets, used to provide connection information so a sender can be used to reply to incoming messages.
`protected void`	`setActive(boolean active)`
`void`	`setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)`
`void`	`setDeserializer(Deserializer<?> deserializer)`
`void`	`setHost(String host)` Set the host; requires the factory to be stopped.
`void`	`setInterceptorFactoryChain(TcpConnectionInterceptorFactoryChain interceptorFactoryChain)`
`void`	`setLeaveOpen(boolean leaveOpen)` If true, sockets created by this factory will be reused.
`void`	`setLookupHost(boolean lookupHost)` If true, DNS reverse lookup is done on the remote ip address.
`void`	`setMapper(TcpMessageMapper mapper)`
`void`	`setNioHarvestInterval(int nioHarvestInterval)` How often we clean up closed NIO connections if soTimeout is 0.
`void`	`setPort(int port)` Set the port; requires the factory to be stopped.
`void`	`setReadDelay(long readDelay)` The delay (in milliseconds) before retrying a read after the previous attempt failed due to insufficient threads.
`void`	`setSerializer(Serializer<?> serializer)`
`void`	`setSingleUse(boolean singleUse)` If true, sockets created by this factory will be used once.
`protected void`	`setSocketAttributes(Socket socket)` Sets socket attributes on the socket.
`void`	`setSoKeepAlive(boolean soKeepAlive)`
`void`	`setSoLinger(int soLinger)`
`void`	`setSoReceiveBufferSize(int soReceiveBufferSize)`
`void`	`setSoSendBufferSize(int soSendBufferSize)`
`void`	`setSoTcpNoDelay(boolean soTcpNoDelay)`
`void`	`setSoTimeout(int soTimeout)`
`void`	`setSoTrafficClass(int soTrafficClass)`
`void`	`setSslHandshakeTimeout(int sslHandshakeTimeout)` Set the handshake timeout used when waiting for SSL handshake data; only applies to SSL connections, when using NIO.
`void`	`setTaskExecutor(Executor taskExecutor)`
`void`	`setTcpSocketSupport(TcpSocketSupport tcpSocketSupport)`
`void`	`start()`
`void`	`stop()` Stops the server.
`String`	`toString()`
`protected TcpConnectionSupport`	`wrapConnection(TcpConnectionSupport connectionArg)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.springframework.integration.ip.tcp.connection.ConnectionFactory
getConnection

- Field Detail
  - DEFAULT_REPLY_TIMEOUT
```
protected static final int DEFAULT_REPLY_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - lifecycleMonitor
```
protected final Object lifecycleMonitor
```
- Constructor Detail
  - AbstractConnectionFactory
```
public AbstractConnectionFactory(int port)
```
  - AbstractConnectionFactory
```
public AbstractConnectionFactory(String host,
                                 int port)
```
- Method Detail
  - setApplicationEventPublisher
```
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
```
    Specified by:
    
    setApplicationEventPublisher in interface ApplicationEventPublisherAware
  - getApplicationEventPublisher
```
public ApplicationEventPublisher getApplicationEventPublisher()
```
  - setSocketAttributes
```
protected void setSocketAttributes(Socket socket)
                            throws SocketException
```
    Sets socket attributes on the socket.
    
    Parameters:
    
    socket - The socket.
    
    Throws:
    
    SocketException - Any SocketException.
  - getSoTimeout
```
public int getSoTimeout()
```
    Returns:
    
    the soTimeout
  - setSoTimeout
```
public void setSoTimeout(int soTimeout)
```
    Parameters:
    
    soTimeout - the soTimeout to set
  - getSoReceiveBufferSize
```
public int getSoReceiveBufferSize()
```
    Returns:
    
    the soReceiveBufferSize
  - setSoReceiveBufferSize
```
public void setSoReceiveBufferSize(int soReceiveBufferSize)
```
    Parameters:
    
    soReceiveBufferSize - the soReceiveBufferSize to set
  - getSoSendBufferSize
```
public int getSoSendBufferSize()
```
    Returns:
    
    the soSendBufferSize
  - setSoSendBufferSize
```
public void setSoSendBufferSize(int soSendBufferSize)
```
    Parameters:
    
    soSendBufferSize - the soSendBufferSize to set
  - isSoTcpNoDelay
```
public boolean isSoTcpNoDelay()
```
    Returns:
    
    the soTcpNoDelay
  - setSoTcpNoDelay
```
public void setSoTcpNoDelay(boolean soTcpNoDelay)
```
    Parameters:
    
    soTcpNoDelay - the soTcpNoDelay to set
  - getSoLinger
```
public int getSoLinger()
```
    Returns:
    
    the soLinger
  - setSoLinger
```
public void setSoLinger(int soLinger)
```
    Parameters:
    
    soLinger - the soLinger to set
  - isSoKeepAlive
```
public boolean isSoKeepAlive()
```
    Returns:
    
    the soKeepAlive
  - setSoKeepAlive
```
public void setSoKeepAlive(boolean soKeepAlive)
```
    Parameters:
    
    soKeepAlive - the soKeepAlive to set
  - getSoTrafficClass
```
public int getSoTrafficClass()
```
    Returns:
    
    the soTrafficClass
  - setSoTrafficClass
```
public void setSoTrafficClass(int soTrafficClass)
```
    Parameters:
    
    soTrafficClass - the soTrafficClass to set
  - setHost
```
public void setHost(String host)
```
    Set the host; requires the factory to be stopped.
    
    Parameters:
    
    host - the host.
    
    Since:
    
    5.0
  - getHost
```
public String getHost()
```
    Returns:
    
    the host
  - setPort
```
public void setPort(int port)
```
    Set the port; requires the factory to be stopped.
    
    Parameters:
    
    port - the port.
    
    Since:
    
    5.0
  - getPort
```
public int getPort()
```
    Returns:
    
    the port
  - getListener
```
@Nullable
public TcpListener getListener()
```
    Returns:
    
    the listener
  - getSender
```
@Nullable
public TcpSender getSender()
```
    Returns:
    
    the sender
  - getSerializer
```
public Serializer<?> getSerializer()
```
    Returns:
    
    the serializer
  - getDeserializer
```
public Deserializer<?> getDeserializer()
```
    Returns:
    
    the deserializer
  - getMapper
```
public TcpMessageMapper getMapper()
```
    Returns:
    
    the mapper
  - registerListener
```
public void registerListener(TcpListener listenerToRegister)
```
    Registers a TcpListener to receive messages after the payload has been converted from the input data.
    
    Parameters:
    
    listenerToRegister - the TcpListener.
  - registerSender
```
public void registerSender(TcpSender senderToRegister)
```
    Registers a TcpSender; for server sockets, used to provide connection information so a sender can be used to reply to incoming messages.
    
    Parameters:
    
    senderToRegister - The sender
  - setTaskExecutor
```
public void setTaskExecutor(Executor taskExecutor)
```
    Parameters:
    
    taskExecutor - the taskExecutor to set
  - setDeserializer
```
public void setDeserializer(Deserializer<?> deserializer)
```
    Parameters:
    
    deserializer - the deserializer to set
  - setSerializer
```
public void setSerializer(Serializer<?> serializer)
```
    Parameters:
    
    serializer - the serializer to set
  - setMapper
```
public void setMapper(TcpMessageMapper mapper)
```
    Parameters:
    
    mapper - the mapper to set; defaults to a TcpMessageMapper
  - isSingleUse
```
public boolean isSingleUse()
```
    Returns:
    
    the singleUse
  - setSingleUse
```
public void setSingleUse(boolean singleUse)
```
    If true, sockets created by this factory will be used once.
    
    Parameters:
    
    singleUse - The singleUse to set.
  - setLeaveOpen
```
public void setLeaveOpen(boolean leaveOpen)
```
    If true, sockets created by this factory will be reused. Inverse of setSingleUse(boolean).
    
    Parameters:
    
    leaveOpen - The keepOpen to set.
    
    Since:
    
    5.0
  - setInterceptorFactoryChain
```
public void setInterceptorFactoryChain(TcpConnectionInterceptorFactoryChain interceptorFactoryChain)
```
  - setLookupHost
```
public void setLookupHost(boolean lookupHost)
```
    If true, DNS reverse lookup is done on the remote ip address. Default true.
    
    Parameters:
    
    lookupHost - the lookupHost to set
  - isLookupHost
```
public boolean isLookupHost()
```
    Returns:
    
    the lookupHost
  - setNioHarvestInterval
```
public void setNioHarvestInterval(int nioHarvestInterval)
```
    How often we clean up closed NIO connections if soTimeout is 0. Ignored when soTimeout > 0 because the clean up process is run as part of the timeout handling. Default 2000 milliseconds.
    
    Parameters:
    
    nioHarvestInterval - The interval in milliseconds.
  - setSslHandshakeTimeout
```
public void setSslHandshakeTimeout(int sslHandshakeTimeout)
```
    Set the handshake timeout used when waiting for SSL handshake data; only applies to SSL connections, when using NIO.
    
    Parameters:
    
    sslHandshakeTimeout - the timeout.
    
    Since:
    
    4.3.6
  - getSslHandshakeTimeout
```
@Nullable
protected Integer getSslHandshakeTimeout()
```
    Returns:
    
    the handshake timeout.
    
    Since:
    
    4.3.6
    
    See Also:
    
    setSslHandshakeTimeout(int)
  - getDelayedReads
```
protected BlockingQueue<org.springframework.integration.ip.tcp.connection.AbstractConnectionFactory.PendingIO> getDelayedReads()
```
  - getReadDelay
```
protected long getReadDelay()
```
  - setReadDelay
```
public void setReadDelay(long readDelay)
```
    The delay (in milliseconds) before retrying a read after the previous attempt failed due to insufficient threads. Default 100.
    
    Parameters:
    
    readDelay - the readDelay to set.
  - getLifecycleMonitor
```
protected Object getLifecycleMonitor()
```
  - onInit
```
protected void onInit()
```
    Description copied from class: IntegrationObjectSupport
    
    Subclasses may implement this for initialization logic.
    
    Overrides:
    
    onInit in class IntegrationObjectSupport
  - start
```
public void start()
```
    Specified by:
    
    start in interface Lifecycle
  - getTaskExecutor
```
protected Executor getTaskExecutor()
```
    Creates a taskExecutor (if one was not provided).
    
    Returns:
    
    The executor.
  - stop
```
public void stop()
```
    Stops the server.
    
    Specified by:
    
    stop in interface Lifecycle
  - wrapConnection
```
protected TcpConnectionSupport wrapConnection(TcpConnectionSupport connectionArg)
```
  - processNioSelections
```
protected void processNioSelections(int selectionCount,
                                    Selector selector,
                                    @Nullable
                                    ServerSocketChannel server,
                                    Map<SocketChannel,TcpNioConnection> connectionMap)
```
    Times out any expired connections then, if selectionCount > 0, processes the selected keys. Removes closed connections from the connections field, and from the connections parameter.
    
    Parameters:
    
    selectionCount - Number of IO Events, if 0 we were probably woken up by a close.
    
    selector - The selector.
    
    server - The server socket channel.
    
    connectionMap - Map of connections.
  - delayRead
```
protected void delayRead(Selector selector,
                         long now,
                         SelectionKey key)
```
  - doAccept
```
protected void doAccept(Selector selector,
                        ServerSocketChannel server,
                        long now)
```
    Parameters:
    
    selector - The selector.
    
    server - The server socket channel.
    
    now - The current time.
  - addConnection
```
protected void addConnection(TcpConnectionSupport connection)
```
  - harvestClosedConnections
```
protected void harvestClosedConnections()
```
    Cleans up this.connections by removing any closed connections.
  - isRunning
```
public boolean isRunning()
```
    Specified by:
    
    isRunning in interface Lifecycle
  - isActive
```
protected boolean isActive()
```
    Returns:
    
    the active
  - setActive
```
protected void setActive(boolean active)
```
    Parameters:
    
    active - the active to set
  - checkActive
```
protected void checkActive()
```
  - getTcpSocketSupport
```
protected TcpSocketSupport getTcpSocketSupport()
```
  - setTcpSocketSupport
```
public void setTcpSocketSupport(TcpSocketSupport tcpSocketSupport)
```
  - getOpenConnectionIds
```
public List<String> getOpenConnectionIds()
```
    Returns a list of (currently) open TcpConnection connection ids; allows, for example, broadcast operations to all open connections.
    
    Returns:
    
    the list of connection ids.
  - closeConnection
```
public boolean closeConnection(String connectionId)
```
    Close a connection with the specified connection id.
    
    Parameters:
    
    connectionId - the connection id.
    
    Returns:
    
    true if the connection was closed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class IntegrationObjectSupport

Class AbstractConnectionFactory

Field Summary

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport

Constructor Summary

Method Summary

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_REPLY_TIMEOUT

lifecycleMonitor

Constructor Detail

AbstractConnectionFactory

AbstractConnectionFactory

Method Detail

setApplicationEventPublisher

getApplicationEventPublisher

setSocketAttributes

getSoTimeout

setSoTimeout

getSoReceiveBufferSize

setSoReceiveBufferSize

getSoSendBufferSize

setSoSendBufferSize

isSoTcpNoDelay

setSoTcpNoDelay

getSoLinger

setSoLinger

isSoKeepAlive

setSoKeepAlive

getSoTrafficClass

setSoTrafficClass

setHost

getHost

setPort

getPort

getListener

getSender

getSerializer

getDeserializer

getMapper

registerListener

registerSender

setTaskExecutor

setDeserializer

setSerializer

setMapper

isSingleUse

setSingleUse

setLeaveOpen

setInterceptorFactoryChain

setLookupHost

isLookupHost

setNioHarvestInterval

setSslHandshakeTimeout

getSslHandshakeTimeout

getDelayedReads

getReadDelay

setReadDelay

getLifecycleMonitor

onInit

start

getTaskExecutor

stop

wrapConnection

processNioSelections

delayRead

doAccept

addConnection

harvestClosedConnections

isRunning

isActive

setActive

checkActive

getTcpSocketSupport

setTcpSocketSupport

getOpenConnectionIds

closeConnection

toString