org.glassfish.jersey.server.ExtendedUriInfo Maven / Gradle / Ivy
Show all versions of jaxrs-ri Show documentation
/*
* Copyright (c) 2010, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0, which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the
* Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
* version 2 with the GNU Classpath Exception, which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
*/
package org.glassfish.jersey.server;
import java.util.List;
import java.util.regex.MatchResult;
import javax.ws.rs.core.PathSegment;
import javax.ws.rs.core.UriInfo;
import org.glassfish.jersey.server.model.Resource;
import org.glassfish.jersey.server.model.ResourceMethod;
import org.glassfish.jersey.server.model.RuntimeResource;
import org.glassfish.jersey.uri.UriTemplate;
/**
* Extensions to {@link UriInfo}.
*
* @author Paul Sandoz
*/
public interface ExtendedUriInfo extends UriInfo {
/**
* Get the throwable that was mapped to a response.
*
* A 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.
*
* @return the throwable that was mapped to a response, otherwise null
* if no throwable was mapped to a response.
*/
Throwable getMappedThrowable();
/**
* Get a read-only list of {@link MatchResult} for matched resources.
* Entries are ordered in reverse request URI matching order, with the
* root resource match result last.
*
* @return a read-only list of match results for matched resources.
*/
List getMatchedResults();
/**
* Get a read-only list of {@link org.glassfish.jersey.uri.UriTemplate} for matched resources.
* Each entry is a URI template that is the value of the
* {@link javax.ws.rs.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.
*
* @return a read-only list of URI templates for matched resources.
*/
List getMatchedTemplates();
/**
* Get the path segments that contain a template variable.
* All sequences of escaped octets are decoded,
* equivalent to getPathSegments(true).
*
* @param name the template variable name
* @return the path segments, the list will be empty the matching path does
* not contain the template
*/
List getPathSegments(String name);
/**
* Get the path segments that contain a template variable.
*
* @param name the template variable name
* @param decode controls whether sequences of escaped octets are decoded
* (true) or not (false).
* @return the path segments, the list will be empty the matching path does
* not contain the template
*/
List getPathSegments(String name, boolean decode);
/**
* Return all matched {@link RuntimeResource runtime resources} including runtime resources
* based on child resources. The list is ordered so that the {@link RuntimeResource 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"]
*
*
* @return List of resources and child resources that were processed during request matching.
*/
public List getMatchedRuntimeResources();
/**
* Get matched {@link ResourceMethod resource 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.
*
* @return The matched resource method that was invoked or null if no resource method was invoked.
*/
public ResourceMethod getMatchedResourceMethod();
/**
* Get matched {@link Resource model resource} from which {@link #getMatchedResourceMethod() 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 {@link ResourceMethod resource method}
* and not intermediary processed resources (parent resources or resources containing sub resource locators).
*
* @return The matched model resource or null if no resource was matched.
*/
public Resource getMatchedModelResource();
/**
* Get resource locators matched since beginning of a matching. The list contains resource
* locators sorted in the order that the first element of the list is the last locator executed (LIFO ordering).
* The method can be invoked from request scoped code. When method is invoked from the resource locator
* itself such a locator will be already in the returned list as a first element.
*
* The resource locator is
* a {@link ResourceMethod resource method} which is annotated by the {@link javax.ws.rs.Path @Path}
* and returns a sub resource.
*
* @return List of matched resource locators.
*/
public List getMatchedResourceLocators();
/**
* Get the list of sub resources returned from resource locators during matching.
* The sub resources are sorted in the
* order, so that the first element of the list is a sub resource that was lastly returned from the
* resource locator (LIFO ordering).
*
* Sub resource is a resource that is returned from invoked resource locator method and that will be
* used for further resource matching.
*
* @return Locator sub resource.
*/
public List getLocatorSubResources();
}