Spec-Zone .ru спецификации, руководства, описания, API

javax.ws.rs.core
Ответ класса

java.lang.Object
  javax.ws.rs.core.Response

public abstract class Response
расширяет java.lang. Объект

Определяет контракт между возвращенным экземпляром и временем выполнения, когда приложение должно обеспечить метаданные для времени выполнения. Приложение class может расширить этот class непосредственно или может использовать один из статических методов, чтобы создать экземпляр, используя ResponseBuilder. У нескольких методов есть параметры URI типа, UriBuilder обеспечивает удобные методы, чтобы создать такую стоимость как делает URI.create ().

См. Также:

Response.ResponseBuilder

Вложенная Сводка Класса

static class	Ответ. ResponseBuilder class, используемый, чтобы создать экземпляры Ответа, которые содержат метаданные вместо или в дополнение к объекту.
static class	Ответ. Состояние Обычно используемые коды состояния, определенные HTTP, см. документацию HTTP/1.1 для полного списка.
static interface	Ответ. StatusType Основной интерфейс для состояний используется в ответах.

Сводка конструктора

protected

Response() Защищенный конструктор, используйте один из статических методов, чтобы получить a Response.ResponseBuilder экземпляр и получает Ответ из этого.

Сводка метода

static Response.ResponseBuilder	created(java.net.URI location) Создайте новый ResponseBuilder для создаваемого ресурса, установите заголовок расположения, используя предоставленное значение.
static Response.ResponseBuilder	fromResponse(Response response) Создайте новый ResponseBuilder, выполняя мелкую копию существующего Ответа.
abstract java.lang.Object	getEntity() Возвратите объект ответа.
abstract MultivaluedMap<java.lang.String,java.lang.Object>	getMetadata() Свяжите метаданные с ответом как карта.
abstract int	getStatus() Свяжите код состояния с ответом.
static Response.ResponseBuilder	noContent() Создайте новый ResponseBuilder для пустого ответа.
static Response.ResponseBuilder	notAcceptable(java.util.List<Variant> variants) Создайте новый ResponseBuilder для не приемлемого ответа.
static Response.ResponseBuilder	notModified() Создайте новый ResponseBuilder с не - измененное состояние.
static Response.ResponseBuilder	notModified(EntityTag tag) Создайте новый ResponseBuilder с не - измененное состояние.
static Response.ResponseBuilder	notModified(java.lang.String tag) Создайте новый ResponseBuilder с не - измененное состояние и тег объекта strong.
static Response.ResponseBuilder	ok() Создайте новый ResponseBuilder с состоянием OK.
static Response.ResponseBuilder	ok(java.lang.Object entity) Создайте новый ResponseBuilder, который содержит представление.
static Response.ResponseBuilder	ok(java.lang.Object entity, MediaType type) Создайте новый ResponseBuilder, который содержит представление.
static Response.ResponseBuilder	ok(java.lang.Object entity, java.lang.String type) Создайте новый ResponseBuilder, который содержит представление.
static Response.ResponseBuilder	ok(java.lang.Object entity, Variant variant) Создайте новый ResponseBuilder, который содержит представление.
static Response.ResponseBuilder	seeOther(java.net.URI location) Создайте новый ResponseBuilder для перенаправления.
static Response.ResponseBuilder	serverError() Создайте новый ResponseBuilder с ошибочным состоянием сервера.
static Response.ResponseBuilder	status(int status) Создайте новый ResponseBuilder с предоставленным состоянием.
static Response.ResponseBuilder	status(Response.Status status) Создайте новый ResponseBuilder с предоставленным состоянием.
static Response.ResponseBuilder	status(Response.StatusType status) Создайте новый ResponseBuilder с предоставленным состоянием.
static Response.ResponseBuilder	temporaryRedirect(java.net.URI location) Создайте новый ResponseBuilder для временного перенаправления.

Методы, наследованные от class java.lang. Объект

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Деталь конструктора

Ответ

protected Response()

Защищенный конструктор, используйте один из статических методов, чтобы получить a Response.ResponseBuilder экземпляр и получает Ответ из этого.

Деталь метода

getEntity

public abstract java.lang.Object getEntity()

Возвратите объект ответа. Ответ будет сериализирован, используя MessageBodyWriter или для class объекта или для, в случае GenericEntity, значение GenericEntity#getRawType().

Возвраты:

объектный экземпляр или нуль, если нет никакого объекта

См. Также:

MessageBodyWriter

getStatus

public abstract int getStatus()

Свяжите код состояния с ответом.

Возвраты:

код состояния ответа или-1, если состояние не было установлено.

getMetadata

public abstract MultivaluedMap<java.lang.String,java.lang.Object> getMetadata()

Свяжите метаданные с ответом как карта. Возвращенная карта может быть впоследствии изменена временем выполнения JAX-РТС. Значения будут сериализированы, используя a RuntimeDelegate.HeaderDelegate если Вы доступны через RuntimeDelegate.createHeaderDelegate(java.lang.Class) для class значения или использования значений toString метод, если делегат заголовка не доступен.

Возвраты:

метаданные ответа как карта

fromResponse

public static Response.ResponseBuilder fromResponse(Response response)

Создайте новый ResponseBuilder, выполняя мелкую копию существующего Ответа. У возвращенного разработчика есть его собственная карта метаданных, но записи являются просто ссылками на ключи и значения, содержавшиеся в предоставленной карте метаданных Ответа.

Параметры:

response - Ответ, с которого будут скопированы код состояния, объект и метаданные

Возвраты:

новый ReponseBuilder

состояние

public static Response.ResponseBuilder status(Response.StatusType status)

Создайте новый ResponseBuilder с предоставленным состоянием.

Параметры:

status - состояние ответа

Возвраты:

новый ResponseBuilder

Броски:

IllegalArgumentException - если состояние является нулем

состояние

public static Response.ResponseBuilder status(Response.Status status)

Создайте новый ResponseBuilder с предоставленным состоянием.

Параметры:

status - состояние ответа

Возвраты:

новый ResponseBuilder

Броски:

IllegalArgumentException - если состояние является нулем

состояние

public static Response.ResponseBuilder status(int status)

Создайте новый ResponseBuilder с предоставленным состоянием.

Параметры:

status - состояние ответа

Возвраты:

новый ResponseBuilder

Броски:

IllegalArgumentException - если состояние - меньше чем 100 или больше чем 599.

хорошо

public static Response.ResponseBuilder ok()

Создайте новый ResponseBuilder с состоянием OK.

Возвраты:

новый ResponseBuilder

хорошо

public static Response.ResponseBuilder ok(java.lang.Object entity)

Создайте новый ResponseBuilder, который содержит представление. Это - обязанность за вызывающие стороны обернуть фактический объект с GenericEntity если сохранение его универсального типа требуется.

Параметры:

entity - данные объекта представления

Возвраты:

новый ResponseBuilder

хорошо

public static Response.ResponseBuilder ok(java.lang.Object entity,
                                          MediaType type)

Создайте новый ResponseBuilder, который содержит представление. Это - обязанность за вызывающие стороны обернуть фактический объект с GenericEntity если сохранение его универсального типа требуется.

Параметры:

entity - данные объекта представления

type - тип носителей объекта

Возвраты:

новый ResponseBuilder

хорошо

public static Response.ResponseBuilder ok(java.lang.Object entity,
                                          java.lang.String type)

Создайте новый ResponseBuilder, который содержит представление. Это - обязанность за вызывающие стороны обернуть фактический объект с GenericEntity если сохранение его универсального типа требуется.

Параметры:

entity - данные объекта представления

type - тип носителей объекта

Возвраты:

новый ResponseBuilder

хорошо

public static Response.ResponseBuilder ok(java.lang.Object entity,
                                          Variant variant)

Создайте новый ResponseBuilder, который содержит представление. Это - обязанность за вызывающие стороны обернуть фактический объект с GenericEntity если сохранение его универсального типа требуется.

Параметры:

entity - данные объекта представления

variant - метаданные представления

Возвраты:

новый ResponseBuilder

serverError

public static Response.ResponseBuilder serverError()

Создайте новый ResponseBuilder с ошибочным состоянием сервера.

Возвраты:

новый ResponseBuilder

создаваемый

public static Response.ResponseBuilder created(java.net.URI location)

Создайте новый ResponseBuilder для создаваемого ресурса, установите заголовок расположения, используя предоставленное значение.

Параметры:

location - URI нового ресурса. Если относительный URI будет предоставлен, то он будет преобразован в абсолютный URI, разрешая это относительно URI запроса (см. UriInfo#getRequestUri).

Возвраты:

новый ResponseBuilder

Броски:

java.lang.IllegalArgumentException - если расположение является нулем

noContent

public static Response.ResponseBuilder noContent()

Создайте новый ResponseBuilder для пустого ответа.

Возвраты:

новый ResponseBuilder

notModified

public static Response.ResponseBuilder notModified()

Создайте новый ResponseBuilder с не - измененное состояние.

Возвраты:

новый ResponseBuilder

notModified

public static Response.ResponseBuilder notModified(EntityTag tag)

Создайте новый ResponseBuilder с не - измененное состояние.

Параметры:

tag - тег для неизмененного объекта

Возвраты:

новый ResponseBuilder

Броски:

java.lang.IllegalArgumentException - если тег является нулем

notModified

public static Response.ResponseBuilder notModified(java.lang.String tag)

Создайте новый ResponseBuilder с не - измененное состояние и тег объекта strong. Это - ярлык для notModified(new EntityTag(value)).

Параметры:

tag - строковый контент тега объекта strong. Время выполнения JAX-РТС заключит предоставленное значение в кавычки, создавая заголовок.

Возвраты:

новый ResponseBuilder

Броски:

java.lang.IllegalArgumentException - если тег является нулем

seeOther

public static Response.ResponseBuilder seeOther(java.net.URI location)

Создайте новый ResponseBuilder для перенаправления. Используемый в перенаправлении после POST (иначе POST/перенаправление/ПОЛУЧАТЬ) образец.

Параметры:

location - URI перенаправления. Если относительный URI будет предоставлен, то он будет преобразован в абсолютный URI, разрешая это относительно основного URI приложения (см. UriInfo#getBaseUri).

Возвраты:

новый ResponseBuilder

Броски:

java.lang.IllegalArgumentException - если расположение является нулем

temporaryRedirect

public static Response.ResponseBuilder temporaryRedirect(java.net.URI location)

Создайте новый ResponseBuilder для временного перенаправления.

Параметры:

location - URI перенаправления. Если относительный URI будет предоставлен, то он будет преобразован в абсолютный URI, разрешая это относительно основного URI приложения (см. UriInfo#getBaseUri).

Возвраты:

новый ResponseBuilder

Броски:

java.lang.IllegalArgumentException - если расположение является нулем

notAcceptable

public static Response.ResponseBuilder notAcceptable(java.util.List<Variant> variants)

Создайте новый ResponseBuilder для не приемлемого ответа.

Параметры:

variants - список разновидностей, которые были доступны, нулевое значение, эквивалентен пустому списку.

Возвраты:

новый ResponseBuilder