org.apache.juneau.rest.annotation

Annotation Type Header

@Documented
 @Target(value=PARAMETER)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Header

Annotation that can be applied to a parameter of a @RestMethod annotated method to identify it as a HTTP request header converted to a POJO.

Example:

@RestMethod(name=GET) public void doGet(RestRequest req, RestResponse res, @Header("ETag") UUID etag) { ... }

This is functionally equivalent to the following code...

@RestMethod(name=GET) public void doPostPerson(RestRequest req, RestResponse res) { UUID etag = req.getHeader(UUID.class, "ETag"); ... }

See Also:

• Overview > juneau-rest-server > @Header

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	def The default value for this header if it's not present in the request.
String	name HTTP header name.
Class<? extends HttpPartParser>	parser Specifies the HttpPartParser class used for parsing values from strings.
String	value A synonym for name().

Element Detail

def

public abstract String def

The default value for this header if it's not present in the request.

Default:

""

name

public abstract String name

HTTP header name.

Default:

""

parser

public abstract Class<? extends HttpPartParser> parser

Specifies the HttpPartParser class used for parsing values from strings.

The default value for this parser is inherited from the servlet/method which defaults to UonPartParser.
You can use SimplePartParser to parse POJOs that are directly convertible from Strings.

Default:

org.apache.juneau.httppart.HttpPartParser.Null.class

value

public abstract String value

A synonym for name().

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

Default:

""