Package org.eclipse.microprofile.rest.client.annotation

Annotation Interface ClientHeaderParam

@Target({TYPE,METHOD})
@Retention(RUNTIME)
@Documented
@Repeatable(ClientHeaderParams.class)
public @interface ClientHeaderParam

Used to specify an HTTP parameter that should be sent with the outbound request. When this annotation is placed at the interface level of a REST client interface, the specified header will be sent on each request for all methods in the interface. When this annotation is placed on a method, the header will be sent only for that method. If the same HTTP header is specified in an annotation for both the type and the method, only the header value specified in the annotation on the method will be sent.

The value of the header to send can be specified explicitly by using the value attribute. The value can also be computed via a default method on the client interface or a public static method on a different class. The compute method must return a String or String[] (indicating a multivalued header) value. This method must be specified in the value attribute but wrapped in curly-braces. The compute method's signature must either contain no arguments or a single String argument. The String argument is the name of the header.

Here is an example that explicitly defines a header value and computes a value:

 public interface MyClient {

    static AtomicInteger counter = new AtomicInteger(1);

    default String determineHeaderValue(String headerName) {
        if ("SomeHeader".equals(headerName)) {
            return "InvokedCount " + counter.getAndIncrement();
        }
        throw new UnsupportedOperationException("unknown header name");
    }

    @ClientHeaderParam(name="SomeHeader", value="ExplicitlyDefinedValue")
    @GET
    Response useExplicitHeaderValue();

    @ClientHeaderParam(name="SomeHeader", value="{determineHeaderValue}")
    @DELETE
    Response useComputedHeaderValue();
 }
 

The implementation should fail to deploy a client interface if the annotation contains a @ClientHeaderParam annotation with a value attribute that references a method that does not exist, or contains an invalid signature.

The required attribute will determine what action the implementation should take if the method specified in the value attribute throws an exception. If the attribute is true (default), then the implementation will abort the request and will throw the exception back to the caller. If the required attribute is set to false, then the implementation will not send this header if the method throws an exception.

Note that if an interface method contains an argument annotated with @HeaderParam, that argument will take priority over anything specified in a ClientHeaderParam annotation.

Since:

1.2

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	name
String[]	value

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	required

Element Details

name

String name

Returns:

the name of the HTTP header.

value

String[] value

Returns:

the value(s) of the HTTP header - or the method to invoke to get the value (surrounded by curly braces).

required

boolean required

Returns:

whether to abort the request if the method to compute the header value throws an exception (true; default) or just skip this header (false)

Default:

true