T.M. SoftStudio

feci quod potui, faciant meliora potentes

JAX-RS API

Пакет javax.ws.rs

Аннотация @Path(value=[URI-шаблон]) определяет URI-шаблон, обеспечивающий запрос к классу RESTful Web-сервиса (классу ресурса) или методу класса ресурса.

Аннотация @ApplicationPath(value=[базовый URI-шаблон]) применяется к классу, расширяющему класс javax.ws.rs.core.Application, который обеспечивает развертывание JAX-RS-приложения на платформе Java EE. Аннотация @ApplicationPath указывает базовый URI-адрес для всех URI-адресов классов ресурсов JAX-RS-приложения.

Аннотации @GET, @PUT, @POST, @DELETE, @HEAD маркируют Java-методы класса ресурса, которые отвечают на соответствующие HTTP-методы запроса.

Аннотация @MatrixParam(value=[имя параметра matrix]) маркирует параметры метода класса ресурса или его поля/свойства и извлекает значение параметра matrix из строки URI-запроса.

Аннотация @QueryParam(value=[имя параметра query]) маркирует параметры метода класса ресурса или его поля/свойства и извлекает значение параметра query из строки URI-запроса.

Аннотация @PathParam(value=[имя параметра]) маркирует параметры метода класса ресурса или его поля/свойства и извлекает значение указанного параметра из строки URI-запроса.

Аннотация @CookieParam(value=[имя HTTP cookie]) маркирует параметры метода класса ресурса или его поля/свойства и извлекает значение HTTP cookie.

Аннотация @HeaderParam(value=[имя HTTP-заголовка]) маркирует параметры метода класса ресурса или его поля/свойства и извлекает значение указанного HTTP-заголовка.

Аннотация @FormParam(value=[имя параметра]) маркирует параметры метода класса ресурса или его поля/свойства и извлекает значение указанного параметра из тела URI-запроса.

Аннотация @DefaultValue(value=[значение по умолчанию]) используется вместе с аннотациями @PathParam, @QueryParam, @MatrixParam, @CookieParam, @FormParam и @HeaderParam и определяет значения по умолчанию для параметров запроса на случай, если они не определены в строке запроса.

Аннотация @Produces(value=[список MIME-типов]) ограничивает MIME-типы представления ресурса, отсылаемого отсылается клиенту в ответ на запрос, по умолчанию — любой тип.

Аннотация @Consumes(value=[список MIME-типов]) ограничивает MIME-типы представления ресурса, посылаемого клиентом вместе с запросом, по умолчанию — любой тип.

Аннотация @Encoded используется вместе с аннотациями @QueryParam, @MatrixParam, @PathParam, @FormParam и отключает автоматическое декодирование значений параметров запроса. При формировании клиентом строки запроса параметры запроса кодируются в соответствии с URL-кодировкой. При извлечении параметров из строки запроса JAX-RS-реализация автоматически их декодирует. Если же есть необходимость работать с кодированными значениями параметров, тогда используется аннотация @Encoded.

Аннотация @HttpMethod(value=[имя HTTP-метода]) позволяет создавать новые аннотации типа @GET, @POST, @PUT, @DELETE и @HEAD, связывая определенный HTTP-метод с аннотацией.

Аннотация @OPTIONS маркирует Java-метод класса ресурса, который отвечает на HTTP-метод OPTIONS запроса, предоставляя информацию об опциях соединения.

Класс WebApplicationException представляет исключение, автоматически конвертируемое JAX-RS-реализацией в HTTP-ответ клиенту. Класс WebApplicationException имеет следующие конструкторы:

public WebApplicationException()

public WebApplicationException(javax.ws.rs.core.Response response)

public WebApplicationException(int HTTP-status)

public WebApplicationException(javax.ws.rs.core.Response.Status status)

public WebApplicationException(java.lang.Throwable cause)

public WebApplicationException(java.lang.Throwable cause,
javax.ws.rs.core.Response response)

public WebApplicationException(java.lang.Throwable cause, int HTTP-status)

public WebApplicationException(java.lang.Throwable cause,
javax.ws.rs.core.Response.Status status)