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

Access	Constructor and Description
private	RequestContext(URI requestURI, String queryString, Object httpSession, boolean secure, Principal userPrincipal, RequestContext.Builder.IsUserInRoleDelegate IsUserInRoleDelegate, String remoteAddr, String serverAddr, int serverPort, Map<String, List<String>> parameterMap, Map<String, List<String>> headers, Map<String, Object> tyrusProperties)

Method Summary

Modifier and Type	Method and Description
public String	Returns: `List` of header values iff found, `null` otherwise. getHeader(String header name. name) Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.getHeader. Returns the header value corresponding to the name.
public Map<String, List<String>>	Returns: headers map. List items are corresponding to header declaration in HTTP request. getHeaders() Implements jakarta.websocket.server.HandshakeRequest.getHeaders. Get headers.
public Object	getHttpSession() Implements jakarta.websocket.server.HandshakeRequest.getHttpSession. Return a reference to the HttpSession that the web socket handshake that started this conversation was part of, if the implementation is part of a Java EE web container.
public Map<String, List<String>>	getParameterMap() Implements jakarta.websocket.server.HandshakeRequest.getParameterMap. Return the request parameters associated with the request.
public String	getQueryString() Implements jakarta.websocket.server.HandshakeRequest.getQueryString. Return the query string associated with the request.
public String	Returns: a `String` containing the IP address of the client that sent the request or `null` when method is called on client-side. getRemoteAddr() Get the Internet Protocol (IP) address of the client or last proxy that sent the request.
public URI	getRequestURI() Implements jakarta.websocket.server.HandshakeRequest.getRequestURI. Return the request URI of the handshake request.
public String	getRequestUri() Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.getRequestUri. Get the undecoded request uri (up to the query string) of underlying HTTP handshake request.
public String	Returns: a `String` Returns the host name of the server to which the request was sent or `null` when method is called on client-side. getServerAddr() Returns the host name of the server to which the request was sent.
public int	Returns: a port of the client that sent the request. getServerPort() Get the port of the last client or proxy that sent the request.
pack-priv TyrusConfiguration	getTyrusConfiguration()
public Principal	getUserPrincipal() Implements jakarta.websocket.server.HandshakeRequest.getUserPrincipal. Return the authenticated user or `null` if no user is authenticated for this handshake.
public boolean	isSecure() Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.isSecure. Indicates whether this request was made using a secure channel (such as HTTPS).
public boolean	isUserInRole(String the role being checked. role) Implements jakarta.websocket.server.HandshakeRequest.isUserInRole. Checks whether the current user is in the given role.
public void	lock() Make headers and parameter map read-only.

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

httpSession	back to summary
private final Object httpSession

isUserInRoleDelegate	back to summary
private final RequestContext.Builder.IsUserInRoleDelegate isUserInRoleDelegate

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

queryString	back to summary
private final String queryString

remoteAddr	back to summary
private final String remoteAddr

requestURI	back to summary
private final URI requestURI

secure	back to summary
private final boolean secure

serverAddr	back to summary
private final String serverAddr

serverPort	back to summary
private final int serverPort

tyrusConfiguration	back to summary
private final TyrusConfiguration tyrusConfiguration

userPrincipal	back to summary
private final Principal userPrincipal

RequestContext	back to summary
private RequestContext(URI requestURI, String queryString, Object httpSession, boolean secure, Principal userPrincipal, RequestContext.Builder.IsUserInRoleDelegate IsUserInRoleDelegate, String remoteAddr, String serverAddr, int serverPort, Map<String, List<String>> parameterMap, Map<String, List<String>> headers, Map<String, Object> tyrusProperties)

Method Detail

getHeader back to summary

getHeader	back to summary
public String getHeader(String name) Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.getHeader. Returns the header value corresponding to the name. Parameters name:String header name. Returns:String `List` of header values iff found, `null` otherwise. Annotations @Override

public String getHeader(String name)

Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.getHeader.

Returns the header value corresponding to the name.

Parameters

name:String: header name.

Returns:String

List of header values iff found, null otherwise.

Annotations

@Override

getHeaders	back to summary
public Map<String, List<String>> getHeaders() Implements jakarta.websocket.server.HandshakeRequest.getHeaders. Get headers. Returns:Map<String, List<String>> headers map. List items are corresponding to header declaration in HTTP request. Annotations @Override

getHeaders

back to summary

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

Implements jakarta.websocket.server.HandshakeRequest.getHeaders.

Get headers.

Returns:Map<String, List<String>>

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

Annotations

@Override

getHttpSession back to summary

getHttpSession	back to summary
public Object getHttpSession() Implements jakarta.websocket.server.HandshakeRequest.getHttpSession. Doc from jakarta.websocket.server.HandshakeRequest.getHttpSession. Return a reference to the HttpSession that the web socket handshake that started this conversation was part of, if the implementation is part of a Java EE web container. Returns:Object the http session or `null` if either the websocket implementation is not part of a Java EE web container, or there is no HttpSession associated with the opening handshake request. Annotations @Override

public Object getHttpSession()

Implements jakarta.websocket.server.HandshakeRequest.getHttpSession.

Doc from jakarta.websocket.server.HandshakeRequest.getHttpSession.

Return a reference to the HttpSession that the web socket handshake that started this conversation was part of, if the implementation is part of a Java EE web container.

Returns:Object

the http session or null if either the websocket implementation is not part of a Java EE web container, or there is no HttpSession associated with the opening handshake request.

Annotations

@Override

getParameterMap	back to summary
public Map<String, List<String>> getParameterMap() Implements jakarta.websocket.server.HandshakeRequest.getParameterMap. Doc from jakarta.websocket.server.HandshakeRequest.getParameterMap. Return the request parameters associated with the request. Returns:Map<String, List<String>> the unmodifiable map of the request parameters. Annotations @Override

getParameterMap

back to summary

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

Implements jakarta.websocket.server.HandshakeRequest.getParameterMap.

Doc from jakarta.websocket.server.HandshakeRequest.getParameterMap.

Return the request parameters associated with the request.

Returns:Map<String, List<String>>

the unmodifiable map of the request parameters.

Annotations

@Override

getQueryString	back to summary
public String getQueryString() Implements jakarta.websocket.server.HandshakeRequest.getQueryString. Doc from jakarta.websocket.server.HandshakeRequest.getQueryString. Return the query string associated with the request. Returns:String the query string. Annotations @Override

getQueryString

back to summary

public String getQueryString()

Implements jakarta.websocket.server.HandshakeRequest.getQueryString.

Doc from jakarta.websocket.server.HandshakeRequest.getQueryString.

Return the query string associated with the request.

Returns:String

the query string.

Annotations

@Override

getRemoteAddr back to summary

getRemoteAddr	back to summary
public String getRemoteAddr() Get the Internet Protocol (IP) address of the client or last proxy that sent the request. Returns:String a `String` containing the IP address of the client that sent the request or `null` when method is called on client-side.

public String getRemoteAddr()

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

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

getRequestURI	back to summary
public URI getRequestURI() Implements jakarta.websocket.server.HandshakeRequest.getRequestURI. Doc from jakarta.websocket.server.HandshakeRequest.getRequestURI. Return the request URI of the handshake request. Returns:URI the request uri of the handshake request. Annotations @Override

getRequestURI

back to summary

public URI getRequestURI()

Implements jakarta.websocket.server.HandshakeRequest.getRequestURI.

Doc from jakarta.websocket.server.HandshakeRequest.getRequestURI.

Return the request URI of the handshake request.

Returns:URI

the request uri of the handshake request.

Annotations

@Override

getRequestUri	back to summary
public String getRequestUri() Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.getRequestUri. Doc from org.glassfish.tyrus.spi.UpgradeRequest.getRequestUri. Get the undecoded request uri (up to the query string) of underlying HTTP handshake request. Returns:String request uri. Annotations @Override

getRequestUri

back to summary

public String getRequestUri()

Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.getRequestUri.

Doc from org.glassfish.tyrus.spi.UpgradeRequest.getRequestUri.

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

Returns:String

request uri.

Annotations

@Override

getServerAddr back to summary

getServerAddr	back to summary
public String getServerAddr() Returns the host name of the server to which the request was sent. Returns:String a `String` Returns the host name of the server to which the request was sent or `null` when method is called on client-side.

public String getServerAddr()

Returns the host name of the server to which the request was sent.

Returns:String: a String Returns the host name of the server to which the request was sent or null when method is called on client-side.

getServerPort	back to summary
public int getServerPort() Get the port of the last client or proxy that sent the request. Returns:int a port of the client that sent the request.

getServerPort

back to summary

public int getServerPort()

Get the port of the last client or proxy that sent the request.

Returns:int: a port of the client that sent the request.

getTyrusConfiguration	back to summary
pack-priv TyrusConfiguration getTyrusConfiguration()

getUserPrincipal back to summary

getUserPrincipal	back to summary
public Principal getUserPrincipal() Implements jakarta.websocket.server.HandshakeRequest.getUserPrincipal. Doc from jakarta.websocket.server.HandshakeRequest.getUserPrincipal. Return the authenticated user or `null` if no user is authenticated for this handshake. Returns:Principal the user principal. Annotations @Override

public Principal getUserPrincipal()

Implements jakarta.websocket.server.HandshakeRequest.getUserPrincipal.

Doc from jakarta.websocket.server.HandshakeRequest.getUserPrincipal.

Return the authenticated user or null if no user is authenticated for this handshake.

Returns:Principal

the user principal.

Annotations

@Override

isSecure	back to summary
public boolean isSecure() Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.isSecure. Doc from org.glassfish.tyrus.spi.UpgradeRequest.isSecure. Indicates whether this request was made using a secure channel (such as HTTPS). Returns:boolean true if the request was made using secure channel, false otherwise. Annotations @Override

isSecure

back to summary

public boolean isSecure()

Implements abstract org.glassfish.tyrus.spi.UpgradeRequest.isSecure.

Doc from org.glassfish.tyrus.spi.UpgradeRequest.isSecure.

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

Returns:boolean

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

Annotations

@Override

isUserInRole back to summary

isUserInRole	back to summary
public boolean isUserInRole(String role) Implements jakarta.websocket.server.HandshakeRequest.isUserInRole. Doc from jakarta.websocket.server.HandshakeRequest.isUserInRole. Checks whether the current user is in the given role. Roles and role membership can be defined using deployment descriptors of the containing WAR file, if running in a Java EE web container. If the user has not been authenticated, the method returns `false`. Parameters role:String the role being checked. Returns:boolean whether the authenticated user is in the role, or false if the user has not been authenticated. Annotations @Override

public boolean isUserInRole(String role)

Implements jakarta.websocket.server.HandshakeRequest.isUserInRole.

Doc from jakarta.websocket.server.HandshakeRequest.isUserInRole.

Checks whether the current user is in the given role. Roles and role membership can be defined using deployment descriptors of the containing WAR file, if running in a Java EE web container. If the user has not been authenticated, the method returns false.

Parameters

role:String: the role being checked.

Returns:boolean

whether the authenticated user is in the role, or false if the user has not been authenticated.

Annotations

@Override

lock	back to summary
public void lock() Make headers and parameter map read-only.

org.glassfish.tyrus.core back to summary

public final Class RequestContext.Builder

Class Inheritance

extends Object

java.lang.Object
org.glassfish.tyrus.core.RequestContext.Builder

RequestContext builder.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static interface	RequestContext.Builder.IsUserInRoleDelegate Is user in role delegate.

Field Summary

Modifier and Type	Field and Description
private Map<String, List<String>>	headers
private Object	httpSession
private RequestContext.Builder.IsUserInRoleDelegate	isUserInRoleDelegate
private Map<String, List<String>>	parameterMap
private String	queryString
private String	remoteAddr
private URI	requestURI
private boolean	secure
private String	serverAddr
private int	serverPort
private Map<String, Object>	tyrusProperties
private Principal	userPrincipal

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public RequestContext	Returns: created `RequestContext`. build() Build `RequestContext` from given properties.
public static RequestContext.Builder	Returns: empty builder instance. create() Create empty builder.
public static RequestContext.Builder	Returns: builder instance. create(RequestContext request context. requestContext) Create builder instance based on provided `RequestContext`.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. httpSession(Object `jakarta.servlet.http.HttpSession` session to be set. httpSession) Set http session.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. isUserInRoleDelegate(RequestContext.Builder.IsUserInRoleDelegate delegate for `RequestContext#isUserInRole(String)`. isUserInRoleDelegate) Set delegate for `RequestContext#isUserInRole(String)` method.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. parameterMap(Map<String, String[]> parameter map. Takes map returned from ServletRequest#getParameterMap. parameterMap) Set parameter map.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. queryString(String query string to be set. queryString) Set query string.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. remoteAddr(String remote address to be set. remoteAddr) Set remote address.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. requestURI(URI request URI to be set. requestURI) Set request URI.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. secure(boolean secure state to be set. secure) Set secure state.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. serverAddr(String server address to be set. serverAddr) Set server address or hostname.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. serverPort(int server port to be set. serverPort) Set server port.
public RequestContext.Builder	tyrusProperties(Map<String, Object> tyrusProperties) Set properties for Tyrus framework.
public RequestContext.Builder	Returns: updated `RequestContext.Builder` instance. userPrincipal(Principal principal to be set. principal) Set `Principal`.

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

Field Detail

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

httpSession	back to summary
private Object httpSession

isUserInRoleDelegate	back to summary
private RequestContext.Builder.IsUserInRoleDelegate isUserInRoleDelegate

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

queryString	back to summary
private String queryString

remoteAddr	back to summary
private String remoteAddr

requestURI	back to summary
private URI requestURI

secure	back to summary
private boolean secure

serverAddr	back to summary
private String serverAddr

serverPort	back to summary
private int serverPort

tyrusProperties	back to summary
private Map<String, Object> tyrusProperties

userPrincipal	back to summary
private Principal userPrincipal

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build back to summary

build	back to summary
public RequestContext build() Build `RequestContext` from given properties. Returns:RequestContext created `RequestContext`.

public RequestContext build()

Build RequestContext from given properties.

Returns:RequestContext: created RequestContext.

create

back to summary

public static RequestContext.Builder create()

Create empty builder.

Returns:RequestContext.Builder: empty builder instance.

create back to summary

public static RequestContext.Builder create(RequestContext requestContext)

Create builder instance based on provided RequestContext.

Parameters

requestContext:RequestContext: request context.

Returns:RequestContext.Builder

builder instance.

httpSession back to summary

public RequestContext.Builder httpSession(Object httpSession)

Set http session.

Parameters

httpSession:Object: jakarta.servlet.http.HttpSession session to be set.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

isUserInRoleDelegate back to summary

public RequestContext.Builder isUserInRoleDelegate(RequestContext.Builder.IsUserInRoleDelegate isUserInRoleDelegate)

Set delegate for RequestContext#isUserInRole(String) method.

Parameters

isUserInRoleDelegate:RequestContext.Builder.IsUserInRoleDelegate: delegate for RequestContext#isUserInRole(String).

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

parameterMap back to summary

public RequestContext.Builder parameterMap(Map<String, String[]> parameterMap)

Set parameter map.

Parameters

parameterMap:Map<String, String[]>: parameter map. Takes map returned from ServletRequest#getParameterMap.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

queryString back to summary

public RequestContext.Builder queryString(String queryString)

Set query string.

Parameters

queryString:String: query string to be set.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

remoteAddr back to summary

public RequestContext.Builder remoteAddr(String remoteAddr)

Set remote address.

Parameters

remoteAddr:String: remote address to be set.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

requestURI back to summary

public RequestContext.Builder requestURI(URI requestURI)

Set request URI.

Parameters

requestURI:URI: request URI to be set.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

secure back to summary

public RequestContext.Builder secure(boolean secure)

Set secure state.

Parameters

secure:boolean: secure state to be set.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

serverAddr back to summary

public RequestContext.Builder serverAddr(String serverAddr)

Set server address or hostname.

Parameters

serverAddr:String: server address to be set.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

serverPort back to summary

public RequestContext.Builder serverPort(int serverPort)

Set server port.

Parameters

serverPort:int: server port to be set.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

tyrusProperties	back to summary
public RequestContext.Builder tyrusProperties(Map<String, Object> tyrusProperties) Set properties for Tyrus framework.

userPrincipal back to summary

public RequestContext.Builder userPrincipal(Principal principal)

Set Principal.

Parameters

principal:Principal: principal to be set.

Returns:RequestContext.Builder

updated RequestContext.Builder instance.

org.glassfish.tyrus.core back to summary

public Interface RequestContext.Builder.IsUserInRoleDelegate

Is user in role delegate.

Cannot easily query ServletContext or HttpServletRequest for this information, since it is stored only as object.

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated. isUserInRole(String a String specifying the name of the role. role) Returns a boolean indicating whether the authenticated user is included in the specified logical "role".

Method Detail

isUserInRole

back to summary

public boolean isUserInRole(String role)

Returns a boolean indicating whether the authenticated user is included in the specified logical "role". Roles and role membership can be defined using deployment descriptors. If the user has not been authenticated, the method returns false.

Parameters

role:String: a String specifying the name of the role.

Returns:boolean

a boolean indicating whether the user making this request belongs to a given role; false if the user has not been authenticated.

Modifier and Type	Field and Description
private Map<String, List<String>>	headers
private final Object	httpSession
private final RequestContext.Builder.IsUserInRoleDelegate	isUserInRoleDelegate
private Map<String, List<String>>	parameterMap
private final String	queryString
private final String	remoteAddr
private final URI	requestURI
private final boolean	secure
private final String	serverAddr
private final int	serverPort
private final TyrusConfiguration	tyrusConfiguration
private final Principal	userPrincipal