org.springframework.integration.ip.tcp.connection.ThreadAffinityClientConnectionFactory

All Implemented Interfaces:: Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, ExpressionCapable, ConnectionFactory, NamedComponent, ManageableLifecycle

public class ThreadAffinityClientConnectionFactory
extends AbstractClientConnectionFactory

A client connection factory that binds a connection to a thread. Close operations are ignored; to physically close a connection and release the thread local, invoke releaseConnection().

Since:: 5.0
Author:: Gary Russell

Field Summary

Fields inherited from class org.springframework.integration.ip.tcp.connection.AbstractConnectionFactory
DEFAULT_REPLY_TIMEOUT, lifecycleMonitor

Fields inherited from class org.springframework.integration.context.IntegrationObjectSupport
EXPRESSION_PARSER, logger
Constructor Summary

Constructors

Constructor Description

ThreadAffinityClientConnectionFactory(AbstractClientConnectionFactory connectionFactory)

Method Summary

Modifier and Type	Method	Description
`boolean`	`closeConnection(String connectionId)`	Close a connection with the specified connection id.
`void`	`enableManualListenerRegistration()`	Set whether to automatically (default) or manually add a `TcpListener` to the connections created by this factory.
`void`	`forceClose(TcpConnection connection)`	Force close the connection and null the field if it's a shared connection.
`String`	`getApplicationContextId()`	Returns the `ApplicationContext.getId()` if the `ApplicationContext` is available.
`ApplicationEventPublisher`	`getApplicationEventPublisher()`
`String`	`getComponentName()`	Will return the name of this component identified by `IntegrationObjectSupport.componentName` field.
`String`	`getComponentType()`	Subclasses may implement this method to provide component type information.
`TcpConnectionSupport`	`getConnection()`	Obtain a connection - if `AbstractConnectionFactory.setSingleUse(boolean)` was called with true, a new connection is returned; otherwise a single connection is reused for all requests while the connection remains open.
`ConversionService`	`getConversionService()`
`Deserializer<?>`	`getDeserializer()`
`Expression`	`getExpression()`	Return the primary SpEL expression if this component is expression-based.
`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`	`getPort()`
`TcpSender`	`getSender()`
`List<TcpSender>`	`getSenders()`	Return the list of senders.
`Serializer<?>`	`getSerializer()`
`int`	`getSoLinger()`
`int`	`getSoReceiveBufferSize()`
`int`	`getSoSendBufferSize()`
`int`	`getSoTimeout()`
`int`	`getSoTrafficClass()`
`boolean`	`isLookupHost()`
`boolean`	`isRunning()`
`boolean`	`isSoKeepAlive()`
`boolean`	`isSoTcpNoDelay()`
`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.
`void`	`releaseConnection()`
`void`	`setApplicationContext(ApplicationContext applicationContext)`
`void`	`setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)`
`void`	`setBeanFactory(BeanFactory beanFactory)`
`void`	`setChannelResolver(DestinationResolver<MessageChannel> channelResolver)`	Specify the `DestinationResolver` strategy to use.
`void`	`setComponentName(String componentName)`	Sets the name of this component.
`void`	`setDeserializer(Deserializer<?> deserializer)`
`void`	`setHost(String host)`	Set the host; requires the factory to be stopped.
`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`	`setMessageBuilderFactory(MessageBuilderFactory messageBuilderFactory)`
`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`	`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()`

Methods inherited from class org.springframework.integration.ip.tcp.connection.AbstractClientConnectionFactory

buildNewConnection, getConnectionTest, getConnectTimeout, getTheConnection, initializeConnection, obtainConnection, obtainNewConnection, obtainSharedConnection, setConnectionTest, setConnectTimeout, setTheConnection

Methods inherited from class org.springframework.integration.ip.tcp.connection.AbstractConnectionFactory

addConnection, checkActive, delayRead, doAccept, getDelayedReads, getLifecycleMonitor, getReadDelay, getSslHandshakeTimeout, getTaskExecutor, getTcpSocketSupport, harvestClosedConnections, isActive, isSingleUse, onInit, processNioSelections, setActive, setLeaveOpen, setSingleUse, setSocketAttributes, unregisterSender, wrapConnection

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setBeanName, setConversionService, setPrimaryExpression, setTaskScheduler

Methods inherited from class java.lang.Object

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

Constructor Details
- ThreadAffinityClientConnectionFactory
  
  public ThreadAffinityClientConnectionFactory(AbstractClientConnectionFactory connectionFactory)
Method Details
- getConnection
  
  public TcpConnectionSupport getConnection() throws InterruptedException
  
  Description copied from class: AbstractClientConnectionFactory
  
  Obtain a connection - if AbstractConnectionFactory.setSingleUse(boolean) was called with true, a new connection is returned; otherwise a single connection is reused for all requests while the connection remains open.
  
  Specified by:
  
  getConnection in interface ConnectionFactory
  
  Overrides:
  
  getConnection in class AbstractClientConnectionFactory
  
  Throws:
  
  InterruptedException - if interrupted.
- releaseConnection
  
  public void releaseConnection()
- enableManualListenerRegistration
  
  public void enableManualListenerRegistration()
  
  Description copied from class: AbstractClientConnectionFactory
  
  Set whether to automatically (default) or manually add a TcpListener to the connections created by this factory. By default, the factory automatically configures the listener. When manual registration is in place, incoming messages will be delayed until the listener is registered.
  
  Overrides:
  
  enableManualListenerRegistration in class AbstractClientConnectionFactory
- getComponentName
  
  public String getComponentName()
  
  Description copied from class: IntegrationObjectSupport
  
  Will return the name of this component identified by IntegrationObjectSupport.componentName field. If IntegrationObjectSupport.componentName was not set this method will default to the 'beanName' of this component;
  
  Specified by:
  
  getComponentName in interface NamedComponent
  
  Overrides:
  
  getComponentName in class IntegrationObjectSupport
- setComponentName
  
  public void setComponentName(String componentName)
  
  Description copied from class: IntegrationObjectSupport
  
  Sets the name of this component.
  
  Overrides:
  
  setComponentName in class IntegrationObjectSupport
  
  Parameters:
  
  componentName - The component name.
- setApplicationEventPublisher
  
  public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
  
  Specified by:
  
  setApplicationEventPublisher in interface ApplicationEventPublisherAware
  
  Overrides:
  
  setApplicationEventPublisher in class AbstractConnectionFactory
- getComponentType
  
  public String getComponentType()
  
  Description copied from class: IntegrationObjectSupport
  
  Subclasses may implement this method to provide component type information.
  
  Specified by:
  
  getComponentType in interface NamedComponent
  
  Overrides:
  
  getComponentType in class IntegrationObjectSupport
- setBeanFactory
  
  public void setBeanFactory(BeanFactory beanFactory)
  
  Specified by:
  
  setBeanFactory in interface BeanFactoryAware
  
  Overrides:
  
  setBeanFactory in class IntegrationObjectSupport
- setApplicationContext
  
  public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
  
  Specified by:
  
  setApplicationContext in interface ApplicationContextAware
  
  Overrides:
  
  setApplicationContext in class IntegrationObjectSupport
  
  Throws:
  
  BeansException
- getApplicationEventPublisher
  
  @Nullable public ApplicationEventPublisher getApplicationEventPublisher()
  
  Overrides:
  
  getApplicationEventPublisher in class AbstractConnectionFactory
- setChannelResolver
  
  public void setChannelResolver(DestinationResolver<MessageChannel> channelResolver)
  
  Description copied from class: IntegrationObjectSupport
  
  Specify the DestinationResolver strategy to use. The default is a BeanFactoryChannelResolver.
  
  Overrides:
  
  setChannelResolver in class IntegrationObjectSupport
  
  Parameters:
  
  channelResolver - The channel resolver.
- getExpression
  
  public Expression getExpression()
  
  Description copied from interface: ExpressionCapable
  
  Return the primary SpEL expression if this component is expression-based.
  
  Specified by:
  
  getExpression in interface ExpressionCapable
  
  Overrides:
  
  getExpression in class IntegrationObjectSupport
  
  Returns:
  
  the expression as a String.
- forceClose
  
  public void forceClose(TcpConnection connection)
  
  Description copied from class: AbstractClientConnectionFactory
  
  Force close the connection and null the field if it's a shared connection.
  
  Overrides:
  
  forceClose in class AbstractClientConnectionFactory
  
  Parameters:
  
  connection - The connection.
- getSoTimeout
  
  public int getSoTimeout()
  
  Overrides:
  
  getSoTimeout in class AbstractConnectionFactory
  
  Returns:
  
  the soTimeout
- setSoTimeout
  
  public void setSoTimeout(int soTimeout)
  
  Overrides:
  
  setSoTimeout in class AbstractConnectionFactory
  
  Parameters:
  
  soTimeout - the soTimeout to set
- getSoReceiveBufferSize
  
  public int getSoReceiveBufferSize()
  
  Overrides:
  
  getSoReceiveBufferSize in class AbstractConnectionFactory
  
  Returns:
  
  the soReceiveBufferSize
- setSoReceiveBufferSize
  
  public void setSoReceiveBufferSize(int soReceiveBufferSize)
  
  Overrides:
  
  setSoReceiveBufferSize in class AbstractConnectionFactory
  
  Parameters:
  
  soReceiveBufferSize - the soReceiveBufferSize to set
- getSoSendBufferSize
  
  public int getSoSendBufferSize()
  
  Overrides:
  
  getSoSendBufferSize in class AbstractConnectionFactory
  
  Returns:
  
  the soSendBufferSize
- setSoSendBufferSize
  
  public void setSoSendBufferSize(int soSendBufferSize)
  
  Overrides:
  
  setSoSendBufferSize in class AbstractConnectionFactory
  
  Parameters:
  
  soSendBufferSize - the soSendBufferSize to set
- isSoTcpNoDelay
  
  public boolean isSoTcpNoDelay()
  
  Overrides:
  
  isSoTcpNoDelay in class AbstractConnectionFactory
  
  Returns:
  
  the soTcpNoDelay
- setSoTcpNoDelay
  
  public void setSoTcpNoDelay(boolean soTcpNoDelay)
  
  Overrides:
  
  setSoTcpNoDelay in class AbstractConnectionFactory
  
  Parameters:
  
  soTcpNoDelay - the soTcpNoDelay to set
- getSoLinger
  
  public int getSoLinger()
  
  Overrides:
  
  getSoLinger in class AbstractConnectionFactory
  
  Returns:
  
  the soLinger
- setSoLinger
  
  public void setSoLinger(int soLinger)
  
  Overrides:
  
  setSoLinger in class AbstractConnectionFactory
  
  Parameters:
  
  soLinger - the soLinger to set
- isSoKeepAlive
  
  public boolean isSoKeepAlive()
  
  Overrides:
  
  isSoKeepAlive in class AbstractConnectionFactory
  
  Returns:
  
  the soKeepAlive
- setSoKeepAlive
  
  public void setSoKeepAlive(boolean soKeepAlive)
  
  Overrides:
  
  setSoKeepAlive in class AbstractConnectionFactory
  
  Parameters:
  
  soKeepAlive - the soKeepAlive to set
- getConversionService
  
  public ConversionService getConversionService()
  
  Overrides:
  
  getConversionService in class IntegrationObjectSupport
- getSoTrafficClass
  
  public int getSoTrafficClass()
  
  Overrides:
  
  getSoTrafficClass in class AbstractConnectionFactory
  
  Returns:
  
  the soTrafficClass
- setSoTrafficClass
  
  public void setSoTrafficClass(int soTrafficClass)
  
  Overrides:
  
  setSoTrafficClass in class AbstractConnectionFactory
  
  Parameters:
  
  soTrafficClass - the soTrafficClass to set
- setHost
  
  public void setHost(String host)
  
  Description copied from class: AbstractConnectionFactory
  
  Set the host; requires the factory to be stopped.
  
  Overrides:
  
  setHost in class AbstractConnectionFactory
  
  Parameters:
  
  host - the host.
- getHost
  
  public String getHost()
  
  Overrides:
  
  getHost in class AbstractConnectionFactory
  
  Returns:
  
  the host
- setPort
  
  public void setPort(int port)
  
  Description copied from class: AbstractConnectionFactory
  
  Set the port; requires the factory to be stopped.
  
  Overrides:
  
  setPort in class AbstractConnectionFactory
  
  Parameters:
  
  port - the port.
- getApplicationContextId
  
  public String getApplicationContextId()
  
  Description copied from class: IntegrationObjectSupport
  
  Returns the ApplicationContext.getId() if the ApplicationContext is available.
  
  Overrides:
  
  getApplicationContextId in class IntegrationObjectSupport
  
  Returns:
  
  The id, or null if there is no application context.
- getPort
  
  public int getPort()
  
  Overrides:
  
  getPort in class AbstractConnectionFactory
  
  Returns:
  
  the port
- getListener
  
  public TcpListener getListener()
  
  Overrides:
  
  getListener in class AbstractConnectionFactory
  
  Returns:
  
  the listener
- getSender
  
  public TcpSender getSender()
  
  Overrides:
  
  getSender in class AbstractConnectionFactory
  
  Returns:
  
  the first sender, if present.
- getSenders
  
  public List<TcpSender> getSenders()
  
  Description copied from class: AbstractConnectionFactory
  
  Return the list of senders.
  
  Overrides:
  
  getSenders in class AbstractConnectionFactory
  
  Returns:
  
  the senders.
- getSerializer
  
  public Serializer<?> getSerializer()
  
  Overrides:
  
  getSerializer in class AbstractConnectionFactory
  
  Returns:
  
  the serializer
- getDeserializer
  
  public Deserializer<?> getDeserializer()
  
  Overrides:
  
  getDeserializer in class AbstractConnectionFactory
  
  Returns:
  
  the deserializer
- getMapper
  
  public TcpMessageMapper getMapper()
  
  Overrides:
  
  getMapper in class AbstractConnectionFactory
  
  Returns:
  
  the mapper
- registerListener
  
  public void registerListener(TcpListener listener)
  
  Description copied from class: AbstractConnectionFactory
  
  Registers a TcpListener to receive messages after the payload has been converted from the input data.
  
  Overrides:
  
  registerListener in class AbstractConnectionFactory
  
  Parameters:
  
  listener - the TcpListener.
- setMessageBuilderFactory
  
  public void setMessageBuilderFactory(MessageBuilderFactory messageBuilderFactory)
  
  Overrides:
  
  setMessageBuilderFactory in class IntegrationObjectSupport
- registerSender
  
  public void registerSender(TcpSender sender)
  
  Description copied from class: AbstractConnectionFactory
  
  Registers a TcpSender; for server sockets, used to provide connection information so a sender can be used to reply to incoming messages.
  
  Overrides:
  
  registerSender in class AbstractConnectionFactory
  
  Parameters:
  
  sender - The sender
- setTaskExecutor
  
  public void setTaskExecutor(Executor taskExecutor)
  
  Overrides:
  
  setTaskExecutor in class AbstractConnectionFactory
  
  Parameters:
  
  taskExecutor - the taskExecutor to set
- setDeserializer
  
  public void setDeserializer(Deserializer<?> deserializer)
  
  Overrides:
  
  setDeserializer in class AbstractConnectionFactory
  
  Parameters:
  
  deserializer - the deserializer to set
- setSerializer
  
  public void setSerializer(Serializer<?> serializer)
  
  Overrides:
  
  setSerializer in class AbstractConnectionFactory
  
  Parameters:
  
  serializer - the serializer to set
- setMapper
  
  public void setMapper(TcpMessageMapper mapper)
  
  Overrides:
  
  setMapper in class AbstractConnectionFactory
  
  Parameters:
  
  mapper - the mapper to set; defaults to a TcpMessageMapper
- setInterceptorFactoryChain
  
  public void setInterceptorFactoryChain(TcpConnectionInterceptorFactoryChain interceptorFactoryChain)
  
  Overrides:
  
  setInterceptorFactoryChain in class AbstractConnectionFactory
- setLookupHost
  
  public void setLookupHost(boolean lookupHost)
  
  Description copied from class: AbstractConnectionFactory
  
  If true, DNS reverse lookup is done on the remote ip address. Default true.
  
  Overrides:
  
  setLookupHost in class AbstractConnectionFactory
  
  Parameters:
  
  lookupHost - the lookupHost to set
- isLookupHost
  
  public boolean isLookupHost()
  
  Overrides:
  
  isLookupHost in class AbstractConnectionFactory
  
  Returns:
  
  the lookupHost
- setNioHarvestInterval
  
  public void setNioHarvestInterval(int nioHarvestInterval)
  
  Description copied from class: AbstractConnectionFactory
  
  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.
  
  Overrides:
  
  setNioHarvestInterval in class AbstractConnectionFactory
  
  Parameters:
  
  nioHarvestInterval - The interval in milliseconds.
- setSslHandshakeTimeout
  
  public void setSslHandshakeTimeout(int sslHandshakeTimeout)
  
  Description copied from class: AbstractConnectionFactory
  
  Set the handshake timeout used when waiting for SSL handshake data; only applies to SSL connections, when using NIO.
  
  Overrides:
  
  setSslHandshakeTimeout in class AbstractConnectionFactory
  
  Parameters:
  
  sslHandshakeTimeout - the timeout.
- setReadDelay
  
  public void setReadDelay(long readDelay)
  
  Description copied from class: AbstractConnectionFactory
  
  The delay (in milliseconds) before retrying a read after the previous attempt failed due to insufficient threads. Default 100.
  
  Overrides:
  
  setReadDelay in class AbstractConnectionFactory
  
  Parameters:
  
  readDelay - the readDelay to set.
- start
  
  public void start()
  
  Specified by:
  
  start in interface Lifecycle
  
  Specified by:
  
  start in interface ManageableLifecycle
  
  Overrides:
  
  start in class AbstractConnectionFactory
- stop
  
  public void stop()
  
  Description copied from class: AbstractConnectionFactory
  
  Stops the server.
  
  Specified by:
  
  stop in interface Lifecycle
  
  Specified by:
  
  stop in interface ManageableLifecycle
  
  Overrides:
  
  stop in class AbstractConnectionFactory
- isRunning
  
  public boolean isRunning()
  
  Specified by:
  
  isRunning in interface Lifecycle
  
  Specified by:
  
  isRunning in interface ManageableLifecycle
  
  Overrides:
  
  isRunning in class AbstractConnectionFactory
- setTcpSocketSupport
  
  public void setTcpSocketSupport(TcpSocketSupport tcpSocketSupport)
  
  Overrides:
  
  setTcpSocketSupport in class AbstractConnectionFactory
- getOpenConnectionIds
  
  public List<String> getOpenConnectionIds()
  
  Description copied from class: AbstractConnectionFactory
  
  Returns a list of (currently) open TcpConnection connection ids; allows, for example, broadcast operations to all open connections.
  
  Overrides:
  
  getOpenConnectionIds in class AbstractConnectionFactory
  
  Returns:
  
  the list of connection ids.
- closeConnection
  
  public boolean closeConnection(String connectionId)
  
  Description copied from class: AbstractConnectionFactory
  
  Close a connection with the specified connection id.
  
  Overrides:
  
  closeConnection in class AbstractConnectionFactory
  
  Parameters:
  
  connectionId - the connection id.
  
  Returns:
  
  true if the connection was closed.
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class AbstractConnectionFactory

Class ThreadAffinityClientConnectionFactory

Field Summary

Fields inherited from class org.springframework.integration.ip.tcp.connection.AbstractConnectionFactory

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

Constructor Summary

Method Summary

Methods inherited from class org.springframework.integration.ip.tcp.connection.AbstractClientConnectionFactory

Methods inherited from class org.springframework.integration.ip.tcp.connection.AbstractConnectionFactory

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

Methods inherited from class java.lang.Object

Constructor Details

Method Details