org.glassfish.jersey.server.internal.routing

Interface RoutingContext

All Superinterfaces:

ExtendedUriInfo, ResourceInfo, UriInfo

All Known Implementing Classes:

UriRoutingContext

public interface RoutingContext
extends ResourceInfo, ExtendedUriInfo

Jersey request matching and routing context.

Author:

Marek Potociar, Martin Matula

Method Summary

Modifier and Type	Method and Description
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.
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.
void	setEndpoint(Endpoint endpoint) Set the matched server-side endpoint.
void	setMappedThrowable(Throwable throwable) Set the throwable that was mapped to a response.
void	setMatchedResourceMethod(ResourceMethod resourceMethod) Set the matched resource method.

Methods inherited from interface javax.ws.rs.container.ResourceInfo

getResourceClass, getResourceMethod

Methods inherited from interface org.glassfish.jersey.server.ExtendedUriInfo

getLocatorSubResources, getMappedThrowable, getMatchedModelResource, getMatchedResourceLocators, getMatchedResourceMethod, getMatchedResults, getMatchedRuntimeResources, getMatchedTemplates, getPathSegments, getPathSegments

Methods inherited from interface javax.ws.rs.core.UriInfo

getAbsolutePath, getAbsolutePathBuilder, getBaseUri, getBaseUriBuilder, getMatchedResources, getMatchedURIs, getMatchedURIs, getPath, getPath, getPathParameters, getPathParameters, getPathSegments, getPathSegments, getQueryParameters, getQueryParameters, getRequestUri, getRequestUriBuilder, relativize, resolve

Method Detail

pushMatchResult

void pushMatchResult(MatchResult matchResult)

Push the result of the successful request URI routing pattern match.

Parameters:

matchResult - successful request URI routing pattern match result.

pushMatchedResource

void pushMatchedResource(Object resource)

Push the resource that matched the request URI.

Parameters:

resource - instance of the resource that matched the request URI.

peekMatchedResource

Object peekMatchedResource()

Peek the last resource object that successfully matched the request URI.

Returns:

last resource matched as previously set by pushMatchedResource(java.lang.Object)

pushTemplates

void pushTemplates(UriTemplate resourceTemplate,
                   UriTemplate methodTemplate)

Push matched request URI routing pattern templates 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.

Parameters:

resourceTemplate - resource URI template that should be pushed.

methodTemplate - (sub-resource) method or locator URI template that should be pushed.

getFinalMatchingGroup

String getFinalMatchingGroup()

Get the final matching group of the last successful request URI routing pattern match result. Also known as right-hand path.

May be empty but is never null.

Returns:

final matching group of the last successful request URI routing pattern match result.

pushLeftHandPath

void pushLeftHandPath()

Add currently matched left-hand side part of request path to the list of matched paths returned by UriInfo.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.

setEndpoint

void setEndpoint(Endpoint endpoint)

Set the matched server-side endpoint.

This method can be used in a non-terminal stage to set the server-side endpoint that can be retrieved and processed by a subsequent stage.

Parameters:

endpoint - matched server-side endpoint.

getEndpoint

Endpoint getEndpoint()

Get the matched server-side endpoint if present, or null otherwise.

Returns:

matched server-side endpoint, or null if not available.

setMatchedResourceMethod

void setMatchedResourceMethod(ResourceMethod resourceMethod)

Set the matched resource 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.

Parameters:

resourceMethod - Resource method that was matched.

pushMatchedLocator

void pushMatchedLocator(ResourceMethod resourceLocator)

Push the matched sub resource locator method.

Parameters:

resourceLocator - Sub resource locator method.

pushMatchedRuntimeResource

void pushMatchedRuntimeResource(RuntimeResource runtimeResource)

Push a matched runtime resource that was visited during matching phase. This method must be called for any matched runtime resource.

Parameters:

runtimeResource - Runtime resource that was matched during matching.

pushLocatorSubResource

void pushLocatorSubResource(Resource subResourceFromLocator)

Push sub 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.

Parameters:

subResourceFromLocator - Resource constructed from result of sub resource locator method.

setMappedThrowable

void setMappedThrowable(Throwable throwable)

Set the throwable that was mapped to a response.

Parameters:

throwable - throwable that was mapped to a response.

See Also:

ExtendedUriInfo.getMappedThrowable()