|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UriInfo
An injectable interface that provides access to application and request
URI information. Relative URIs are relative to the base URI of the
application, see getBaseUri()
.
All methods throw java.lang.IllegalStateException
if called outside the scope of a request (e.g. from a provider constructor).
Context
Method Summary | |
---|---|
java.net.URI |
getAbsolutePath()
Get the absolute path of the request. |
UriBuilder |
getAbsolutePathBuilder()
Get the absolute path of the request in the form of a UriBuilder. |
java.net.URI |
getBaseUri()
Get the base URI of the application. |
UriBuilder |
getBaseUriBuilder()
Get the base URI of the application in the form of a UriBuilder. |
java.util.List<java.lang.Object> |
getMatchedResources()
Get a read-only list of the currently matched resource class instances. |
java.util.List<java.lang.String> |
getMatchedURIs()
Get a read-only list of URIs for matched resources. |
java.util.List<java.lang.String> |
getMatchedURIs(boolean decode)
Get a read-only list of URIs for matched resources. |
java.lang.String |
getPath()
Get the path of the current request relative to the base URI as a string. |
java.lang.String |
getPath(boolean decode)
Get the path of the current request relative to the base URI as a string. |
MultivaluedMap<java.lang.String,java.lang.String> |
getPathParameters()
Get the values of any embedded URI template parameters. |
MultivaluedMap<java.lang.String,java.lang.String> |
getPathParameters(boolean decode)
Get the values of any embedded URI template parameters. |
java.util.List<PathSegment> |
getPathSegments()
Get the path of the current request relative to the base URI as a list of PathSegment . |
java.util.List<PathSegment> |
getPathSegments(boolean decode)
Get the path of the current request relative to the base URI as a list of PathSegment . |
MultivaluedMap<java.lang.String,java.lang.String> |
getQueryParameters()
Get the URI query parameters of the current request. |
MultivaluedMap<java.lang.String,java.lang.String> |
getQueryParameters(boolean decode)
Get the URI query parameters of the current request. |
java.net.URI |
getRequestUri()
Get the absolute request URI including any query parameters. |
UriBuilder |
getRequestUriBuilder()
Get the absolute request URI in the form of a UriBuilder. |
Method Detail |
---|
java.lang.String getPath()
getPath(true)
.
java.lang.IllegalStateException
- if called outside the scope of a requestjava.lang.String getPath(boolean decode)
decode
- controls whether sequences of escaped octets are decoded
(true) or not (false).
java.lang.IllegalStateException
- if called outside the scope of a requestjava.util.List<PathSegment> getPathSegments()
PathSegment
. This method is useful when the
path needs to be parsed, particularly when matrix parameters may be
present in the path. All sequences of escaped octets in path segments
and matrix parameter values are decoded,
equivalent to getPathSegments(true)
.
PathSegment
. The matrix parameter
map of each path segment is also unmodifiable.
java.lang.IllegalStateException
- if called outside the scope of a requestPathSegment
,
Matrix URIsjava.util.List<PathSegment> getPathSegments(boolean decode)
PathSegment
. This method is useful when the
path needs to be parsed, particularly when matrix parameters may be
present in the path.
decode
- controls whether sequences of escaped octets in path segments
and matrix parameter values are decoded (true) or not (false).
PathSegment
. The matrix parameter
map of each path segment is also unmodifiable.
java.lang.IllegalStateException
- if called outside the scope of a requestPathSegment
,
Matrix URIsjava.net.URI getRequestUri()
java.lang.IllegalStateException
- if called outside the scope of a requestUriBuilder getRequestUriBuilder()
java.lang.IllegalStateException
- if called outside the scope of a requestjava.net.URI getAbsolutePath()
uriInfo.getBase().resolve(uriInfo.getPath()).
java.lang.IllegalStateException
- if called outside the scope of a requestUriBuilder getAbsolutePathBuilder()
java.lang.IllegalStateException
- if called outside the scope of a requestjava.net.URI getBaseUri()
UriBuilder getBaseUriBuilder()
MultivaluedMap<java.lang.String,java.lang.String> getPathParameters()
getPathParameters(true)
.
java.lang.IllegalStateException
- if called outside the scope of a requestPath
,
PathParam
MultivaluedMap<java.lang.String,java.lang.String> getPathParameters(boolean decode)
decode
- controls whether sequences of escaped octets are decoded
(true) or not (false).
java.lang.IllegalStateException
- if called outside the scope of a requestPath
,
PathParam
MultivaluedMap<java.lang.String,java.lang.String> getQueryParameters()
getQueryParameters(true)
.
java.lang.IllegalStateException
- if called outside the scope of a requestMultivaluedMap<java.lang.String,java.lang.String> getQueryParameters(boolean decode)
decode
- controls whether sequences of escaped octets in parameter
values are decoded (true) or not (false).
java.lang.IllegalStateException
- if called outside the scope of a requestjava.util.List<java.lang.String> getMatchedURIs()
getMatchedURIs(true)
.
Entries do not include query parameters but do include matrix parameters
if present in the request URI. Entries are ordered in reverse request
URI matching order, with the current resource URI first. E.g. given the
following resource classes:
@Path("foo") public class FooResource { @GET public String getFoo() {...} @Path("bar") public BarResource getBarResource() {...} } public class BarResource { @GET public String getBar() {...} }
The values returned by this method based on request uri and where the method is called from are:
Request | Called from | Value(s) |
---|---|---|
GET /foo | FooResource.getFoo | foo |
GET /foo/bar | FooResource.getBarResource | foo/bar, foo |
GET /foo/bar | BarResource.getBar | foo/bar, foo |
java.util.List<java.lang.String> getMatchedURIs(boolean decode)
getMatchedURIs()
for an
example.
decode
- controls whether sequences of escaped octets are decoded
(true) or not (false).
java.util.List<java.lang.Object> getMatchedResources()
@Path("foo") public class FooResource { @GET public String getFoo() {...} @Path("bar") public BarResource getBarResource() {...} } public class BarResource { @GET public String getBar() {...} }
The values returned by this method based on request uri and where the method is called from are:
Request | Called from | Value(s) |
---|---|---|
GET /foo | FooResource.getFoo | FooResource |
GET /foo/bar | FooResource.getBarResource | FooResource |
GET /foo/bar | BarResource.getBar | BarResource, FooResource |
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.
Generated on 10-February-2011 12:41