Package org.forgerock.http.header

Class ContentEncodingHeader

java.lang.Object
org.forgerock.http.protocol.Header
org.forgerock.http.header.ContentEncodingHeader
public class ContentEncodingHeader extends Header
Processes the Content-Encoding message header. For more information, see RFC 2616 ยง14.11.

  • Field Details

  • Constructor Details

    • ContentEncodingHeader

      public ContentEncodingHeader()
      Constructs a new empty header.

    • ContentEncodingHeader

      public ContentEncodingHeader(List<String> codings)
      Constructs a new header with the provided content encodings.
      Parameters:
      codings - The content encodings.

  • Method Details

    • valueOf

      public static ContentEncodingHeader 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 ContentEncodingHeader 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.

    • decode

      public InputStream decode(InputStream in) throws IOException
      Returns an input stream that decodes the specified input stream, given the content-codings that are specified in the codings list.
      Parameters:
      in - the input stream to decode.
      Returns:
      an input stream that provides the decoded content.
      Throws:
      IOException - if an I/O exception occurs.
      UnsupportedEncodingException - if an unsupported content-encoding is specified.

    • decode

      public io.reactivex.rxjava3.core.Flowable<ByteBuffer> decode(io.reactivex.rxjava3.core.Flowable<ByteBuffer> content)
      Returns a flowable that decodes the specified flowable, given the content-codings that are specified in the codings list. The returned Flowable may convey an UnsupportedEncodingException in case an unsupported content-encoding is specified. EXPERIMENTAL API
      Parameters:
      content - the flowable to decode.
      Returns:
      a flowable that provides the decoded content.

    • getCodings

      public List<String> getCodings()
      Returns the list of content codings.
      Returns:
      The list of content codings.

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

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