Top Description Fields Methods
jakarta.websocket.server

public Interface HandshakeRequest

Known Direct Implementers
org.apache.tomcat.websocket.server.WsHandshakeRequest
Imports
java.net.URI, java.security.Principal, java.util.List, .Map
Represents the HTTP request that asked to be upgraded to WebSocket.

Field Summary

Modifier and TypeField and Description
public static final String
SEC_WEBSOCKET_EXTENSIONS

public static final String
SEC_WEBSOCKET_KEY

public static final String
SEC_WEBSOCKET_PROTOCOL

public static final String
SEC_WEBSOCKET_VERSION

Method Summary

Modifier and TypeMethod and Description
public Map<String, List<String>>
getHeaders()

public Object

Returns:

The jakarta.servlet.http.HttpSession object associated with this request, if any.
getHttpSession()

Get the HTTP Session object associated with this request.

public Map<String, List<String>>
getParameterMap()

public String
getQueryString()

public URI
getRequestURI()

public Principal
getUserPrincipal()

public boolean
isUserInRole(String role)

Field Detail

SEC_WEBSOCKET_EXTENSIONSback to summary
public static final String SEC_WEBSOCKET_EXTENSIONS
SEC_WEBSOCKET_KEYback to summary
public static final String SEC_WEBSOCKET_KEY
SEC_WEBSOCKET_PROTOCOLback to summary
public static final String SEC_WEBSOCKET_PROTOCOL
SEC_WEBSOCKET_VERSIONback to summary
public static final String SEC_WEBSOCKET_VERSION

Method Detail

getHeadersback to summary
public Map<String, List<String>> getHeaders()
getHttpSessionback to summary
public Object getHttpSession()

Get the HTTP Session object associated with this request. Object is used to avoid a direct dependency on the Servlet API.

Returns:Object

The jakarta.servlet.http.HttpSession object associated with this request, if any.

getParameterMapback to summary
public Map<String, List<String>> getParameterMap()
getQueryStringback to summary
public String getQueryString()
getRequestURIback to summary
public URI getRequestURI()
getUserPrincipalback to summary
public Principal getUserPrincipal()
isUserInRoleback to summary
public boolean isUserInRole(String role)