Module jakarta.ws.rs
Package jakarta.ws.rs.client

Interface ClientResponseContext

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

  • Method Details

    • getStatus

      int getStatus()
      Get the status code associated with the response.
      Returns:
      the response status code or -1 if the status was not set.

    • setStatus

      void setStatus(int code)
      Set a new response status code.
      Parameters:
      code - new status code.

    • getStatusInfo

      Response.StatusType getStatusInfo()
      Get the complete status information associated with the response.
      Returns:
      the response status information or null if the status was not set.

    • setStatusInfo

      void setStatusInfo(Response.StatusType statusInfo)
      Set the complete status information (status code and reason phrase) associated with the response.
      Parameters:
      statusInfo - the response status information.

    • getHeaders

      MultivaluedMap<String,String> getHeaders()
      Get the mutable response headers multivalued map.
      Returns:
      mutable multivalued map of response 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 - Regular expression that 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:

    • getAllowedMethods

      Set<String> getAllowedMethods()
      Get the allowed HTTP methods from the Allow HTTP header.
      Returns:
      the allowed HTTP methods, all methods will returned as upper case strings.

    • 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 response entity).

    • getCookies

      Map<String,NewCookie> getCookies()
      Get any new cookies set on the response message.
      Returns:
      a read-only map of cookie name (String) to a new cookie.

    • getEntityTag

      EntityTag getEntityTag()
      Get the entity tag.
      Returns:
      the entity tag, otherwise null if not present.

    • getLastModified

      Date getLastModified()
      Get the last modified date.
      Returns:
      the last modified date, otherwise null if not present.

    • getLocation

      URI getLocation()
      Get the location.
      Returns:
      the location URI, otherwise null if not present.

    • getLinks

      Set<Link> getLinks()
      Get the links attached to the message as header.
      Returns:
      links, may return empty Set if no links are present. Never returns null.

    • hasLink

      boolean hasLink(String relation)
      Check if link for relation exists.
      Parameters:
      relation - link relation.
      Returns:
      true if the for the relation link exists, false otherwise.

    • getLink

      Link getLink(String relation)
      Get the link for the relation.
      Parameters:
      relation - link relation.
      Returns:
      the link for the relation, otherwise null if not present.

    • getLinkBuilder

      Link.Builder getLinkBuilder(String relation)
      Convenience method that returns a Link.Builder for the relation.
      Parameters:
      relation - link relation.
      Returns:
      the link builder for the relation, otherwise null if not present.

    • hasEntity

      boolean hasEntity()
      Check if there is a non-empty entity input stream is available in the response 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.