org.apache.juneau.remoteable

Annotation Type Header

@Documented
 @Target(value={PARAMETER,FIELD,METHOD})
 @Retention(value=RUNTIME)
 @Inherited
public @interface Header

Annotation applied to Java method arguments of interface proxies to denote that they are serialized as an HTTP header value.

Example:

@Remoteable(path="/myproxy") public interface MyProxy { // Explicit names specified for HTTP headers. // pojo will be converted to UON notation (unless plain-text parts enabled). @RemoteMethod(path="/mymethod1") String myProxyMethod1(@Header("Foo") String foo, @Header("Bar") MyPojo pojo); // Multiple values pulled from a NameValuePairs object. // Same as @Header("*"). @RemoteMethod(path="/mymethod2") String myProxyMethod2(@Header NameValuePairs nameValuePairs); // Multiple values pulled from a Map. // Same as @Header("*"). @RemoteMethod(path="/mymethod3") String myProxyMethod3(@Header Map<String,Object> map); // Multiple values pulled from a bean. // Same as @Header("*"). @RemoteMethod(path="/mymethod4") String myProxyMethod4(@Header MyBean myBean); }

The annotation can also be applied to a bean property field or getter when the argument is annotated with @RequestBean:

Example:

@Remoteable(path="/myproxy") public interface MyProxy { @RemoteMethod(path="/mymethod") String myProxyMethod(@RequestBean MyRequestBean bean); } public interface MyRequestBean { // Name explicitly specified. @Header("Foo") String getX(); // Name inherited from bean property. // Same as @Header("bar") @Header String getBar(); // Name inherited from bean property. // Same as @Header("Baz") @Header @BeanProperty("Baz") String getY(); // Multiple values pulled from NameValuePairs object. // Same as @Header("*") @Header NameValuePairs getNameValuePairs(); // Multiple values pulled from Map. // Same as @Header("*") @Header Map<String,Object> getMap(); // Multiple values pulled from bean. // Same as @Header("*") @Header MyBean getBean(); }

The name() and value() elements are synonyms for specifying the header name. Only one should be used.
The following annotations are fully equivalent:

@Header(name="Foo") @Header("Foo")

See Also:

• Overview > juneau-rest-client > Interface Proxies Against 3rd-party REST Interfaces

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	name The HTTP header name.
Class<? extends HttpPartSerializer>	serializer Specifies the HttpPartSerializer class used for serializing values to strings.
boolean	skipIfEmpty Skips this value if it's an empty string or empty collection/array.
String	value A synonym for name().

Element Detail

name

public abstract String name

The HTTP header name.

A blank value (the default) indicates to reuse the bean property name when used on a request bean property.

The value should be either "*" to represent multiple name/value pairs, or a label that defines the header name.

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 serialized as name/value pairs.

  Example:

  // When used on a remote method parameter @Remoteable(path="/myproxy") public interface MyProxy { // Equivalent to @Header("*") @RemoteMethod(path="/mymethod") String myProxyMethod1(@Header Map<String,Object> headers); } // When used on a request bean method public interface MyRequestBean { // Equivalent to @Header("*") @Header Map<String,Object> getFoo(); }

• If used on a request bean method, uses the bean property name.

  Example:

  public interface MyRequestBean { // Equivalent to @Header("Foo") @Header @BeanProperty("Foo") String getFoo(); }

Default:

""

value

public abstract String value

A synonym for name().

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

Default:

""

skipIfEmpty

public abstract boolean skipIfEmpty

Skips this value if it's an empty string or empty collection/array.

Note that null values are already ignored.

Default:

false

serializer

public abstract Class<? extends HttpPartSerializer> serializer

Specifies the HttpPartSerializer class used for serializing values to strings.

The default value defaults to the using the part serializer defined on the @RequestBean annotation, then on the client which by default is UrlEncodingSerializer.

This annotation is provided to allow values to be custom serialized.

Default:

org.apache.juneau.httppart.HttpPartSerializer.Null.class