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

javax.ws.rs
Путь Типа аннотации

@Target(value={TYPE,METHOD})
@Retention(value=RUNTIME)
public @interface Path

Идентифицирует путь URI, на который метод class ИЛИ class ресурса будет служить запросам.

Пути относительны. Для аннотируемого class основной URI является путем приложения, см. ApplicationPath. Для аннотируемого метода основной URI является эффективным URI содержания class. В целях абсолютизировать путь против основного URI, игнорируется продвижение '/' в пути, и основные URI обрабатываются, как будто они закончили в '/'. Например:

@Path("widgets")
public class WidgetsResource {
  @GET
  String getList() {...}
 
  @GET @Path("{id}")
  String getWidget(@PathParam("id") String id) {...}
}

В вышеупомянутом, если путь приложения catalogue и приложение развертывается в http://example.com/, тогда GET запросы на http://example.com/catalogue/widgets будет обработан getList метод, в то время как запросы на http://example.com/catalogue/widgets/nnn (где nnn некоторое значение), будет обработан getWidget метод. То же самое применялось бы если значение также @Path аннотация, запущенная с '/'.

Классы и методы могут также быть аннотированы Consumes и Produces чтобы фильтровать запросы, они получат.

См. Также:

Consumes, Produces, PathParam

Необходимая Сводка Элемента

java.lang.String

значение Определяет шаблон URI для ресурса class или метод, не должен включать параметры матрицы.

Деталь элемента

значение

public abstract java.lang.String value

Определяет шаблон URI для ресурса class или метод, не должен включать параметры матрицы.

Встроенные шаблонные параметры позволяются и имеют форму:

 param = "{" *WSP name *WSP [ ":" *WSP regex *WSP ] "}"
 name = (ALPHA / DIGIT / "_")*(ALPHA / DIGIT / "." / "_" / "-" ) ; \w[\w\.-]*
 regex = *( nonbrace / "{" *nonbrace "}" ) ; where nonbrace is any char other than "{" and "}"

См. RFC 5234 для описания синтаксиса, используемого выше и расширения WSP, ALPHA и DIGIT. В вышеупомянутом name шаблонное название параметра и дополнительное regex определяет содержание группы фиксации для параметра. Если regex не предоставляется тогда значение по умолчанию [^/]+ то, который завершается на границе сегмента пути, используется. Соответствие URI запроса к шаблонам URI выполняется против закодированных значений пути, и реализации не будут выходить из литеральных символов в regex автоматически, поэтому любые литералы в regex должен быть оставлен автором согласно правилам раздела RFC 3986 3.3. Предостережение рекомендуется в использовании regex, неправильное использование может привести к шаблонному параметру, соответствующему неожиданные пути URI. См. Образец для дополнительной информации о синтаксисе регулярных выражений. Значения шаблонных параметров могут быть извлечены, используя PathParam.

Литеральная часть предоставленного значения (те символы, которые не являются частью шаблонного параметра) является автоматически процентом, закодированным, чтобы соответствовать path производство раздела RFC 3986 3.3. Отметьте, что процент, который закодированные значения позволяются в литеральной части значения, реализация, распознает такие значения и не будет удваиваться, кодируют символ '%'.