Class WebSocketCapabilities

java.lang.Object

io.fluxzero.common.websocket.WebSocketCapabilities

public final class WebSocketCapabilities
extends Object

Utility methods for exchanging Fluxzero websocket client capabilities through handshake headers.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLIENT_SDK_VERSION_HEADER
static final String	CLIENT_SESSION_ID_HEADER
static final String	REPLACES_SESSION_ID_HEADER
static final String	RUNTIME_SESSION_ID_HEADER
static final String	RUNTIME_VERSION_HEADER
static final String	SELECTED_COMPRESSION_ALGORITHM_HEADER
static final String	SELECTED_TRANSPORT_FORMAT_HEADER
static final String	SUPPORTED_COMPRESSION_ALGORITHMS_HEADER
static final String	SUPPORTED_DOCUMENT_COMPRESSION_HEADER	Supported document compression codecs; stored bytes are preserved when the client knows their codec.
static final String	SUPPORTED_MODEL_MEMBERSHIP_VERSIONS_HEADER	Explicit packed Model membership versions understood by this client (independent of transport format).
static final String	SUPPORTED_TRANSPORT_FORMATS_HEADER
static final String	SUPPORTS_MIXED_MODEL_EVENT_BLOCKS_HEADER	This reader accepts mixed legacy and binary records within one compact Model-event block.

Method Summary

Modifier and Type	Method	Description
static Map<String, List<String>>	asHeaders(Collection<CompressionAlgorithm> supportedCompressionAlgorithms)	Serializes the supplied compression capabilities into websocket request headers.
static Map<String, List<String>>	asTransportHeaders(Collection<WebSocketTransportFormat> supportedTransportFormats)	Serializes the supplied websocket transport formats into websocket request headers.
static Optional<String>	getClientSdkVersion(Map<String, List<String>> headers)
static Optional<String>	getClientSessionId(Map<String, List<String>> headers)
static Optional<CompressionAlgorithm>	getPreferredCompressionAlgorithm(Map<String, List<String>> headers)	Returns the most preferred compression algorithm advertised via request headers, if available.
static Optional<WebSocketTransportFormat>	getPreferredTransportFormat(Map<String, List<String>> headers)	Returns the most preferred websocket transport format advertised via request headers, if available.
static Optional<String>	getReplacedSessionId(Map<String, List<String>> headers)
static Optional<String>	getRuntimeSessionId(Map<String, List<String>> headers)
static Optional<String>	getRuntimeVersion(Map<String, List<String>> headers)
static Optional<CompressionAlgorithm>	getSelectedCompressionAlgorithm(Map<String, List<String>> headers)
static Optional<WebSocketTransportFormat>	getSelectedTransportFormat(Map<String, List<String>> headers)
static List<CompressionAlgorithm>	getSupportedCompressionAlgorithms(Map<String, List<String>> headers)	Extracts the ordered list of compression algorithms from websocket request headers.
static List<WebSocketTransportFormat>	getSupportedTransportFormats(Map<String, List<String>> headers)	Extracts the ordered list of websocket transport formats from websocket request headers.
static String	newShortSessionId()

Methods inherited from class Object

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

Field Details

SUPPORTED_DOCUMENT_COMPRESSION_HEADER

public static final String SUPPORTED_DOCUMENT_COMPRESSION_HEADER

Supported document compression codecs; stored bytes are preserved when the client knows their codec.

See Also:

• Constant Field Values

SUPPORTED_MODEL_MEMBERSHIP_VERSIONS_HEADER

public static final String SUPPORTED_MODEL_MEMBERSHIP_VERSIONS_HEADER

Explicit packed Model membership versions understood by this client (independent of transport format).

See Also:

• Constant Field Values

SUPPORTS_MIXED_MODEL_EVENT_BLOCKS_HEADER

public static final String SUPPORTS_MIXED_MODEL_EVENT_BLOCKS_HEADER

This reader accepts mixed legacy and binary records within one compact Model-event block.

See Also:

• Constant Field Values

SUPPORTED_COMPRESSION_ALGORITHMS_HEADER

public static final String SUPPORTED_COMPRESSION_ALGORITHMS_HEADER

See Also:

• Constant Field Values

SELECTED_COMPRESSION_ALGORITHM_HEADER

public static final String SELECTED_COMPRESSION_ALGORITHM_HEADER

See Also:

• Constant Field Values

SUPPORTED_TRANSPORT_FORMATS_HEADER

public static final String SUPPORTED_TRANSPORT_FORMATS_HEADER

See Also:

• Constant Field Values

SELECTED_TRANSPORT_FORMAT_HEADER

public static final String SELECTED_TRANSPORT_FORMAT_HEADER

See Also:

• Constant Field Values

CLIENT_SESSION_ID_HEADER

public static final String CLIENT_SESSION_ID_HEADER

See Also:

• Constant Field Values

REPLACES_SESSION_ID_HEADER

public static final String REPLACES_SESSION_ID_HEADER

See Also:

• Constant Field Values

CLIENT_SDK_VERSION_HEADER

public static final String CLIENT_SDK_VERSION_HEADER

See Also:

• Constant Field Values

RUNTIME_SESSION_ID_HEADER

public static final String RUNTIME_SESSION_ID_HEADER

See Also:

• Constant Field Values

RUNTIME_VERSION_HEADER

public static final String RUNTIME_VERSION_HEADER

See Also:

• Constant Field Values

Method Details

asHeaders

public static Map<String, List<String>> asHeaders(Collection<CompressionAlgorithm> supportedCompressionAlgorithms)

Serializes the supplied compression capabilities into websocket request headers.

Parameters:

supportedCompressionAlgorithms - ordered list of supported compression algorithms, most preferred first

Returns:

websocket request headers representing the supplied capabilities

asTransportHeaders

public static Map<String, List<String>> asTransportHeaders(Collection<WebSocketTransportFormat> supportedTransportFormats)

Serializes the supplied websocket transport formats into websocket request headers.

Parameters:

supportedTransportFormats - ordered list of supported transport formats, most preferred first

Returns:

websocket request headers representing the supplied transport capabilities

getSupportedCompressionAlgorithms

public static List<CompressionAlgorithm> getSupportedCompressionAlgorithms(Map<String, List<String>> headers)

Extracts the ordered list of compression algorithms from websocket request headers.

getPreferredCompressionAlgorithm

public static Optional<CompressionAlgorithm> getPreferredCompressionAlgorithm(Map<String, List<String>> headers)

Returns the most preferred compression algorithm advertised via request headers, if available.

getSelectedCompressionAlgorithm

public static Optional<CompressionAlgorithm> getSelectedCompressionAlgorithm(Map<String, List<String>> headers)

getSupportedTransportFormats

public static List<WebSocketTransportFormat> getSupportedTransportFormats(Map<String, List<String>> headers)

Extracts the ordered list of websocket transport formats from websocket request headers.

getPreferredTransportFormat

public static Optional<WebSocketTransportFormat> getPreferredTransportFormat(Map<String, List<String>> headers)

Returns the most preferred websocket transport format advertised via request headers, if available.

getSelectedTransportFormat

public static Optional<WebSocketTransportFormat> getSelectedTransportFormat(Map<String, List<String>> headers)

getClientSessionId

public static Optional<String> getClientSessionId(Map<String, List<String>> headers)

getReplacedSessionId

public static Optional<String> getReplacedSessionId(Map<String, List<String>> headers)

getClientSdkVersion

public static Optional<String> getClientSdkVersion(Map<String, List<String>> headers)

getRuntimeSessionId

public static Optional<String> getRuntimeSessionId(Map<String, List<String>> headers)

getRuntimeVersion

public static Optional<String> getRuntimeVersion(Map<String, List<String>> headers)

newShortSessionId

public static String newShortSessionId()