org.wso2.transport.http.netty.contractimpl.websocket.message

Class DefaultWebSocketHandshaker

java.lang.Object

org.wso2.transport.http.netty.contractimpl.websocket.message.DefaultWebSocketHandshaker

All Implemented Interfaces:

WebSocketHandshaker, WebSocketMessage

public class DefaultWebSocketHandshaker
extends Object
implements WebSocketHandshaker

Default implementation of WebSocketHandshaker.

Constructor Summary

Constructors

Constructor and Description
DefaultWebSocketHandshaker(io.netty.channel.ChannelHandlerContext ctx, ServerConnectorFuture connectorFuture, io.netty.handler.codec.http.FullHttpRequest httpRequest)

Method Summary

Modifier and Type	Method and Description
io.netty.channel.ChannelFuture	cancelHandshake(int statusCode, String closeReason) Cancel the handshake with HTTP response.
String	getChannelId() Retrieve the Channel ID of the connection.
HttpCarbonRequest	getHttpCarbonRequest() Get the HttpCarbonRequest received from the client to perform the handshake.
String	getTarget() Retrieve the target of the application as a String.
WebSocketConnection	getWebSocketConnection() Retrieve the session of the connection.
ServerHandshakeFuture	handshake() Complete the handshake of a given request.
ServerHandshakeFuture	handshake(String[] subProtocols) Complete the handshake of a given request.
ServerHandshakeFuture	handshake(String[] subProtocols, int idleTimeout) Complete the handshake of a given request.
ServerHandshakeFuture	handshake(String[] subProtocols, int idleTimeout, io.netty.handler.codec.http.HttpHeaders responseHeaders) Complete the handshake of a given request.
ServerHandshakeFuture	handshake(String[] subProtocols, int idleTimeout, io.netty.handler.codec.http.HttpHeaders responseHeaders, int maxFramePayloadLength) Complete the handshake of a given request.
boolean	isCancelled() Check whether the handshake is cancelled in someplace or not.
boolean	isHandshakeStarted() Check whether the handshake has been started or not.
boolean	isSecure() Check whether the connection is secure or not.
boolean	isServerMessage() Check whether the message is coming from server connector or client connector.
void	setHttpCarbonRequest(HttpCarbonRequest request)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWebSocketHandshaker

public DefaultWebSocketHandshaker(io.netty.channel.ChannelHandlerContext ctx,
                                  ServerConnectorFuture connectorFuture,
                                  io.netty.handler.codec.http.FullHttpRequest httpRequest)

Method Detail

getTarget

public String getTarget()

Description copied from interface: WebSocketMessage

Retrieve the target of the application as a String.

Specified by:

getTarget in interface WebSocketMessage

Returns:

the target of the application.

handshake

public ServerHandshakeFuture handshake()

Description copied from interface: WebSocketHandshaker

Complete the handshake of a given request. There will not be a idle timeout for the connection if this method is used.

Specified by:

handshake in interface WebSocketHandshaker

Returns:

the Server session for the newly created WebSocket connection.

handshake

public ServerHandshakeFuture handshake(String[] subProtocols)

Description copied from interface: WebSocketHandshaker

Complete the handshake of a given request. There will not be a idle timeout for the connection if this method is used.

Specified by:

handshake in interface WebSocketHandshaker

Parameters:

subProtocols - Sub-Protocols which are allowed by the service.

Returns:

the Server session for the newly created WebSocket connection.

handshake

public ServerHandshakeFuture handshake(String[] subProtocols,
                                       int idleTimeout)

Description copied from interface: WebSocketHandshaker

Complete the handshake of a given request. The connection will be timed out if the connection is idle for given time period.

Specified by:

handshake in interface WebSocketHandshaker

Parameters:

subProtocols - Sub-Protocols which are allowed by the service.

idleTimeout - Idle timeout in milli-seconds for WebSocket connection.

Returns:

the handshake future.

handshake

public ServerHandshakeFuture handshake(String[] subProtocols,
                                       int idleTimeout,
                                       io.netty.handler.codec.http.HttpHeaders responseHeaders)

Description copied from interface: WebSocketHandshaker

Complete the handshake of a given request. The connection will be timed out if the connection is idle for given time period.

Specified by:

handshake in interface WebSocketHandshaker

Parameters:

subProtocols - Sub-Protocols which are allowed by the service.

idleTimeout - Idle timeout in milli-seconds for WebSocket connection.

responseHeaders - Extra headers to add to the handshake response or null if no extra headers should be added

Returns:

the handshake future.

handshake

public ServerHandshakeFuture handshake(String[] subProtocols,
                                       int idleTimeout,
                                       io.netty.handler.codec.http.HttpHeaders responseHeaders,
                                       int maxFramePayloadLength)

Description copied from interface: WebSocketHandshaker

Complete the handshake of a given request. The connection will be timed out if the connection is idle for given time period.

Specified by:

handshake in interface WebSocketHandshaker

Parameters:

subProtocols - Sub-Protocols which are allowed by the service.

idleTimeout - Idle timeout in milli-seconds for WebSocket connection.

responseHeaders - Extra headers to add to the handshake response or null if no extra headers should be added.

maxFramePayloadLength - Maximum allowable frame payload length. Setting this value to your application's requirement may reduce denial of service attacks using long data frames.

Returns:

the handshake future.

cancelHandshake

public io.netty.channel.ChannelFuture cancelHandshake(int statusCode,
                                                      String closeReason)

Description copied from interface: WebSocketHandshaker

Cancel the handshake with HTTP response.

Specified by:

cancelHandshake in interface WebSocketHandshaker

Parameters:

statusCode - close code for cancelling the handshake.

closeReason - reason for canceling the handshake.

Returns:

the ChannelPromise created after submitting response

isCancelled

public boolean isCancelled()

Description copied from interface: WebSocketHandshaker

Check whether the handshake is cancelled in someplace or not.

Specified by:

isCancelled in interface WebSocketHandshaker

Returns:

true if the handshake is cancelled.

isHandshakeStarted

public boolean isHandshakeStarted()

Description copied from interface: WebSocketHandshaker

Check whether the handshake has been started or not.

Specified by:

isHandshakeStarted in interface WebSocketHandshaker

Returns:

true if the handshake has been started.

isSecure

public boolean isSecure()

Description copied from interface: WebSocketHandshaker

Check whether the connection is secure or not.

Specified by:

isSecure in interface WebSocketHandshaker

Returns:

true if the connection is secure.

isServerMessage

public boolean isServerMessage()

Description copied from interface: WebSocketMessage

Check whether the message is coming from server connector or client connector.

Specified by:

isServerMessage in interface WebSocketMessage

Returns:

true if the message is coming from server connector else return false if the message is coming from client connector.

getWebSocketConnection

public WebSocketConnection getWebSocketConnection()

Description copied from interface: WebSocketMessage

Retrieve the session of the connection.

Specified by:

getWebSocketConnection in interface WebSocketMessage

Returns:

the session of the connection.

getChannelId

public String getChannelId()

Description copied from interface: WebSocketHandshaker

Retrieve the Channel ID of the connection.

Specified by:

getChannelId in interface WebSocketHandshaker

Returns:

the channel ID of the connection.

getHttpCarbonRequest

public HttpCarbonRequest getHttpCarbonRequest()

Description copied from interface: WebSocketHandshaker

Get the HttpCarbonRequest received from the client to perform the handshake.

Specified by:

getHttpCarbonRequest in interface WebSocketHandshaker

Returns:

the carbon request received to perform the handshake

setHttpCarbonRequest

public void setHttpCarbonRequest(HttpCarbonRequest request)