public class WebSocketInboundChannelAdapter extends org.springframework.integration.endpoint.MessageProducerSupport implements WebSocketListener
Constructor and Description |
---|
WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer) |
WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer,
SubProtocolHandlerRegistry protocolHandlerRegistry) |
Modifier and Type | Method and Description |
---|---|
void |
afterSessionEnded(org.springframework.web.socket.WebSocketSession session,
org.springframework.web.socket.CloseStatus closeStatus)
Invoked after a
WebSocketSession has ended. |
void |
afterSessionStarted(org.springframework.web.socket.WebSocketSession session)
Invoked after a
WebSocketSession has started. |
protected void |
doStart() |
protected void |
doStop() |
java.lang.String |
getComponentType() |
java.util.List<java.lang.String> |
getSubProtocols() |
protected void |
onInit() |
void |
onMessage(org.springframework.web.socket.WebSocketSession session,
org.springframework.web.socket.WebSocketMessage<?> webSocketMessage)
Handle the received
WebSocketMessage . |
void |
setMergeWithDefaultConverters(boolean mergeWithDefaultConverters)
Flag which determines if the default converters should be available after
custom converters.
|
void |
setMessageConverters(java.util.List<org.springframework.messaging.converter.MessageConverter> messageConverters)
Set the message converters to use.
|
void |
setPayloadType(java.lang.Class<?> payloadType)
Set the type for target message payload to convert the WebSocket message body to.
|
void |
setUseBroker(boolean useBroker)
Specify if this adapter should use an existing single
AbstractBrokerMessageHandler
bean for non-MESSAGE WebSocketMessage s
and to route messages with broker destinations. |
sendMessage, setErrorChannel, setOutputChannel, setSendTimeout, setShouldTrack
doStop, getPhase, isAutoStartup, isRunning, setAutoStartup, setPhase, setTaskScheduler, start, stop, stop
afterPropertiesSet, getApplicationContext, getApplicationContextId, getBeanFactory, getComponentName, getConversionService, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, setApplicationContext, setBeanFactory, setBeanName, setComponentName, setConversionService, setMessageBuilderFactory, toString
public WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer)
public WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer, SubProtocolHandlerRegistry protocolHandlerRegistry)
public void setMessageConverters(java.util.List<org.springframework.messaging.converter.MessageConverter> messageConverters)
messageConverters
- The message converters.public void setMergeWithDefaultConverters(boolean mergeWithDefaultConverters)
mergeWithDefaultConverters
- true to merge, false to replace.public void setPayloadType(java.lang.Class<?> payloadType)
payloadType
- to convert inbound WebSocket message bodyCompositeMessageConverter
public void setUseBroker(boolean useBroker)
AbstractBrokerMessageHandler
bean for non-MESSAGE
WebSocketMessage
s
and to route messages with broker destinations.
Since only single AbstractBrokerMessageHandler
bean is allowed in the current
application context, the algorithm to lookup the former by type, rather than applying
the bean reference.
This is used only on server side and is ignored from client side.useBroker
- the boolean flag.protected void onInit()
onInit
in class org.springframework.integration.endpoint.MessageProducerSupport
public java.util.List<java.lang.String> getSubProtocols()
getSubProtocols
in interface org.springframework.web.socket.SubProtocolCapable
public void afterSessionStarted(org.springframework.web.socket.WebSocketSession session) throws java.lang.Exception
WebSocketListener
WebSocketSession
has started.afterSessionStarted
in interface WebSocketListener
session
- the WebSocket sessionjava.lang.Exception
- the 'afterSessionStarted' Exceptionpublic void afterSessionEnded(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.CloseStatus closeStatus) throws java.lang.Exception
WebSocketListener
WebSocketSession
has ended.afterSessionEnded
in interface WebSocketListener
session
- the WebSocket sessioncloseStatus
- the reason why the session was closedjava.lang.Exception
- the 'afterSessionEnded' Exceptionpublic void onMessage(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.WebSocketMessage<?> webSocketMessage) throws java.lang.Exception
WebSocketListener
WebSocketMessage
.onMessage
in interface WebSocketListener
session
- the WebSocket sessionwebSocketMessage
- the WebSocket messagejava.lang.Exception
- the 'onMessage' Exceptionpublic java.lang.String getComponentType()
getComponentType
in interface org.springframework.integration.support.context.NamedComponent
getComponentType
in class org.springframework.integration.context.IntegrationObjectSupport
protected void doStart()
doStart
in class org.springframework.integration.endpoint.MessageProducerSupport
protected void doStop()
doStop
in class org.springframework.integration.endpoint.MessageProducerSupport