Top Description Methods
org.eclipse.microprofile.rest.client.annotation

public @Interface RegisterClientHeaders

extends Annotation
Annotations
@Target:TYPE
@Retention:RUNTIME
@Documented
Imports
java.lang.annotation.Documented, .ElementType, .Retention, .RetentionPolicy, .Target, org.eclipse.microprofile.rest.client.ext.ClientHeadersFactory, .DefaultClientHeadersFactoryImpl

Used to specify that a ClientHeadersFactory should be used to generate or propagate HTTP headers on the outbound request. When annotation is placed at the interface level of a Rest Client interface, the implementation will invoke the ClientHeadersFactory's update method.

If no implementation class of the ClientHeadersFactory interface is specified in the annotation, then the DefaultClientHeadersFactoryImpl will be used. This implementation will simply propagate headers (specified via MP Config property) from an inbound Jakarta RESTful Web Services request (if applicable) to the outbound request.

If a ClientHeadersFactory class specified is not found on the classpath, this should be considered a deployment exception.

Since
1.2

Method Summary

Modifier and TypeMethod and Description
public Class<? extends ClientHeadersFactory>

Returns:

the provider class to register on this client interface
value
()

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

valueback to summary
public Class<? extends ClientHeadersFactory> value()
Returns:Class<? extends ClientHeadersFactory>

the provider class to register on this client interface