Module jakarta.ws.rs
Package jakarta.ws.rs.container

Interface ContainerRequestContext

public interface ContainerRequestContext
Container request filter context. A mutable class that provides request-specific information for the filter, such as request URI, message headers, message entity or request-scoped properties. The exposed setters allow modification of the exposed request-specific information.
Since:
2.0
Author:
Marek Potociar

  • Method Details

    • getProperty

      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.

      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 getPropertyNames(). Custom property names should follow the same convention as package names.

      In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes available in the ServletRequest. Any modifications of the properties are also reflected in the set of properties of the associated ServletRequest.

      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:

    • hasProperty

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

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

      Parameters:
      name - a String specifying the name of the property.
      Returns:
      true if this property is registered in the context, or false if no property exists matching the given name.
      See Also:

    • getPropertyNames

      Collection<String> getPropertyNames()
      Returns an immutable collection containing the property names available within the context of the current request/response exchange context.

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

      In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes available in the ServletRequest. Any modifications of the properties are also reflected in the set of properties of the associated ServletRequest.

      Returns:
      an immutable collection of property names.
      See Also:

    • setProperty

      void setProperty(String name, Object object)
      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 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 removeProperty(String) method.

      In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes available in the ServletRequest. Any modifications of the properties are also reflected in the set of properties of the associated ServletRequest.

      Parameters:
      name - a String specifying the name of the property.
      object - an Object representing the property to be bound.

    • removeProperty

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

      In a Servlet container, the properties are synchronized with the ServletRequest and expose all the attributes available in the ServletRequest. Any modifications of the properties are also reflected in the set of properties of the associated ServletRequest.

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

    • getUriInfo

      UriInfo getUriInfo()
      Get request URI information. The returned object contains "live" view of the request URI information in a sense that any changes made to the request URI using one of the setRequestUri(...) methods will be reflected in the previously returned UriInfo instance.
      Returns:
      request URI information.

    • setRequestUri

      void setRequestUri(URI requestUri)
      Set a new request URI using the current base URI of the application to resolve the application-specific request URI part.

      Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke the method in a filter bound to a resource method results in an IllegalStateException being thrown.

      Parameters:
      requestUri - new URI of the request.
      Throws:
      IllegalStateException - in case the method is not invoked from a pre-matching request filter.
      See Also:

    • setRequestUri

      void setRequestUri(URI baseUri, URI requestUri)
      Set a new request URI using a new base URI to resolve the application-specific request URI part.

      Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke the method in a filter bound to a resource method results in an IllegalStateException being thrown.

      Parameters:
      baseUri - base URI that will be used to resolve the application-specific part of the request URI.
      requestUri - new URI of the request.
      Throws:
      IllegalStateException - in case the method is not invoked from a pre-matching request filter.
      See Also:

    • getRequest

      Request getRequest()
      Get the injectable request information.
      Returns:
      injectable request information.

    • getMethod

      String getMethod()
      Get the request method.
      Returns:
      the request method.
      See Also:

    • setMethod

      void setMethod(String method)
      Set the request method.

      Note that the method is usable only in pre-matching filters, prior to the resource matching occurs. Trying to invoke the method in a filter bound to a resource method results in an IllegalStateException being thrown.

      Parameters:
      method - new request method.
      Throws:
      IllegalStateException - in case the method is not invoked from a pre-matching request filter.
      See Also:

    • getHeaders

      MultivaluedMap<String,String> getHeaders()
      Get the mutable request headers multivalued map.
      Returns:
      mutable multivalued map of request headers.
      See Also:

    • getHeaderString

      String getHeaderString(String name)
      Get a message header as a single string value.
      Parameters:
      name - the message header.
      Returns:
      the message header value. If the message header is not present then null is returned. If the message header is present but has no value then the empty string is returned. If the message header is present more than once then the values of joined together and separated by a ',' character.
      See Also:

    • containsHeaderString

      boolean containsHeaderString(String name, String valueSeparatorRegex, Predicate<String> valuePredicate)
      Checks whether a header with a specific name and value (or item of the token-separated value list) exists.

      For example: containsHeaderString("cache-control", ",", "no-store"::equalsIgnoreCase) will return true if a Cache-Control header exists that has the value no-store, the value No-Store or the value Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform (missing comma), or the value no - store (whitespace within value).

      Parameters:
      name - the message header.
      valueSeparatorRegex - Separates the header value into single values. null does not split.
      valuePredicate - value must fulfil this predicate.
      Returns:
      true if and only if a header with the given name exists, having either a whitespace-trimmed value matching the predicate, or having at least one whitespace-trimmed single value in a token-separated list of single values.
      Since:
      4.0
      See Also:

    • containsHeaderString

      default boolean containsHeaderString(String name, Predicate<String> valuePredicate)
      Checks whether a header with a specific name and value (or item of the comma-separated value list) exists.

      For example: containsHeaderString("cache-control", "no-store"::equalsIgnoreCase) will return true if a Cache-Control header exists that has the value no-store, the value No-Store or the value Max-Age, NO-STORE, no-transform, but false when it has the value no-store;no-transform (missing comma), or the value no - store (whitespace within value).

      Parameters:
      name - the message header.
      valuePredicate - value must fulfil this predicate.
      Returns:
      true if and only if a header with the given name exists, having either a whitespace-trimmed value matching the predicate, or having at least one whitespace-trimmed single value in a comma-separated list of single values.
      Since:
      4.0
      See Also:

    • getDate

      Date getDate()
      Get message date.
      Returns:
      the message date, otherwise null if not present.

    • getLanguage

      Locale getLanguage()
      Get the language of the entity.
      Returns:
      the language of the entity or null if not specified

    • getLength

      int getLength()
      Get Content-Length value.
      Returns:
      Content-Length as integer if present and valid number. In other cases returns -1.

    • getMediaType

      MediaType getMediaType()
      Get the media type of the entity.
      Returns:
      the media type or null if not specified (e.g. there's no request entity).

    • getAcceptableMediaTypes

      List<MediaType> getAcceptableMediaTypes()
      Get a list of media types that are acceptable for the response.
      Returns:
      a read-only list of requested response media types sorted according to their q-value, with highest preference first.

    • getAcceptableLanguages

      List<Locale> getAcceptableLanguages()
      Get a list of languages that are acceptable for the response.
      Returns:
      a read-only list of acceptable languages sorted according to their q-value, with highest preference first.

    • getCookies

      Map<String,Cookie> getCookies()
      Get any cookies that accompanied the request.
      Returns:
      a read-only map of cookie name (String) to Cookie.

    • hasEntity

      boolean hasEntity()
      Check if there is a non-empty entity input stream available in the request message. The method returns true if the entity is present, returns false otherwise.
      Returns:
      true if there is an entity present in the message, false otherwise.

    • getEntityStream

      InputStream getEntityStream()
      Get the entity input stream. The JAX-RS runtime is responsible for closing the input stream.
      Returns:
      entity input stream.

    • setEntityStream

      void setEntityStream(InputStream input)
      Set a new entity input stream. The JAX-RS runtime is responsible for closing the input stream.
      Parameters:
      input - new entity input stream.
      Throws:
      IllegalStateException - in case the method is invoked from a response filter.

    • getSecurityContext

      SecurityContext getSecurityContext()
      Get the injectable security context information for the current request. The SecurityContext.getUserPrincipal() must return null if the current request has not been authenticated.
      Returns:
      injectable request security context information.

    • setSecurityContext

      void setSecurityContext(SecurityContext context)
      Set a new injectable security context information for the current request. The SecurityContext.getUserPrincipal() must return null if the current request has not been authenticated.
      Parameters:
      context - new injectable request security context information.
      Throws:
      IllegalStateException - in case the method is invoked from a response filter.

    • abortWith

      void abortWith(Response response)
      Abort the filter chain with a response. This method breaks the filter chain processing and returns the provided response back to the client. The provided response goes through the chain of applicable response filters.
      Parameters:
      response - response to be sent back to the client.
      Throws:
      IllegalStateException - in case the method is invoked from a response filter.