| <!-- |
| /*************************************************************************************************************************** |
| * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations under the License. |
| ***************************************************************************************************************************/ |
| --> |
| |
| @Header |
| |
| <p> |
| The {@link oaj.http.annotation.Header @Header} annotation is used to retrieve request headers. |
| </p> |
| <ul class='javatree'> |
| <li class='ja'>{@link oaj.http.annotation.Header} |
| <ul> |
| <li class='jf'>{@link oaj.http.annotation.Header#_default() _default} - Default value if not present. |
| <li class='jf'>{@link oaj.http.annotation.Header#_enum() _enum} - Input validation. Must match one of the values. |
| <li class='jf'>{@link oaj.http.annotation.Header#allowEmptyValue() allowEmptyValue} - Input validation. Allow empty value. |
| <li class='jf'>{@link oaj.http.annotation.Header#api() api} - Free-form Swagger JSON. |
| <li class='jf'>{@link oaj.http.annotation.Header#collectionFormat() collectionFormat} - How collections of items are formatted. |
| <li class='jf'>{@link oaj.http.annotation.Header#description() description} - Description. |
| <li class='jf'>{@link oaj.http.annotation.Header#example() example} - Serialized example. |
| <li class='jf'>{@link oaj.http.annotation.Header#exclusiveMaximum() exclusiveMaximum} - Input validation. Whether maximum is exclusive. |
| <li class='jf'>{@link oaj.http.annotation.Header#exclusiveMinimum() exclusiveMinimum} - Input validation. Whether minimum is exclusive. |
| <li class='jf'>{@link oaj.http.annotation.Header#format() format} - The schema type format. |
| <li class='jf'>{@link oaj.http.annotation.Header#items() items} - The schema of items in a collection. |
| <li class='jf'>{@link oaj.http.annotation.Header#maximum() maximum} - Input validation. Maximum numeric value. |
| <li class='jf'>{@link oaj.http.annotation.Header#maxItems() maxItems} - Input validation. Maximum number of items in a collection. |
| <li class='jf'>{@link oaj.http.annotation.Header#maxLength() maxLength} - Input validation. Maximum length of a string. |
| <li class='jf'>{@link oaj.http.annotation.Header#minimum() minimum} - Input validation. Minimum numeric value. |
| <li class='jf'>{@link oaj.http.annotation.Header#minItems() minItems} - Input validation. Minimum number of items in a collection. |
| <li class='jf'>{@link oaj.http.annotation.Header#minLength() minLength} - Input validation. Minimum length of a string. |
| <li class='jf'>{@link oaj.http.annotation.Header#multipleOf() multipleOf} - Input validation. Number must be a multiple of. |
| <li class='jf'>{@link oaj.http.annotation.Header#name() name} - Header name. |
| <li class='jf'>{@link oaj.http.annotation.Header#parser() parser} - Override the part parser. |
| <li class='jf'>{@link oaj.http.annotation.Header#pattern() pattern} - Input validation. Must match regular expression. |
| <li class='jf'>{@link oaj.http.annotation.Header#required() required} - Input validation. Header must be present. |
| <li class='jf'>{@link oaj.http.annotation.Header#type() type} - The schema type. |
| <li class='jf'>{@link oaj.http.annotation.Header#uniqueItems() uniqueItems} - Input validation. Collections must contain unique items only. |
| <li class='jf'>{@link oaj.http.annotation.Header#value() value} - Free-form Swagger JSON. |
| </ul> |
| </ul> |
| <p> |
| The most typical scenario is to simply use the <c>value</c> field to define header parameter names: |
| </p> |
| <h5 class='figure'>Example:</h5> |
| <p class='bpcode w800'> |
| <ja>@RestMethod</ja>(name=<jsf>GET</jsf>) |
| <jk>public void</jk> doGet(<ja>@Header</ja>(<js>"ETag"</js>) UUID etag) {...} |
| </p> |
| <p> |
| This is functionally equivalent to the following code: |
| </p> |
| <p class='bpcode w800'> |
| <ja>@RestMethod</ja>(name=<jsf>GET</jsf>) |
| <jk>public void</jk> doGet(RestRequest req) { |
| RequestHeaders h = req.getHeaders(); |
| UUID etag = h.get(<js>"ETag"</js>, UUID.<jk>class</jk>); |
| } |
| </p> |
| |
| <p> |
| The special name <js>"*"</js> (or blank) can be used to represent all values. |
| When used, the data type must be a <c>Map</c> or bean. |
| </p> |
| <h5 class='figure'>Examples:</h5> |
| <p class='bpcode w800'> |
| <jc>// Multiple values passed as a map.</jc> |
| <ja>@RestMethod</ja>(name=<jsf>GET</jsf>) |
| <jk>public void</jk> doGet(<ja>@Header</ja>(<js>"*"</js>) Map<String,Object> map) {...} |
| </p> |
| <p class='bpcode w800'> |
| <jc>// Same, but name "*" is inferred.</jc> |
| <ja>@RestMethod</ja>(name=<jsf>GET</jsf>) |
| <jk>public void</jk> doGet(<ja>@Header</ja> Map<String,Object> map) {...} |
| </p> |
| <p class='bpcode w800'> |
| <jc>// Multiple values passed as a bean.</jc> |
| <ja>@RestMethod</ja>(name=<jsf>GET</jsf>) |
| <jk>public void</jk> doGet(<ja>@Header</ja> MyBean bean) {...} |
| </p> |
| |
| <p> |
| The registered {@link oajr.RestContext#REST_partParser REST_partParser} is used to convert strings |
| to POJOs and controls what POJO types are supported. |
| By default, this is the {@link oaj.oapi.OpenApiParser} which supports the standard Swagger-based rules for parsing. |
| </p> |
| <p> |
| For example, the following shows how a pipe-delimited list of comma-delimited numbers (e.g. <js>"1,2,3|4,5,6|7,8,9"</js>) can be converted to a 2-dimensional array of <c>Longs</c>: |
| </p> |
| <p class='bpcode w800'> |
| <ja>@RestMethod</ja>(method=<js>"GET"</js>, path=<js>"/testHeader"</js>) |
| <jk>public void</jk> testHeader( |
| <ja>@Header</ja>( |
| name=<js>"My-Header"</js>, |
| collectionFormat=<js>"pipes"</js>, |
| items=<ja>@SubItems</ja>( |
| collectionFormat=<js>"csv"</js>, |
| type=<js>"integer"</js>, |
| format=<js>"int64"</js>, |
| minimum=<js>"0"</js>, |
| maximum=<js>"100"</js> |
| minLength=1, |
| maxLength=10 |
| ), |
| minLength=1, |
| maxLength=10 |
| ) |
| Long[][] myHeader |
| ) {...} |
| </p> |
| <p> |
| Input will be converted based on the types and formats defined in the schema definition. |
| Input validations such as <c>minLength/maxLength</c> that don't match the input will result in automatic <c>400 Bad Request</c> responses. |
| </p> |
| <p> |
| For more information about valid parameter types, see {@doc juneau-marshall.OpenApiDetails.Parsers OpenAPI Parsers} |
| </p> |
| |
| <p> |
| The <ja>@Header</ja> annotation is also used for supplying swagger information about the HTTP part. |
| This information is used to populate the auto-generated Swagger documentation and UI. |
| </p> |
| <h5 class='figure'>Examples:</h5> |
| <p class='bpcode w800'> |
| <jc>// Normal</jc> |
| <ja>@Header</ja>( |
| name=<js>"Pet-Name"</js>, |
| description=<js>"Pet name"</js>, |
| required=<jk>true</jk>, |
| example=<js>"Doggie"</js> |
| ) |
| </p> |
| <p class='bpcode w800'> |
| <jc>// Free-form</jc> |
| <jc>// Note the extra field</jc> |
| <ja>@Header</ja>( |
| name=<js>"Pet-Name"</js>, |
| api={ |
| <js>"description: 'Pet name',"</js>, |
| <js>"required: true,"</js>, |
| <js>"example: 'Doggie',"</js> |
| <js>"x-extra: 'extra field'"</js> |
| } |
| ) |
| </p> |
| <p> |
| {@doc DefaultRestSvlVariables} (e.g. "$L{my.localized.variable}") |
| are supported on annotation fields. |
| </p> |
| <h5 class='figure'>Example:</h5> |
| <p class='bpcode w800'> |
| <ja>@Header</ja>( |
| description=<js>"$L{PetNameDescription}"</js> |
| ) |
| </p> |
| |
| <ul class='seealso'> |
| <li class='jc'>{@link oajr.RequestHeaders} |
| <li class='link'>{@doc juneau-rest-server.OpenApiSchemaPartParsing} |
| </ul> |