All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.ws.rs.core.UriInfo Maven / Gradle / Ivy

There is a newer version: 2.1.1
Show newest version
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2010-2015 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * http://glassfish.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package javax.ws.rs.core;

import java.net.URI;
import java.util.List;

/**
 * An injectable interface that provides access to application and request
 * URI information. Relative URIs are relative to the base URI of the
 * application, see {@link #getBaseUri}.
 *
 * 

All methods throw {@code java.lang.IllegalStateException} * if called outside the scope of a request (e.g. from a provider constructor).

* * @author Paul Sandoz * @author Marc Hadley * @see Context * @since 1.0 */ public interface UriInfo { /** * Get the path of the current request relative to the base URI as a string. * All sequences of escaped octets are decoded, equivalent to * {@link #getPath(boolean) getPath(true)}. * * @return the relative URI path. * @throws java.lang.IllegalStateException * if called outside the scope of * a request. */ public String getPath(); /** * Get the path of the current request relative to the base URI as a string. * * @param decode controls whether sequences of escaped octets are decoded * ({@code true}) or not ({@code false}). * @return the relative URI path * @throws java.lang.IllegalStateException * if called outside the scope of * a request. */ public String getPath(boolean decode); /** * Get the path of the current request relative to the base URI as a * list of {@link 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 {@code getPathSegments(true)}. * * @return an unmodifiable list of {@link PathSegment}. The matrix parameter * map of each path segment is also unmodifiable. * @throws IllegalStateException if called outside the scope of a request * @see PathSegment * @see Matrix URIs */ public List getPathSegments(); /** * Get the path of the current request relative to the base URI as a list of * {@link PathSegment}. This method is useful when the path needs to be parsed, * particularly when matrix parameters may be present in the path. * * @param decode controls whether sequences of escaped octets in path segments * and matrix parameter values are decoded ({@code true}) or not ({@code false}). * @return an unmodifiable list of {@link PathSegment}. The matrix parameter * map of each path segment is also unmodifiable. * @throws java.lang.IllegalStateException * if called outside the scope of a request * @see PathSegment * @see Matrix URIs */ public List getPathSegments(boolean decode); /** * Get the absolute request URI including any query parameters. * * @return the absolute request URI * @throws java.lang.IllegalStateException * if called outside the scope of a request */ public URI getRequestUri(); /** * Get the absolute request URI in the form of a UriBuilder. * * @return a UriBuilder initialized with the absolute request URI. * @throws java.lang.IllegalStateException * if called outside the scope of a * request. */ public UriBuilder getRequestUriBuilder(); /** * Get the absolute path of the request. This includes everything preceding * the path (host, port etc) but excludes query parameters. * This is a shortcut for {@code uriInfo.getBaseUri().resolve(uriInfo.getPath(false))}. * * @return the absolute path of the request. * @throws java.lang.IllegalStateException * if called outside the scope of a * request. */ public URI getAbsolutePath(); /** * Get the absolute path of the request in the form of a UriBuilder. * This includes everything preceding the path (host, port etc) but excludes * query parameters. * * @return a UriBuilder initialized with the absolute path of the request. * @throws java.lang.IllegalStateException * if called outside the scope of a * request. */ public UriBuilder getAbsolutePathBuilder(); /** * Get the base URI of the application. URIs of root resource classes * are all relative to this base URI. * * @return the base URI of the application. */ public URI getBaseUri(); /** * Get the base URI of the application in the form of a UriBuilder. * * @return a UriBuilder initialized with the base URI of the application. */ public UriBuilder getBaseUriBuilder(); /** * Get the values of any embedded URI template parameters. All sequences of * escaped octets are decoded, equivalent to * {@link #getPathParameters(boolean) getPathParameters(true)}. * * @return an unmodifiable map of parameter names and values. * @throws java.lang.IllegalStateException * if called outside the scope of a * request. * @see javax.ws.rs.Path * @see javax.ws.rs.PathParam */ public MultivaluedMap getPathParameters(); /** * Get the values of any embedded URI template parameters. * * @param decode controls whether sequences of escaped octets are decoded * ({@code true}) or not ({@code false}). * @return an unmodifiable map of parameter names and values * @throws java.lang.IllegalStateException * if called outside the scope of a * request. * @see javax.ws.rs.Path * @see javax.ws.rs.PathParam */ public MultivaluedMap getPathParameters(boolean decode); /** * Get the URI query parameters of the current request. The map keys are the * names of the query parameters with any escaped characters decoded. All sequences * of escaped octets in parameter names and values are decoded, equivalent to * {@link #getQueryParameters(boolean) getQueryParameters(true)}. * * @return an unmodifiable map of query parameter names and values. * @throws java.lang.IllegalStateException * if called outside the scope of a * request. */ public MultivaluedMap getQueryParameters(); /** * Get the URI query parameters of the current request. The map keys are the * names of the query parameters with any escaped characters decoded. * * @param decode controls whether sequences of escaped octets in parameter * names and values are decoded ({@code true}) or not ({@code false}). * @return an unmodifiable map of query parameter names and values. * @throws java.lang.IllegalStateException * if called outside the scope of a * request. */ public MultivaluedMap getQueryParameters(boolean decode); /** * Get a read-only list of URIs for matched resources. * * Each entry is a relative URI that matched a resource class, a * sub-resource method or a sub-resource locator. All sequences of escaped * octets are decoded, equivalent to {@code 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:

* * * * * * * * * * * * * * * * * * * * * * *
RequestCalled fromValue(s)
GET /fooFooResource.getFoofoo
GET /foo/barFooResource.getBarResourcefoo/bar, foo
GET /foo/barBarResource.getBarfoo/bar, foo
* * In case the method is invoked prior to the request matching (e.g. from a * pre-matching filter), the method returns an empty list. * * @return a read-only list of URI paths for matched resources. */ public List getMatchedURIs(); /** * Get a read-only list of URIs for matched resources. * * Each entry is a relative URI that matched a resource class, a sub-resource * method or a sub-resource locator. 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. See {@link #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. * * @param decode controls whether sequences of escaped octets are decoded * ({@code true}) or not ({@code false}). * @return a read-only list of URI paths for matched resources. */ public List getMatchedURIs(boolean decode); /** * Get a read-only list of the currently matched resource class instances. * * Each entry is a resource class instance that matched the request URI * either directly or via a sub-resource method or a sub-resource locator. * Entries are ordered according to reverse request URI matching order, * with the current resource 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:

* * * * * * * * * * * * * * * * * * * * * * *
RequestCalled fromValue(s)
GET /fooFooResource.getFooFooResource
GET /foo/barFooResource.getBarResourceFooResource
GET /foo/barBarResource.getBarBarResource, FooResource
* * In case the method is invoked prior to the request matching (e.g. from a * pre-matching filter), the method returns an empty list. * * @return a read-only list of matched resource class instances. */ public List getMatchedResources(); /** * Resolve a relative URI with respect to the base URI of the application. * The resolved URI returned by this method is normalized. If the supplied URI is * already resolved, it is just returned. * * @param uri URI to resolve against the base URI of the application. * @return newly resolved URI or supplied URI if already resolved. * @since 2.0 */ public URI resolve(URI uri); /** *

Relativize a URI with respect to the current request URI. Relativization * works as follows: *

    *
  1. If the URI to relativize is already relative, it is first resolved using * {@link #resolve(java.net.URI)}.
  2. *
  3. The resulting URI is relativized with respect to the current request * URI. If the two URIs do not share a prefix, the URI computed in * step 1 is returned.
  4. *
*

* *

Examples (for base URI {@code 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.

* * @param uri URI to relativize against the request URI. * @return newly relativized URI. * @throws java.lang.IllegalStateException if called outside the scope of a request. * @since 2.0 */ public URI relativize(URI uri); }