Package javax.ws.rs.core
Class Response.ResponseBuilder
java.lang.Object
javax.ws.rs.core.Response.ResponseBuilder
- Enclosing class:
- Response
A class used to build Response instances that contain metadata instead
of or in addition to an entity. An initial instance may be obtained via
static methods of the Response class, instance methods provide the
ability to set metadata. E.g. to create a response that indicates the
creation of a new resource:
@POST Response addWidget(...) { Widget w = ... URI widgetId = UriBuilder.fromResource(Widget.class)... return Response.created(widgetId).build(); }
Several methods have parameters of type URI, UriBuilder
provides
convenient methods to create such values as does URI.create()
.
Where multiple variants of the same method are provided, the type of
the supplied parameter is retained in the metadata of the built
Response
.
-
Constructor Summary
ModifierConstructorDescriptionprotected
Protected constructor, use one of the static methods ofResponse
to obtain an instance. -
Method Summary
Modifier and TypeMethodDescriptionabstract Response.ResponseBuilder
Set the list of allowed methods for the resource.abstract Response.ResponseBuilder
Set the list of allowed methods for the resource.abstract Response
build()
Create a Response instance from the current ResponseBuilder.abstract Response.ResponseBuilder
cacheControl
(CacheControl cacheControl) Set the cache control data of the message.abstract Response.ResponseBuilder
clone()
abstract Response.ResponseBuilder
contentLocation
(URI location) Set the content location.abstract Response.ResponseBuilder
Add cookies to the response message.abstract Response.ResponseBuilder
Set the message entity content encoding.abstract Response.ResponseBuilder
Set the response entity in the builder.abstract Response.ResponseBuilder
entity
(Object entity, Annotation[] annotations) Set the response entity in the builder.abstract Response.ResponseBuilder
Set the response expiration date.abstract Response.ResponseBuilder
Add an arbitrary header.abstract Response.ResponseBuilder
Set the message entity language.abstract Response.ResponseBuilder
Set the message entity language.abstract Response.ResponseBuilder
lastModified
(Date lastModified) Set the response entity last modification date.abstract Response.ResponseBuilder
Add a link header.abstract Response.ResponseBuilder
Add a link header.abstract Response.ResponseBuilder
Add one or more link headers.abstract Response.ResponseBuilder
Set the location.protected static Response.ResponseBuilder
Create a new builder instance.abstract Response.ResponseBuilder
replaceAll
(MultivaluedMap<String, Object> headers) Replaces all existing headers with the newly supplied headers.abstract Response.ResponseBuilder
status
(int status) Set the status on the ResponseBuilder.status
(Response.Status status) Set the status on the ResponseBuilder.status
(Response.StatusType status) Set the status on the ResponseBuilder.abstract Response.ResponseBuilder
Set a strong response entity tag.abstract Response.ResponseBuilder
Set a response entity tag.abstract Response.ResponseBuilder
Set the message entity media type.abstract Response.ResponseBuilder
Set the message entity media type.abstract Response.ResponseBuilder
Set message entity representation metadata.abstract Response.ResponseBuilder
Add a Vary header that lists the available variants.abstract Response.ResponseBuilder
Add a Vary header that lists the available variants.
-
Constructor Details
-
ResponseBuilder
protected ResponseBuilder()Protected constructor, use one of the static methods ofResponse
to obtain an instance.
-
-
Method Details
-
newInstance
Create a new builder instance.- Returns:
- a new response builder.
-
build
Create a Response instance from the current ResponseBuilder. The builder is reset to a blank state equivalent to calling the ok method.- Returns:
- a Response instance.
-
clone
Create a copy of the ResponseBuilder preserving its state.
-
status
Set the status on the ResponseBuilder.- Parameters:
status
- the response status.- Returns:
- the updated response builder.
- Throws:
IllegalArgumentException
- if status is less than100
or greater than599
.
-
status
Set the status on the ResponseBuilder.- Parameters:
status
- the response status.- Returns:
- the updated response builder.
- Throws:
IllegalArgumentException
- if status isnull
.- Since:
- 1.1
-
status
Set the status on the ResponseBuilder.- Parameters:
status
- the response status.- Returns:
- the updated response builder.
- Throws:
IllegalArgumentException
- if status isnull
.
-
entity
Set the response entity in the builder. Any Java type instance for a response entity, that is supported by the runtime can be passed. It is the callers responsibility to wrap the actual entity withGenericEntity
if preservation of its generic type is required. Note that the entity can be also set as aninput stream
. A specific entity media type can be set using one of thetype(...)
methods.- Parameters:
entity
- the request entity.- Returns:
- updated response builder instance.
- See Also:
-
entity
Set the response entity in the builder. Any Java type instance for a response entity, that is supported by the runtime can be passed. It is the callers responsibility to wrap the actual entity withGenericEntity
if preservation of its generic type is required. Note that the entity can be also set as aninput stream
. A specific entity media type can be set using one of thetype(...)
methods.- Parameters:
entity
- the request entity.annotations
- annotations that will be passed to theMessageBodyWriter
.- Returns:
- updated response builder instance.
- Since:
- 2.0
- See Also:
-
allow
Set the list of allowed methods for the resource. Any duplicate method names will be truncated to a single entry.- Parameters:
methods
- the methods to be listed as allowed for the resource, ifnull
any existing allowed method list will be removed.- Returns:
- the updated response builder.
- Since:
- 2.0
-
allow
Set the list of allowed methods for the resource.- Parameters:
methods
- the methods to be listed as allowed for the resource, ifnull
any existing allowed method list will be removed.- Returns:
- the updated response builder.
- Since:
- 2.0
-
cacheControl
Set the cache control data of the message.- Parameters:
cacheControl
- the cache control directives, ifnull
any existing cache control directives will be removed.- Returns:
- the updated response builder.
-
encoding
Set the message entity content encoding.- Parameters:
encoding
- the content encoding of the message entity, ifnull
any existing value for content encoding will be removed.- Returns:
- the updated response builder.
- Since:
- 2.0
-
header
Add an arbitrary header.- Parameters:
name
- the name of the headervalue
- the value of the header, the header will be serialized using aRuntimeDelegate.HeaderDelegate
if one is available viaRuntimeDelegate.createHeaderDelegate(java.lang.Class)
for the class ofvalue
or using itstoString
method if a header delegate is not available. Ifvalue
isnull
then all current headers of the same name will be removed.- Returns:
- the updated response builder.
-
replaceAll
Replaces all existing headers with the newly supplied headers.- Parameters:
headers
- new headers to be set, ifnull
all existing headers will be removed.- Returns:
- the updated response builder.
- Since:
- 2.0
-
language
Set the message entity language.- Parameters:
language
- the language of the message entity, ifnull
any existing value for language will be removed.- Returns:
- the updated response builder.
-
language
Set the message entity language.- Parameters:
language
- the language of the message entity, ifnull
any existing value for type will be removed.- Returns:
- the updated response builder.
-
type
Set the message entity media type.- Parameters:
type
- the media type of the message entity. Ifnull
, any existing value for type will be removed.- Returns:
- the updated response builder.
-
type
Set the message entity media type.- Parameters:
type
- the media type of the message entity. Ifnull
, any existing value for type will be removed.- Returns:
- the updated response builder.
-
variant
Set message entity representation metadata. Equivalent to setting the values of content type, content language, and content encoding separately using the values of the variant properties.- Parameters:
variant
- metadata of the message entity, anull
value is equivalent to a variant with allnull
properties.- Returns:
- the updated response builder.
- Since:
- 2.0
- See Also:
-
contentLocation
Set the content location.- Parameters:
location
- the content location. Relative or absolute URIs may be used for the value of content location. Ifnull
any existing value for content location will be removed.- Returns:
- the updated response builder.
-
cookie
Add cookies to the response message.- Parameters:
cookies
- new cookies that will accompany the response. Anull
value will remove all cookies, including those added via theheader(java.lang.String, java.lang.Object)
method.- Returns:
- the updated response builder.
-
expires
Set the response expiration date.- Parameters:
expires
- the expiration date, ifnull
removes any existing expires value.- Returns:
- the updated response builder.
-
lastModified
Set the response entity last modification date.- Parameters:
lastModified
- the last modified date, ifnull
any existing last modified value will be removed.- Returns:
- the updated response builder.
-
location
Set the location.- Parameters:
location
- the location. 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 (seeUriInfo.getBaseUri()
). Ifnull
any existing value for location will be removed.- Returns:
- the updated response builder.
-
tag
Set a response entity tag.- Parameters:
tag
- the entity tag, ifnull
any existing entity tag value will be removed.- Returns:
- the updated response builder.
-
tag
Set a strong response entity tag. This is a shortcut fortag(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. Ifnull
any existing entity tag value will be removed.- Returns:
- the updated response builder.
-
variants
Add a Vary header that lists the available variants.- Parameters:
variants
- a list of available representation variants, anull
value will remove an existing value for Vary header.- Returns:
- the updated response builder.
- Since:
- 2.0
-
variants
Add a Vary header that lists the available variants.- Parameters:
variants
- a list of available representation variants, anull
value will remove an existing value for Vary header.- Returns:
- the updated response builder.
-
links
Add one or more link headers.- Parameters:
links
- links to be added to the message as headers, anull
value will remove any existing Link headers.- Returns:
- the updated response builder.
- Since:
- 2.0
-
link
Add a link header.- Parameters:
uri
- underlying URI for link header.rel
- value of "rel" parameter.- Returns:
- the updated response builder.
- Since:
- 2.0
-
link
Add a link header.- Parameters:
uri
- underlying URI for link header.rel
- value of "rel" parameter.- Returns:
- the updated response builder.
- Since:
- 2.0
-