Package org.springframework.integration.websocket.support

Class SubProtocolHandlerRegistry

java.lang.Object

org.springframework.integration.websocket.support.SubProtocolHandlerRegistry

public final class SubProtocolHandlerRegistry
extends Object

The utility class to encapsulate search algorithms for a set of provided SubProtocolHandlers.

For internal use only.

Since:

4.1

Author:

Andy Wilkinson, Artem Bilan

See Also:

• WebSocketInboundChannelAdapter
• WebSocketOutboundMessageHandler

Constructor Summary

Constructors

Constructor	Description
SubProtocolHandlerRegistry(List<SubProtocolHandler> protocolHandlers)
SubProtocolHandlerRegistry(List<SubProtocolHandler> protocolHandlers, SubProtocolHandler defaultProtocolHandler)
SubProtocolHandlerRegistry(SubProtocolHandler defaultProtocolHandler)

Method Summary

Modifier and Type	Method	Description
SubProtocolHandler	findProtocolHandler(WebSocketSession session)	Resolves the SubProtocolHandler for the given session using its accepted sub-protocol.
List<String>	getSubProtocols()	Return the List of sub-protocols from provided SubProtocolHandler.
String	resolveSessionId(Message<?> message)	Resolves the sessionId for the given message using the SubProtocolHandler.resolveSessionId(org.springframework.messaging.Message<?>) algorithm.

Methods inherited from class java.lang.Object

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

Constructor Details

SubProtocolHandlerRegistry

public SubProtocolHandlerRegistry(List<SubProtocolHandler> protocolHandlers)

SubProtocolHandlerRegistry

public SubProtocolHandlerRegistry(SubProtocolHandler defaultProtocolHandler)

SubProtocolHandlerRegistry

public SubProtocolHandlerRegistry(List<SubProtocolHandler> protocolHandlers,
 SubProtocolHandler defaultProtocolHandler)

Method Details

findProtocolHandler

public SubProtocolHandler findProtocolHandler(WebSocketSession session)

Resolves the SubProtocolHandler for the given session using its accepted sub-protocol.

Parameters:

session - The session to resolve the sub-protocol handler for

Returns:

The sub-protocol handler

Throws:

IllegalStateException - if a protocol handler cannot be resolved

resolveSessionId

public String resolveSessionId(Message<?> message)

Resolves the sessionId for the given message using the SubProtocolHandler.resolveSessionId(org.springframework.messaging.Message<?>) algorithm.

Parameters:

message - The message to resolve the sessionId from.

Returns:

The sessionId or null, if no one SubProtocolHandler can't resolve it against provided message.

getSubProtocols

public List<String> getSubProtocols()

Return the List of sub-protocols from provided SubProtocolHandler.

Returns:

The List of supported sub-protocols.