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

javax.ws.rs.core
Интерфейс UriInfo

public interface UriInfo

Вводимый интерфейс, который обеспечивает доступ к приложению и информации о URI запроса. Относительные URI относительно основного URI приложения, видят getBaseUri().

Весь бросок методов java.lang.IllegalStateException если вызвано вне контекста запроса (например, от конструктора провайдера).

См. Также:

Context

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

java.net.URI	getAbsolutePath() Получите абсолютный путь запроса.
UriBuilder	getAbsolutePathBuilder() Получите абсолютный путь запроса в форме UriBuilder.
java.net.URI	getBaseUri() Получите основной URI приложения.
UriBuilder	getBaseUriBuilder() Получите основной URI приложения в форме UriBuilder.
java.util.List<java.lang.Object>	getMatchedResources() Получите список только для чтения в настоящий момент соответствующего ресурса экземпляры class.
java.util.List<java.lang.String>	getMatchedURIs() Получите список только для чтения URI для соответствующих ресурсов.
java.util.List<java.lang.String>	getMatchedURIs(boolean decode) Получите список только для чтения URI для соответствующих ресурсов.
java.lang.String	getPath() Получите путь текущего запроса относительно основного URI как строка.
java.lang.String	getPath(boolean decode) Получите путь текущего запроса относительно основного URI как строка.
MultivaluedMap<java.lang.String,java.lang.String>	getPathParameters() Получите значения любых встроенных шаблонных параметров URI.
MultivaluedMap<java.lang.String,java.lang.String>	getPathParameters(boolean decode) Получите значения любых встроенных шаблонных параметров URI.
java.util.List<PathSegment>	getPathSegments() Получите путь текущего запроса относительно основного URI как список PathSegment.
java.util.List<PathSegment>	getPathSegments(boolean decode) Получите путь текущего запроса относительно основного URI как список PathSegment.
MultivaluedMap<java.lang.String,java.lang.String>	getQueryParameters() Получите параметры запроса URI текущего запроса.
MultivaluedMap<java.lang.String,java.lang.String>	getQueryParameters(boolean decode) Получите параметры запроса URI текущего запроса.
java.net.URI	getRequestUri() Получите абсолютный URI запроса включая любые параметры запроса.
UriBuilder	getRequestUriBuilder() Получите абсолютный URI запроса в форме UriBuilder.

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

getPath

java.lang.String getPath()

Получите путь текущего запроса относительно основного URI как строка. Все последовательности оставленных октетов декодируются, эквивалентны getPath(true).

Возвраты:

относительный путь URI

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

getPath

java.lang.String getPath(boolean decode)

Получите путь текущего запроса относительно основного URI как строка.

Параметры:

decode - средства управления, декодируются ли последовательности оставленных октетов (истина) или не (ложь).

Возвраты:

относительный путь URI

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

getPathSegments

java.util.List<PathSegment> getPathSegments()

Получите путь текущего запроса относительно основного URI как список PathSegment. Этот метод полезен, когда путь должен быть проанализирован, особенно когда параметры матрицы могут присутствовать в пути. Все последовательности оставленных октетов в сегментах пути и значениях параметра матрицы декодируются, эквивалентны getPathSegments(true).

Возвраты:

неподдающийся изменению список PathSegment. Карта параметра матрицы каждого сегмента пути является также неподдающейся изменению.

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

См. Также:

PathSegment, Матричные URI

getPathSegments

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

Получите путь текущего запроса относительно основного URI как список PathSegment. Этот метод полезен, когда путь должен быть проанализирован, особенно когда параметры матрицы могут присутствовать в пути.

Параметры:

decode - средства управления, декодируются ли последовательности оставленных октетов в сегментах пути и значениях параметра матрицы (истина) или не (ложь).

Возвраты:

неподдающийся изменению список PathSegment. Карта параметра матрицы каждого сегмента пути является также неподдающейся изменению.

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

См. Также:

PathSegment, Матричные URI

getRequestUri

java.net.URI getRequestUri()

Получите абсолютный URI запроса включая любые параметры запроса.

Возвраты:

абсолютный URI запроса

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

getRequestUriBuilder

UriBuilder getRequestUriBuilder()

Получите абсолютный URI запроса в форме UriBuilder.

Возвраты:

UriBuilder инициализируется с абсолютным URI запроса

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

getAbsolutePath

java.net.URI getAbsolutePath()

Получите абсолютный путь запроса. Это включает все предшествующее пути (узел, порт и т.д.), но исключает параметры запроса. Это - ярлык для uriInfo.getBase().resolve(uriInfo.getPath()).

Возвраты:

абсолютный путь запроса

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

getAbsolutePathBuilder

UriBuilder getAbsolutePathBuilder()

Получите абсолютный путь запроса в форме UriBuilder. Это включает все предшествующее пути (узел, порт и т.д.), но исключает параметры запроса.

Возвраты:

UriBuilder инициализируется с абсолютным путем запроса

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

getBaseUri

java.net.URI getBaseUri()

Получите основной URI приложения. URI корневых классов ресурса - все относительно этого основного URI.

Возвраты:

основной URI приложения

getBaseUriBuilder

UriBuilder getBaseUriBuilder()

Получите основной URI приложения в форме UriBuilder.

Возвраты:

UriBuilder инициализируется с основным URI приложения.

getPathParameters

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

Получите значения любых встроенных шаблонных параметров URI. Все последовательности оставленных октетов декодируются, эквивалентны getPathParameters(true).

Возвраты:

неподдающаяся изменению карта названий параметра и значений

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

См. Также:

Path, PathParam

getPathParameters

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

Получите значения любых встроенных шаблонных параметров URI.

Параметры:

decode - средства управления, декодируются ли последовательности оставленных октетов (истина) или не (ложь).

Возвраты:

неподдающаяся изменению карта названий параметра и значений

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

См. Также:

Path, PathParam

getQueryParameters

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

Получите параметры запроса URI текущего запроса. Ключи карты являются именами параметров запроса с любыми оставленными декодируемыми символами. Все последовательности оставленных октетов в значениях параметра декодируются, эквивалентны getQueryParameters(true).

Возвраты:

неподдающаяся изменению карта имен параметра запроса и значений

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

getQueryParameters

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

Получите параметры запроса URI текущего запроса. Ключи карты являются именами параметров запроса с любыми оставленными декодируемыми символами.

Параметры:

decode - средства управления, декодируются ли последовательности оставленных октетов в значениях параметра (истина) или не (ложь).

Возвраты:

неподдающаяся изменению карта имен параметра запроса и значений

Броски:

java.lang.IllegalStateException - если вызвано вне контекста запроса

getMatchedURIs

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

Получите список только для чтения URI для соответствующих ресурсов. Каждая запись является относительным URI, который соответствовал ресурсу class, метод подресурса или локатор подресурса. Все последовательности оставленных октетов декодируются, эквивалентны getMatchedURIs(true). Записи не включают параметры запроса, но действительно включают параметры матрицы если существующий в URI запроса. Записи упорядочиваются в обратном порядке соответствия URI запроса с текущим URI ресурса сначала. Например, учитывая следующие классы ресурса:

@Path("foo")
public class FooResource {
  @GET
  public String getFoo() {...}
 
  @Path("bar")
  public BarResource getBarResource() {...}
}
 
public class BarResource {
  @GET
  public String getBar() {...}
}
 

Значения, возвращенные этим методом, основанным на турах запроса и где метод вызывают от:

Запрос	Вызванный от	Значение (я)
ПОЛУЧИТЕ/foo	FooResource.getFoo	foo
ПОЛУЧИТЕ/foo/bar	FooResource.getBarResource	foo/bar, foo
ПОЛУЧИТЕ/foo/bar	BarResource.getBar	foo/bar, foo

Возвраты:

список только для чтения путей URI для соответствующих ресурсов.

getMatchedURIs

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

Получите список только для чтения URI для соответствующих ресурсов. Каждая запись является относительным URI, который соответствовал ресурсу class, метод подресурса или локатор подресурса. Записи не включают параметры запроса, но действительно включают параметры матрицы если существующий в URI запроса. Записи упорядочиваются в обратном порядке соответствия URI запроса с текущим URI ресурса сначала. См. getMatchedURIs() для примера.

Параметры:

decode - средства управления, декодируются ли последовательности оставленных октетов (истина) или не (ложь).

Возвраты:

список только для чтения путей URI для соответствующих ресурсов.

getMatchedResources

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

Получите список только для чтения в настоящий момент соответствующего ресурса экземпляры class. Каждая запись является ресурсом экземпляр class, который соответствовал URI запроса или непосредственно или через метод подресурса или локатор подресурса. Записи упорядочиваются согласно обратному порядку соответствия URI запроса с текущим ресурсом сначала. Например, учитывая следующие классы ресурса:

@Path("foo")
public class FooResource {
  @GET
  public String getFoo() {...}
 
  @Path("bar")
  public BarResource getBarResource() {...}
}
 
public class BarResource {
  @GET
  public String getBar() {...}
}
 

Значения, возвращенные этим методом, основанным на турах запроса и где метод вызывают от:

Запрос	Вызванный от	Значение (я)
ПОЛУЧИТЕ/foo	FooResource.getFoo	FooResource
ПОЛУЧИТЕ/foo/bar	FooResource.getBarResource	FooResource
ПОЛУЧИТЕ/foo/bar	BarResource.getBar	BarResource, FooResource

Возвраты:

список только для чтения соответствующего ресурса экземпляры class.