Package org.apache.juneau.bean.openapi3

Class HeaderInfo

java.lang.Object
org.apache.juneau.bean.openapi3.OpenApiElement
org.apache.juneau.bean.openapi3.HeaderInfo
public class HeaderInfo extends OpenApiElement
Describes a single HTTP header.

The Header Object follows the structure of the Parameter Object with the following changes: it does not have a name field since the header name is specified in the key, and it does not have a required field since headers are always optional in HTTP.

OpenAPI Specification:

The Header Object is composed of the following fields:

  • description (string) - A brief description of the header (CommonMark syntax may be used)
  • required (boolean) - Determines whether this header is mandatory (default is false)
  • deprecated (boolean) - Specifies that a header is deprecated
  • allowEmptyValue (boolean) - Sets the ability to pass empty-valued headers
  • style (string) - Describes how the header value will be serialized
  • explode (boolean) - When true, header values of type array or object generate separate headers for each value
  • allowReserved (boolean) - Determines whether the header value should allow reserved characters
  • schema (SchemaInfo) - The schema defining the type used for the header
  • example (any) - Example of the header's potential value
  • examples (map of Example) - Examples of the header's potential value
Example:

// Construct using SwaggerBuilder. HeaderInfo x = headerInfo("integer").description("The number of allowed requests in the current period"); // Serialize using JsonSerializer. String json = Json.from(x); // Or just use toString() which does the same as above. String json = x.toString();

// Output { "description": "The number of allowed requests in the current period", "type": "integer" }

See Also:

  • Constructor Details

    • HeaderInfo

      public HeaderInfo()
      Default constructor.

    • HeaderInfo

      public HeaderInfo(HeaderInfo copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The object to copy.

  • Method Details

    • copy

      public HeaderInfo copy()
      Make a deep copy of this object.
      Returns:
      A deep copy of this object.

    • strict

      protected HeaderInfo strict()
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Returns:
      This object

    • strict

      public HeaderInfo strict(Object value)
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Parameters:
      value - The new value for this property.
      Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
      Can be null (interpreted as false).
      Returns:
      This object

    • getDescription

      public String getDescription()
      Bean property getter: description.

      A short description of the header.

      Returns:
      The property value, or null if it is not set.

    • setDescription

      public HeaderInfo setDescription(String value)
      Bean property setter: description.

      A short description of the header.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getRequired

      public Boolean getRequired()
      Bean property getter: required.

      The type of the object.

      Returns:
      The property value, or null if it is not set.

    • setRequired

      public HeaderInfo setRequired(Boolean value)
      Bean property setter: required.

      The type of the object.

      Parameters:
      value - The new value for this property.
      Property value is required.
      Valid values:
      • "string"
      • "number"
      • "integer"
      • "boolean"
      • "array"

      Can be null to unset the property.
      Returns:
      This object

    • getExplode

      public Boolean getExplode()
      Bean property getter: required.

      The type of the object.

      Returns:
      The property value, or null if it is not set.

    • setExplode

      public HeaderInfo setExplode(Boolean value)
      Bean property setter: explode.

      The type of the object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getDeprecated

      public Boolean getDeprecated()
      Bean property getter: deprecated.

      The type of the object.

      Returns:
      The property value, or null if it is not set.

    • setDeprecated

      public HeaderInfo setDeprecated(Boolean value)
      Bean property setter: deprecated.

      The type of the object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getAllowEmptyValue

      public Boolean getAllowEmptyValue()
      Bean property getter: allowEmptyValue.

      The type of the object.

      Returns:
      The property value, or null if it is not set.

    • setAllowEmptyValue

      public HeaderInfo setAllowEmptyValue(Boolean value)
      Bean property setter: allowEmptyValue.

      The type of the object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getAllowReserved

      public Boolean getAllowReserved()
      Bean property getter: allowReserved.

      The type of the object.

      Returns:
      The property value, or null if it is not set.

    • setAllowReserved

      public HeaderInfo setAllowReserved(Boolean value)
      Bean property setter: allowReserved.

      The type of the object.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getSchema

      public SchemaInfo getSchema()
      Bean property getter: schema.
      Returns:
      The property value, or null if it is not set.

    • setSchema

      public HeaderInfo setSchema(SchemaInfo value)
      Bean property setter: schema.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getRef

      @Beanp("$ref") public String getRef()
      Bean property getter: $ref.
      Returns:
      The property value, or null if it is not set.

    • setRef

      @Beanp("$ref") public HeaderInfo setRef(String value)
      Bean property setter: $ref.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getExample

      @Beanp("x-example") public Object getExample()
      Bean property getter: x-example.
      Returns:
      The property value, or null if it is not set.

    • setExample

      @Beanp("x-example") public HeaderInfo setExample(Object value)
      Bean property setter: examples.
      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • getExamples

      public Map<String,Example> getExamples()
      Bean property getter: examples.

      The list of possible responses as they are returned from executing this operation.

      Returns:
      The property value, or null if it is not set.

    • setExamples

      public HeaderInfo setExamples(Map<String,Example> value)
      Bean property setter: headers.

      A list of examples that are sent with the response.

      Parameters:
      value - The new value for this property.
      Can be null to unset the property.
      Returns:
      This object

    • addExample

      public HeaderInfo addExample(String name, Example example)
      Adds a single value to the examples property.
      Parameters:
      name - The example name. Must not be null.
      example - The example. Must not be null.
      Returns:
      This object

    • get

      public <T> T get(String property, Class<T> type)
      Description copied from class: OpenApiElement
      Generic property getter.

      Can be used to retrieve non-standard Swagger fields such as "$ref".

      Overrides:
      get in class OpenApiElement
      Type Parameters:
      T - The datatype to cast the value to.
      Parameters:
      property - The property name to retrieve.
      type - The datatype to cast the value to.
      Returns:
      The property value, or null if the property does not exist or is not set.

    • set

      public HeaderInfo set(String property, Object value)
      Description copied from class: OpenApiElement
      Generic property setter.

      Can be used to set non-standard Swagger fields such as "$ref".

      Overrides:
      set in class OpenApiElement
      Parameters:
      property - The property name to set. Must not be null.
      value - The new value for the property.
      Returns:
      This object

    • keySet

      public Set<String> keySet()
      Description copied from class: OpenApiElement
      Returns all the keys on this element.
      Overrides:
      keySet in class OpenApiElement
      Returns:
      All the keys on this element.
      Never null.

    • resolveRefs

      public HeaderInfo resolveRefs(OpenApi openApi, Deque<String> refStack, int maxDepth)
      Resolves any "$ref" attributes in this element.
      Parameters:
      openApi - The swagger document containing the definitions.
      refStack - Keeps track of previously-visited references so that we don't cause recursive loops.
      maxDepth - The maximum depth to resolve references.
      After that level is reached, $ref references will be left alone.
      Useful if you have very complex models and you don't want your swagger page to be overly-complex.
      Returns:
      This object with references resolved.
      May or may not be the same object.