Package org.forgerock.http.header

Class AcceptApiVersionHeader

java.lang.Object
org.forgerock.http.protocol.Header
org.forgerock.http.header.AcceptApiVersionHeader
public final class AcceptApiVersionHeader extends Header
Processes the Accept-API-Version message header. Represents the accepted protocol and resource versions.

  • Field Details

  • Constructor Details

    • AcceptApiVersionHeader

      public AcceptApiVersionHeader(Version protocol, Version resource)
      Constructs a new header, initialized with the specified protocol and resource versions.
      Parameters:
      protocol - The accepted protocol version.
      resource - The accepted resource version.

  • Method Details

    • valueOf

      public static AcceptApiVersionHeader 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.
      Throws:
      IllegalArgumentException - If the version header is in an invalid format.

    • valueOf

      public static AcceptApiVersionHeader valueOf(String string)
      Constructs a new header, initialized from the specified string value.
      Parameters:
      string - The value to initialize the header from.
      Returns:
      The parsed header.
      Throws:
      IllegalArgumentException - If the version header is in an invalid format.

    • 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 acceptable protocol version.
      Returns:
      The acceptable protocol version.

    • getResourceVersion

      public Version getResourceVersion()
      Gets the acceptable resource version.
      Returns:
      The acceptable resource version.

    • withDefaultProtocolVersion

      public AcceptApiVersionHeader withDefaultProtocolVersion(Version version)
      Will set the accepted protocol version, if not provided in the Accept-API-Version header.
      Parameters:
      version - The default protocol version.
      Returns:
      The accept api version header.

    • withDefaultResourceVersion

      public AcceptApiVersionHeader withDefaultResourceVersion(Version version)
      Will set the accepted resource version, if not provided in the Accept-API-Version header.
      Parameters:
      version - The default resource version.
      Returns:
      The accept api version header.

    • 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.