Package org.glassfish.grizzly.http

Interface ContentEncoding

All Known Implementing Classes:
GZipContentEncoding, LZMAContentEncoding
public interface ContentEncoding
Abstraction, which represents HTTP content-encoding. Implementation should take care of HTTP content encoding and decoding.
Author:
Alexey Stashok
See Also:

  • Method Details

    • getName

      String getName()
      Get the ContentEncoding name.
      Returns:
      the ContentEncoding name.

    • getAliases

      String[] getAliases()
      Get the ContentEncoding aliases.
      Returns:
      the ContentEncoding aliases.

    • wantDecode

      boolean wantDecode(HttpHeader header)
      Method should implement the logic, which decides if HTTP packet with the specific HttpHeader should be decoded using this ContentEncoding.
      Parameters:
      header - HTTP packet header.
      Returns:
      true, if this ContentEncoding should be used to decode the HTTP packet, or false otherwise.

    • wantEncode

      boolean wantEncode(HttpHeader header)
      Method should implement the logic, which decides if HTTP packet with the specific HttpHeader should be encoded using this ContentEncoding.
      Parameters:
      header - HTTP packet header.
      Returns:
      true, if this ContentEncoding should be used to encode the HTTP packet, or false otherwise.

    • decode

      ParsingResult decode(Connection connection, HttpContent httpContent)
      Decode HTTP packet content represented by HttpContent.
      Parameters:
      connection - Connection.
      httpContent - HttpContent to decode.
      Returns:
      ParsingResult, which represents the result of decoding.

    • encode

      HttpContent encode(Connection connection, HttpContent httpContent)
      Encode HTTP packet content represented by HttpContent.
      Parameters:
      connection - Connection.
      httpContent - HttpContent to encode.
      Returns:
      encoded HttpContent.