Package com.helger.http.header

Class HttpHeaderMap

java.lang.Object
com.helger.http.header.HttpHeaderMap
All Implemented Interfaces:
com.helger.base.clone.ICloneable<HttpHeaderMap>, com.helger.base.iface.IHasSize, com.helger.base.state.IClearable, com.helger.collection.commons.ICommonsIterable<Map.Entry<String,com.helger.collection.commons.ICommonsList<String>>>, Iterable<Map.Entry<String,com.helger.collection.commons.ICommonsList<String>>>
@NotThreadSafe public class HttpHeaderMap extends Object implements com.helger.collection.commons.ICommonsIterable<Map.Entry<String,com.helger.collection.commons.ICommonsList<String>>>, com.helger.base.clone.ICloneable<HttpHeaderMap>, com.helger.base.state.IClearable
Abstracts HTTP header interface for external usage.
Note: since version 9.1.8 (issue #11) the internal scheme changed and the original case is stored. Older versions always stored the lower case header names. The implications are that the casing of the first header is sustained. So if the first API call uses name "Foo" and the second is "foo" they both refer to the same header name and "Foo" will be the name that is retrieved.
Since:
9.0.0
Author:
Philip Helger

  • Field Details

    • SEPARATOR_KEY_VALUE

      public static final String SEPARATOR_KEY_VALUE
      The separator between key and value
      See Also:

    • DEFAULT_QUOTE_IF_NECESSARY

      public static final boolean DEFAULT_QUOTE_IF_NECESSARY
      Default quote if necessary: false (since v10)
      See Also:

  • Constructor Details

    • HttpHeaderMap

      public HttpHeaderMap()
      Default constructor.

    • HttpHeaderMap

      public HttpHeaderMap(@NonNull HttpHeaderMap aOther)
      Copy constructor.
      Parameters:
      aOther - Map to copy from. May not be null.

  • Method Details

    • getUnifiedValue

      public static @NonNull String getUnifiedValue(@Nullable String sValue)
      Avoid having header values spanning multiple lines. This has been deprecated by RFC 7230 and Jetty 9.3 refuses to parse these requests with HTTP 400 by default.
      Since v9.3.6 this method also takes care of quoting header values correctly. If the value does not correspond to a token according to RFC 2616 chapter 2.2, the value is enclosed in double quotes.
      Parameters:
      sValue - The source header value. May be null.
      Returns:
      The unified header value without \r, \n and \t. Never null.

    • getUnifiedValue

      public static @NonNull String getUnifiedValue(@Nullable String sValue, boolean bQuoteIfNecessary)
      Avoid having header values spanning multiple lines. This has been deprecated by RFC 7230 and Jetty 9.3 refuses to parse these requests with HTTP 400 by default.
      Parameters:
      sValue - The source header value. May be null.
      bQuoteIfNecessary - true if automatic quoting according to RFC 2616, chapter 2.2 should be used if necessary.
      Returns:
      The unified header value without \r, \n and \t. Never null.
      Since:
      9.3.6

    • removeAll

      public @NonNull com.helger.base.state.EChange removeAll()
      Remove all contained headers.
      Specified by:
      removeAll in interface com.helger.base.state.IClearable
      Returns:
      EChange.

    • setHeader

      public void setHeader(@Nonempty @NonNull @Nonempty String sName, @Nullable String sValue)
      Set the passed header as is.
      Parameters:
      sName - Header name. May neither be null nor empty.
      sValue - The value to be set. May be null in which case nothing happens.

    • addHeader

      public void addHeader(@Nonempty @NonNull @Nonempty String sName, @Nullable String sValue)
      Add the passed header as is.
      Parameters:
      sName - Header name. May neither be null nor empty.
      sValue - The value to be set. May be null in which case nothing happens.

    • getDateTimeAsString

      public static @NonNull String getDateTimeAsString(@NonNull ZonedDateTime aDT)
      Convert a ZonedDateTime to a string suitable for use in HTTP date headers according to RFC 822.
      Parameters:
      aDT - The date time to convert. May not be null.
      Returns:
      The formatted date string. Never null.

    • getDateTimeAsString

      public static @NonNull String getDateTimeAsString(@NonNull LocalDateTime aLDT)
      Convert a LocalDateTime to a string suitable for use in HTTP date headers according to RFC 822.
      Parameters:
      aLDT - The local date time to convert. May not be null.
      Returns:
      The formatted date string. Never null.

    • setDateHeader

      public void setDateHeader(@Nonempty @NonNull @Nonempty String sName, long nMillis)
      Set the passed header as a date header.
      Parameters:
      sName - Header name. May neither be null nor empty.
      nMillis - The milliseconds to set as a date.

    • setDateHeader

      public void setDateHeader(@Nonempty @NonNull @Nonempty String sName, @NonNull LocalDate aLD)
      Set the passed header as a date header.
      Parameters:
      sName - Header name. May neither be null nor empty.
      aLD - The LocalDate to set as a date. The time is set to start of day. May not be null.

    • setDateHeader

      public void setDateHeader(@Nonempty @NonNull @Nonempty String sName, @NonNull LocalDateTime aLDT)
      Set the passed header as a date header.
      Parameters:
      sName - Header name. May neither be null nor empty.
      aLDT - The LocalDateTime to set as a date. May not be null.

    • setDateHeader

      public void setDateHeader(@Nonempty @NonNull @Nonempty String sName, @NonNull ZonedDateTime aDT)
      Set the passed header as a date header.
      Parameters:
      sName - Header name. May neither be null nor empty.
      aDT - The DateTime to set as a date. May not be null.

    • addDateHeader

      public void addDateHeader(@Nonempty @NonNull @Nonempty String sName, long nMillis)
      Add the passed header as a date header.
      Parameters:
      sName - Header name. May neither be null nor empty.
      nMillis - The milliseconds to set as a date.

    • addDateHeader

      public void addDateHeader(@Nonempty @NonNull @Nonempty String sName, @NonNull LocalDate aLD)
      Add the passed header as a date header.
      Parameters:
      sName - Header name. May neither be null nor empty.
      aLD - The LocalDate to set as a date. The time is set to start of day. May not be null.

    • addDateHeader

      public void addDateHeader(@Nonempty @NonNull @Nonempty String sName, @NonNull LocalDateTime aLDT)
      Add the passed header as a date header.
      Parameters:
      sName - Header name. May neither be null nor empty.
      aLDT - The LocalDateTime to set as a date. May not be null.

    • addDateHeader

      public void addDateHeader(@Nonempty @NonNull @Nonempty String sName, @NonNull ZonedDateTime aDT)
      Add the passed header as a date header.
      Parameters:
      sName - Header name. May neither be null nor empty.
      aDT - The DateTime to set as a date. May not be null.

    • setIntHeader

      public void setIntHeader(@Nonempty @NonNull @Nonempty String sName, int nValue)
      Set the passed header as a number.
      Parameters:
      sName - Header name. May neither be null nor empty.
      nValue - The value to be set. May not be null.

    • addIntHeader

      public void addIntHeader(@Nonempty @NonNull @Nonempty String sName, int nValue)
      Add the passed header as a number.
      Parameters:
      sName - Header name. May neither be null nor empty.
      nValue - The value to be set. May not be null.

    • setLongHeader

      public void setLongHeader(@Nonempty @NonNull @Nonempty String sName, long nValue)
      Set the passed header as a number.
      Parameters:
      sName - Header name. May neither be null nor empty.
      nValue - The value to be set. May not be null.

    • addLongHeader

      public void addLongHeader(@Nonempty @NonNull @Nonempty String sName, long nValue)
      Add the passed header as a number.
      Parameters:
      sName - Header name. May neither be null nor empty.
      nValue - The value to be set. May not be null.

    • setAllHeaders

      public void setAllHeaders(@NonNull HttpHeaderMap aOther)
      Set all headers from the passed map. Existing headers with the same name are overwritten. Existing headers are not changed!
      Parameters:
      aOther - The header map to add. May not be null.

    • addAllHeaders

      public void addAllHeaders(@NonNull HttpHeaderMap aOther)
      Add all headers from the passed map. Existing headers with the same name are extended.
      Parameters:
      aOther - The header map to add. May not be null.

    • getAllHeaders

      @ReturnsMutableCopy public @NonNull com.helger.collection.commons.ICommonsOrderedMap<String,com.helger.collection.commons.ICommonsList<String>> getAllHeaders()
      Returns:
      A copy of all contained headers as an ordered map. Never null.

    • getAllHeaderNames

      @ReturnsMutableCopy public @NonNull com.helger.collection.commons.ICommonsOrderedSet<String> getAllHeaderNames()
      Returns:
      A copy of all contained header names. Never null.

    • getAllHeaderValues

      @ReturnsMutableCopy public @NonNull com.helger.collection.commons.ICommonsList<String> getAllHeaderValues(@Nullable String sName)
      Get all header values of a certain header name.
      Parameters:
      sName - The name to be searched.
      Returns:
      The list with all matching values. Never null but maybe empty.

    • getFirstHeaderValue

      public @Nullable String getFirstHeaderValue(@Nullable String sName)
      Get the first header value of a certain header name. The matching of the name happens case insensitive.
      Parameters:
      sName - The name to be searched. May be null.
      Returns:
      The first matching value or null.

    • getHeaderCombined

      public @Nullable String getHeaderCombined(@Nullable String sName, @NonNull String sDelimiter)
      Get the header value as a combination of all contained values. The matching of the name happens case insensitive.
      Parameters:
      sName - The header name to retrieve. May be null.
      sDelimiter - The delimiter to be used. May not be null.
      Returns:
      null if no such header is contained.

    • containsHeaders

      public boolean containsHeaders(@Nullable String sName)
      Check if headers with the specified name exist. The matching happens case insensitive.
      Parameters:
      sName - The header name to check. May be null.
      Returns:
      true if at least one header with the specified name exists.

    • removeHeadersIf

      public @NonNull com.helger.base.state.EChange removeHeadersIf(@NonNull Predicate<? super String> aNameFilter)
      Remove all header values where the name matches the provided filter.
      Parameters:
      aNameFilter - The name filter to be applied. May not be null.
      Returns:
      EChange

    • removeHeaders

      public @NonNull com.helger.base.state.EChange removeHeaders(@Nullable String sName)
      Remove all header values with the provided name
      Parameters:
      sName - The name to be removed. May be null.
      Returns:
      EChange

    • removeHeader

      public @NonNull com.helger.base.state.EChange removeHeader(@Nullable String sName, @Nullable String sValue)
      Remove a specific header value from the header with the specified name. If the last value of a header is removed, the entire header entry is removed.
      Parameters:
      sName - The header name. May be null.
      sValue - The header value to remove. May be null.
      Returns:
      EChange

    • iterator

      public @NonNull Iterator<Map.Entry<String,com.helger.collection.commons.ICommonsList<String>>> iterator()
      Specified by:
      iterator in interface Iterable<Map.Entry<String,com.helger.collection.commons.ICommonsList<String>>>

    • size

      @Nonnegative public int size()
      Specified by:
      size in interface com.helger.collection.commons.ICommonsIterable<Map.Entry<String,com.helger.collection.commons.ICommonsList<String>>>
      Specified by:
      size in interface com.helger.base.iface.IHasSize
      Returns:
      The number of contained header names.

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface com.helger.collection.commons.ICommonsIterable<Map.Entry<String,com.helger.collection.commons.ICommonsList<String>>>
      Specified by:
      isEmpty in interface com.helger.base.iface.IHasSize
      Returns:
      true if no headers are contained, false otherwise.

    • forEachSingleHeader

      public void forEachSingleHeader(@NonNull BiConsumer<? super String,? super String> aConsumer, boolean bUnifyValue)
      Invoke the provided consumer for every name/value pair.
      Parameters:
      aConsumer - Consumer with key and unified value to be invoked. May not be null.
      bUnifyValue - true to unify the values, false if not
      Since:
      9.3.6
      See Also:

    • forEachSingleHeader

      public void forEachSingleHeader(@NonNull BiConsumer<? super String,? super String> aConsumer, boolean bUnifyValue, boolean bQuoteIfNecessary)
      Invoke the provided consumer for every name/value pair.
      Parameters:
      aConsumer - Consumer with key and unified value to be invoked. May not be null.
      bUnifyValue - true to unify the values, false if not
      bQuoteIfNecessary - true to automatically quote values if it is necessary, false to not do it. This is only used, if "unify values" is true.
      Since:
      9.3.7
      See Also:

    • forEachHeaderLine

      public void forEachHeaderLine(@NonNull Consumer<? super String> aConsumer, boolean bUnifyValue)
      Invoke the provided consumer for every header line.
      Parameters:
      aConsumer - Consumer with the assembled line to be invoked. May not be null.
      bUnifyValue - true to unify the values, false if not
      Since:
      9.3.6
      See Also:

    • forEachHeaderLine

      public void forEachHeaderLine(@NonNull Consumer<? super String> aConsumer, boolean bUnifyValue, boolean bQuoteIfNecessary)
      Invoke the provided consumer for every header line.
      Parameters:
      aConsumer - Consumer with the assembled line to be invoked. May not be null.
      bUnifyValue - true to unify the values, false if not.
      bQuoteIfNecessary - true to automatically quote values if it is necessary, false to not do it. This is only used, if "unify values" is true.
      Since:
      9.3.7
      See Also:

    • getAllHeaderLines

      @ReturnsMutableCopy public @NonNull com.helger.collection.commons.ICommonsList<String> getAllHeaderLines(boolean bUnifyValue)
      Get all header lines as a list of strings.
      Parameters:
      bUnifyValue - true to unify the values, false if not
      Returns:
      Never null but maybe an empty list.

    • getAllHeaderLines

      @ReturnsMutableCopy public @NonNull com.helger.collection.commons.ICommonsList<String> getAllHeaderLines(boolean bUnifyValue, boolean bQuoteIfNecessary)
      Get all header lines as a list of strings.
      Parameters:
      bUnifyValue - true to unify the values, false if not
      bQuoteIfNecessary - true to automatically quote values if it is necessary, false to not do it. This is only used, if "unify values" is true.
      Returns:
      Never null but maybe an empty list.
      Since:
      9.3.7

    • setContentLength

      public void setContentLength(long nLength)
      Set the "Content-Length" HTTP header.
      Parameters:
      nLength - The content length to set.

    • setContentType

      public void setContentType(@NonNull String sContentType)
      Set the "Content-Type" HTTP header.
      Parameters:
      sContentType - The content type to set. May not be null.

    • getClone

      @ReturnsMutableCopy public @NonNull HttpHeaderMap getClone()
      Specified by:
      getClone in interface com.helger.base.clone.ICloneable<HttpHeaderMap>
      Returns:
      A deep copy of this header map. Never null.

    • getAsMapStringToListString

      public @NonNull Map<String,List<String>> getAsMapStringToListString()
      Returns:
      The HTTP header map in a different representation. Never null but maybe empty.
      Since:
      10.0

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object