Package org.jdrupes.httpcodec.protocols.websocket

Class WsProtocolProvider

java.lang.Object

org.jdrupes.httpcodec.plugin.UpgradeProvider

org.jdrupes.httpcodec.protocols.websocket.WsProtocolProvider

public class WsProtocolProvider
extends UpgradeProvider

A protocol provider for the WebSocket protocol.

The web socket protocol is an upgrade from the HTTP protocol.

Constructor Summary

Constructors

Constructor	Description
WsProtocolProvider()

Method Summary

Modifier and Type	Method	Description
void	augmentInitialRequest(HttpRequest request)	Add protocol specific information to a request with an Upgrade header field.
void	augmentInitialResponse(HttpResponse response)	Add any required information to the “switching protocols” response that is sent as the last package of the HTTP and starts the usage of the new protocol.
void	checkSwitchingResponse(HttpRequest request, HttpResponse response)	Check the 101 Switching Protocol response for any problem indicators.
Decoder<?,?>	createRequestDecoder(String protocol)	Creates a new request decoder for the protocol.
Encoder<?,?>	createRequestEncoder(String protocol)	Creates a new request encoder for the protocol.
Decoder<?,?>	createResponseDecoder(String protocol)	Creates a new response decoder for the protocol.
Encoder<?,?>	createResponseEncoder(String protocol)	Creates a new response encoder for the protocol.
boolean	supportsProtocol(String protocol)	Checks if the plugin supports the given protocol.

Methods inherited from class java.lang.Object

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

Constructor Details

WsProtocolProvider

public WsProtocolProvider()

Method Details

supportsProtocol

public boolean supportsProtocol(String protocol)

Description copied from class: UpgradeProvider

Checks if the plugin supports the given protocol.

Specified by:

supportsProtocol in class UpgradeProvider

Parameters:

protocol - the protocol in question

Returns:

the result

augmentInitialRequest

public void augmentInitialRequest(HttpRequest request)

Description copied from class: UpgradeProvider

Add protocol specific information to a request with an Upgrade header field.

Specified by:

augmentInitialRequest in class UpgradeProvider

Parameters:

request - the request

checkSwitchingResponse

public void checkSwitchingResponse(HttpRequest request,
 HttpResponse response)
                            throws ProtocolException

Description copied from class: UpgradeProvider

Check the 101 Switching Protocol response for any problem indicators.

Specified by:

checkSwitchingResponse in class UpgradeProvider

Parameters:

request - the request

response - the response

Throws:

ProtocolException - the protocol exception

augmentInitialResponse

public void augmentInitialResponse(HttpResponse response)

Description copied from class: UpgradeProvider

Add any required information to the “switching protocols” response that is sent as the last package of the HTTP and starts the usage of the new protocol.

Specified by:

augmentInitialResponse in class UpgradeProvider

Parameters:

response - the response

createRequestEncoder

public Encoder<?,?> createRequestEncoder(String protocol)

Description copied from class: UpgradeProvider

Creates a new request encoder for the protocol.

Specified by:

createRequestEncoder in class UpgradeProvider

Parameters:

protocol - the protocol, which must be supported by this plugin

Returns:

the request encoder

createRequestDecoder

public Decoder<?,?> createRequestDecoder(String protocol)

Description copied from class: UpgradeProvider

Creates a new request decoder for the protocol.

Specified by:

createRequestDecoder in class UpgradeProvider

Parameters:

protocol - the protocol, which must be supported by this plugin

Returns:

the request decoder

createResponseEncoder

public Encoder<?,?> createResponseEncoder(String protocol)

Description copied from class: UpgradeProvider

Creates a new response encoder for the protocol.

Specified by:

createResponseEncoder in class UpgradeProvider

Parameters:

protocol - the protocol, which must be supported by this plugin

Returns:

the response encoder

createResponseDecoder

public Decoder<?,?> createResponseDecoder(String protocol)

Description copied from class: UpgradeProvider

Creates a new response decoder for the protocol.

Specified by:

createResponseDecoder in class UpgradeProvider

Parameters:

protocol - the protocol, which must be supported by this plugin

Returns:

the response decoder