Package org.apache.tomcat.websocket.server

Class WsHandshakeRequest

java.lang.Object

org.apache.tomcat.websocket.server.WsHandshakeRequest

All Implemented Interfaces:

HandshakeRequest

public class WsHandshakeRequest
extends java.lang.Object
implements HandshakeRequest

Represents the request that this session was opened under.

Field Summary

Fields inherited from interface jakarta.websocket.server.HandshakeRequest

SEC_WEBSOCKET_EXTENSIONS, SEC_WEBSOCKET_KEY, SEC_WEBSOCKET_PROTOCOL, SEC_WEBSOCKET_VERSION

Constructor Summary

Constructors

Constructor	Description
WsHandshakeRequest(HttpServletRequest request, java.util.Map<java.lang.String,java.lang.String> pathParams)	Constructs a new WsHandshakeRequest.

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders()	Returns the HTTP headers from the handshake request.
java.lang.Object	getHttpSession()	Get the HTTP Session object associated with this request.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParameterMap()	Returns the query parameters from the handshake request.
java.lang.String	getQueryString()	Returns the query string from the handshake request.
java.net.URI	getRequestURI()	Returns the URI of the handshake request.
java.security.Principal	getUserPrincipal()	Returns the principal of the user associated with this request, or null if the user is not authenticated.
boolean	isUserInRole(java.lang.String role)	Returns whether the user associated with this request is in the given role.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsHandshakeRequest

public WsHandshakeRequest(HttpServletRequest request,
                          java.util.Map<java.lang.String,java.lang.String> pathParams)

Constructs a new WsHandshakeRequest.

Parameters:

request - The HTTP servlet request

pathParams - The path parameters

Method Detail

getRequestURI

public java.net.URI getRequestURI()

Description copied from interface: jakarta.websocket.server.HandshakeRequest

Returns the URI of the handshake request.

Specified by:

getRequestURI in interface HandshakeRequest

Returns:

The request URI

getParameterMap

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParameterMap()

Description copied from interface: jakarta.websocket.server.HandshakeRequest

Returns the query parameters from the handshake request.

Specified by:

getParameterMap in interface HandshakeRequest

Returns:

The query parameter map

getQueryString

public java.lang.String getQueryString()

Description copied from interface: jakarta.websocket.server.HandshakeRequest

Returns the query string from the handshake request.

Specified by:

getQueryString in interface HandshakeRequest

Returns:

The query string

getUserPrincipal

public java.security.Principal getUserPrincipal()

Description copied from interface: jakarta.websocket.server.HandshakeRequest

Returns the principal of the user associated with this request, or null if the user is not authenticated.

Specified by:

getUserPrincipal in interface HandshakeRequest

Returns:

The user principal

getHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()

Description copied from interface: jakarta.websocket.server.HandshakeRequest

Returns the HTTP headers from the handshake request.

Specified by:

getHeaders in interface HandshakeRequest

Returns:

The HTTP headers

isUserInRole

public boolean isUserInRole(java.lang.String role)

Description copied from interface: jakarta.websocket.server.HandshakeRequest

Returns whether the user associated with this request is in the given role.

Specified by:

isUserInRole in interface HandshakeRequest

Parameters:

role - The role to check

Returns:

true if the user is in the specified role

getHttpSession

public java.lang.Object getHttpSession()

Description copied from interface: jakarta.websocket.server.HandshakeRequest

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

Specified by:

getHttpSession in interface HandshakeRequest

Returns:

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