T.M. SoftStudio

feci quod potui, faciant meliora potentes

JAX-RS API

Пакет javax.ws.rs.core

Аннотация @Context позволяет, дополнительно к аннотациям @HeaderParam, @CookieParam, @MatrixParam, @QueryParam, @FormParam или @PathParam пакета javax.ws.rs, вводить информацию контекста клиентского запроса или самого JAX-RS-приложения. Аннотация @Context дает возможность вводить такие объекты как Application, UriInfo, Request, HttpHeaders, SecurityContext, Providers, ServletConfig, ServletContext, HttpServletRequest и HttpServletResponse.

Объект HttpHeaders, введенный с помощью аннотации @Context, реализует интерфейс HttpHeaders, обеспечивающий информацию о HTTP-заголовках запроса. Интерфейс HttpHeaders имеет следующие поля:

  • static final java.lang.String ACCEPT — заголовок Accept указывает MIME-типы, допустимые для ответного сообщения;

  • static final java.lang.String ACCEPT_CHARSET — заголовок Accept-Charset указывает допустимую символьную кодировку для ответного сообщения;

  • static final java.lang.String ACCEPT_ENCODING — заголовок Accept-Encoding указывает допустимый стиль кодирования содержимого ответа;

  • static final java.lang.String ACCEPT_LANGUAGE — заголовок Accept-Language указывает допустимые языки ответа;

  • static final java.lang.String AUTHORIZATION — заголовок Authorization содержит аутентификационную информацию клиента;

  • static final java.lang.String CACHE_CONTROL — заголовок Cache-Control содержит директивы относительно кэширования;

  • static final java.lang.String CONTENT_ENCODING — заголовок Content-Encoding указывает стиль кодирования содержимого запроса;

  • static final java.lang.String CONTENT_LANGUAGE — заголовок Content-Language указывает локализацию запроса;

  • static final java.lang.String CONTENT_LENGTH — заголовок Content-Length указывает размер содержимого запроса;

  • static final java.lang.String CONTENT_LOCATION — заголовок Content-Location содержит ссылку на ресурс в запросе;

  • static final java.lang.String CONTENT_TYPE — заголовок Content-Type указывает MIME-тип запроса;

  • static final java.lang.String DATE — заголовок Date указывает дату и время запроса;

  • static final java.lang.String ETAG — заголовок Etag указывает идентификатор ресурса для кэширования ответа;

  • static final java.lang.String EXPIRES — заголовок Expires указывает время действия ответа при кэшировании;

  • static final java.lang.String HOST — заголовок Host указывает хост и порт запрашиваемого ресурса;

  • static final java.lang.String IF_MATCH — заголовок If-Match содержит идентификатор кэшированного ресурса для указания того, что метод PUT не может быть применен к ресурсу, если его кэш уже не является его представлением;

  • static final java.lang.String IF_MODIFIED_SINCE — заголовок If-Modified-Since указывает время, начиная с которого запрашиваемый ресурс не модифицировался; если ресурс модифицировался, тогда ответ содержит новое представление ресурса;

  • static final java.lang.String IF_NONE_MATCH — заголовок If-None-Match содержит идентификатор кэшированного ресурса для его сравнения с идентификатором текущей версии ресурса; если идентификаторы не совпадают, тогда ответ содержит новое представление ресурса;

  • static final java.lang.String IF_UNMODIFIED_SINCE — заголовок If-Unmodified-Since указывает время, начиная с которого запрашиваемый ресурс не модифицировался; если ресурс не модифицировался, тогда посылается ответ;

  • static final java.lang.String LAST_MODIFIED — заголовок Last-Modified указывает время последней модификации ресурса;

  • static final java.lang.String LOCATION — заголовок Location содержит адрес для перенаправления запроса;

  • static final java.lang.String USER_AGENT — заголовок User-Agent содержит идентификатор клиентского приложения;

  • static final java.lang.String VARY — заголовок Vary указывает кэшу названия заголовков запроса, при изменении которых ответ может содержать другое представление ресурса;

  • static final java.lang.String WWW_AUTHENTICATE — заголовок WWW-Authenticate указывает требуемую схему аутентификации для доступа к ресурсу;

  • static final java.lang.String COOKIE — заголовок Cookie содержит cookie запроса;

  • static final java.lang.String SET_COOKIE — заголовок Set-Cookie устанавливает cookie.

Далее перечислены методы интерфейса HttpHeaders, обеспечивающие HTTP-заголовки запроса и ответа.

  • java.util.List<java.lang.String> getRequestHeader(java.lang.String name)

Возвращает заголовок запроса по его имени.

  • MultivaluedMap<java.lang.String,java.lang.String> getRequestHeaders()

Возвращает заголовки запроса как объект javax.ws.rs.core.MultivaluedMap<K,V>, расширяющий интерфейс java.util.Map<K,java.util.List<V>> методами void putSingle(K key, V value), void add(K key, V value), V getFirst(K key).

  • java.util.List<MediaType> getAcceptableMediaTypes()

Возвращает список MIME-типов, допустимых для ответа.

  • java.util.List<java.util.Locale> getAcceptableLanguages()

Возвращает список языков, допустимых для ответа.

  • MediaType getMediaType()

Возвращает MIME-тип запроса в виде объекта javax.ws.rs.core.MediaType.

  • java.util.Locale getLanguage()

Возвращает язык запроса.

  • java.util.Map<java.lang.String,Cookie> getCookies()

Возвращает cookies запроса.

Класс MediaType представляет MIME-тип и имеет следующие поля:

  • public static final java.lang.String MEDIA_TYPE_WILDCARD — MIME-тип *;

  • public static final java.lang.String WILDCARD, public static final MediaType WILDCARD_TYPE — MIME-тип */*;

  • public static final java.lang.String APPLICATION_XML, public static final MediaType APPLICATION_XML_TYPE — MIME-тип application/xml;

  • public static final java.lang.String APPLICATION_ATOM_XML, public static final MediaType APPLICATION_ATOM_XML_TYPE — MIME-тип application/atom+xml;

  • public static final java.lang.String APPLICATION_XHTML_XML, public static final MediaType APPLICATION_XHTML_XML_TYPE — MIME-тип application/xhtml+xml;

  • public static final java.lang.String APPLICATION_SVG_XML, public static final MediaType APPLICATION_SVG_XML_TYPE — MIME-тип application/svg+xml;

  • public static final java.lang.String APPLICATION_JSON, public static final MediaType APPLICATION_JSON_TYPE — MIME-тип application/json;

  • public static final java.lang.String APPLICATION_FORM_URLENCODED, public static final MediaType APPLICATION_FORM_URLENCODED_TYPE — MIME-тип application/x-www-form-urlencoded;

  • public static final java.lang.String MULTIPART_FORM_DATA, public static final MediaType MULTIPART_FORM_DATA_TYPE — MIME-тип multipart/form-data;

  • public static final java.lang.String APPLICATION_OCTET_STREAM, public static final MediaType APPLICATION_OCTET_STREAM_TYPE — MIME-тип application/octet-stream;

  • public static final java.lang.String TEXT_PLAIN, public static final MediaType TEXT_PLAIN_TYPE — MIME-тип text/plain;

  • public static final java.lang.String TEXT_XML, public static final MediaType TEXT_XML_TYPE — MIME-тип text/xml;

  • public static final java.lang.String TEXT_HTML, public static final MediaType TEXT_HTML_TYPE — MIME-тип text/html.

Далее приведены конструкторы и методы класса MediaType.

  • public MediaType(java.lang.String type, java.lang.String subtype,
    java.util.Map<java.lang.String,java.lang.String> parameters)

public MediaType(java.lang.String type, java.lang.String subtype)

public MediaType()

Создают объект MediaType.

  • public static MediaType valueOf(java.lang.String type)

Создает объект MediaType из MIME-типа.

  • public java.lang.String getType()

Возвращает MIME-тип.

  • public boolean isWildcardType()

Если true, тогда MIME-тип *.

  • public java.lang.String getSubtype()

Возвращает подтип.

  • public boolean isWildcardSubtype()

Если true, тогда подтип *.

  • public java.util.Map<java.lang.String,java.lang.String> getParameters()

Возвращает параметры MIME-типа.

  • public boolean isCompatible(MediaType other)

Возвращает true, если данный MIME-тип совместим с указанным.

  • public boolean equals(java.lang.Object obj)

Возвращает true, если два MIME-типа одинаковы.

  • public int hashCode()

Генерирует хэш из MIME-типа.

  • public java.lang.String toString()

Конвертирует MIME-тип в строку для HTTP-заголовка.

Класс Application обеспечивает развертывание JAX-RS приложения с помощью своего класса реализации. Класс, расширяющий класс Application, переопределяет его методы, перечисленные далее.

  • public java.util.Set<java.lang.Class<?>> getClasses()

Возвращает набор классов, предназначенных для развертывания.

  • public java.util.Set<java.lang.Object> getSingletons()

Возвращает набор экземпляров классов для развертывания.

Метод getClasses() контролирует классы приложения, а метод getSingletons() дает возможность контролировать создание объектов при развертывании приложения.

Объект Request, введенный с помощью аннотации @Context, реализует интерфейс Request, помогающий обрабатывать запрос клиента. Интерфейс Request имеет перечисленные далее методы.

  • java.lang.String getMethod()

Возвращает HTTP-метод запроса.

  • Variant selectVariant(java.util.List<Variant> variants)

Возвращает объект javax.ws.rs.core.Variant, как наиболее подходящий вариант представления ресурса для запроса. Наиболее подходящий вариант представления ресурса выбирается из списка вариантов, который создается с помощью класса javax.ws.rs.core.Variant.VariantListBuilder, имеющего следующие методы:

    – public static Variant.VariantListBuilder newInstance() — создает объект Variant.VariantListBuilder;

    – public abstract Variant.VariantListBuilder languages(java.util.Locale... languages) — устанавливает допустимые языки для представлений ресурса;

    – public abstract Variant.VariantListBuilder encodings(java.lang.String... encodings) — устанавливает допустимые стили кодирования для представлений ресурса;

    – public abstract Variant.VariantListBuilder mediaTypes(MediaType... mediaTypes) — устанавливает допустимые MIME-типы для представлений ресурса;

    – public abstract java.util.List<Variant> build() — создает набор вариантов после установки языков, стилей кодирования и MIME-типов;

    – public abstract Variant.VariantListBuilder add() — позволяет разграничить и дифференцировать создаваемые наборы вариантов, например, Variant.VariantBuilder.newInstance. languages().encodings().mediaTypes().add().languages().encodings().mediaTypes().build().

  • Response.ResponseBuilder evaluatePreconditions(EntityTag eTag)

Response.ResponseBuilder evaluatePreconditions(java.util.Date
lastModified)

Response.ResponseBuilder evaluatePreconditions(java.util.Date
lastModified, EntityTag eTag)

Сравнивают ETag текущего состояния ресурса и дату его модификации с заголовком If-Modified-Since или/и If-None-Match запроса и при совпадении возвращают null. Если же условия не совпадают, тогда возвращается объект javax.ws.rs.core.Response.ResponseBuilder с новыми заголовками ETag или/и Last-Modified.

  • Response.ResponseBuilder evaluatePreconditions()

Обеспечивает проверку заголовков запроса If-Match: * и If-None-Match: *.

Класс Variant, представляющий вариант представления ресурса, имеет следующие конструкторы и методы.

  • public Variant(MediaType mediaType, java.util.Locale language,
    java.lang.String encoding)

Создает объект Variant.

  • public java.util.Locale getLanguage()

Возвращает язык варианта.

  • public MediaType getMediaType()

Возвращает MIME-тип варианта.

  • public java.lang.String getEncoding()

Возвращает стили кодирования варианта.

  • public static Variant.VariantListBuilder mediaTypes(MediaType...
    mediaTypes)

public static Variant.VariantListBuilder languages(java.util.Locale...
languages)

public static Variant.VariantListBuilder encodings(java.lang.String...
encodings)

Создают объекты Variant.VariantListBuilder, обеспечивающие создание списка вариантов.

  • public int hashCode()

Создает хэш варианта.

  • public boolean equals(java.lang.Object obj)

Сравнивает два варианта.

  • public java.lang.String toString()

Конвертирует вариант в строку.

Класс EntityTag представляет HTTP-заголовок ETag и имеет следующие конструкторы и методы.

  • public EntityTag(java.lang.String valueofETag)

public EntityTag(java.lang.String valueofETag, boolean weak)

Создают объект EntityTag, при этом если weak равно false, тогда текущие версии ресурса должны быть идентичны byte-for-byte.

  • public static EntityTag valueOf(java.lang.String valueofETag)

Создает объект EntityTag из строки.

  • public boolean isWeak()

Если true, тогда используется WETag.

  • public java.lang.String getValue()

Возвращает значение заголовка ETag.

  • public boolean equals(java.lang.Object obj)

Сравнивает два заголовка ETag.

  • public int hashCode()

Создает хэш заголовка.

  • public java.lang.String toString()

Конвертирует заголовок в строку.

Объект SecurityContext, введенный с помощью аннотации @Context реализует интерфейс SecurityContext, обеспечивающий аутентификационную информацию запроса. Интерфейс SecurityContext имеет следующие поля и методы:

  • static final java.lang.String BASIC_AUTH — базовая аутентификация клиента с помощью логина/пароля;

  • static final java.lang.String CLIENT_CERT_AUTH — аутентификация с помощью сертификата;

  • static final java.lang.String DIGEST_AUTH — аутентификация с помощью зашифрованного пароля;

  • static final java.lang.String FORM_AUTH — аутентификация с помощью пользовательского интерфейса;

  • java.security.Principal getUserPrincipal() — возвращает имя клиента;

  • boolean isUserInRole(java.lang.String role) — возвращает true, если клиент соответствует роли;

  • boolean isSecure() — возвращает true, если запрос сделан по HTTPS-каналу;

  • java.lang.String getAuthenticationScheme() — возвращает тип аутентификации клиента BASIC_AUTH, FORM_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH.

Объект UriInfo, введенный с помощью аннотации @Context, реализует интерфейс UriInfo, обеспечивающий информацию о URI запроса. Интерфейс UriInfo имеет следующие методы.

  • java.lang.String getPath()

java.lang.String getPath(boolean decode)

Возвращают URI-путь запроса относительно базового URI. Если значение decode равно false, тогда строка URI не декодируется.

  • java.util.List<PathSegment> getPathSegments()

java.util.List<PathSegment> getPathSegments(boolean decode)

Возвращают URI-путь запроса относительно базового URI в виде списка объектов javax.ws.rs.core.PathSegment, представляющих сегменты URI-пути и связанных с ними параметров. Интерфейс PathSegment имеет методы java.lang.String getPath() и MultivaluedMap<java.lang.String,java.lang.String> getMatrixParameters().

  • java.net.URI getRequestUri()

Возвращает абсолютный URI-путь запроса.

  • UriBuilder getRequestUriBuilder()

Возвращает абсолютный URI-путь запроса в виде объекта javax.ws.rs.core.UriBuilder.

  • java.net.URI getAbsolutePath()

Возвращает абсолютный URI-путь запроса без параметров.

  • UriBuilder getAbsolutePathBuilder()

Возвращает абсолютный URI-путь запроса без параметров в виде объекта javax.ws.rs.core.UriBuilder.

  • java.net.URI getBaseUri()

Возвращает базовый URI-путь приложения.

  • UriBuilder getBaseUriBuilder()

Возвращает базовый URI-путь приложения в виде объекта javax.ws.rs.core.UriBuilder.

  • MultivaluedMap<java.lang.String,java.lang.String> getPathParameters()

MultivaluedMap<java.lang.String,java.lang.String>
getPathParameters(boolean decode)

MultivaluedMap<java.lang.String,java.lang.String> getQueryParameters()

MultivaluedMap<java.lang.String,java.lang.String>
getQueryParameters(boolean decode)

Возвращают набор параметров запроса.

  • java.util.List<java.lang.String> getMatchedURIs()

java.util.List<java.lang.String> getMatchedURIs(boolean decode)

Возвращают список относительных путей ресурсов приложения.

  • java.util.List<java.lang.Object> getMatchedResources()

Возвращает список ресурсов.

Класс UriBuilder позволяет создавать URI с помощью следующих методов.

  • public static UriBuilder fromUri(java.net.URI uri)

public static UriBuilder fromUri(java.lang.String uri)

public static UriBuilder fromPath(java.lang.String path)

public static UriBuilder fromResource(java.lang.Class<?> resource)

Создают объекты UriBuilder из адреса, пути и ресурса.

  • public abstract UriBuilder clone()

Создает копию объекта UriBuilder.

  • public abstract UriBuilder uri(java.net.URI uri)

Изменяет объект UriBuilder.

  • public abstract UriBuilder scheme(java.lang.String scheme)

Устанавливает URI-схему, например, http, file или др.

  • public abstract UriBuilder schemeSpecificPart(java.lang.String ssp)

Устанавливает часть URI, следующую за URI-схемой.

  • public abstract UriBuilder userInfo(java.lang.String ui)

Устанавливает часть URI, содержащую информацию о клиенте.

  • public abstract UriBuilder host(java.lang.String host)

Устанавливает URI-хост.

  • public abstract UriBuilder port(int port)

Устанавливает URI-порт.

  • public abstract UriBuilder replacePath(java.lang.String path)

Устанавливает URI-путь.

  • public abstract UriBuilder path(java.lang.String path)

public abstract UriBuilder path(java.lang.Class resource)

public abstract UriBuilder path(java.lang.Class resource,
java.lang.String method)

public abstract UriBuilder path(java.lang.reflect.Method method)

Добавляют путь, определенный аннотацией @Path, к существующему.

  • public abstract UriBuilder segment(java.lang.String... segments)

Добавляет сегмент к пути.

  • public abstract UriBuilder replaceMatrix(java.lang.String matrix)

Устанавливает matrix-параметры.

  • public abstract UriBuilder matrixParam(java.lang.String name,
    java.lang.Object... values)

Добавляет matrix-параметры к существующим.

  • public abstract UriBuilder replaceMatrixParam(java.lang.String name,
    java.lang.Object... values)

Заменяет значения существующих matrix-параметров.

  • public abstract UriBuilder replaceQuery(java.lang.String query)

Устанавливает query-параметры.

  • public abstract UriBuilder queryParam(java.lang.String name,
    java.lang.Object... values)

Добавляет query-параметры к существующим.

  • public abstract UriBuilder replaceQueryParam(java.lang.String name,
    java.lang.Object... values)

Заменяет значения существующих query-параметров.

  • public abstract UriBuilder fragment(java.lang.String fragment)

Устанавливает URI-фрагмент.

  • public abstract java.net.URI buildFromMap
    (java.util.Map<java.lang.String,? extends java.lang.Object> values)

public abstract java.net.URI buildFromEncodedMap
(java.util.Map<java.lang.String,? extends java.lang.Object> values)

public abstract java.net.URI build(java.lang.Object... values)

public abstract java.net.URI buildFromEncoded
(java.lang.Object... values)

Создают URI с параметрами.

Класс Response представляет ответ, возвращаемый методом ресурса, и имеет следующие методы.

  • public abstract java.lang.Object getEntity()

Возвращает тело ответа.

  • public abstract int getStatus()

Возвращает HTTP-код ответа.

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

Возвращает HTTP-заголовки, добавляемые к телу ответа.

  • public static Response.ResponseBuilder fromResponse(Response response)

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

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

public static Response.ResponseBuilder status(int status)

public static Response.ResponseBuilder ok()

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

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

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

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

public static Response.ResponseBuilder serverError()

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

public static Response.ResponseBuilder noContent()

public static Response.ResponseBuilder notModified()

public static Response.ResponseBuilder notModified(EntityTag tag)

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

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

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

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

Создают новый объект Response.ResponseBuilder из копии ответа, с различным HTTP-кодом, MIME-типом и вариантами представления, с телом ответа и URI ресурса, а также для пустого ответа.

Класс Response.ResponseBuilder позволяет создавать объекты Response, содержащие различные метаданные, которые добавляются к телу ответа, и имеет следующие методы.

  • public abstract Response build()

Создает новый объект Response.

  • public abstract Response.ResponseBuilder clone()

Создает копию объекта Response.ResponseBuilder.

  • public abstract Response.ResponseBuilder status(int status)

public Response.ResponseBuilder status(Response.StatusType status)

public Response.ResponseBuilder status(Response.Status status)

Устанавливают HTTP-код ответа.

  • public abstract Response.ResponseBuilder entity(java.lang.Object entity)

Устанавливает тело ответа.

  • public abstract Response.ResponseBuilder type(MediaType type)

public abstract Response.ResponseBuilder type(java.lang.String type)

Устанавливают MIME-тип ответа.

  • public abstract Response.ResponseBuilder variant(Variant variant)

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

Устанавливают варианты представления.

  • public abstract Response.ResponseBuilder language(java.lang.String
    language)

public abstract Response.ResponseBuilder language(java.util.Locale
language)

Устанавливают язык ответа.

  • public abstract Response.ResponseBuilder location(java.net.URI location)

public abstract Response.ResponseBuilder contentLocation(java.net.URI
location)

Устанавливают URI ответа.

  • public abstract Response.ResponseBuilder tag(EntityTag tag)

public abstract Response.ResponseBuilder tag(java.lang.String tag)

Устанавливают заголовок ETag ответа.

  • public abstract Response.ResponseBuilder lastModified(java.util.Date
    lastModified)

Устанавливает заголовок Last-Modified ответа.

  • public abstract Response.ResponseBuilder cacheControl(CacheControl
    cacheControl)

Устанавливает заголовок Cache-Control ответа.

  • public abstract Response.ResponseBuilder expires(java.util.Date expires)

Устанавливает заголовок Expires ответа.

  • public abstract Response.ResponseBuilder header(java.lang.String name,
    java.lang.Object value)

Устанавливает заголовки ответа.

  • public abstract Response.ResponseBuilder cookie(NewCookie... cookies)

Устанавливает cookies ответа.

Реализация интерфейса Response.StatusType позволяет расширить стандартные HTTP-коды статуса ответа. Интерфейс Response.StatusType обеспечивает информацию о статусе ответа с помощью перечисленных далее методов.

  • int getStatusCode()

Возвращает код статуса.

  • java.lang.String getReasonPhrase()

Возвращает описание статуса.

  • Response.Status.Family getFamily()

Возвращает объект перечисления javax.ws.rs.core.Response.Status.Family кода статуса. Перечисление Response.Status.Family имеет константы INFORMATIONAL, SUCCESSFUL, REDIRECTION, CLIENT_ERROR, SERVER_ERROR, OTHER.

Перечисление Response.Status HTTP-кодов имеет следующие константы:

  • OK — 200 OK;

  • CREATED — 201 Created;

  • ACCEPTED — 202 Accepted;

  • NO_CONTENT — 204 No Content;

  • MOVED_PERMANENTLY — 301 Moved Permanently;

  • SEE_OTHER — 303 See Other;

  • NOT_MODIFIED — 304 Not Modified;

  • TEMPORARY_REDIRECT — 307 Temporary Redirect;

  • BAD_REQUEST — 400 Bad Request;

  • UNAUTHORIZED — 401 Unauthorized;

  • FORBIDDEN — 403 Forbidden;

  • NOT_FOUND — 404 Not Found;

  • NOT_ACCEPTABLE — 406 Not Acceptable;

  • CONFLICT — 409 Conflict;

  • GONE — 410 Gone;

  • PRECONDITION_FAILED — 412 Precondition Failed;

  • UNSUPPORTED_MEDIA_TYPE — 415 Unsupported Media Type;

  • INTERNAL_SERVER_ERROR — 500 Internal Server Error;

  • SERVICE_UNAVAILABLE — 503 Service Unavailable.

Класс GenericEntity<T> представляет тело ответа общего Java-типа и имеет следующие конструкторы и методы.

  • public GenericEntity(T entity, java.lang.reflect.Type genericType)

Создает новый объект GenericEntity.

  • public final java.lang.Class<?> getRawType()

Возвращает Java-тип тела ответа.

  • public final java.lang.reflect.Type getType()

Возвращает общий Java-тип тела ответа.

  • public final T getEntity()

Возвращает тело ответа.

Метод ресурса может также возвращать объект, реализующий интерфейс StreamingOutput, который имеет метод void write(java.io.OutputStream output) для создания тела ответа.

Класс CacheControl обеспечивает HTTP-заголовок Cache-Control и имеет следующие конструкторы и методы.

  • public CacheControl()

Создает новый объект CacheControl.

  • public static CacheControl valueOf(java.lang.String value)

Создает новый объект CacheControl из строки.

  • public boolean isMustRevalidate()

Если true, тогда заголовок содержит директиву must-revalidate.

  • public void setMustRevalidate(boolean mustRevalidate)

Устанавливает для заголовка директиву must-revalidate.

  • public boolean isProxyRevalidate()

Если true, тогда заголовок содержит директиву proxy-revalidate.

  • public void setProxyRevalidate(boolean proxyRevalidate)

Устанавливает для заголовка директиву proxy-revalidate.

  • public int getMaxAge()

public void setMaxAge(int maxAge)

Первый метод возвращает, второй метод устанавливает директиву max-age.

  • public int getSMaxAge()

public void setSMaxAge(int sMaxAge)

Первый метод возвращает, второй метод устанавливает директиву s-maxage.

  • public java.util.List<java.lang.String> getNoCacheFields()

public void setNoCache(boolean noCache)

Первый метод возвращает, второй метод устанавливает директиву no-cache.

  • public boolean isNoCache()

Если true, тогда заголовок содержит директиву no-cache.

  • public boolean isPrivate()

Если true, тогда заголовок содержит директиву private.

  • public java.util.List<java.lang.String> getPrivateFields()

public void setPrivate(boolean _private)

Первый метод возвращает, второй метод устанавливает директиву private.

  • public boolean isNoTransform()

Если true, тогда заголовок содержит директиву no-transform.

  • public void setNoTransform(boolean noTransform)

Устанавливает директиву no-transform.

  • public boolean isNoStore()

Если true, тогда заголовок содержит директиву no-store.

  • public void setNoStore(boolean noStore)

Устанавливает директиву no-store.

  • public java.util.Map<java.lang.String, java.lang.String>
    getCacheExtension()

Возвращает расширения директив.

  • public java.lang.String toString()

Конвертирует объект в строку.

  • public int hashCode()

Создает хэш объекта.

  • public boolean equals(java.lang.Object obj)

Сравнивает два объекта.

Класс Cookie представляет HTTP-запроса cookie и имеет следующие поля, конструкторы и методы.

  • public static final int DEFAULT_VERSION — версия, по умолчанию 1 (RFC 2109).

  • public Cookie(java.lang.String name, java.lang.String value,
    java.lang.String path, java.lang.String domain, int version)

public Cookie(java.lang.String name, java.lang.String value,
java.lang.String path, java.lang.String domain)

public Cookie(java.lang.String name, java.lang.String value)

Создают новый объект Cookie.

  • public static Cookie valueOf(java.lang.String value)

Создает объект Cookie из строки.

  • public java.lang.String getName()

Возвращает имя cookie.

  • public java.lang.String getValue()

Возвращает значение cookie.

  • public int getVersion()

Возвращает версию cookie.

  • public java.lang.String getDomain()

Возвращает домен cookie.

  • public java.lang.String getPath()

Возвращает путь cookie.

  • public java.lang.String toString()

Конвертирует объект в строку.

  • public int hashCode()

Создает хэш объекта.

  • public boolean equals(java.lang.Object obj)

Сравнивает два объекта.

Класс NewCookie расширяет класс Cookie, представляет HTTP-ответа cookie и имеет дополнительно следующие поля, конструкторы и методы:

  • public static final int DEFAULT_MAX_AGE — время действия cookie.

  • public NewCookie(java.lang.String name, java.lang.String value)

public NewCookie(java.lang.String name, java.lang.String value,
java.lang.String path, java.lang.String domain,
java.lang.String comment, int maxAge, boolean secure)

public NewCookie(java.lang.String name, java.lang.String value,
java.lang.String path, java.lang.String domain, int version,
java.lang.String comment, int maxAge, boolean secure)

public NewCookie(Cookie cookie)

public NewCookie(Cookie cookie, java.lang.String comment, int maxAge,
boolean secure)

Создают новый объект NewCookie.

  • public static NewCookie valueOf(java.lang.String value)

Создает новый объект NewCookie из строки.

  • public java.lang.String getComment()

Возвращает комментарии cookie.

  • public int getMaxAge()

Возвращает время действия cookie.

  • public boolean isSecure()

Если true, тогда cookie должны передаваться по защищенному каналу.

  • public Cookie toCookie()

Конвертирует в объект Cookie для сравнения.

  • public java.lang.String toString()

Конвертирует объект в строку.

  • public int hashCode()

Создает хэш объекта.

  • public boolean equals(java.lang.Object obj)

Сравнивает два объекта.