org.glassfish.tyrus.core

Class RequestContext

java.lang.Object

org.glassfish.tyrus.core.RequestContext

All Implemented Interfaces:

javax.websocket.server.HandshakeRequest, SPIHandshakeRequest, WebSocketRequest

public final class RequestContext
extends Object
implements javax.websocket.server.HandshakeRequest, SPIHandshakeRequest, WebSocketRequest

Implementation of all possible request interfaces. Should be only point of truth.

Author:

Pavel Bucek (pavel.bucek at oracle.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestContext.Builder RequestContext builder.

Field Summary

Fields inherited from interface javax.websocket.server.HandshakeRequest

SEC_WEBSOCKET_EXTENSIONS, SEC_WEBSOCKET_KEY, SEC_WEBSOCKET_PROTOCOL, SEC_WEBSOCKET_VERSION

Method Summary

Methods

Modifier and Type	Method and Description
Connection	getConnection()
String	getFirstHeaderValue(String name) Gets the first header value from the List of header values corresponding to the name.
String	getHeader(String name) Returns the header value corresponding to the name.
Map<String,List<String>>	getHeaders() Get headers.
Object	getHttpSession()
Map<String,List<String>>	getParameterMap()
String	getQueryString()
String	getRequestPath()
String	getRequestUri()
URI	getRequestURI()
Principal	getUserPrincipal()
boolean	isSecure()
boolean	isUserInRole(String role)
void	lock() Make headers and parameter map read-only.
void	putSingleHeader(String headerName, String headerValue)
void	setRequestPath(String requestPath)

Methods inherited from class java.lang.Object

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

Method Detail

getHeaders

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

Get headers.

Specified by:

getHeaders in interface javax.websocket.server.HandshakeRequest

Specified by:

getHeaders in interface WebSocketRequest

Returns:

headers map. List items are corresponding to header declaration in HTTP request.

getHeader

public String getHeader(String name)

Returns the header value corresponding to the name.

Specified by:

getHeader in interface SPIHandshakeRequest

Specified by:

getHeader in interface WebSocketRequest

Parameters:

name - header name.

Returns:

List of header values iff found, null otherwise.

getFirstHeaderValue

public String getFirstHeaderValue(String name)

Gets the first header value from the List of header values corresponding to the name.

Specified by:

getFirstHeaderValue in interface WebSocketRequest

Parameters:

name - header name.

Returns:

String value iff it exists, null otherwise.

lock

public void lock()

Make headers and parameter map read-only.

putSingleHeader

public void putSingleHeader(String headerName,
                   String headerValue)

Specified by:

putSingleHeader in interface WebSocketRequest

getRequestPath

public String getRequestPath()

Specified by:

getRequestPath in interface WebSocketRequest

setRequestPath

public void setRequestPath(String requestPath)

Specified by:

setRequestPath in interface WebSocketRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.websocket.server.HandshakeRequest

Specified by:

getUserPrincipal in interface SPIHandshakeRequest

getRequestURI

public URI getRequestURI()

Specified by:

getRequestURI in interface javax.websocket.server.HandshakeRequest

Specified by:

getRequestURI in interface WebSocketRequest

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface javax.websocket.server.HandshakeRequest

getHttpSession

public Object getHttpSession()

Specified by:

getHttpSession in interface javax.websocket.server.HandshakeRequest

getParameterMap

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

Specified by:

getParameterMap in interface javax.websocket.server.HandshakeRequest

Specified by:

getParameterMap in interface SPIHandshakeRequest

Specified by:

getParameterMap in interface WebSocketRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface javax.websocket.server.HandshakeRequest

Specified by:

getQueryString in interface SPIHandshakeRequest

Specified by:

getQueryString in interface WebSocketRequest

getRequestUri

public String getRequestUri()

Specified by:

getRequestUri in interface SPIHandshakeRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface SPIHandshakeRequest

Specified by:

isSecure in interface WebSocketRequest

getConnection

public Connection getConnection()

Specified by:

getConnection in interface WebSocketRequest