org.snf4j.websocket

Class DefaultWebSocketSessionConfig

java.lang.Object

org.snf4j.core.session.DefaultSessionConfig

org.snf4j.websocket.DefaultWebSocketSessionConfig

All Implemented Interfaces:

ISessionConfig, IWebSocketSessionConfig

Direct Known Subclasses:

SessionConfig

public class DefaultWebSocketSessionConfig
extends DefaultSessionConfig
implements IWebSocketSessionConfig

Default configuration for the Web Socket session.

Author:

SNF4J.ORG

Field Summary

Fields inherited from interface org.snf4j.websocket.IWebSocketSessionConfig

HANDSHAKE_DECODER, HANDSHAKE_ENCODER, WEBSOCKET_DECODER, WEBSOCKET_ENCODER, WEBSOCKET_UTF8_VALIDATOR

Constructor Summary

Constructors

Constructor and Description
DefaultWebSocketSessionConfig() Constructs the default Web Socket configuration for a server session
DefaultWebSocketSessionConfig(URI requestUri) Constructs the default Web Socket configuration for a client session

Method Summary

Modifier and Type	Method and Description
boolean	acceptRequestUri(URI requestUri) Determines if a received Web Socket handshake request with given request URI should be accepted by the server session associated with this configuration object.
ICodecExecutor	createCodecExecutor() Creates a new codec executor that will be responsible for decoding and encoding data read/received and written/send in the associated session.
void	customizeHeaders(HandshakeRequest request) Called when the Web Socket handshake request is ready to be sent and can be now customized, if needed.
void	customizeHeaders(HandshakeResponse response) Called when the Web Socket handshake response is ready to be sent and can be now customized, if needed.
int	getMaxFramePayloadLength() Determines the maximum length of the payload in the decoded Web Socket frames.
int	getMaxHandshakeFrameLength() Determines the maximum length of the decoded Web Socket handshake frames.
String	getRequestOrigin() Determines the value of the Origin header field in the client Web Socket handshake request.
URI	getRequestUri() Determines the request URI (the server endpoint) in the client Web Socket handshake request.
IExtension[]	getSupportedExtensions() Determines the supported extensions for both the server and client Web Socket sessions.
String[]	getSupportedSubProtocols() Determines the names of supported subprotocols for both the server and client Web Socket sessions.
boolean	handleCloseFrame() Determines if the received Web Socket close frames should be handled automatically.
boolean	ignoreHostHeaderField() Determines if the server session associated with this configuration object should ignore missing the Host header field in the received Web Socket handshake request.
boolean	isClientMode() Tells if this configuration is for a client or server session.
DefaultWebSocketSessionConfig	setHandleCloseFrame(boolean handleCloseFrame) Configures if the received Web Socket close frames should be handled automatically.
DefaultWebSocketSessionConfig	setIgnoreHostHeaderField(boolean ignoreHostHeaderField) Configures if the server session associated with this configuration object should ignore missing the Host header field in the received Web Socket handshake request.
DefaultWebSocketSessionConfig	setMaxFramePayloadLength(int maxFramePayloadLength) Sets the maximum length of the payload in the decoded Web Socket frames.
DefaultWebSocketSessionConfig	setMaxHandshakeFrameLength(int maxHandshakeFrameLength) Sets the maximum length of the decoded Web Socket handshake frames.
DefaultWebSocketSessionConfig	setRequestOrigin(String requestOrigin) Sets the value of the Origin header field in the client Web Socket handshake request.
DefaultWebSocketSessionConfig	setSupportedExtensions(IExtension... extensions) Sets the supported extensions for both the server and client Web Socket sessions.
DefaultWebSocketSessionConfig	setSupportedSubProtocols(String... subProtocols) Sets the names of supported subprotocols for both the server and client Web Socket sessions.
void	switchDecoders(ICodecPipeline pipeline, boolean allowExtensions) Called when the decoders in the codec pipeline should be switched after finishing of the Web Socket handshake.
void	switchEncoders(ICodecPipeline pipeline, boolean allowExtensions) Called when the encoders in the codec pipeline should be switched after finishing of the Web Socket handshake.

Methods inherited from class org.snf4j.core.session.DefaultSessionConfig

addSSLEngineBuilder, alwaysNotifiedBeingInPipeline, createSSLEngine, createSSLEngine, getDatagramServerSessionNoReopenPeriod, getEndingAction, getEngineHandshakeTimeout, getMaxInBufferCapacity, getMaxSSLApplicationBufferSizeRatio, getMaxSSLNetworkBufferSizeRatio, getMaxWriteSpinCount, getMinInBufferCapacity, getMinOutBufferCapacity, getSSLEngineBuilder, getThroughputCalculationInterval, ignorePossiblyIncompleteDatagrams, optimizeDataCopying, removeSSLEngineBuilder, setAlwaysNotifiedBeingInPipeline, setDatagramServerSessionNoReopenPeriod, setEndingAction, setEngineHandshakeTimeout, setIgnorePossiblyIncompleteDatagrams, setMaxInBufferCapacity, setMaxSSLApplicationBufferSizeRatio, setMaxSSLNetworkBufferSizeRatio, setMaxWriteSpinCount, setMinInBufferCapacity, setMinOutBufferCapacity, setOptimizeDataCopying, setThroughputCalculationInterval, setWaitForInboundCloseMessage, waitForInboundCloseMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.snf4j.core.session.ISessionConfig

alwaysNotifiedBeingInPipeline, createSSLEngine, createSSLEngine, getDatagramServerSessionNoReopenPeriod, getEndingAction, getEngineHandshakeTimeout, getMaxInBufferCapacity, getMaxSSLApplicationBufferSizeRatio, getMaxSSLNetworkBufferSizeRatio, getMaxWriteSpinCount, getMinInBufferCapacity, getMinOutBufferCapacity, getThroughputCalculationInterval, ignorePossiblyIncompleteDatagrams, optimizeDataCopying, waitForInboundCloseMessage

Constructor Detail

DefaultWebSocketSessionConfig

public DefaultWebSocketSessionConfig(URI requestUri)

Constructs the default Web Socket configuration for a client session

Parameters:

requestUri - request URI that will be used to set the Host header field and the "Request-URI" of the GET method

DefaultWebSocketSessionConfig

public DefaultWebSocketSessionConfig()

Constructs the default Web Socket configuration for a server session

Method Detail

isClientMode

public boolean isClientMode()

Tells if this configuration is for a client or server session.

Returns:

true if this configuration is for a client session.

getRequestUri

public URI getRequestUri()

Description copied from interface: IWebSocketSessionConfig

Determines the request URI (the server endpoint) in the client Web Socket handshake request. It is used to configure the Request-URI of the HTTP GET method and the value of the Host header field.

It is not used for configuration of server sessions.

Specified by:

getRequestUri in interface IWebSocketSessionConfig

Returns:

the request URI

getRequestOrigin

public String getRequestOrigin()

Determines the value of the Origin header field in the client Web Socket handshake request.

It is not used for configuration of server sessions.

The default value is null

Specified by:

getRequestOrigin in interface IWebSocketSessionConfig

Returns:

the value of the Origin header field, or null if the Origin field is not required in the request.

setRequestOrigin

public DefaultWebSocketSessionConfig setRequestOrigin(String requestOrigin)

Sets the value of the Origin header field in the client Web Socket handshake request.

Parameters:

requestOrigin - the value of the Origin header field, or null if the Origin field is not required in the request.

Returns:

this session config object

getSupportedSubProtocols

public String[] getSupportedSubProtocols()

Determines the names of supported subprotocols for both the server and client Web Socket sessions.

The default value is null

Specified by:

getSupportedSubProtocols in interface IWebSocketSessionConfig

Returns:

the names of supported subprotocols

setSupportedSubProtocols

public DefaultWebSocketSessionConfig setSupportedSubProtocols(String... subProtocols)

Sets the names of supported subprotocols for both the server and client Web Socket sessions.

Parameters:

subProtocols - the names of supported subprotocols

Returns:

this session config object

getSupportedExtensions

public IExtension[] getSupportedExtensions()

Determines the supported extensions for both the server and client Web Socket sessions.

The default value is null

Specified by:

getSupportedExtensions in interface IWebSocketSessionConfig

Returns:

the supported extensions

setSupportedExtensions

public DefaultWebSocketSessionConfig setSupportedExtensions(IExtension... extensions)

Sets the supported extensions for both the server and client Web Socket sessions.

Parameters:

extensions - the supported extensions

Returns:

this session config object

ignoreHostHeaderField

public boolean ignoreHostHeaderField()

Determines if the server session associated with this configuration object should ignore missing the Host header field in the received Web Socket handshake request.

The default value is false

Specified by:

ignoreHostHeaderField in interface IWebSocketSessionConfig

Returns:

true to ignore missing the Host header field

setIgnoreHostHeaderField

public DefaultWebSocketSessionConfig setIgnoreHostHeaderField(boolean ignoreHostHeaderField)

Configures if the server session associated with this configuration object should ignore missing the Host header field in the received Web Socket handshake request.

Parameters:

ignoreHostHeaderField - true to ignore missing the Host header field

Returns:

this session config object

getMaxHandshakeFrameLength

public int getMaxHandshakeFrameLength()

Determines the maximum length of the decoded Web Socket handshake frames. All bigger frames will be rejected and the affected handshakes will not be finished and the sessions will be closed.

The default value is 65536

Specified by:

getMaxHandshakeFrameLength in interface IWebSocketSessionConfig

Returns:

the maximum length of the decoded handshake frames

setMaxHandshakeFrameLength

public DefaultWebSocketSessionConfig setMaxHandshakeFrameLength(int maxHandshakeFrameLength)

Sets the maximum length of the decoded Web Socket handshake frames. All bigger frames will be rejected and the affected handshakes will not be finished and the sessions will be closed.

Parameters:

maxHandshakeFrameLength - the maximum length of the decoded handshake frames

Returns:

this session config object

getMaxFramePayloadLength

public int getMaxFramePayloadLength()

Determines the maximum length of the payload in the decoded Web Socket frames. All bigger frames will be rejected and the affected sessions will be closed.

The default value is 65536

Specified by:

getMaxFramePayloadLength in interface IWebSocketSessionConfig

Returns:

the maximum length of the payload in the decoded frames

setMaxFramePayloadLength

public DefaultWebSocketSessionConfig setMaxFramePayloadLength(int maxFramePayloadLength)

Sets the maximum length of the payload in the decoded Web Socket frames. All bigger frames will be rejected and the affected sessions will be closed.

Parameters:

maxFramePayloadLength - the maximum length of the payload in the decoded frames

Returns:

this session config object

handleCloseFrame

public boolean handleCloseFrame()

Determines if the received Web Socket close frames should be handled automatically. The automatically handled close frames will not be passed to the user's web socket handlers.

The default value is true

Specified by:

handleCloseFrame in interface IWebSocketSessionConfig

Returns:

true if the close frames should be handled automatically

setHandleCloseFrame

public DefaultWebSocketSessionConfig setHandleCloseFrame(boolean handleCloseFrame)

Configures if the received Web Socket close frames should be handled automatically. The automatically handled close frames will not be passed to the user's web socket handlers.

Parameters:

handleCloseFrame - true if the close frames should be handled automatically

Returns:

this session config object

createCodecExecutor

public ICodecExecutor createCodecExecutor()

Description copied from class: DefaultSessionConfig

Creates a new codec executor that will be responsible for decoding and encoding data read/received and written/send in the associated session.

The default value is null

Specified by:

createCodecExecutor in interface ISessionConfig

Overrides:

createCodecExecutor in class DefaultSessionConfig

Returns:

the codec executor, or null if decoding and encoding is not required.

switchEncoders

public void switchEncoders(ICodecPipeline pipeline,
                           boolean allowExtensions)

Description copied from interface: IWebSocketSessionConfig

Called when the encoders in the codec pipeline should be switched after finishing of the Web Socket handshake.

Specified by:

switchEncoders in interface IWebSocketSessionConfig

Parameters:

pipeline - the codec pipeline to be changed

allowExtensions - informs that some extensions have been negotiated during the Web Socket handshake

switchDecoders

public void switchDecoders(ICodecPipeline pipeline,
                           boolean allowExtensions)

Description copied from interface: IWebSocketSessionConfig

Called when the decoders in the codec pipeline should be switched after finishing of the Web Socket handshake.

Specified by:

switchDecoders in interface IWebSocketSessionConfig

Parameters:

pipeline - the codec pipeline to be changed

allowExtensions - informs that some extensions have been negotiated during the Web Socket handshake

customizeHeaders

public void customizeHeaders(HandshakeRequest request)

Called when the Web Socket handshake request is ready to be sent and can be now customized, if needed.

By default it does nothing

Specified by:

customizeHeaders in interface IWebSocketSessionConfig

Parameters:

request - the handshake request to be sent

customizeHeaders

public void customizeHeaders(HandshakeResponse response)

Called when the Web Socket handshake response is ready to be sent and can be now customized, if needed.

By default it does nothing

Specified by:

customizeHeaders in interface IWebSocketSessionConfig

Parameters:

response - the handshake response to be sent

acceptRequestUri

public boolean acceptRequestUri(URI requestUri)

Determines if a received Web Socket handshake request with given request URI should be accepted by the server session associated with this configuration object.

The requestUri argument is built based on the Host header field and the "Request-URI" of the GET method. If the Host header field is missed and the IWebSocketSessionConfig.ignoreHostHeaderField() returns true the host-port part of the URI will be set to the "null" string.

By default it always returns true

Specified by:

acceptRequestUri in interface IWebSocketSessionConfig

Parameters:

requestUri - the request URI in the received Web Socket handshake request

Returns:

true if the request URI should be accepted