Module jakarta.ws.rs
Package jakarta.ws.rs.core

Class Response

java.lang.Object
jakarta.ws.rs.core.Response
All Implemented Interfaces:
AutoCloseable
public abstract class Response extends Object implements AutoCloseable
Defines the contract between a returned instance and the runtime when an application needs to provide meta-data to the runtime.

An application class should not extend this class directly. Response class is reserved for an extension by a JAX-RS implementation providers. An application should use one of the static methods to create a Response instance using a ResponseBuilder.

Several methods have parameters of type URI, UriBuilder provides convenient methods to create such values as does URI.create(java.lang.String).

Since:
1.0
Author:
Paul Sandoz, Marc Hadley, Marek Potociar
See Also:

  • Constructor Details

    • Response

      protected Response()
      Protected constructor, use one of the static methods to obtain a Response.ResponseBuilder instance and obtain a Response from that.

  • Method Details

    • getStatus

      public abstract int getStatus()
      Get the status code associated with the response.
      Returns:
      the response status code.

    • getStatusInfo

      public abstract Response.StatusType getStatusInfo()
      Get the complete status information associated with the response.
      Returns:
      the response status information. The returned value is never null.
      Since:
      2.0

    • getEntity

      public abstract Object getEntity()
      Get the message entity Java instance. Returns null if the message does not contain an entity body.

      If the entity is represented by an un-consumed input stream the method will return the input stream.

      Returns:
      the message entity or null if message does not contain an entity body (i.e. when hasEntity() returns false).
      Throws:
      IllegalStateException - if the entity was previously fully consumed as an input stream, or if the response has been closed.

    • readEntity

      public abstract <T> T readEntity(Class<T> entityType)
      Read the message entity input stream as an instance of specified Java type using a MessageBodyReader that supports mapping the message entity stream onto the requested type.

      Method throws an ProcessingException if the content of the message cannot be mapped to an entity of the requested type and IllegalStateException in case the entity is not backed by an input stream or if the original entity input stream has already been consumed without buffering the entity data prior consuming.

      A message instance returned from this method will be cached for subsequent retrievals via getEntity(). Unless the supplied entity type is an input stream, this method automatically closes the an unconsumed original response entity data stream if open. In case the entity data has been buffered, the buffer will be reset prior consuming the buffered data to enable subsequent invocations of readEntity(...) methods on this response.

      Type Parameters:
      T - entity instance Java type.
      Parameters:
      entityType - the type of entity.
      Returns:
      the message entity; for a zero-length response entities returns a corresponding Java object that represents zero-length data. In case no zero-length representation is defined for the Java type, a ProcessingException wrapping the underlying NoContentException is thrown.
      Throws:
      ProcessingException - if the content of the message cannot be mapped to an entity of the requested type.
      IllegalStateException - if the entity is not backed by an input stream, the response has been closed already, or if the entity input stream has been fully consumed already and has not been buffered prior consuming.
      Since:
      2.0
      See Also:

    • readEntity

      public abstract <T> T readEntity(GenericType<T> entityType)
      Read the message entity input stream as an instance of specified Java type using a MessageBodyReader that supports mapping the message entity stream onto the requested type.

      Method throws an ProcessingException if the content of the message cannot be mapped to an entity of the requested type and IllegalStateException in case the entity is not backed by an input stream or if the original entity input stream has already been consumed without buffering the entity data prior consuming.

      A message instance returned from this method will be cached for subsequent retrievals via getEntity(). Unless the supplied entity type is an input stream, this method automatically closes the an unconsumed original response entity data stream if open. In case the entity data has been buffered, the buffer will be reset prior consuming the buffered data to enable subsequent invocations of readEntity(...) methods on this response.

      Type Parameters:
      T - entity instance Java type.
      Parameters:
      entityType - the type of entity; may be generic.
      Returns:
      the message entity; for a zero-length response entities returns a corresponding Java object that represents zero-length data. In case no zero-length representation is defined for the Java type, a ProcessingException wrapping the underlying NoContentException is thrown.
      Throws:
      ProcessingException - if the content of the message cannot be mapped to an entity of the requested type.
      IllegalStateException - if the entity is not backed by an input stream, the response has been closed already, or if the entity input stream has been fully consumed already and has not been buffered prior consuming.
      Since:
      2.0
      See Also:

    • readEntity

      public abstract <T> T readEntity(Class<T> entityType, Annotation[] annotations)
      Read the message entity input stream as an instance of specified Java type using a MessageBodyReader that supports mapping the message entity stream onto the requested type.

      Method throws an ProcessingException if the content of the message cannot be mapped to an entity of the requested type and IllegalStateException in case the entity is not backed by an input stream or if the original entity input stream has already been consumed without buffering the entity data prior consuming.

      A message instance returned from this method will be cached for subsequent retrievals via getEntity(). Unless the supplied entity type is an input stream, this method automatically closes the an unconsumed original response entity data stream if open. In case the entity data has been buffered, the buffer will be reset prior consuming the buffered data to enable subsequent invocations of readEntity(...) methods on this response.

      Type Parameters:
      T - entity instance Java type.
      Parameters:
      entityType - the type of entity.
      annotations - annotations that will be passed to the MessageBodyReader.
      Returns:
      the message entity; for a zero-length response entities returns a corresponding Java object that represents zero-length data. In case no zero-length representation is defined for the Java type, a ProcessingException wrapping the underlying NoContentException is thrown.
      Throws:
      ProcessingException - if the content of the message cannot be mapped to an entity of the requested type.
      IllegalStateException - if the entity is not backed by an input stream, the response has been closed already, or if the entity input stream has been fully consumed already and has not been buffered prior consuming.
      Since:
      2.0
      See Also:

    • readEntity

      public abstract <T> T readEntity(GenericType<T> entityType, Annotation[] annotations)
      Read the message entity input stream as an instance of specified Java type using a MessageBodyReader that supports mapping the message entity stream onto the requested type.

      Method throws an ProcessingException if the content of the message cannot be mapped to an entity of the requested type and IllegalStateException in case the entity is not backed by an input stream or if the original entity input stream has already been consumed without buffering the entity data prior consuming.

      A message instance returned from this method will be cached for subsequent retrievals via getEntity(). Unless the supplied entity type is an input stream, this method automatically closes the an unconsumed original response entity data stream if open. In case the entity data has been buffered, the buffer will be reset prior consuming the buffered data to enable subsequent invocations of readEntity(...) methods on this response.

      Type Parameters:
      T - entity instance Java type.
      Parameters:
      entityType - the type of entity; may be generic.
      annotations - annotations that will be passed to the MessageBodyReader.
      Returns:
      the message entity; for a zero-length response entities returns a corresponding Java object that represents zero-length data. In case no zero-length representation is defined for the Java type, a ProcessingException wrapping the underlying NoContentException is thrown.
      Throws:
      ProcessingException - if the content of the message cannot be mapped to an entity of the requested type.
      IllegalStateException - if the entity is not backed by an input stream, the response has been closed already, or if the entity input stream has been fully consumed already and has not been buffered prior consuming.
      Since:
      2.0
      See Also:

    • hasEntity

      public abstract boolean hasEntity()
      Check if there is an entity available in the response. The method returns true if the entity is present, returns false otherwise.

      Note that the method may return true also for response messages with a zero-length content, in case the "Content-Length" and "Content-Type" headers are specified in the message. In such case, an attempt to read the entity using one of the readEntity(...) methods will return a corresponding instance representing a zero-length entity for a given Java type or produce a ProcessingException in case no such instance is available for the Java type.

      Returns:
      true if there is an entity present in the message, false otherwise.
      Throws:
      IllegalStateException - in case the response has been closed.
      Since:
      2.0

    • bufferEntity

      public abstract boolean bufferEntity()
      Buffer the message entity data.

      In case the message entity is backed by an unconsumed entity input stream, all the bytes of the original entity input stream are read and stored in a local buffer. The original entity input stream is consumed and automatically closed as part of the operation and the method returns true.

      In case the response entity instance is not backed by an unconsumed input stream an invocation of bufferEntity method is ignored and the method returns false.

      This operation is idempotent, i.e. it can be invoked multiple times with the same effect which also means that calling the bufferEntity() method on an already buffered (and thus closed) message instance is legal and has no further effect. Also, the result returned by the bufferEntity() method is consistent across all invocations of the method on the same Response instance.

      Buffering the message entity data allows for multiple invocations of readEntity(...) methods on the response instance. Note however, that once the response instance itself is closed, the implementations are expected to release the buffered message entity data too. Therefore any subsequent attempts to read a message entity stream on such closed response will result in an IllegalStateException being thrown.

      Returns:
      true if the message entity input stream was available and was buffered successfully, returns false if the entity stream was not available.
      Throws:
      ProcessingException - if there was an error while buffering the entity input stream.
      IllegalStateException - in case the response has been closed.
      Since:
      2.0

    • close

      public abstract void close()
      Close the underlying message entity input stream (if available and open) as well as releases any other resources associated with the response (e.g. buffered message entity data).

      This operation is idempotent, i.e. it can be invoked multiple times with the same effect which also means that calling the close() method on an already closed message instance is legal and has no further effect.

      The close() method should be invoked on all instances that contain an un-consumed entity input stream to ensure the resources associated with the instance are properly cleaned-up and prevent potential memory leaks. This is typical for client-side scenarios where application layer code processes only the response headers and ignores the response entity.

      Any attempts to manipulate (read, get, buffer) a message entity on a closed response will result in an IllegalStateException being thrown.

      Specified by:
      close in interface AutoCloseable
      Throws:
      ProcessingException - if there is an error closing the response.
      Since:
      2.0

    • getMediaType

      public abstract MediaType getMediaType()
      Get the media type of the message entity.
      Returns:
      the media type or null if there is no response entity.
      Since:
      2.0

    • getLanguage

      public abstract Locale getLanguage()
      Get the language of the message entity.
      Returns:
      the language of the entity or null if not specified.
      Since:
      2.0

    • getLength

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

    • getAllowedMethods

      public abstract 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.
      Since:
      2.0

    • getCookies

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

    • getEntityTag

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

    • getDate

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

    • getLastModified

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

    • getLocation

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

    • getLinks

      public abstract Set<Link> getLinks()
      Get the links attached to the message as headers. Any links in the message that are relative must be resolved with respect to the actual request URI that produced this response. Note that request URIs may be updated by filters, so the actual request URI may differ from that in the original invocation.
      Returns:
      links, may return empty Set if no links are present. Does not return null.
      Since:
      2.0

    • hasLink

      public abstract boolean hasLink(String relation)
      Check if link for relation exists.
      Parameters:
      relation - link relation.
      Returns:
      true if the link for the relation is present in the message headers, false otherwise.
      Since:
      2.0

    • getLink

      public abstract Link getLink(String relation)
      Get the link for the relation. A relative link is resolved with respect to the actual request URI that produced this response. Note that request URIs may be updated by filters, so the actual request URI may differ from that in the original invocation.
      Parameters:
      relation - link relation.
      Returns:
      the link for the relation, otherwise null if not present.
      Since:
      2.0

    • getLinkBuilder

      public abstract Link.Builder getLinkBuilder(String relation)
      Convenience method that returns a Link.Builder for the relation. See getLink(java.lang.String) for more information.
      Parameters:
      relation - link relation.
      Returns:
      the link builder for the relation, otherwise null if not present.
      Since:
      2.0

    • getMetadata

      public abstract MultivaluedMap<String,Object> getMetadata()
      See getHeaders(). This method is considered deprecated. Users are encouraged to switch their code to use the getHeaders() method instead. The method may be annotated as @Deprecated in a future release of JAX-RS API.
      Returns:
      response headers as a multivalued map.

    • getHeaders

      public MultivaluedMap<String,Object> getHeaders()
      Get view of the response headers and their object values. The underlying header data may be subsequently modified by the JAX-RS runtime on the server side. Changes in the underlying header data are reflected in this view.

      On the server-side, when the message is sent, the non-string values will be serialized using a RuntimeDelegate.HeaderDelegate if one is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the class of the value or using the values toString method if a header delegate is not available.

      On the client side, the returned map is identical to the one returned by getStringHeaders().

      Returns:
      response headers as an object view of header values.
      Since:
      2.0
      See Also:

    • getStringHeaders

      public abstract MultivaluedMap<String,String> getStringHeaders()
      Get view of the response headers and their string values. The underlying header data may be subsequently modified by the JAX-RS runtime on the server side. Changes in the underlying header data are reflected in this view.
      Returns:
      response headers as a string view of header values.
      Since:
      2.0
      See Also:

    • getHeaderString

      public abstract String getHeaderString(String name)
      Get a message header as a single string value. Each single header value is converted to String using a RuntimeDelegate.HeaderDelegate if one is available via RuntimeDelegate.createHeaderDelegate(java.lang.Class) for the header value class or using its toString method if a header delegate is not available.
      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.
      Since:
      2.0
      See Also:

    • isClosed

      public boolean isClosed()
      Check if the response is closed. The method returns true if the response is closed, returns false otherwise.
      Returns:
      true if the response has been closed, false otherwise.
      Since:
      3.1

    • fromResponse

      public static Response.ResponseBuilder fromResponse(Response response)
      Create a new ResponseBuilder by performing a shallow copy of an existing Response.

      The returned builder has its own response headers but the header values are shared with the original Response instance. The original response entity instance reference is set in the new response builder.

      Note that if the entity is backed by an un-consumed input stream, the reference to the stream is copied. In such case make sure to buffer the entity stream of the original response instance before passing it to this method.

      Parameters:
      response - a Response from which the status code, entity and response headers will be copied.
      Returns:
      a new response builder.
      Since:
      2.0

    • status

      public static Response.ResponseBuilder status(Response.StatusType status)
      Create a new ResponseBuilder with the supplied status.
      Parameters:
      status - the response status.
      Returns:
      a new response builder.
      Throws:
      IllegalArgumentException - if status is null.

    • status

      public static Response.ResponseBuilder status(Response.Status status)
      Create a new ResponseBuilder with the supplied status.
      Parameters:
      status - the response status.
      Returns:
      a new response builder.
      Throws:
      IllegalArgumentException - if status is null.

    • status

      public static Response.ResponseBuilder status(int status)
      Create a new ResponseBuilder with the supplied status.
      Parameters:
      status - the response status.
      Returns:
      a new response builder.
      Throws:
      IllegalArgumentException - if status is less than 100 or greater than 599.

    • status

      public static Response.ResponseBuilder status(int status, String reasonPhrase)
      Create a new ResponseBuilder with the supplied status and reason phrase.
      Parameters:
      status - the response status.
      reasonPhrase - the reason phrase.
      Returns:
      the updated response builder.
      Throws:
      IllegalArgumentException - if status is less than 100 or greater than 599.
      Since:
      2.1

    • ok

      public static Response.ResponseBuilder ok()
      Create a new ResponseBuilder with an OK status.
      Returns:
      a new response builder.

    • ok

      public static Response.ResponseBuilder ok(Object entity)
      Create a new ResponseBuilder that contains a representation. It is the callers responsibility to wrap the actual entity with GenericEntity if preservation of its generic type is required.
      Parameters:
      entity - the representation entity data.
      Returns:
      a new response builder.

    • ok

      public static Response.ResponseBuilder ok(Object entity, MediaType type)
      Create a new ResponseBuilder that contains a representation. It is the callers responsibility to wrap the actual entity with GenericEntity if preservation of its generic type is required.
      Parameters:
      entity - the representation entity data.
      type - the media type of the entity.
      Returns:
      a new response builder.

    • ok

      public static Response.ResponseBuilder ok(Object entity, String type)
      Create a new ResponseBuilder that contains a representation. It is the callers responsibility to wrap the actual entity with GenericEntity if preservation of its generic type is required.
      Parameters:
      entity - the representation entity data.
      type - the media type of the entity.
      Returns:
      a new response builder.

    • ok

      public static Response.ResponseBuilder ok(Object entity, Variant variant)
      Create a new ResponseBuilder that contains a representation. It is the callers responsibility to wrap the actual entity with GenericEntity if preservation of its generic type is required.
      Parameters:
      entity - the representation entity data.
      variant - representation metadata.
      Returns:
      a new response builder.

    • serverError

      public static Response.ResponseBuilder serverError()
      Create a new ResponseBuilder with an server error status.
      Returns:
      a new response builder.

    • created

      public static Response.ResponseBuilder created(URI location)
      Create a new ResponseBuilder for a created resource, set the location header using the supplied value.
      Parameters:
      location - the URI of the new resource. If a relative URI is supplied it will be converted into an absolute URI by resolving it relative to the base URI (see UriInfo.getRequestUri()).
      Returns:
      a new response builder.
      Throws:
      IllegalArgumentException - if location is null.

    • accepted

      public static Response.ResponseBuilder accepted()
      Create a new ResponseBuilder with an ACCEPTED status.
      Returns:
      a new response builder.
      Since:
      2.0

    • accepted

      public static Response.ResponseBuilder accepted(Object entity)
      Create a new ResponseBuilder with an ACCEPTED status that contains a representation. It is the callers responsibility to wrap the actual entity with GenericEntity if preservation of its generic type is required.
      Parameters:
      entity - the representation entity data.
      Returns:
      a new response builder.
      Since:
      2.0

    • noContent

      public static Response.ResponseBuilder noContent()
      Create a new ResponseBuilder for an empty response.
      Returns:
      a new response builder.

    • notModified

      public static Response.ResponseBuilder notModified()
      Create a new ResponseBuilder with a not-modified status.
      Returns:
      a new response builder.

    • notModified

      public static Response.ResponseBuilder notModified(EntityTag tag)
      Create a new ResponseBuilder with a not-modified status.
      Parameters:
      tag - a tag for the unmodified entity.
      Returns:
      a new response builder.
      Throws:
      IllegalArgumentException - if tag is null.

    • notModified

      public static Response.ResponseBuilder notModified(String tag)
      Create a new ResponseBuilder with a not-modified status and a strong entity tag. This is a shortcut for notModified(new EntityTag(value)).
      Parameters:
      tag - the string content of a strong entity tag. The JAX-RS runtime will quote the supplied value when creating the header.
      Returns:
      a new response builder.
      Throws:
      IllegalArgumentException - if tag is null.

    • seeOther

      public static Response.ResponseBuilder seeOther(URI location)
      Create a new ResponseBuilder for a redirection. Used in the redirect-after-POST (aka POST/redirect/GET) pattern.
      Parameters:
      location - the redirection URI. If a relative URI is supplied it will be converted into an absolute URI by resolving it relative to the base URI of the application (see UriInfo.getBaseUri()).
      Returns:
      a new response builder.
      Throws:
      IllegalArgumentException - if location is null.

    • temporaryRedirect

      public static Response.ResponseBuilder temporaryRedirect(URI location)
      Create a new ResponseBuilder for a temporary redirection.
      Parameters:
      location - the redirection URI. If a relative URI is supplied it will be converted into an absolute URI by resolving it relative to the base URI of the application (see UriInfo.getBaseUri()).
      Returns:
      a new response builder.
      Throws:
      IllegalArgumentException - if location is null.

    • notAcceptable

      public static Response.ResponseBuilder notAcceptable(List<Variant> variants)
      Create a new ResponseBuilder for a not acceptable response.
      Parameters:
      variants - list of variants that were available, a null value is equivalent to an empty list.
      Returns:
      a new response builder.