org.apache.juneau.http.annotation.Path Maven / Gradle / Ivy

Go to download
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
// * with the License.  You may obtain a copy of the License at                                                              *
// *                                                                                                                         *
// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
// *                                                                                                                         *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
// * specific language governing permissions and limitations under the License.                                              *
// ***************************************************************************************************************************
package org.apache.juneau.http.annotation;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.*;

import java.lang.annotation.*;

import org.apache.juneau.annotation.*;
import org.apache.juneau.httppart.*;
import org.apache.juneau.oapi.*;

/**
 * REST request path annotation.
 *
 * 
 * Identifies a POJO to be used as a path entry on an HTTP request.
 *
 * 

 * Can be used in the following locations:
 * 

 * 	Arguments and argument-types of server-side @RestOp-annotated methods.
 * 	
Arguments and argument-types of client-side @RemoteResource-annotated interfaces.
 * 	
Methods and return types of server-side and client-side @Request-annotated interfaces.
 * 
 *
 * Arguments and argument-types of server-side @RestOp-annotated methods
 * 
 * Annotation that can be applied to a parameter of a @RestOp-annotated method to identify it as a variable
 * in a URL path pattern.
 *
 * 
Example:
 * 
 * 	@RestGet("/myurl/{foo}/{bar}/{baz}/*")
 * 	public void doGet(
 * 			@Path("foo") String foo,
 * 			@Path("bar") int bar,
 * 			@Path("baz") UUID baz,
 * 			@Path("/*") String remainder,
 * 		) {...}
 * 
 *
 * 
 * The special name "/*" is used to retrieve the path remainder after the path match (i.e. the part that matches "/*").
 *
 * 
See Also:

 * 	Swagger
 * 	
Swagger Parameter Object
 * 
 *
 * Arguments and argument-types of client-side @RemoteResource-annotated interfaces
 * 
 * Annotation applied to Java method arguments of interface proxies to denote that they are path variables on the request.
 *
 * 
See Also:

 * 	@Path
 * 
 *
 * Methods and return types of server-side and client-side @Request-annotated interfaces
 * 
 * 
See Also:

 * 	@Request
 * 
 *
 * See Also:


 * 
 */
@Documented
@Target({PARAMETER,METHOD,TYPE,FIELD})
@Retention(RUNTIME)
@Inherited
@Repeatable(PathAnnotation.Array.class)
@ContextApply(PathAnnotation.Applier.class)
public @interface Path {

	/**
	 * Default value for this parameter.
	 *
	 * @return The annotation value.
	 */
	String def() default "";

	/**
	 * URL path variable name.
	 *
	 * 
	 * The path remainder after the path match can be referenced using the name "/*".
	 * 
The non-URL-decoded path remainder after the path match can be referenced using the name "/**".
	 *
	 * 

	 * The value should be either a valid path parameter name, or "*" to represent multiple name/value pairs
	 *
	 * 

	 * A blank value (the default) has the following behavior:
	 * 

	 * 	
	 * 		If the data type is NameValuePairs, Map, or a bean,
	 * 		then it's the equivalent to "*" which will cause the value to be treated as name/value pairs.
	 *
	 * 		Examples:
	 * 		
	 * 	// When used on a REST method
	 * 	@RestPost
	 * 	public void addPet(@Path JsonMap allPathParameters) {...}
	 * 		
	 * 		
	 * 	// When used on a remote method parameter
	 * 	@RemoteResource(path="/myproxy")
	 * 	public interface MyProxy {
	 *
	 * 		// Equivalent to @Path("*")
	 * 		@RemoteGet("/mymethod/{foo}/{bar}")
	 * 		String myProxyMethod1(@Path Map<String,Object> allPathParameters);
	 * 	}
	 * 		
	 * 		
	 * 	// When used on a request bean method
	 * 	public interface MyRequest {
	 *
	 * 		// Equivalent to @Path("*")
	 * 		@Path
	 * 		Map<String,Object> getPathVars();
	 * 	}
	 * 		
	 * 	
	 * 	
	 * 		If used on a request bean method, uses the bean property name.
	 *
	 * 		Example:
	 * 		
	 * 	public interface MyRequest {
	 *
	 * 		// Equivalent to @Path("foo")
	 * 		@Path
	 * 		String getFoo();
	 * 	}
	 * 
	 *
	 * 
	 * The name field MUST correspond to the associated path segment from the path field in the Paths Object.
	 * See Path Templating for further information.
	 *
	 * 
Notes:

	 * 	
	 * 		The format is plain-text.
	 * 
	 *
	 * @return The annotation value.
	 */
	String name() default "";

	/**
	 * Dynamically apply this annotation to the specified classes.
	 *
	 * See Also:

	 * 	Dynamically Applied Annotations
	 * 
	 *
	 * @return The annotation value.
	 */
	String[] on() default {};

	/**
	 * Dynamically apply this annotation to the specified classes.
	 *
	 * 
	 * Identical to {@link #on()} except allows you to specify class objects instead of a strings.
	 *
	 * 
See Also:

	 * 	Dynamically Applied Annotations
	 * 
	 *
	 * @return The annotation value.
	 */
	Class[] onClass() default {};

	/**
	 * Specifies the {@link HttpPartParser} class used for parsing strings to values.
	 *
	 * 
	 * Overrides for this part the part parser defined on the REST resource which by default is {@link OpenApiParser}.
	 *
	 * @return The annotation value.
	 */
	Class parser() default HttpPartParser.Void.class;

	/**
	 * schema field of the Swagger Parameter Object.
	 *
	 * 

	 * The schema defining the type used for parameter.
	 *
	 * 

	 * The {@link Schema @Schema} annotation can also be used standalone on the parameter or type.
	 * Values specified on this field override values specified on the type, and values specified on child types override values
	 * specified on parent types.
	 *
	 * 
Used for:
	 * 
	 * 	
	 * 		Server-side schema-based parsing and parsing validation.
	 * 	

	 * 		Server-side generated Swagger documentation.
	 * 	

	 * 		Client-side schema-based serializing and serializing validation.
	 * 
	 *
	 * @return The annotation value.
	 */
	Schema schema() default @Schema;

	/**
	 * Specifies the {@link HttpPartSerializer} class used for serializing values to strings.
	 *
	 * 
	 * Overrides for this part the part serializer defined on the REST client which by default is {@link OpenApiSerializer}.
	 *
	 * @return The annotation value.
	 */
	Class serializer() default HttpPartSerializer.Void.class;

	/**
	 * A synonym for {@link #name()}.
	 *
	 * 

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

	 * The following are completely equivalent ways of defining a path entry:
	 * 

	 * 	@RestGet("/pet/{petId}")
	 * 	public Pet getPet(@Path(name="petId") long petId) { ... }
	 * 
	 * 
	 * 	@RestGet("/pet/{petId}")
	 * 	public Pet getPet(@Path("petId") long petId) { ... }
	 * 
	 *
	 * @return The annotation value.
	 */
	String value() default "";
}