Class ContainerRequest
- All Implemented Interfaces:
javax.ws.rs.container.ContainerRequestContext
,javax.ws.rs.core.HttpHeaders
,javax.ws.rs.core.Request
,PropertiesDelegate
ApplicationHandler
for each incoming client request.-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate javax.ws.rs.core.Response
private URI
private URI
private String
private static final URI
private String
private static final String
private static final String
private static final String
private String
private boolean
private static final String
private static final String
private static final String
private ProcessingProviders
private final PropertiesDelegate
private RequestScopedInitializer
private URI
private ContainerResponseWriter
private javax.ws.rs.core.SecurityContext
private final UriRoutingContext
private String
Fields inherited from interface javax.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, 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
ConstructorsConstructorDescriptionContainerRequest
(URI baseUri, URI requestUri, String httpMethod, javax.ws.rs.core.SecurityContext securityContext, PropertiesDelegate propertiesDelegate) Create new Jersey container request context. -
Method Summary
Modifier and TypeMethodDescriptionvoid
abortWith
(javax.ws.rs.core.Response response) (package private) void
Check if the container request has been properly initialized for processing.private static <T> Iterable<T>
emptyIfNull
(Iterable<T> iterable) private String
private javax.ws.rs.core.Response.ResponseBuilder
evaluateIfMatch
(javax.ws.rs.core.EntityTag eTag) private javax.ws.rs.core.Response.ResponseBuilder
evaluateIfModifiedSince
(long lastModified) private javax.ws.rs.core.Response.ResponseBuilder
evaluateIfModifiedSince
(long lastModified, String ifModifiedSinceHeader) private javax.ws.rs.core.Response.ResponseBuilder
evaluateIfNoneMatch
(javax.ws.rs.core.EntityTag eTag) private javax.ws.rs.core.Response.ResponseBuilder
evaluateIfNoneMatch
(javax.ws.rs.core.EntityTag eTag, Set<? extends javax.ws.rs.core.EntityTag> matchingTags, boolean isGetOrHead) private javax.ws.rs.core.Response.ResponseBuilder
evaluateIfUnmodifiedSince
(long lastModified) javax.ws.rs.core.Response.ResponseBuilder
javax.ws.rs.core.Response.ResponseBuilder
evaluatePreconditions
(Date lastModified) javax.ws.rs.core.Response.ResponseBuilder
evaluatePreconditions
(Date lastModified, javax.ws.rs.core.EntityTag eTag) javax.ws.rs.core.Response.ResponseBuilder
evaluatePreconditions
(javax.ws.rs.core.EntityTag eTag) javax.ws.rs.core.Response
Get the request filter chain aborting response if set, ornull
otherwise.Get the absolute path of the request.List<javax.ws.rs.core.MediaType>
Get base request URI.getPath
(boolean decode) Get the path of the current request relative to the application root (base) URI as a string.Get the underlying properties delegate.getProperty
(String name) Returns the property with the given name registered in the current request/response exchange context, ornull
if there is no property by that name.Returns an immutablecollection
containing the property names available within the context of the current request/response exchange context.protected Iterable<javax.ws.rs.ext.ReaderInterceptor>
Get all reader interceptors applicable to this request.javax.ws.rs.core.Request
(package private) Iterable<RankedProvider<javax.ws.rs.container.ContainerRequestFilter>>
Get all bound request filters applicable to this request.getRequestHeader
(String name) Get the values of a HTTP request header.Get the values of HTTP request headers.Get a custom container extensions initializer for the current request.Get request URI.(package private) Iterable<RankedProvider<javax.ws.rs.container.ContainerResponseFilter>>
Get all bound response filters applicable to this request.Get the container response writer for the current request.javax.ws.rs.core.SecurityContext
(package private) UriRoutingContext
Get the value of HTTP Vary response header to be set in the response, ornull
if no value is to be set.(package private) Iterable<javax.ws.rs.ext.WriterInterceptor>
Get all writer interceptors applicable to this request.void
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.private static long
roundDown
(long time) Round down the time to the nearest second.javax.ws.rs.core.Variant
selectVariant
(List<javax.ws.rs.core.Variant> variants) void
setEntityStream
(InputStream input) Set a new entity input stream.void
void
setMethodWithoutException
(String method) LikesetMethod(String)
but does not throwIllegalStateException
if the method is invoked in other than pre-matching phase.(package private) void
setProcessingProviders
(ProcessingProviders providers) 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
(javax.ws.rs.core.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, 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 javax.ws.rs.container.ContainerRequestContext
getDate, getEntityStream, getHeaders, getHeaderString, getLanguage, getLength, getMediaType, hasEntity
Methods inherited from interface javax.ws.rs.core.HttpHeaders
getDate, getHeaderString, getLanguage, getLength, getMediaType
-
Field Details
-
DEFAULT_BASE_URI
-
propertiesDelegate
-
uriRoutingContext
-
baseUri
-
requestUri
-
encodedRelativePath
-
decodedRelativePath
-
absolutePathUri
-
httpMethod
-
securityContext
private javax.ws.rs.core.SecurityContext securityContext -
abortResponse
private javax.ws.rs.core.Response abortResponse -
varyValue
-
processingProviders
-
requestScopedInitializer
-
responseWriter
-
inResponseProcessingPhase
private boolean inResponseProcessingPhase -
ERROR_REQUEST_SET_ENTITY_STREAM_IN_RESPONSE_PHASE
-
ERROR_REQUEST_SET_SECURITY_CONTEXT_IN_RESPONSE_PHASE
-
ERROR_REQUEST_ABORT_IN_RESPONSE_PHASE
-
METHOD_PARAMETER_CANNOT_BE_NULL_OR_EMPTY
-
METHOD_PARAMETER_CANNOT_BE_NULL_ETAG
-
METHOD_PARAMETER_CANNOT_BE_NULL_LAST_MODIFIED
-
-
Constructor Details
-
ContainerRequest
public ContainerRequest(URI baseUri, URI requestUri, String httpMethod, javax.ws.rs.core.SecurityContext securityContext, PropertiesDelegate propertiesDelegate) 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 benull
. TheSecurityContext.getUserPrincipal()
must returnnull
if the current request has not been authenticated by the container.propertiesDelegate
- customproperties delegate
to be used by the context.
-
-
Method Details
-
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
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
Get the container response writer for the current request.- Returns:
- container response writer.
-
setWriter
Set the container response writer for the current request.- Parameters:
responseWriter
- container response writer. Must not benull
.
-
readEntity
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
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
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
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.
-
getProperty
Description copied from interface:PropertiesDelegate
Returns the property with the given name registered in the current request/response exchange context, ornull
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 interfacejavax.ws.rs.container.ContainerRequestContext
- Specified by:
getProperty
in interfacePropertiesDelegate
- Parameters:
name
- aString
specifying the name of the property.- Returns:
- an
Object
containing the value of the property, ornull
if no property exists matching the given name. - See Also:
-
getPropertyNames
Description copied from interface:PropertiesDelegate
Returns an immutablecollection
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 interfacejavax.ws.rs.container.ContainerRequestContext
- Specified by:
getPropertyNames
in interfacePropertiesDelegate
- Returns:
- an immutable
collection
of property names. - See Also:
-
setProperty
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 thePropertiesDelegate.removeProperty(String)
method.- Specified by:
setProperty
in interfacejavax.ws.rs.container.ContainerRequestContext
- Specified by:
setProperty
in interfacePropertiesDelegate
- Parameters:
name
- aString
specifying the name of the property.object
- anObject
representing the property to be bound.
-
removeProperty
Description copied from interface:PropertiesDelegate
Removes a property with the given name from the current request/response exchange context. After removal, subsequent calls toPropertiesDelegate.getProperty(java.lang.String)
to retrieve the property value will returnnull
.- Specified by:
removeProperty
in interfacejavax.ws.rs.container.ContainerRequestContext
- Specified by:
removeProperty
in interfacePropertiesDelegate
- Parameters:
name
- aString
specifying the name of the property to be removed.
-
getPropertiesDelegate
Get the underlying properties delegate.- Returns:
- underlying properties delegate.
-
getUriInfo
- Specified by:
getUriInfo
in interfacejavax.ws.rs.container.ContainerRequestContext
-
setProcessingProviders
-
getUriRoutingContext
UriRoutingContext getUriRoutingContext() -
getRequestFilters
Iterable<RankedProvider<javax.ws.rs.container.ContainerRequestFilter>> getRequestFilters()Get all bound request filters applicable to this request.- Returns:
- All bound (dynamically or by name) request filters applicable to the matched inflector (or an empty collection if no inflector matched yet).
-
getResponseFilters
Iterable<RankedProvider<javax.ws.rs.container.ContainerResponseFilter>> getResponseFilters()Get all bound response filters applicable to this request. This is populated once the right resource method is matched.- Returns:
- All bound (dynamically or by name) response filters applicable to the matched inflector (or an empty collection if no inflector matched yet).
-
getReaderInterceptors
Get all reader interceptors applicable to this request. This is populated once the right resource method is matched.- Specified by:
getReaderInterceptors
in classInboundMessageContext
- Returns:
- All reader interceptors applicable to the matched inflector (or an empty collection if no inflector matched yet).
-
getWriterInterceptors
Iterable<javax.ws.rs.ext.WriterInterceptor> getWriterInterceptors()Get all writer interceptors applicable to this request.- Returns:
- All writer interceptors applicable to the matched inflector (or an empty collection if no inflector matched yet).
-
getInflector
-
emptyIfNull
-
getBaseUri
Get base request URI.- Returns:
- base request URI.
-
getRequestUri
Get request URI.- Returns:
- request 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
- Specified by:
setRequestUri
in interfacejavax.ws.rs.container.ContainerRequestContext
- Throws:
IllegalStateException
-
setRequestUri
- Specified by:
setRequestUri
in interfacejavax.ws.rs.container.ContainerRequestContext
- Throws:
IllegalStateException
-
getPath
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.
-
encodedRelativePath
-
getMethod
- Specified by:
getMethod
in interfacejavax.ws.rs.container.ContainerRequestContext
- Specified by:
getMethod
in interfacejavax.ws.rs.core.Request
-
setMethod
- Specified by:
setMethod
in interfacejavax.ws.rs.container.ContainerRequestContext
- Throws:
IllegalStateException
-
setMethodWithoutException
LikesetMethod(String)
but does not throwIllegalStateException
if the method is invoked in other than pre-matching phase.- Parameters:
method
- HTTP method.
-
getSecurityContext
public javax.ws.rs.core.SecurityContext getSecurityContext()- Specified by:
getSecurityContext
in interfacejavax.ws.rs.container.ContainerRequestContext
-
setSecurityContext
public void setSecurityContext(javax.ws.rs.core.SecurityContext context) - Specified by:
setSecurityContext
in interfacejavax.ws.rs.container.ContainerRequestContext
-
setEntityStream
Description copied from class:InboundMessageContext
Set a new entity input stream.- Specified by:
setEntityStream
in interfacejavax.ws.rs.container.ContainerRequestContext
- Overrides:
setEntityStream
in classInboundMessageContext
- Parameters:
input
- new entity input stream.
-
getRequest
public javax.ws.rs.core.Request getRequest()- Specified by:
getRequest
in interfacejavax.ws.rs.container.ContainerRequestContext
-
abortWith
public void abortWith(javax.ws.rs.core.Response response) - Specified by:
abortWith
in interfacejavax.ws.rs.container.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 javax.ws.rs.core.Response getAbortResponse()Get the request filter chain aborting response if set, ornull
otherwise.- Returns:
- request filter chain aborting response if set, or
null
otherwise.
-
getCookies
- Specified by:
getCookies
in interfacejavax.ws.rs.container.ContainerRequestContext
- Specified by:
getCookies
in interfacejavax.ws.rs.core.HttpHeaders
-
getAcceptableMediaTypes
- Specified by:
getAcceptableMediaTypes
in interfacejavax.ws.rs.container.ContainerRequestContext
- Specified by:
getAcceptableMediaTypes
in interfacejavax.ws.rs.core.HttpHeaders
-
getAcceptableLanguages
- Specified by:
getAcceptableLanguages
in interfacejavax.ws.rs.container.ContainerRequestContext
- Specified by:
getAcceptableLanguages
in interfacejavax.ws.rs.core.HttpHeaders
-
selectVariant
public javax.ws.rs.core.Variant selectVariant(List<javax.ws.rs.core.Variant> variants) throws IllegalArgumentException - Specified by:
selectVariant
in interfacejavax.ws.rs.core.Request
- Throws:
IllegalArgumentException
-
getVaryValue
Get the value of HTTP Vary response header to be set in the response, ornull
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 javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions(javax.ws.rs.core.EntityTag eTag) - Specified by:
evaluatePreconditions
in interfacejavax.ws.rs.core.Request
-
evaluatePreconditions
- Specified by:
evaluatePreconditions
in interfacejavax.ws.rs.core.Request
-
evaluatePreconditions
public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions(Date lastModified, javax.ws.rs.core.EntityTag eTag) - Specified by:
evaluatePreconditions
in interfacejavax.ws.rs.core.Request
-
evaluatePreconditions
public javax.ws.rs.core.Response.ResponseBuilder evaluatePreconditions()- Specified by:
evaluatePreconditions
in interfacejavax.ws.rs.core.Request
-
evaluateIfMatch
private javax.ws.rs.core.Response.ResponseBuilder evaluateIfMatch(javax.ws.rs.core.EntityTag eTag) -
evaluateIfNoneMatch
private javax.ws.rs.core.Response.ResponseBuilder evaluateIfNoneMatch(javax.ws.rs.core.EntityTag eTag) -
evaluateIfNoneMatch
private javax.ws.rs.core.Response.ResponseBuilder evaluateIfNoneMatch(javax.ws.rs.core.EntityTag eTag, Set<? extends javax.ws.rs.core.EntityTag> matchingTags, boolean isGetOrHead) -
evaluateIfUnmodifiedSince
private javax.ws.rs.core.Response.ResponseBuilder evaluateIfUnmodifiedSince(long lastModified) -
evaluateIfModifiedSince
private javax.ws.rs.core.Response.ResponseBuilder evaluateIfModifiedSince(long lastModified) -
evaluateIfModifiedSince
private javax.ws.rs.core.Response.ResponseBuilder evaluateIfModifiedSince(long lastModified, String ifModifiedSinceHeader) -
roundDown
private static long roundDown(long time) Round down the time to the nearest second.- Parameters:
time
- the time to round down.- Returns:
- the rounded down time.
-
getRequestHeader
Get the values of a HTTP request header. The returned List is read-only. This is a shortcut forgetRequestHeaders().get(name)
.- Specified by:
getRequestHeader
in interfacejavax.ws.rs.core.HttpHeaders
- Parameters:
name
- the header name, case insensitive.- Returns:
- a read-only list of header values.
- Throws:
IllegalStateException
- if called outside the scope of a request.
-
getRequestHeaders
Get the values of HTTP request headers. The returned Map is case-insensitive wrt. keys and is read-only. The method never returnsnull
.- Specified by:
getRequestHeaders
in interfacejavax.ws.rs.core.HttpHeaders
- Returns:
- a read-only map of header names and values.
- Throws:
IllegalStateException
- if called outside the scope of a request.
-
checkState
Check if the container request has been properly initialized for processing.- Throws:
IllegalStateException
- in case the internal state is not ready for processing.
-