java.lang.Object

org.springframework.integration.ip.tcp.connection.TcpConnectionSupport

org.springframework.integration.ip.tcp.connection.TcpConnectionInterceptorSupport

All Implemented Interfaces:: Runnable, TcpConnection, TcpConnectionInterceptor, TcpListener, TcpSender

public abstract class TcpConnectionInterceptorSupport
extends TcpConnectionSupport
implements TcpConnectionInterceptor

Base class for TcpConnectionInterceptors; passes all method calls through to the underlying TcpConnection.

Since:: 2.0
Author:: Gary Russell

Field Summary

Fields inherited from class org.springframework.integration.ip.tcp.connection.TcpConnectionSupport
logger
Constructor Summary

Constructors

Constructor Description

TcpConnectionInterceptorSupport()

TcpConnectionInterceptorSupport(ApplicationEventPublisher applicationEventPublisher)

Method Summary

Modifier and Type	Method	Description
`void`	`addNewConnection(TcpConnection connection)`	When we are using sockets owned by a `TcpListener`, this method is called each time a new connection is made.
`void`	`close()`	Close this connection.
`String`	`getConnectionFactoryName()`
`String`	`getConnectionId()`
`Deserializer<?>`	`getDeserializer()`
`Object`	`getDeserializerStateKey()`
`String`	`getHostAddress()`
`String`	`getHostName()`
`TcpListener`	`getListener()`
`Object`	`getPayload()`	Uses the deserializer to obtain the message payload from the connection's input stream.
`int`	`getPort()`
`TcpSender`	`getSender()`
`List<TcpSender>`	`getSenders()`	Return the list of senders.
`Serializer<?>`	`getSerializer()`
`SocketInfo`	`getSocketInfo()`	Provides getters for `Socket` properties.
`SSLSession`	`getSslSession()`
`TcpConnectionSupport`	`getTheConnection()`	Return the underlying connection (or next interceptor).
`protected boolean`	`hasRealSender()`
`long`	`incrementAndGetConnectionSequence()`
`boolean`	`isOpen()`
`boolean`	`isServer()`
`boolean`	`onMessage(Message<?> message)`	Called by a TCPConnection when a new message arrives.
`void`	`registerListener(TcpListener listener)`	Set the listener that will receive incoming Messages.
`void`	`registerSender(TcpSender sender)`	Register a sender.
`void`	`registerSenders(List<TcpSender> sendersToRegister)`	Register the senders.
`void`	`removeDeadConnection(TcpConnection connection)`	When we are using sockets owned by a `TcpListener`, this method is called each time a connection is closed.
`void`	`run()`
`void`	`send(Message<?> message)`	Converts and sends the message.
`void`	`setDeserializer(Deserializer<?> deserializer)`
`void`	`setMapper(TcpMessageMapper mapper)`
`void`	`setSerializer(Serializer<?> serializer)`
`void`	`setTheConnection(TcpConnectionSupport theConnection)`	Set the underlying connection (or next interceptor).

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

closeConnection, enableManualListenerRegistration, getMapper, isNoReadErrorOnClose, publishConnectionCloseEvent, publishConnectionExceptionEvent, publishConnectionOpenEvent, publishEvent, registerTestListener, sendExceptionToListener, setNeedsTest, setNoReadErrorOnClose, setWrapped, setWrapper, 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.TcpConnection

shutdownInput, shutdownOutput

Constructor Details
- TcpConnectionInterceptorSupport
  
  public TcpConnectionInterceptorSupport()
- TcpConnectionInterceptorSupport
  
  public TcpConnectionInterceptorSupport(ApplicationEventPublisher applicationEventPublisher)
Method Details
- close
  
  public void close()
  
  Description copied from class: TcpConnectionSupport
  
  Close this connection.
  
  Specified by:
  
  close in interface TcpConnection
  
  Overrides:
  
  close in class TcpConnectionSupport
- isOpen
  
  public boolean isOpen()
  
  Specified by:
  
  isOpen in interface TcpConnection
  
  Returns:
  
  true if the connection is open.
- getPayload
  
  public Object getPayload()
  
  Description copied from interface: TcpConnection
  
  Uses the deserializer to obtain the message payload from the connection's input stream.
  
  Specified by:
  
  getPayload in interface TcpConnection
  
  Returns:
  
  The payload.
- getHostName
  
  public String getHostName()
  
  Specified by:
  
  getHostName in interface TcpConnection
  
  Overrides:
  
  getHostName in class TcpConnectionSupport
  
  Returns:
  
  the host name
- getHostAddress
  
  public String getHostAddress()
  
  Specified by:
  
  getHostAddress in interface TcpConnection
  
  Overrides:
  
  getHostAddress in class TcpConnectionSupport
  
  Returns:
  
  the host address
- getPort
  
  public int getPort()
  
  Specified by:
  
  getPort in interface TcpConnection
  
  Returns:
  
  the port
- getDeserializerStateKey
  
  public Object getDeserializerStateKey()
  
  Specified by:
  
  getDeserializerStateKey in interface TcpConnection
  
  Returns:
  
  a key that can be used to reference state in a Deserializer that maintains state for this connection. Currently, this would be the InputStream associated with the connection, but the object should be treated as opaque and ONLY used as a key.
- registerListener
  
  public void registerListener(TcpListener listener)
  
  Description copied from class: TcpConnectionSupport
  
  Set the listener that will receive incoming Messages.
  
  Overrides:
  
  registerListener in class TcpConnectionSupport
  
  Parameters:
  
  listener - The listener.
- registerSender
  
  public void registerSender(TcpSender sender)
  
  Description copied from class: TcpConnectionSupport
  
  Register a sender. Used on server side connections so a sender can determine which connection to send a reply to.
  
  Overrides:
  
  registerSender in class TcpConnectionSupport
  
  Parameters:
  
  sender - the sender.
- registerSenders
  
  public void registerSenders(List<TcpSender> sendersToRegister)
  
  Description copied from class: TcpConnectionSupport
  
  Register the senders. Used on server side connections so a sender can determine which connection to send a reply to.
  
  Overrides:
  
  registerSenders in class TcpConnectionSupport
  
  Parameters:
  
  sendersToRegister - the sender.
- getConnectionId
  
  public String getConnectionId()
  
  IMPORTANT: Do not override this method in your interceptor implementation if the intercepted connection is created by a server connection factory, because the connection id of the underlying connection is used for routing when arbitrary outbound messaging is being used. The method is not final because client-side interceptors can override it without any issues.
  
  Specified by:
  
  getConnectionId in interface TcpConnection
  
  Overrides:
  
  getConnectionId in class TcpConnectionSupport
  
  Returns:
  
  a string uniquely representing a connection.
- getSocketInfo
  
  public SocketInfo getSocketInfo()
  
  Description copied from interface: TcpConnection
  
  Provides getters for Socket properties.
  
  Specified by:
  
  getSocketInfo in interface TcpConnection
  
  Overrides:
  
  getSocketInfo in class TcpConnectionSupport
  
  Returns:
  
  the socketInfo - may be null, for example in interceptors; interceptors should override and delegate to the actual TcpConnection.
- getConnectionFactoryName
  
  public String getConnectionFactoryName()
  
  Overrides:
  
  getConnectionFactoryName in class TcpConnectionSupport
- run
  
  public void run()
  
  Specified by:
  
  run in interface Runnable
- setMapper
  
  public void setMapper(TcpMessageMapper mapper)
  
  Overrides:
  
  setMapper in class TcpConnectionSupport
  
  Parameters:
  
  mapper - the mapper to set
- getDeserializer
  
  public Deserializer<?> getDeserializer()
  
  Specified by:
  
  getDeserializer in interface TcpConnection
  
  Overrides:
  
  getDeserializer in class TcpConnectionSupport
  
  Returns:
  
  the deserializer
- setDeserializer
  
  public void setDeserializer(Deserializer<?> deserializer)
  
  Overrides:
  
  setDeserializer in class TcpConnectionSupport
  
  Parameters:
  
  deserializer - the deserializer to set
- getSerializer
  
  public Serializer<?> getSerializer()
  
  Specified by:
  
  getSerializer in interface TcpConnection
  
  Overrides:
  
  getSerializer in class TcpConnectionSupport
  
  Returns:
  
  the serializer
- setSerializer
  
  public void setSerializer(Serializer<?> serializer)
  
  Overrides:
  
  setSerializer in class TcpConnectionSupport
  
  Parameters:
  
  serializer - the serializer to set
- isServer
  
  public boolean isServer()
  
  Specified by:
  
  isServer in interface TcpConnection
  
  Overrides:
  
  isServer in class TcpConnectionSupport
  
  Returns:
  
  True if connection is used once.
- getSslSession
  
  public SSLSession getSslSession()
  
  Specified by:
  
  getSslSession in interface TcpConnection
  
  Returns:
  
  the SSLSession associated with this connection, if SSL is in use, null otherwise.
- onMessage
  
  public boolean onMessage(Message<?> message)
  
  Description copied from interface: TcpListener
  
  Called by a TCPConnection when a new message arrives.
  
  Specified by:
  
  onMessage in interface TcpListener
  
  Parameters:
  
  message - The message.
  
  Returns:
  
  true if the message was intercepted
- send
  
  public void send(Message<?> message)
  
  Description copied from interface: TcpConnection
  
  Converts and sends the message.
  
  Specified by:
  
  send in interface TcpConnection
  
  Parameters:
  
  message - The message,
- getTheConnection
  
  public TcpConnectionSupport getTheConnection()
  
  Return the underlying connection (or next interceptor).
  
  Returns:
  
  the connection
- setTheConnection
  
  public void setTheConnection(TcpConnectionSupport theConnection)
  
  Set the underlying connection (or next interceptor).
  
  Parameters:
  
  theConnection - the connection
- getListener
  
  @Nullable public TcpListener getListener()
  
  Specified by:
  
  getListener in interface TcpConnection
  
  Overrides:
  
  getListener in class TcpConnectionSupport
  
  Returns:
  
  the listener
- addNewConnection
  
  public void addNewConnection(TcpConnection connection)
  
  Description copied from interface: TcpSender
  
  When we are using sockets owned by a TcpListener, this method is called each time a new connection is made.
  
  Specified by:
  
  addNewConnection in interface TcpSender
  
  Parameters:
  
  connection - The connection.
- removeDeadConnection
  
  public void removeDeadConnection(TcpConnection connection)
  
  Description copied from interface: TcpSender
  
  When we are using sockets owned by a TcpListener, this method is called each time a connection is closed.
  
  Specified by:
  
  removeDeadConnection in interface TcpSender
  
  Parameters:
  
  connection - The connection.
- incrementAndGetConnectionSequence
  
  public long incrementAndGetConnectionSequence()
  
  Specified by:
  
  incrementAndGetConnectionSequence in interface TcpConnection
  
  Overrides:
  
  incrementAndGetConnectionSequence in class TcpConnectionSupport
  
  Returns:
  
  the next sequence number for a message received on this socket
- getSender
  
  @Nullable public TcpSender getSender()
  
  Overrides:
  
  getSender in class TcpConnectionSupport
  
  Returns:
  
  the first sender, if present.
- getSenders
  
  public List<TcpSender> getSenders()
  
  Description copied from class: TcpConnectionSupport
  
  Return the list of senders.
  
  Overrides:
  
  getSenders in class TcpConnectionSupport
  
  Returns:
  
  the senders.
- hasRealSender
  
  protected boolean hasRealSender()

Constructor	Description
`TcpConnectionInterceptorSupport()`
`TcpConnectionInterceptorSupport(ApplicationEventPublisher applicationEventPublisher)`

Class TcpConnectionInterceptorSupport

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

Method Details