Tomcat 10.1.19 · org.apache.tomcat.websocket.server.WsHandshakeRequest

Field Summary

Modifier and Type	Field and Description
private final Map<String, List<String>>	headers
private final Object	httpSession
private final Map<String, List<String>>	parameterMap
private final String	queryString
private volatile HttpServletRequest	request
private final URI	requestUri
private static final StringManager	sm
private final Principal	userPrincipal

Access	Constructor and Description
public	WsHandshakeRequest(HttpServletRequest request, Map<String, String> pathParams)

Modifier and Type	Method and Description
private static URI	buildRequestUri(HttpServletRequest req)
pack-priv void	finished() Called when the HandshakeRequest is no longer required.
public Map<String, List<String>>	getHeaders() Implements jakarta.websocket.server.HandshakeRequest.getHeaders.
public Object	getHttpSession() Implements jakarta.websocket.server.HandshakeRequest.getHttpSession. Get the HTTP Session object associated with this request.
public Map<String, List<String>>	getParameterMap() Implements jakarta.websocket.server.HandshakeRequest.getParameterMap.
public String	getQueryString() Implements jakarta.websocket.server.HandshakeRequest.getQueryString.
public URI	getRequestURI() Implements jakarta.websocket.server.HandshakeRequest.getRequestURI.
public Principal	getUserPrincipal() Implements jakarta.websocket.server.HandshakeRequest.getUserPrincipal.
public boolean	isUserInRole(String role) Implements jakarta.websocket.server.HandshakeRequest.isUserInRole.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

headers	back to summary
private final Map<String, List<String>> headers

httpSession	back to summary
private final Object httpSession

parameterMap	back to summary
private final Map<String, List<String>> parameterMap

queryString	back to summary
private final String queryString

request	back to summary
private volatile HttpServletRequest request

requestUri	back to summary
private final URI requestUri

sm	back to summary
private static final StringManager sm

userPrincipal	back to summary
private final Principal userPrincipal

WsHandshakeRequest	back to summary
public WsHandshakeRequest(HttpServletRequest request, Map<String, String> pathParams)

buildRequestUri	back to summary
private static URI buildRequestUri(HttpServletRequest req)

finished	back to summary
pack-priv void finished() Called when the HandshakeRequest is no longer required. Since an instance of this class retains a reference to the current HttpServletRequest that reference needs to be cleared as the HttpServletRequest may be reused. There is no reason for instances of this class to be accessed once the handshake has been completed.

getHeaders	back to summary
public Map<String, List<String>> getHeaders() Implements jakarta.websocket.server.HandshakeRequest.getHeaders. Annotations @Override

getHeaders

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

Annotations

getHttpSession	back to summary
public Object getHttpSession() Implements jakarta.websocket.server.HandshakeRequest.getHttpSession. Doc from jakarta.websocket.server.HandshakeRequest.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. Annotations @Override

getHttpSession

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.

Annotations