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

jakarta.ws.rs.Path Maven / Gradle / Ivy

/*
 * Copyright (c) 2010, 2019 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 jakarta.ws.rs;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Identifies the URI path that a resource class or class method will serve requests for.
 *
 * 

* Paths are relative. For an annotated class the base URI is the application path, see {@link ApplicationPath}. For an * annotated method the base URI is the effective URI of the containing class. For the purposes of absolutizing a path * against the base URI , a leading '/' in a path is ignored and base URIs are treated as if they ended in '/'. E.g.: *

* *
 * @Path("widgets")
 * public class WidgetsResource {
 *  @GET
 *  String getList() {...}
 *
 *  @GET @Path("{id}")
 *  String getWidget(@PathParam("id") String id) {...}
 * }
 * 
* *

* In the above, if the application path is {@code catalogue} and the application is deployed at * {@code http://example.com/}, then {@code GET} requests for {@code http://example.com/catalogue/widgets} will be * handled by the {@code getList} method while requests for http://example.com/catalogue/widgets/nnn * (where nnn is some value) will be handled by the {@code getWidget} method. The same would apply * if the value of either {@code @Path} annotation started with '/'. *

* *

* Classes and methods may also be annotated with {@link Consumes} and {@link Produces} to filter the requests they will * receive. *

* * @author Paul Sandoz * @author Marc Hadley * @see Consumes * @see Produces * @see PathParam * @since 1.0 */ @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Path { /** * Defines a URI template for the resource class or method, must not include matrix parameters. * *

* Embedded template parameters are allowed and are of the form: *

* *
     *  param = "{" *WSP name *WSP [ ":" *WSP regex *WSP ] "}"
     * name = (ALPHA / DIGIT / "_")*(ALPHA / DIGIT / "." / "_" / "-" ) ; \w[\w\.-]*
     * regex = *( nonbrace / "{" *nonbrace "}" ) ; where nonbrace is any char other than "{" and "}"
     * 
* *

* See RFC 5234 for a description of the syntax used above and the * expansions of {@code WSP}, {@code ALPHA} and {@code DIGIT}. In the above {@code name} is the template parameter name * and the optional {@code regex} specifies the contents of the capturing group for the parameter. If {@code regex} is * not supplied then a default value of {@code [^/]+} which terminates at a path segment boundary, is used. Matching of * request URIs to URI templates is performed against encoded path values and implementations will not escape literal * characters in regex automatically, therefore any literals in {@code regex} should be escaped by the author according * to the rules of RFC 3986 section 3.3. Caution is * recommended in the use of {@code regex}, incorrect use can lead to a template parameter matching unexpected URI * paths. See Pattern for * further information on the syntax of regular expressions. Values of template parameters may be extracted using * {@link PathParam}. *

* *

* The literal part of the supplied value (those characters that are not part of a template parameter) is automatically * percent encoded to conform to the {@code path} production of * RFC 3986 section 3.3. Note that percent encoded values * are allowed in the literal part of the value, an implementation will recognize such values and will not double encode * the '%' character. *

* * @return URI template. */ String value(); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy