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:

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:

  • Constructor Details

    • HeaderArg

      protected HeaderArg(ParamInfo 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(ParamInfo 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.