AbstractConnectionFactory (Spring Integration 4.0.0.RC1 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, Phased, SmartLifecycle, ConnectionFactory, NamedComponent

Direct Known Subclasses:

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

Since:

2.0

Author:

Gary Russell

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

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`	`doAccept(Selector selector, ServerSocketChannel server, long now)`
`protected ApplicationEventPublisher`	`getApplicationEventPublisher()`
`Deserializer<?>`	`getDeserializer()`
`String`	`getHost()`
`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`	`getPhase()`
`int`	`getPort()`
`TcpSender`	`getSender()`
`Serializer<?>`	`getSerializer()`
`int`	`getSoLinger()`
`int`	`getSoReceiveBufferSize()`
`int`	`getSoSendBufferSize()`
`int`	`getSoTimeout()`
`int`	`getSoTrafficClass()`
`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`	`isAutoStartup()` We are controlled by the startup options of the bound endpoint.
`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> connections)` Times out any expired connections then, if `selectionCount > 0`, processes the selected keys.
`void`	`registerListener(TcpListener listener)` Registers a TcpListener to receive messages after the payload has been converted from the input data.
`void`	`registerSender(TcpSender sender)` 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`	`setInterceptorFactoryChain(TcpConnectionInterceptorFactoryChain interceptorFactoryChain)`
`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`	`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`	`setTaskExecutor(Executor taskExecutor)`
`void`	`setTcpSocketSupport(TcpSocketSupport tcpSocketSupport)`
`void`	`start()`
`void`	`stop()` Stops the server.
`void`	`stop(Runnable callback)`
`protected TcpConnectionSupport`	`wrapConnection(TcpConnectionSupport connection)`

Methods inherited from class org.springframework.integration.context.IntegrationObjectSupport
afterPropertiesSet, getApplicationContextId, getBeanFactory, getComponentName, getComponentType, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, setTaskScheduler, toString

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
```
protected 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
  - getHost
```
public String getHost()
```
    Returns:
    the host
  - getPort
```
public int getPort()
```
    Returns:
    the port
  - getListener
```
public TcpListener getListener()
```
    Returns:
    the listener
  - getSender
```
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 listener)
```
    Registers a TcpListener to receive messages after the payload has been converted from the input data.
    
    Parameters:
    listener - the TcpListener.
  - registerSender
```
public void registerSender(TcpSender sender)
```
    Registers a TcpSender; for server sockets, used to provide connection information so a sender can be used to reply to incoming messages.
    
    Parameters:
    sender - 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.
  - 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.
  - onInit
```
protected void onInit()
               throws Exception
```
    Description copied from class: IntegrationObjectSupport
    
    Subclasses may implement this for initialization logic.
    
    Overrides:
    
    onInit in class IntegrationObjectSupport
    
    Throws:
    
    Exception - Any exception.
  - 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 connection)
                                       throws Exception
```
    Throws:
    
    Exception
  - processNioSelections
```
protected void processNioSelections(int selectionCount,
                        Selector selector,
                        ServerSocketChannel server,
                        Map<SocketChannel,TcpNioConnection> connections)
                             throws IOException
```
    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.
    connections - Map of connections.
    
    Throws:
    
    IOException - Any IOException.
  - doAccept
```
protected void doAccept(Selector selector,
            ServerSocketChannel server,
            long now)
                 throws IOException
```
    Parameters:
    selector - The selector.
    server - The server socket channel.
    now - The current time.
    
    Throws:
    
    IOException - Any IOException.
  - getPhase
```
public int getPhase()
```
    Specified by:
    
    getPhase in interface Phased
  - isAutoStartup
```
public boolean isAutoStartup()
```
    We are controlled by the startup options of the bound endpoint.
    
    Specified by:
    
    isAutoStartup in interface SmartLifecycle
  - stop
```
public void stop(Runnable callback)
```
    Specified by:
    
    stop in interface SmartLifecycle
  - 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()
                    throws IOException
```
    Throws:
    
    IOException
  - 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.

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

getHost

getPort

getListener

getSender

getSerializer

getDeserializer

getMapper

registerListener

registerSender

setTaskExecutor

setDeserializer

setSerializer

setMapper

isSingleUse

setSingleUse

setInterceptorFactoryChain

setLookupHost

isLookupHost

setNioHarvestInterval

onInit

start

getTaskExecutor

stop

wrapConnection

processNioSelections

doAccept

getPhase

isAutoStartup

stop

addConnection

harvestClosedConnections

isRunning

isActive

setActive

checkActive

getTcpSocketSupport

setTcpSocketSupport

getOpenConnectionIds

closeConnection