Interface Summary Interface Description AsyncChannelWrapperThis is a wrapper for a
AsynchronousSocketChannelthat limits the methods available thereby simplifying the process of implementing SSL/TLS support since there are fewer methods to intercept.
BackgroundProcess ClientEndpointHolder TransformationThe internal representation of the transformation that a WebSocket extension performs on a message. WrappedMessageHandler
Class Summary Class Description AsyncChannelGroupUtilThis is a utility class that enables multiple
WsWebSocketContainerinstances to share a single
AsynchronousChannelGroupwhile ensuring that the group is destroyed when no longer required.
AsyncChannelWrapperNonSecureGenerally, just passes calls straight to the wrapped
AuthenticatorBase class for the authentication methods used by the WebSocket client. AuthenticatorFactoryUtility method to return the appropriate authenticator according to the scheme that the server uses. BackgroundProcessManagerProvides a background processing mechanism that triggers roughly once a second. BasicAuthenticatorAuthenticator supporting the BASIC authentication method. ConstantsInternal implementation constants. DecoderEntry DigestAuthenticatorAuthenticator supporting the DIGEST authentication method. EndpointClassHolder EndpointHolder MessageHandlerResult PerMessageDeflate PojoClassHolder PojoHolder TransformationFactory UtilUtility class for internal use only within the
Util.DecoderMatch WsContainerProvider WsExtension WsExtensionParameter WsFrameBaseTakes the ServletInputStream, processes the WebSocket frames it contains and extracts the messages. WsFrameClient WsHandshakeResponseRepresents the response to a WebSocket handshake. WsPongMessage WsRemoteEndpointAsync WsRemoteEndpointBase WsRemoteEndpointBasic WsRemoteEndpointImplBase WsRemoteEndpointImplClient WsSession WsWebSocketContainer
Enum Summary Enum Description AuthenticationType MessageHandlerResultType TransformationResult WsFrameBase.ReadStateWAITING - not suspended Server case: waiting for a notification that data is ready to be read from the socket, the socket is registered to the poller Client case: data has been read from the socket and is waiting for data to be processed PROCESSING - not suspended Server case: reading from the socket and processing the data Client case: processing the data if such has already been read and more data will be read from the socket SUSPENDING_WAIT - suspended, a call to suspend() was made while in WAITING state.
Exception Summary Exception Description AuthenticationExceptionException thrown on authentication error connecting to a remote websocket endpoint. ReadBufferOverflowException WsIOExceptionAllows the WebSocket implementation to throw an
IOExceptionthat includes a
CloseReasonspecific to the error that can be passed back to the client.