org.glassfish.tyrus.core

Class RequestContext

java.lang.Object

org.glassfish.tyrus.spi.UpgradeRequest

org.glassfish.tyrus.core.RequestContext

All Implemented Interfaces:

javax.websocket.server.HandshakeRequest

public final class RequestContext
extends UpgradeRequest

Implementation of all possible request interfaces. Should be the 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 class org.glassfish.tyrus.spi.UpgradeRequest

AUTHORIZATION, CLUSTER_CONNECTION_ID_HEADER, CONNECTION, ENABLE_TRACING_HEADER, HOST, ORIGIN_HEADER, RESPONSE_CODE_MESSAGE, SEC_WS_ORIGIN_HEADER, SERVER_KEY_HASH, TRACING_THRESHOLD, UPGRADE, WEBSOCKET

Fields inherited from interface javax.websocket.server.HandshakeRequest

SEC_WEBSOCKET_EXTENSIONS, SEC_WEBSOCKET_KEY, SEC_WEBSOCKET_PROTOCOL, SEC_WEBSOCKET_VERSION

Method Summary

Modifier and Type	Method and Description
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	getRemoteAddr() Get the Internet Protocol (IP) address of the client or last proxy that sent the request.
String	getRequestUri() Get the undecoded request uri (up to the query string) of underlying HTTP handshake request.
URI	getRequestURI()
Principal	getUserPrincipal()
boolean	isSecure() Indicates whether this request was made using a secure channel (such as HTTPS).
boolean	isUserInRole(String role)
void	lock() Make headers and parameter map read-only.

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.

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 class UpgradeRequest

Parameters:

name - header name.

Returns:

List of header values iff found, null otherwise.

lock

public void lock()

Make headers and parameter map read-only.

getUserPrincipal

public Principal getUserPrincipal()

getRequestURI

public URI getRequestURI()

isUserInRole

public boolean isUserInRole(String role)

getHttpSession

public Object getHttpSession()

getParameterMap

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

getQueryString

public String getQueryString()

getRequestUri

public String getRequestUri()

Description copied from class: UpgradeRequest

Get the undecoded request uri (up to the query string) of underlying HTTP handshake request.

Specified by:

getRequestUri in class UpgradeRequest

Returns:

request uri.

isSecure

public boolean isSecure()

Description copied from class: UpgradeRequest

Indicates whether this request was made using a secure channel (such as HTTPS).

Specified by:

isSecure in class UpgradeRequest

Returns:

true if the request was made using secure channel, false otherwise.

getRemoteAddr

public String getRemoteAddr()

Get the Internet Protocol (IP) address of the client or last proxy that sent the request.

Returns:

a String containing the IP address of the client that sent the request or null when method is called on client-side.