feign.Headers Maven / Gradle / Ivy

Go to download
package feign;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Expands headers supplied in the {@code value}.  Variables are permitted as values. 

 *  * @Headers("Content-Type: application/xml")
 * interface SoapApi {
 * ...   
 * @RequestLine("GET /")
 * @Headers("Cache-Control: max-age=640000")
 * ...
 *
 * @RequestLine("POST /")
 * @Headers({
 *   "X-Foo: Bar",
 *   "X-Ping: {token}"
 * }) void post(@Param("token") String token);
 * ...
 * 
 * 
 Note: Headers do not overwrite each other. All headers with the same name
 * will be included in the request. 

Relationship to JAXRS
 
 The following two
 * forms are identical. 
 Feign:
 *  * @RequestLine("POST /")
 * @Headers({
 *   "X-Ping: {token}"
 * }) void post(@Named("token") String token);
 * ...
 * 
 * 
 JAX-RS:
 *  * @POST @Path("/")
 * void post(@HeaderParam("X-Ping") String token);
 * ...
 * 
 */
@Target({METHOD, TYPE})
@Retention(RUNTIME)
public @interface Headers {

  String[] value();
}