org.apache.juneau.rest.annotation

Annotation Type Path

@Documented
 @Target(value=PARAMETER)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Path

Annotation that can be applied to a parameter of a @RestMethod annotated method to identify it as a variable in a URL path pattern converted to a POJO.

Example:

@RestMethod(name=GET, path="/myurl/{foo}/{bar}/{baz}/*") public void doGet(RestRequest req, RestResponse res, @Path String foo, @Path int bar, @Path UUID baz) { ... }

The @Path annotation is optional if the parameters are specified immediately following the RestRequest and RestResponse parameters, and are specified in the same order as the variables in the URL path pattern. The following example is equivalent to the previous example.

@RestMethod(name=GET, path="/myurl/{foo}/{bar}/{baz}/*") public void doGet(RestRequest req, RestResponse res, String foo, int bar, UUID baz) { ... }

If the order of parameters is not the default order shown above, the attribute names must be specified (since parameter names are lost during compilation). The following example is equivalent to the previous example, except the parameter order has been switched, requiring the use of the @Path annotations.

@RestMethod(name=GET, path="/myurl/{foo}/{bar}/{baz}/*") public void doGet(RestRequest req, RestResponse res, @Path("baz") UUID baz, @Path("foo") String foo, @Path("bar") int bar) { ... }

You can also use {#} notation to specify path parameters without specifying names.

@RestMethod(name=GET, path="/myurl/{0}/{1}/{2}/*") public void doGet(RestRequest req, RestResponse res, @Path String foo, @Path int bar, @Path UUID baz) { ... }

See Also:

• Overview > juneau-rest-server > Method Parameters

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name URL path variable name.
Class<? extends HttpPartParser>	parser Specifies the HttpPartParser class used for parsing values from strings.
String	value A synonym for name().

Element Detail

name

public abstract String name

URL path variable name.

Optional if the attributes are specified in the same order as in the URL path pattern.

Default:

""

parser

public abstract Class<? extends HttpPartParser> parser

Specifies the HttpPartParser class used for parsing values from strings.

The default value for this parser is inherited from the servlet/method which defaults to UonPartParser.
You can use SimplePartParser to parse POJOs that are directly convertible from Strings.

Default:

org.apache.juneau.httppart.HttpPartParser.Null.class

value

public abstract String value

A synonym for name().

Allows you to use shortened notation if you're only specifying the name.

Default:

""