Package org.forgerock.http.header

Class ContentApiVersionHeader

java.lang.Object
org.forgerock.http.protocol.Header
org.forgerock.http.header.ContentApiVersionHeader
public final class ContentApiVersionHeader extends Header
Processes the Content-API-Version message header. Represents the protocol and resource versions of the returned content.

  • Field Details

  • Constructor Details

    • ContentApiVersionHeader

      public ContentApiVersionHeader(Version protocolVersion, Version resourceVersion)
      Constructs a new header, initialized with the specified protocol and resource versions.
      Parameters:
      protocolVersion - The protocol version of the content of the returned content.
      resourceVersion - The resource version of the returned content.

  • Method Details

    • valueOf

      public static ContentApiVersionHeader valueOf(Message<?> message)
      Constructs a new header, initialized from the specified message.
      Parameters:
      message - The message to initialize the header from.
      Returns:
      The parsed header.

    • valueOf

      public static ContentApiVersionHeader valueOf(String headerValue)
      Constructs a new header, initialized from the specified string.
      Parameters:
      headerValue - The value to initialize the header from.
      Returns:
      The parsed header.

    • getName

      public String getName()
      Description copied from class: Header
      Returns the name of the header, as it would canonically appear within an HTTP message.
      Specified by:
      getName in class Header
      Returns:
      The name of the header, as it would canonically appear within an HTTP message.

    • getProtocolVersion

      public Version getProtocolVersion()
      Gets the protocol version of the content of the returned content.
      Returns:
      The protocol version of the content of the returned content.

    • getResourceVersion

      public Version getResourceVersion()
      Gets the resource version of the returned content.
      Returns:
      The resource version of the returned content.

    • getValues

      public List<String> getValues()
      Description copied from class: Header
      Returns the header as a list of strings. If the header has no values then it must return an empty list, never null. Each String should represent the value component of the key-value pair that makes up the HTTP header - as such, for some Header implementations each String in this List may contain multiple token-separated values.

      The List returned from this method should not be expected to be mutable. However, some subclasses of Header may choose to implement it as such.

      Specified by:
      getValues in class Header
      Returns:
      The header as a non-null list of string values. Can be an empty list.