org.springframework.integration.websocket.inbound

Class WebSocketInboundChannelAdapter

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

org.springframework.integration.endpoint.AbstractEndpoint

org.springframework.integration.endpoint.MessageProducerSupport

org.springframework.integration.websocket.inbound.WebSocketInboundChannelAdapter

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, SmartInitializingSingleton, ApplicationContextAware, ApplicationEventPublisherAware, Lifecycle, Phased, SmartLifecycle, ExpressionCapable, MessageProducer, IntegrationPattern, NamedComponent, ManageableLifecycle, ManageableSmartLifecycle, TrackableComponent, WebSocketListener, SubProtocolCapable

public class WebSocketInboundChannelAdapter
extends MessageProducerSupport
implements WebSocketListener, ApplicationEventPublisherAware

The MessageProducerSupport for inbound WebSocket messages.

Since:

4.1

Author:

Artem Bilan

Field Summary

Fields inherited from class org.springframework.integration.endpoint.AbstractEndpoint

lifecycleCondition, lifecycleLock

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

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor and Description
WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer)
WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer, SubProtocolHandlerRegistry protocolHandlerRegistry)

Method Summary

Modifier and Type	Method and Description
void	afterSessionEnded(WebSocketSession session, CloseStatus closeStatus) Invoked after a WebSocketSession has ended.
void	afterSessionStarted(WebSocketSession session) Invoked after a WebSocketSession has started.
protected void	doStart() Take no action by default.
protected void	doStop() Take no action by default.
String	getComponentType() Subclasses may implement this method to provide component type information.
List<String>	getSubProtocols()
boolean	isActive()
protected void	onInit() Subclasses may implement this for initialization logic.
void	onMessage(WebSocketSession session, WebSocketMessage<?> webSocketMessage) Handle the received WebSocketMessage.
void	setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)
void	setMergeWithDefaultConverters(boolean mergeWithDefaultConverters) Flag which determines if the default converters should be available after custom converters.
void	setMessageConverters(List<MessageConverter> messageConverters) Set the message converters to use.
void	setPayloadType(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 WebSocketMessages and to route messages with broker destinations.

Methods inherited from class org.springframework.integration.endpoint.MessageProducerSupport

afterSingletonsInstantiated, buildErrorMessage, getErrorChannel, getErrorMessageAttributes, getIntegrationPatternType, getMessagingTemplate, getOutputChannel, sendErrorMessageIfNecessary, sendMessage, setErrorChannel, setErrorChannelName, setErrorMessageStrategy, setOutputChannel, setOutputChannelName, setSendTimeout, setShouldTrack, subscribeToPublisher

Methods inherited from class org.springframework.integration.endpoint.AbstractEndpoint

destroy, doStop, getPhase, getRole, isAutoStartup, isRunning, setAutoStartup, setPhase, setRole, start, stop, stop

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

afterPropertiesSet, extractTypeIfPossible, generateId, getApplicationContext, getApplicationContextId, getBeanDescription, getBeanFactory, getBeanName, getChannelResolver, getComponentName, getConversionService, getExpression, getIntegrationProperties, getIntegrationProperty, getMessageBuilderFactory, getTaskScheduler, isInitialized, setApplicationContext, setBeanFactory, setBeanName, setChannelResolver, setComponentName, setConversionService, setMessageBuilderFactory, setPrimaryExpression, 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.support.context.NamedComponent

getBeanName, getComponentName

Constructor Detail

WebSocketInboundChannelAdapter

public WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer)

WebSocketInboundChannelAdapter

public WebSocketInboundChannelAdapter(IntegrationWebSocketContainer webSocketContainer,
                                      SubProtocolHandlerRegistry protocolHandlerRegistry)

Method Detail

setMessageConverters

public void setMessageConverters(List<MessageConverter> messageConverters)

Set the message converters to use. These converters are used to convert the message to send for appropriate internal subProtocols type.

Parameters:

messageConverters - The message converters.

setMergeWithDefaultConverters

public void setMergeWithDefaultConverters(boolean mergeWithDefaultConverters)

Flag which determines if the default converters should be available after custom converters.

Parameters:

mergeWithDefaultConverters - true to merge, false to replace.

setPayloadType

public void setPayloadType(Class<?> payloadType)

Set the type for target message payload to convert the WebSocket message body to.

Parameters:

payloadType - to convert inbound WebSocket message body

See Also:

CompositeMessageConverter

setUseBroker

public void setUseBroker(boolean useBroker)

Specify if this adapter should use an existing single AbstractBrokerMessageHandler bean for non-MESSAGE WebSocketMessages 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.

Parameters:

useBroker - the boolean flag.

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

onInit

protected void onInit()

Description copied from class: IntegrationObjectSupport

Subclasses may implement this for initialization logic.

Overrides:

onInit in class MessageProducerSupport

getSubProtocols

public List<String> getSubProtocols()

Specified by:

getSubProtocols in interface SubProtocolCapable

afterSessionStarted

public void afterSessionStarted(WebSocketSession session)
                         throws Exception

Description copied from interface: WebSocketListener

Invoked after a WebSocketSession has started.

Specified by:

afterSessionStarted in interface WebSocketListener

Parameters:

session - the WebSocket session

Throws:

Exception - the 'afterSessionStarted' Exception

afterSessionEnded

public void afterSessionEnded(WebSocketSession session,
                              CloseStatus closeStatus)
                       throws Exception

Description copied from interface: WebSocketListener

Invoked after a WebSocketSession has ended.

Specified by:

afterSessionEnded in interface WebSocketListener

Parameters:

session - the WebSocket session

closeStatus - the reason why the session was closed

Throws:

Exception - the 'afterSessionEnded' Exception

onMessage

public void onMessage(WebSocketSession session,
                      WebSocketMessage<?> webSocketMessage)
               throws Exception

Description copied from interface: WebSocketListener

Handle the received WebSocketMessage.

Specified by:

onMessage in interface WebSocketListener

Parameters:

session - the WebSocket session

webSocketMessage - the WebSocket message

Throws:

Exception - the 'onMessage' Exception

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

doStart

protected void doStart()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior. Protected by 'lifecycleLock'.

Overrides:

doStart in class MessageProducerSupport

doStop

protected void doStop()

Description copied from class: MessageProducerSupport

Take no action by default. Subclasses may override this if they need lifecycle-managed behavior.

Overrides:

doStop in class MessageProducerSupport

isActive

public boolean isActive()

Overrides:

isActive in class AbstractEndpoint