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 org.glassfish.tyrus.spi.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
java.lang.String	getHeader(java.lang.String name) Returns the header value corresponding to the name.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders() Get headers.
java.lang.Object	getHttpSession()
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getParameterMap()
java.lang.String	getQueryString()
java.lang.String	getRemoteAddr() Get the Internet Protocol (IP) address of the client or last proxy that sent the request.
java.lang.String	getRequestUri()
java.net.URI	getRequestURI()
java.security.Principal	getUserPrincipal()
boolean	isSecure()
boolean	isUserInRole(java.lang.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 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getHeaders()

Get headers.

Returns:

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

getHeader

public java.lang.String getHeader(java.lang.String name)

Returns the header value corresponding to the name.

Specified by:

getHeader in class org.glassfish.tyrus.spi.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 java.security.Principal getUserPrincipal()

getRequestURI

public java.net.URI getRequestURI()

isUserInRole

public boolean isUserInRole(java.lang.String role)

getHttpSession

public java.lang.Object getHttpSession()

getParameterMap

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

getQueryString

public java.lang.String getQueryString()

getRequestUri

public java.lang.String getRequestUri()

Specified by:

getRequestUri in class org.glassfish.tyrus.spi.UpgradeRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in class org.glassfish.tyrus.spi.UpgradeRequest

getRemoteAddr

public java.lang.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.