Package org.forgerock.http.protocol

Class Header

java.lang.Object
org.forgerock.http.protocol.Header
Direct Known Subclasses:
AbstractSetCookieHeader, AcceptApiVersionHeader, AcceptLanguageHeader, AuthorizationHeader, ConnectionHeader, ContentApiVersionHeader, ContentEncodingHeader, ContentLengthHeader, ContentTypeHeader, CookieHeader, ForwardedHeader, GenericHeader, LocationHeader, ReferrerHeader, TrailerHeader, TransactionIdHeader, WarningHeader, WwwAuthenticateHeader, XForwardedForHeader
public abstract class Header extends Object
An HTTP message header.

  • Constructor Details

    • Header

      public Header()

  • Method Details

    • getName

      public abstract String getName()
      Returns the name of the header, as it would canonically appear within an HTTP message.
      Returns:
      The name of the header, as it would canonically appear within an HTTP message.

    • getValues

      public abstract List<String> getValues()
      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.

      Returns:
      The header as a non-null list of string values. Can be an empty list.

    • getFirstValue

      public String getFirstValue()
      Gets the first value of this header instance. As with getValues(), the returned String may contain multiple token-separated values.
      Returns:
      The first value, or null if none exist.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object