org.snf4j.example.websocket

Class SessionConfig

java.lang.Object

org.snf4j.core.session.DefaultSessionConfig

org.snf4j.websocket.DefaultWebSocketSessionConfig

org.snf4j.example.websocket.SessionConfig

All Implemented Interfaces:

ISessionConfig, IWebSocketSessionConfig

public class SessionConfig
extends DefaultWebSocketSessionConfig

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
SessionConfig()
SessionConfig(URI requestUri)

Method Summary

Modifier and Type	Method and Description
boolean	acceptRequestUri(URI uri) Determines if a received Web Socket handshake request with given request URI should be accepted by the server session associated with this configuration object.
SSLEngine	createSSLEngine(boolean clientMode) Creates a new SSLEngine for the SSL/DTLS session.

Methods inherited from class org.snf4j.websocket.DefaultWebSocketSessionConfig

createCodecExecutor, customizeHeaders, customizeHeaders, getMaxFramePayloadLength, getMaxHandshakeFrameLength, getRequestOrigin, getRequestUri, getSupportedExtensions, getSupportedSubProtocols, handleCloseFrame, ignoreHostHeaderField, isClientMode, setHandleCloseFrame, setIgnoreHostHeaderField, setMaxFramePayloadLength, setMaxHandshakeFrameLength, setRequestOrigin, setSupportedExtensions, setSupportedSubProtocols, switchDecoders, switchEncoders

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

addSSLEngineBuilder, alwaysNotifiedBeingInPipeline, 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, getDatagramServerSessionNoReopenPeriod, getEndingAction, getEngineHandshakeTimeout, getMaxInBufferCapacity, getMaxSSLApplicationBufferSizeRatio, getMaxSSLNetworkBufferSizeRatio, getMaxWriteSpinCount, getMinInBufferCapacity, getMinOutBufferCapacity, getThroughputCalculationInterval, ignorePossiblyIncompleteDatagrams, optimizeDataCopying, waitForInboundCloseMessage

Constructor Detail

SessionConfig

public SessionConfig(URI requestUri)

SessionConfig

public SessionConfig()

Method Detail

createSSLEngine

public SSLEngine createSSLEngine(boolean clientMode)
                          throws SSLEngineCreateException

Description copied from class: DefaultSessionConfig

Creates a new SSLEngine for the SSL/DTLS session.

By default, if no SSLEngine builder is configured for the specified handshaking mode, it returns the engine created by calling the SSLContext.getDefault().createSSLEngine()

Specified by:

createSSLEngine in interface ISessionConfig

Overrides:

createSSLEngine in class DefaultSessionConfig

Parameters:

clientMode - true if the engine should start its handshaking in client mode

Returns:

the SSLEngine object

Throws:

SSLEngineCreateException - when the SSL engine could not be created

acceptRequestUri

public boolean acceptRequestUri(URI uri)

Description copied from class: DefaultWebSocketSessionConfig

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

Overrides:

acceptRequestUri in class DefaultWebSocketSessionConfig

Parameters:

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

Returns:

true if the request URI should be accepted