Package org.apache.juneau.rest.arg

Class HeaderArg

java.lang.Object

org.apache.juneau.rest.arg.HeaderArg

All Implemented Interfaces:

RestOpArg

public class HeaderArg
extends Object
implements RestOpArg

Resolves method parameters and parameter types annotated with Header on RestOp-annotated Java methods.

This includes any of the following predefined request header types:

• Accept
• AcceptCharset
• AcceptEncoding
• AcceptLanguage
• AcceptRanges
• Authorization
• CacheControl
• ClientVersion
• Connection
• ContentDisposition
• ContentEncoding
• ContentLength
• ContentType
• Date
• Debug
• Expect
• Forwarded
• From
• Host
• IfMatch
• IfModifiedSince
• IfNoneMatch
• IfRange
• IfUnmodifiedSince
• MaxForwards
• NoTrace
• Origin
• Pragma
• ProxyAuthorization
• Range
• Referer
• TE
• Thrown
• Upgrade
• UserAgent
• Warning

The parameter value is resolved using:

opSession .getRequest() .getHeaders();

schema is derived from the Header annotation.

If the Schema.collectionFormat() value is HttpPartCollectionFormat.MULTI, then the data type can be a Collection or array.

See Also:

• Java Method Parameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HeaderArg(ParameterInfo pi, AnnotationWorkList annotations)	Constructor.

Method Summary

Modifier and Type	Method	Description
static HeaderArg	create(ParameterInfo paramInfo, AnnotationWorkList annotations)	Static creator.
Object	resolve(RestOpSession opSession)	Resolves the parameter object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HeaderArg

protected HeaderArg(ParameterInfo pi,
 AnnotationWorkList annotations)

Constructor.

Parameters:

pi - The Java method parameter being resolved.

annotations - The annotations to apply to any new part parsers.

Method Details

create

public static HeaderArg create(ParameterInfo paramInfo,
 AnnotationWorkList annotations)

Static creator.

Parameters:

paramInfo - The Java method parameter being resolved.

annotations - The annotations to apply to any new part parsers.

Returns:

A new HeaderArg, or null if the parameter is not annotated with Header.

resolve

public Object resolve(RestOpSession opSession)
               throws Exception

Description copied from interface: RestOpArg

Resolves the parameter object.

Specified by:

resolve in interface RestOpArg

Parameters:

opSession - The rest call.

Returns:

The resolved object.

Throws:

Exception - Generic error occurred.