Package org.apache.juneau.http

Annotation Interface Header

@Documented @Target({PARAMETER,METHOD,TYPE,FIELD}) @Retention(RUNTIME) @Inherited public @interface Header
REST request header annotation.

Identifies a POJO to be used as the header of an HTTP request.

Can be used in the following locations:

  • Arguments and argument-types of server-side @RestOp-annotated methods.
  • Arguments and argument-types of client-side @RemoteResource-annotated interfaces.
  • Methods and return types of server-side and client-side @Request-annotated interfaces.
Arguments and argument-types of server-side @RestOp-annotated methods

Annotation that can be applied to a parameter of a @RestOp-annotated method to identify it as a HTTP request header.

Example:

@RestGet public void doGet(@Header("ETag") UUID etag) {...}

This is functionally equivalent to the following code...

@RestGet public void doGet(RestRequest req, RestResponse res) { UUID etag = req.getHeader("ETag").as(UUID.class).orElse(null); ... }

See Also:
Arguments and argument-types of client-side @RemoteResource-annotated interfaces

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

See Also:
Methods and return types of server-side and client-side @Request-annotated interfaces

See Also:

  • Element Details

    • def

      String def
      Default value for this parameter.
      Returns:
      The annotation value.
      Default:
      ""

    • description

      String[] description
      Optional description for the exposed API.
      Returns:
      The annotation value.
      Since:
      9.2.0
      Default:
      {}

    • summary

      String summary
      Short, concise summary of the exposed API.

      Intended as a brief, single-line description suitable for AI/LLM consumption, compact documentation, or any context where brevity matters. See Schema.summary() for the canonical definition.

      Returns:
      The annotation value.
      Since:
      10.0.0
      Default:
      ""

    • name

      String name
      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 a valid HTTP header name, or "*" to represent multiple name/value pairs

      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.
        Examples:

        // When used on a REST method @RestPost("/addPet") public void addPet(@Header JsonMap allHeaderParameters) {...}

        // When used on a remote method parameter @RemoteResource(path="/myproxy") public interface MyProxy { // Equivalent to @Header("*") @RemoteGet("/mymethod") String myProxyMethod1(@Header Map<String,Object> allHeaderParameters); }

        // When used on a request bean method public interface MyRequest { // Equivalent to @Header("*") @Header Map<String,Object> getFoo(); }

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

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

      Returns:
      The annotation value.
      Default:
      ""

    • schema

      Schema schema
      schema field of the Swagger Parameter Object.

      The schema defining the type used for parameter.

      The @Schema annotation can also be used standalone on the parameter or type. Values specified on this field override values specified on the type, and values specified on child types override values specified on parent types.

      Used for:
      • Server-side schema-based parsing and parsing validation.
      • Server-side generated Swagger documentation.
      • Client-side schema-based serializing and serializing validation.
      Returns:
      The annotation value.
      Default:
      @org.apache.juneau.commons.Schema

    • value

      String value
      A synonym for name().

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

      The following are completely equivalent ways of defining a header entry:

      public Order placeOrder(@Header(name="api_key") String apiKey) {...}

      public Order placeOrder(@Header("api_key") String apiKey) {...}

      Returns:
      The annotation value.
      Default:
      ""