weblogic.websocket
Class WSHandshakeRequest

java.lang.Object
  javax.servlet.ServletRequestWrapper
      javax.servlet.http.HttpServletRequestWrapper
          weblogic.websocket.WSHandshakeRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class WSHandshakeRequest
extends HttpServletRequestWrapper

Defines an object to provide the WebSocket opening handshake request information to a WebSocketListener. The container creates a WSHandshakeRequest object and passes it as an argument to the accept method of a WebSocket listener.

Except for providing HTTP request information, including the parameter name and values, cookies, etc, WSHandshakeRequest provides additional WebSocket Protocol specific data, such as the WebSocket version, WebSocket subprotocols, etc.

WSHandshakeRequest

public WSHandshakeRequest(WebSocketContext context,
                          HttpServletRequest request)

Constructs a new instance of WSHandshakeRequest.

Parameters:

context - instance of WebSocketContext

request - instance of HttpServletRequest

Throws:

HandshakeException

getOrigin

public String getOrigin()

Returns "Origin" header in the handshake request.

Returns:

"Origin" header

getResourcePath

public String getResourcePath()

Returns the resource path of the WebSocket.

Returns:

resource path

getSubProtocols

public String[] getSubProtocols()

Returns subprotocols in the handshake request.

Returns:

subprotocols

getExtensions

public String[] getExtensions()

Returns extensions in the handshake request.

Returns:

extensions

getVersion

public int getVersion()

Returns the WebSocket version.

Returns:

WebSocket version