public class UriRoutingContext extends Object implements RoutingContext
| Constructor and Description |
|---|
UriRoutingContext(ContainerRequest requestContext)
Injection constructor.
|
| Modifier and Type | Method and Description |
|---|---|
URI |
getAbsolutePath()
Get the absolute path of the request.
|
UriBuilder |
getAbsolutePathBuilder()
Get the absolute path of the request in the form of a UriBuilder.
|
URI |
getBaseUri()
Get the base URI of the application.
|
UriBuilder |
getBaseUriBuilder()
Get the base URI of the application in the form of a UriBuilder.
|
Endpoint |
getEndpoint()
Get the matched server-side endpoint if present, or
null otherwise. |
String |
getFinalMatchingGroup()
Get the final matching group of the last successful request URI routing
pattern
match result. |
List<Resource> |
getLocatorSubResources()
Get the list of sub resources returned from resource locators during matching.
|
Throwable |
getMappedThrowable()
Get the throwable that was mapped to a response.
|
Resource |
getMatchedModelResource()
Get matched
model resource from which the matched resource method
was invoked. |
List<ResourceMethod> |
getMatchedResourceLocators()
Get resource locators matched since beginning of a matching.
|
ResourceMethod |
getMatchedResourceMethod()
Get matched
resource method that is invoked. |
List<Object> |
getMatchedResources()
Get a read-only list of the currently matched resource class instances.
|
LinkedList<MatchResult> |
getMatchedResults()
Get a read-only list of
MatchResult for matched resources. |
List<RuntimeResource> |
getMatchedRuntimeResources()
Return all matched
runtime resources including runtime resources
based on child resources. |
List<UriTemplate> |
getMatchedTemplates()
Get a read-only list of
UriTemplate for matched resources. |
List<String> |
getMatchedURIs()
Get a read-only list of URIs for matched resources.
|
List<String> |
getMatchedURIs(boolean decode)
Get a read-only list of URIs for matched resources.
|
String |
getPath()
Get the path of the current request relative to the base URI as a string.
|
String |
getPath(boolean decode)
Get the path of the current request relative to the base URI as a string.
|
MultivaluedMap<String,String> |
getPathParameters()
Get the values of any embedded URI template parameters.
|
MultivaluedMap<String,String> |
getPathParameters(boolean decode)
Get the values of any embedded URI template parameters.
|
List<PathSegment> |
getPathSegments()
Get the path of the current request relative to the base URI as a list of
PathSegment. |
List<PathSegment> |
getPathSegments(boolean decode)
Get the path of the current request relative to the base URI as a list of
PathSegment. |
List<PathSegment> |
getPathSegments(String name)
Get the path segments that contain a template variable.
|
List<PathSegment> |
getPathSegments(String name,
boolean decode)
Get the path segments that contain a template variable.
|
MultivaluedMap<String,String> |
getQueryParameters()
Get the URI query parameters of the current request.
|
MultivaluedMap<String,String> |
getQueryParameters(boolean decode)
Get the URI query parameters of the current request.
|
URI |
getRequestUri()
Get the absolute request URI including any query parameters.
|
UriBuilder |
getRequestUriBuilder()
Get the absolute request URI in the form of a UriBuilder.
|
Class<?> |
getResourceClass()
Get the resource class that is the target of a request, or
null if this information is not available. |
Method |
getResourceMethod()
Get the resource method that is the target of a request, or
null if this information is not available. |
void |
invalidateUriComponentViews()
Invalidate internal URI component cache views.
|
Object |
peekMatchedResource()
Peek the last resource object that successfully matched the request URI.
|
void |
pushLeftHandPath()
Add currently matched left-hand side part of request path to the list of
matched paths returned by
UriInfo.getMatchedURIs(). |
void |
pushLocatorSubResource(Resource subResourceFromLocator)
Push
sub resource returned from a sub resource locator method. |
void |
pushMatchedLocator(ResourceMethod resourceLocator)
Push the matched
sub resource locator method. |
void |
pushMatchedResource(Object resource)
Push the resource that matched the request URI.
|
void |
pushMatchedRuntimeResource(RuntimeResource runtimeResource)
Push a matched
runtime resource that was visited during matching phase. |
void |
pushMatchResult(MatchResult matchResult)
Push the result of the successful request URI routing pattern match.
|
void |
pushTemplates(UriTemplate resourceTemplate,
UriTemplate methodTemplate)
Push matched request URI routing pattern
templates
for a single matched method. |
URI |
relativize(URI uri)
Relativize a URI with respect to the current request URI.
|
URI |
resolve(URI uri)
Resolve a relative URI with respect to the base URI of the application.
|
void |
setEndpoint(Endpoint endpoint)
Set the matched server-side endpoint.
|
void |
setMappedThrowable(Throwable mappedThrowable)
Set the throwable that was mapped to a response.
|
void |
setMatchedResourceMethod(ResourceMethod resourceMethod)
Set the matched
resource method. |
public UriRoutingContext(ContainerRequest requestContext)
requestContext - request reference.public void pushMatchResult(MatchResult matchResult)
RoutingContextpushMatchResult in interface RoutingContextmatchResult - successful request URI routing pattern
match result.public void pushMatchedResource(Object resource)
RoutingContextpushMatchedResource in interface RoutingContextresource - instance of the resource that matched the request URI.public Object peekMatchedResource()
RoutingContextpeekMatchedResource in interface RoutingContextRoutingContext.pushMatchedResource(java.lang.Object)public void pushMatchedLocator(ResourceMethod resourceLocator)
RoutingContextsub resource locator method.pushMatchedLocator in interface RoutingContextresourceLocator - Sub resource locator method.public void pushLeftHandPath()
RoutingContextUriInfo.getMatchedURIs().
Left-hand side request path is the request path excluding the suffix
part of the path matched by the final
matching group of the last successful request URI routing pattern.pushLeftHandPath in interface RoutingContextpublic void pushTemplates(UriTemplate resourceTemplate, UriTemplate methodTemplate)
RoutingContexttemplates
for a single matched method.
In case only a single path matching has been performed on the resource (in case of resource methods,
only the resource path is matched), the method template should be passed as null.
In case a path matching has been performed on both a resource and method paths
(in case of sub-resource methods and locators), both templates (resource and method) must be specified.
pushTemplates in interface RoutingContextresourceTemplate - resource URI template that should be pushed.methodTemplate - (sub-resource) method or locator URI template that should be pushed.public String getFinalMatchingGroup()
RoutingContextmatch result. Also known as right-hand path.
May be empty but is never null.
getFinalMatchingGroup in interface RoutingContextpublic LinkedList<MatchResult> getMatchedResults()
ExtendedUriInfoMatchResult for matched resources.
Entries are ordered in reverse request URI matching order, with the
root resource match result last.getMatchedResults in interface ExtendedUriInfopublic void setEndpoint(Endpoint endpoint)
RoutingContextsetEndpoint in interface RoutingContextendpoint - matched server-side endpoint.public Endpoint getEndpoint()
RoutingContextnull otherwise.getEndpoint in interface RoutingContextnull if not available.public void setMatchedResourceMethod(ResourceMethod resourceMethod)
RoutingContextresource method. This method needs to be called only if the method was
matched. This method should be called only for setting the final resource method and not for setting sub resource
locators invoked during matching.setMatchedResourceMethod in interface RoutingContextresourceMethod - Resource method that was matched.public void pushMatchedRuntimeResource(RuntimeResource runtimeResource)
RoutingContextruntime resource that was visited during matching phase. This method must
be called for any matched runtime resource.pushMatchedRuntimeResource in interface RoutingContextruntimeResource - Runtime resource that was matched during matching.public void pushLocatorSubResource(Resource subResourceFromLocator)
RoutingContextsub resource returned from a sub resource locator method. The pushed
subResourceFromLocator is the final model of a sub resource which is already enhanced by
model processors and
validated.pushLocatorSubResource in interface RoutingContextsubResourceFromLocator - Resource constructed from result of sub resource locator method.public URI getAbsolutePath()
UriInfouriInfo.getBaseUri().resolve(uriInfo.getPath(false)).getAbsolutePath in interface UriInfopublic UriBuilder getAbsolutePathBuilder()
UriInfogetAbsolutePathBuilder in interface UriInfopublic URI getBaseUri()
UriInfogetBaseUri in interface UriInfopublic UriBuilder getBaseUriBuilder()
UriInfogetBaseUriBuilder in interface UriInfopublic List<Object> getMatchedResources()
UriInfo
@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 |
getMatchedResources in interface UriInfopublic List<String> getMatchedURIs()
UriInfogetMatchedURIs(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 |
getMatchedURIs in interface UriInfopublic List<String> getMatchedURIs(boolean decode)
UriInfoUriInfo.getMatchedURIs() for an
example.
In case the method is invoked prior to the request matching (e.g. from a pre-matching filter), the method returns an
empty list.getMatchedURIs in interface UriInfodecode - controls whether sequences of escaped octets are decoded (true) or not (false).public String getPath()
UriInfogetPath(true).public String getPath(boolean decode)
UriInfopublic MultivaluedMap<String,String> getPathParameters()
UriInfogetPathParameters(true).getPathParameters in interface UriInfoPath,
PathParampublic MultivaluedMap<String,String> getPathParameters(boolean decode)
UriInfogetPathParameters in interface UriInfodecode - controls whether sequences of escaped octets are decoded (true) or not (false).Path,
PathParampublic List<PathSegment> getPathSegments()
UriInfoPathSegment. 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).getPathSegments in interface UriInfoPathSegment. The matrix parameter map of each path segment is also
unmodifiable.PathSegment,
Matrix URIspublic List<PathSegment> getPathSegments(boolean decode)
UriInfoPathSegment. This method is useful
when the path needs to be parsed, particularly when matrix parameters may be present in the path.getPathSegments in interface UriInfodecode - 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.PathSegment,
Matrix URIspublic MultivaluedMap<String,String> getQueryParameters()
UriInfogetQueryParameters(true).getQueryParameters in interface UriInfopublic MultivaluedMap<String,String> getQueryParameters(boolean decode)
UriInfogetQueryParameters in interface UriInfodecode - controls whether sequences of escaped octets in parameter names and values are decoded (true)
or not (false).public void invalidateUriComponentViews()
This method needs to be called if request URI information changes.
public URI getRequestUri()
UriInfogetRequestUri in interface UriInfopublic UriBuilder getRequestUriBuilder()
UriInfogetRequestUriBuilder in interface UriInfopublic Throwable getMappedThrowable()
ExtendedUriInfoA response filter or a message body writer may utilize this method to determine if a resource method was invoked but did not return a response because an exception was thrown from the resource method, or the resource method returned but a response filter threw an exception.
getMappedThrowable in interface ExtendedUriInfopublic void setMappedThrowable(Throwable mappedThrowable)
RoutingContextsetMappedThrowable in interface RoutingContextmappedThrowable - throwable that was mapped to a response.ExtendedUriInfo.getMappedThrowable()public List<UriTemplate> getMatchedTemplates()
ExtendedUriInfoUriTemplate for matched resources.
Each entry is a URI template that is the value of the
Path that is a partial path that matched a resource
class, a sub-resource method or a sub-resource locator.
Entries are ordered in reverse request URI matching order, with the
root resource URI template last.getMatchedTemplates in interface ExtendedUriInfopublic List<PathSegment> getPathSegments(String name)
ExtendedUriInfogetPathSegments(true).getPathSegments in interface ExtendedUriInfoname - the template variable namepublic List<PathSegment> getPathSegments(String name, boolean decode)
ExtendedUriInfogetPathSegments in interface ExtendedUriInfoname - the template variable namedecode - controls whether sequences of escaped octets are decoded
(true) or not (false).public Method getResourceMethod()
ResourceInfonull if this information is not available.getResourceMethod in interface ResourceInfoResourceInfo.getResourceClass()public Class<?> getResourceClass()
ResourceInfonull if this information is not available.getResourceClass in interface ResourceInfoResourceInfo.getResourceMethod()public List<RuntimeResource> getMatchedRuntimeResources()
ExtendedUriInforuntime resources including runtime resources
based on child resources. The list is ordered so that the runtime resource
currently being processed is the first element in the list.
The following example
@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 | RuntimeResource["/foo"] |
| GET /foo/bar | FooResource.getBarResource | RuntimeResource["foo/bar"], Resource["foo"] |
| GET /foo/bar | BarResource.getBar | RuntimeResource[no path; based on BarResource.class], RuntimeResource["foo/bar"], RuntimeResource["foo"] |
getMatchedRuntimeResources in interface ExtendedUriInfopublic ResourceMethod getMatchedResourceMethod()
ExtendedUriInforesource method that is invoked.
Note that sub resource locator is not not considered as a matched resource method and calling the method from
sub resource locator will therefore return null.getMatchedResourceMethod in interface ExtendedUriInfopublic List<ResourceMethod> getMatchedResourceLocators()
ExtendedUriInfo
The resource locator is
a resource method which is annotated by the @Path
and returns a sub resource.
getMatchedResourceLocators in interface ExtendedUriInfopublic List<Resource> getLocatorSubResources()
ExtendedUriInfogetLocatorSubResources in interface ExtendedUriInfopublic Resource getMatchedModelResource()
ExtendedUriInfomodel resource from which the matched resource method
was invoked. The resource can also be a child if the matched method is a sub resource method.
Note that method return only resource containing finally matched resource method
and not intermediary processed resources (parent resources or resources containing sub resource locators).getMatchedModelResource in interface ExtendedUriInfopublic URI resolve(URI uri)
UriInfopublic URI relativize(URI uri)
UriInfoUriInfo.resolve(java.net.URI).
Examples (for base URI http://example.com:8080/app/root/):
Request URI: http://example.com:8080/app/root/a/b/c/resource.html
Supplied URI: a/b/c/d/file.txt
Returned URI: d/file.txt
Request URI: http://example.com:8080/app/root/a/b/c/resource.html
Supplied URI: http://example2.com:9090/app2/root2/a/d/file.txt
Returned URI: http://example2.com:9090/app2/root2/a/d/file.txt
In the second example, the supplied URI is returned given that it is absolute and there is no common prefix between it and the request URI.
relativize in interface UriInfouri - URI to relativize against the request URI.Copyright © 2007-2024, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms.