Package org.glassfish.jersey.server

Class ContainerRequest

java.lang.Object

org.glassfish.jersey.message.internal.InboundMessageContext

org.glassfish.jersey.server.ContainerRequest

All Implemented Interfaces:

ContainerRequestContext, HttpHeaders, Request, PropertiesDelegate, PropertiesResolver

public class ContainerRequest
extends InboundMessageContext
implements ContainerRequestContext, Request, HttpHeaders, PropertiesDelegate, PropertiesResolver

Jersey container request context.

An instance of the request context is passed by the container to the ApplicationHandler for each incoming client request.

Author:

Marek Potociar

Field Summary

Fields inherited from interface jakarta.ws.rs.core.HttpHeaders

ACCEPT, ACCEPT_CHARSET, ACCEPT_ENCODING, ACCEPT_LANGUAGE, ALLOW, AUTHORIZATION, CACHE_CONTROL, CONTENT_DISPOSITION, CONTENT_ENCODING, CONTENT_ID, CONTENT_LANGUAGE, CONTENT_LENGTH, CONTENT_LOCATION, CONTENT_TYPE, COOKIE, DATE, ETAG, EXPECT, EXPIRES, HOST, IF_MATCH, IF_MODIFIED_SINCE, IF_NONE_MATCH, IF_UNMODIFIED_SINCE, LAST_EVENT_ID_HEADER, LAST_MODIFIED, LINK, LOCATION, RETRY_AFTER, SET_COOKIE, USER_AGENT, VARY, WWW_AUTHENTICATE

Constructor Summary

Constructors

Constructor	Description
ContainerRequest(URI baseUri, URI requestUri, String httpMethod, SecurityContext securityContext, PropertiesDelegate propertiesDelegate)	Deprecated.
ContainerRequest(URI baseUri, URI requestUri, String httpMethod, SecurityContext securityContext, PropertiesDelegate propertiesDelegate, Configuration configuration)	Create new Jersey container request context.

Method Summary

Modifier and Type	Method	Description
void	abortWith(Response response)
Response.ResponseBuilder	evaluatePreconditions()
Response.ResponseBuilder	evaluatePreconditions(EntityTag eTag)
Response.ResponseBuilder	evaluatePreconditions(Date lastModified)
Response.ResponseBuilder	evaluatePreconditions(Date lastModified, EntityTag eTag)
Response	getAbortResponse()	Get the request filter chain aborting response if set, or null otherwise.
URI	getAbsolutePath()	Get the absolute path of the request.
List<Locale>	getAcceptableLanguages()
List<MediaType>	getAcceptableMediaTypes()
URI	getBaseUri()	Get base request URI.
Map<String,Cookie>	getCookies()
String	getMethod()
String	getPath(boolean decode)	Get the path of the current request relative to the application root (base) URI as a string.
PropertiesDelegate	getPropertiesDelegate()	Get the underlying properties delegate.
Object	getProperty(String name)	Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.
Collection<String>	getPropertyNames()	Returns an immutable collection containing the property names available within the context of the current request/response exchange context.
protected Iterable<ReaderInterceptor>	getReaderInterceptors()	Get all reader interceptors applicable to this request.
Request	getRequest()
List<String>	getRequestHeader(String name)	Get the values of an HTTP request header if the header exists on the current request.
MultivaluedMap<String,String>	getRequestHeaders()	Get the values of HTTP request headers.
RequestScopedInitializer	getRequestScopedInitializer()	Get a custom container extensions initializer for the current request.
URI	getRequestUri()	Get request URI.
ContainerResponseWriter	getResponseWriter()	Get the container response writer for the current request.
SecurityContext	getSecurityContext()
ExtendedUriInfo	getUriInfo()
String	getVaryValue()	Get the value of HTTP Vary response header to be set in the response, or null if no value is to be set.
boolean	hasProperty(String name)	Returns true if the property with the given name registered in the current request/response exchange context, or false if there is no property by that name.
void	inResponseProcessing()	Notify this request that the response created from this request is already being processed.
<T> T	readEntity(Class<T> rawType)	Read entity from a context entity input stream.
<T> T	readEntity(Class<T> rawType, Annotation[] annotations)	Read entity from a context entity input stream.
<T> T	readEntity(Class<T> rawType, Type type)	Read entity from a context entity input stream.
<T> T	readEntity(Class<T> rawType, Type type, Annotation[] annotations)	Read entity from a context entity input stream.
void	removeProperty(String name)	Removes a property with the given name from the current request/response exchange context.
<T> T	resolveProperty(String name, Class<T> type)	Resolve a property value for the specified property name.
<T> T	resolveProperty(String name, T defaultValue)	Resolve a property value for the specified property name.
Variant	selectVariant(List<Variant> variants)
void	setEntityStream(InputStream input)	Set a new entity input stream.
void	setMethod(String method)
void	setMethodWithoutException(String method)	Like setMethod(String) but does not throw IllegalStateException if the method is invoked in other than pre-matching phase.
void	setProperty(String name, Object object)	Binds an object to a given property name in the current request/response exchange context.
void	setRequestScopedInitializer(RequestScopedInitializer requestScopedInitializer)	Set a custom container extensions initializer for the current request.
void	setRequestUri(URI requestUri)
void	setRequestUri(URI baseUri, URI requestUri)
void	setSecurityContext(SecurityContext context)
void	setWriter(ContainerResponseWriter responseWriter)	Set the container response writer for the current request.

Methods inherited from class org.glassfish.jersey.message.internal.InboundMessageContext

bufferEntity, close, getAllowedMethods, getConfiguration, getDate, getEntityStream, getEntityTag, getHeaders, getHeaderString, getIfMatch, getIfNoneMatch, getLanguage, getLastModified, getLength, getLink, getLinkBuilder, getLinks, getLocation, getMediaType, getQualifiedAcceptableLanguages, getQualifiedAcceptableMediaTypes, getQualifiedAcceptCharset, getQualifiedAcceptEncoding, getRequestCookies, getResponseCookies, getWorkers, hasEntity, hasLink, header, headers, headers, headers, headers, readEntity, readEntity, readEntity, readEntity, remove, setWorkers

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.ws.rs.container.ContainerRequestContext

getDate, getEntityStream, getHeaders, getHeaderString, getLanguage, getLength, getMediaType, hasEntity

Methods inherited from interface jakarta.ws.rs.core.HttpHeaders

getDate, getHeaderString, getLanguage, getLength, getMediaType

Constructor Details

ContainerRequest

public ContainerRequest(URI baseUri,
 URI requestUri,
 String httpMethod,
 SecurityContext securityContext,
 PropertiesDelegate propertiesDelegate,
 Configuration configuration)

Create new Jersey container request context.

Parameters:

baseUri - base application URI.

requestUri - request URI.

httpMethod - request HTTP method name.

securityContext - security context of the current request. Must not be null. The SecurityContext.getUserPrincipal() must return null if the current request has not been authenticated by the container.

propertiesDelegate - custom properties delegate to be used by the context.

configuration - the server Configuration. If null, the default behaviour is expected.

ContainerRequest

@Deprecated
public ContainerRequest(URI baseUri,
 URI requestUri,
 String httpMethod,
 SecurityContext securityContext,
 PropertiesDelegate propertiesDelegate)

Deprecated.

Create new Jersey container request context.

Parameters:

baseUri - base application URI.

requestUri - request URI.

httpMethod - request HTTP method name.

securityContext - security context of the current request. Must not be null. The SecurityContext.getUserPrincipal() must return null if the current request has not been authenticated by the container.

propertiesDelegate - custom properties delegate to be used by the context.

See Also:

• ContainerRequest(URI, URI, String, SecurityContext, PropertiesDelegate, Configuration)

Method Details

getRequestScopedInitializer

public RequestScopedInitializer getRequestScopedInitializer()

Get a custom container extensions initializer for the current request.

The initializer is guaranteed to be run from within the request scope of the current request.

Returns:

custom container extensions initializer or null if not available.

setRequestScopedInitializer

public void setRequestScopedInitializer(RequestScopedInitializer requestScopedInitializer)

Set a custom container extensions initializer for the current request.

The initializer is guaranteed to be run from within the request scope of the current request.

Parameters:

requestScopedInitializer - custom container extensions initializer.

getResponseWriter

public ContainerResponseWriter getResponseWriter()

Get the container response writer for the current request.

Returns:

container response writer.

setWriter

public void setWriter(ContainerResponseWriter responseWriter)

Set the container response writer for the current request.

Parameters:

responseWriter - container response writer. Must not be null.

readEntity

public <T> T readEntity(Class<T> rawType)

Read entity from a context entity input stream.

Type Parameters:

T - entity Java object type.

Parameters:

rawType - raw Java entity type.

Returns:

entity read from a context entity input stream.

readEntity

public <T> T readEntity(Class<T> rawType,
 Annotation[] annotations)

Read entity from a context entity input stream.

Type Parameters:

T - entity Java object type.

Parameters:

rawType - raw Java entity type.

annotations - entity annotations.

Returns:

entity read from a context entity input stream.

readEntity

public <T> T readEntity(Class<T> rawType,
 Type type)

Read entity from a context entity input stream.

Type Parameters:

T - entity Java object type.

Parameters:

rawType - raw Java entity type.

type - generic Java entity type.

Returns:

entity read from a context entity input stream.

readEntity

public <T> T readEntity(Class<T> rawType,
 Type type,
 Annotation[] annotations)

Read entity from a context entity input stream.

Type Parameters:

T - entity Java object type.

Parameters:

rawType - raw Java entity type.

type - generic Java entity type.

annotations - entity annotations.

Returns:

entity read from a context entity input stream.

resolveProperty

public <T> T resolveProperty(String name,
 Class<T> type)

Description copied from interface: PropertiesResolver

Resolve a property value for the specified property name.

The method returns the value of the property registered in the request-specific property bag, if available. If no property for the given property name is found in the request-specific property bag, the method looks at the properties stored in the global runtime configuration this request belongs to. If there is a value defined in the runtime configuration, it is returned, otherwise the method returns null if no such property is registered neither in the runtime nor in the request-specific property bag.

Specified by:

resolveProperty in interface PropertiesResolver

Type Parameters:

T - property Java type.

Parameters:

name - property name.

type - expected property class type.

Returns:

resolved property value or null if no such property is registered.

resolveProperty

public <T> T resolveProperty(String name,
 T defaultValue)

Description copied from interface: PropertiesResolver

Resolve a property value for the specified property name.

The method returns the value of the property registered in the request-specific property bag, if available. If no property for the given property name is found in the request-specific property bag, the method looks at the properties stored in the global runtime configuration this request belongs to. If there is a value defined in the runtime configuration, it is returned, otherwise the method returns defaultValue if no such property is registered neither in the runtime nor in the request-specific property bag.

Specified by:

resolveProperty in interface PropertiesResolver

Type Parameters:

T - property Java type.

Parameters:

name - property name.

defaultValue - default value to return if the property is not registered.

Returns:

resolved property value or defaultValue if no such property is registered.

hasProperty

public boolean hasProperty(String name)

Description copied from interface: PropertiesDelegate

Returns true if the property with the given name registered in the current request/response exchange context, or false if there is no property by that name.

Use the PropertiesDelegate.getProperty(java.lang.String) method with a property name to get the value of a property.

Specified by:

hasProperty in interface ContainerRequestContext

Specified by:

hasProperty in interface PropertiesDelegate

Returns:

true if a property matching the given name exists, or false otherwise.

See Also:

• PropertiesDelegate.getProperty(java.lang.String)

getProperty

public Object getProperty(String name)

Description copied from interface: PropertiesDelegate

Returns the property with the given name registered in the current request/response exchange context, or null if there is no property by that name.

A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

A list of supported properties can be retrieved using PropertiesDelegate.getPropertyNames(). Custom property names should follow the same convention as package names.

Specified by:

getProperty in interface ContainerRequestContext

Specified by:

getProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property.

Returns:

an Object containing the value of the property, or null if no property exists matching the given name.

See Also:

• PropertiesDelegate.getPropertyNames()

getPropertyNames

public Collection<String> getPropertyNames()

Description copied from interface: PropertiesDelegate

Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

Use the PropertiesDelegate.getProperty(java.lang.String) method with a property name to get the value of a property.

Specified by:

getPropertyNames in interface ContainerRequestContext

Specified by:

getPropertyNames in interface PropertiesDelegate

Returns:

an immutable collection of property names.

See Also:

• PropertiesDelegate.getProperty(java.lang.String)

setProperty

public void setProperty(String name,
 Object object)

Description copied from interface: PropertiesDelegate

Binds an object to a given property name in the current request/response exchange context. If the name specified is already used for a property, this method will replace the value of the property with the new value.

A property allows a JAX-RS filters and interceptors to exchange additional custom information not already provided by this interface.

A list of supported properties can be retrieved using PropertiesDelegate.getPropertyNames(). Custom property names should follow the same convention as package names.

If a null value is passed, the effect is the same as calling the PropertiesDelegate.removeProperty(String) method.

Specified by:

setProperty in interface ContainerRequestContext

Specified by:

setProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property.

object - an Object representing the property to be bound.

removeProperty

public void removeProperty(String name)

Description copied from interface: PropertiesDelegate

Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls to PropertiesDelegate.getProperty(java.lang.String) to retrieve the property value will return null.

Specified by:

removeProperty in interface ContainerRequestContext

Specified by:

removeProperty in interface PropertiesDelegate

Parameters:

name - a String specifying the name of the property to be removed.

getPropertiesDelegate

public PropertiesDelegate getPropertiesDelegate()

Get the underlying properties delegate.

Returns:

underlying properties delegate.

getUriInfo

public ExtendedUriInfo getUriInfo()

Specified by:

getUriInfo in interface ContainerRequestContext

getReaderInterceptors

protected Iterable<ReaderInterceptor> getReaderInterceptors()

Get all reader interceptors applicable to this request. This is populated once the right resource method is matched.

Specified by:

getReaderInterceptors in class InboundMessageContext

Returns:

All reader interceptors applicable to the matched inflector (or an empty collection if no inflector matched yet).

getBaseUri

public URI getBaseUri()

Get base request URI.

Returns:

base request URI.

getRequestUri

public URI getRequestUri()

Get request URI.

Returns:

request URI.

getAbsolutePath

public URI getAbsolutePath()

Get the absolute path of the request. This includes everything preceding the path (host, port etc), but excludes query parameters or fragment.

Returns:

the absolute path of the request.

setRequestUri

public void setRequestUri(URI requestUri)
                   throws IllegalStateException

Specified by:

setRequestUri in interface ContainerRequestContext

Throws:

IllegalStateException

setRequestUri

public void setRequestUri(URI baseUri,
 URI requestUri)
                   throws IllegalStateException

Specified by:

setRequestUri in interface ContainerRequestContext

Throws:

IllegalStateException

getPath

public String getPath(boolean decode)

Get the path of the current request relative to the application root (base) URI as a string.

Parameters:

decode - controls whether sequences of escaped octets are decoded (true) or not (false).

Returns:

relative request path.

getMethod

public String getMethod()

Specified by:

getMethod in interface ContainerRequestContext

Specified by:

getMethod in interface Request

setMethod

public void setMethod(String method)
               throws IllegalStateException

Specified by:

setMethod in interface ContainerRequestContext

Throws:

IllegalStateException

setMethodWithoutException

public void setMethodWithoutException(String method)

Like setMethod(String) but does not throw IllegalStateException if the method is invoked in other than pre-matching phase.

Parameters:

method - HTTP method.

getSecurityContext

public SecurityContext getSecurityContext()

Specified by:

getSecurityContext in interface ContainerRequestContext

setSecurityContext

public void setSecurityContext(SecurityContext context)

Specified by:

setSecurityContext in interface ContainerRequestContext

setEntityStream

public void setEntityStream(InputStream input)

Description copied from class: InboundMessageContext

Set a new entity input stream.

Specified by:

setEntityStream in interface ContainerRequestContext

Overrides:

setEntityStream in class InboundMessageContext

Parameters:

input - new entity input stream.

getRequest

public Request getRequest()

Specified by:

getRequest in interface ContainerRequestContext

abortWith

public void abortWith(Response response)

Specified by:

abortWith in interface ContainerRequestContext

inResponseProcessing

public void inResponseProcessing()

Notify this request that the response created from this request is already being processed. This means that the request processing phase has finished and this request can be used only in the request processing phase (for example in ContainerResponseFilter).

The request can be used for processing of more than one response (in async cases). Then this method should be called when the first response is created from this request. Multiple calls to this method has the same effect as calling the method only once.

getAbortResponse

public Response getAbortResponse()

Get the request filter chain aborting response if set, or null otherwise.

Returns:

request filter chain aborting response if set, or null otherwise.

getCookies

public Map<String,Cookie> getCookies()

Specified by:

getCookies in interface ContainerRequestContext

Specified by:

getCookies in interface HttpHeaders

getAcceptableMediaTypes

public List<MediaType> getAcceptableMediaTypes()

Specified by:

getAcceptableMediaTypes in interface ContainerRequestContext

Specified by:

getAcceptableMediaTypes in interface HttpHeaders

getAcceptableLanguages

public List<Locale> getAcceptableLanguages()

Specified by:

getAcceptableLanguages in interface ContainerRequestContext

Specified by:

getAcceptableLanguages in interface HttpHeaders

selectVariant

public Variant selectVariant(List<Variant> variants)
                      throws IllegalArgumentException

Specified by:

selectVariant in interface Request

Throws:

IllegalArgumentException

getVaryValue

public String getVaryValue()

Get the value of HTTP Vary response header to be set in the response, or null if no value is to be set.

Returns:

value of HTTP Vary response header to be set in the response if available, null otherwise.

evaluatePreconditions

public Response.ResponseBuilder evaluatePreconditions(EntityTag eTag)

Specified by:

evaluatePreconditions in interface Request

evaluatePreconditions

public Response.ResponseBuilder evaluatePreconditions(Date lastModified)

Specified by:

evaluatePreconditions in interface Request

evaluatePreconditions

public Response.ResponseBuilder evaluatePreconditions(Date lastModified,
 EntityTag eTag)

Specified by:

evaluatePreconditions in interface Request

evaluatePreconditions

public Response.ResponseBuilder evaluatePreconditions()

Specified by:

evaluatePreconditions in interface Request

getRequestHeader

public List<String> getRequestHeader(String name)

Get the values of an HTTP request header if the header exists on the current request. The returned value will be a read-only List if the specified header exists or null if it does not. This is a shortcut for getRequestHeaders().get(name).

Specified by:

getRequestHeader in interface HttpHeaders

Parameters:

name - the header name, case insensitive.

Returns:

a read-only list of header values if the specified header exists, otherwise null.

Throws:

IllegalStateException - if called outside the scope of a request.

getRequestHeaders

public MultivaluedMap<String,String> getRequestHeaders()

Get the values of HTTP request headers. The returned Map is case-insensitive wrt. keys and is read-only. The method never returns null.

Specified by:

getRequestHeaders in interface HttpHeaders

Returns:

a read-only map of header names and values.

Throws:

IllegalStateException - if called outside the scope of a request.