|
||||||||||
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. All methods except getBaseUri()
and
getBaseUriBuilder()
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.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. |
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. |
UriBuilder |
getRequestUriBuilder()
Get the absolute request URI in the form of a UriBuilder. |
MultivaluedMap<java.lang.String,java.lang.String> |
getTemplateParameters()
Get the values of any embedded URI template parameters. |
MultivaluedMap<java.lang.String,java.lang.String> |
getTemplateParameters(boolean decode)
Get the values of any embedded URI template parameters. |
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 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
java.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 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
java.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> getTemplateParameters()
getTemplateParameters(true)
.
java.lang.IllegalStateException
- if called outside the scope of a requestPath
MultivaluedMap<java.lang.String,java.lang.String> getTemplateParameters(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
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 are decoded
(true) or not (false).
java.lang.IllegalStateException
- if called outside the scope of a request
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |