Package io.envoyproxy.envoy.extensions.compression.gzip.decompressor.v3

Interface GzipOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Gzip, Gzip.Builder
public interface GzipOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.UInt32Value
    getChunkSize()
    Value for zlib's decompressor output buffer.
    com.google.protobuf.UInt32ValueOrBuilder
    getChunkSizeOrBuilder()
    Value for zlib's decompressor output buffer.
    com.google.protobuf.UInt32Value
    getMaxInflateRatio()
    An upper bound to the number of times the output buffer is allowed to be bigger than the size of the accumulated input.
    com.google.protobuf.UInt32ValueOrBuilder
    getMaxInflateRatioOrBuilder()
    An upper bound to the number of times the output buffer is allowed to be bigger than the size of the accumulated input.
    com.google.protobuf.UInt32Value
    getWindowBits()
    Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.
    com.google.protobuf.UInt32ValueOrBuilder
    getWindowBitsOrBuilder()
    Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.
    boolean
    hasChunkSize()
    Value for zlib's decompressor output buffer.
    boolean
    hasMaxInflateRatio()
    An upper bound to the number of times the output buffer is allowed to be bigger than the size of the accumulated input.
    boolean
    hasWindowBits()
    Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasWindowBits

      boolean hasWindowBits()
       Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.
 The decompression window size needs to be equal or larger than the compression window size.
 The default window size is 15.
 This is so that the decompressor can decompress a response compressed by a compressor with any compression window size.
 For more details about this parameter, please refer to `zlib manual <https://www.zlib.net/manual.html>`_ > inflateInit2.
      .google.protobuf.UInt32Value window_bits = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the windowBits field is set.

    • getWindowBits

      com.google.protobuf.UInt32Value getWindowBits()
       Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.
 The decompression window size needs to be equal or larger than the compression window size.
 The default window size is 15.
 This is so that the decompressor can decompress a response compressed by a compressor with any compression window size.
 For more details about this parameter, please refer to `zlib manual <https://www.zlib.net/manual.html>`_ > inflateInit2.
      .google.protobuf.UInt32Value window_bits = 1 [(.validate.rules) = { ... }
      Returns:
      The windowBits.

    • getWindowBitsOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getWindowBitsOrBuilder()
       Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.
 The decompression window size needs to be equal or larger than the compression window size.
 The default window size is 15.
 This is so that the decompressor can decompress a response compressed by a compressor with any compression window size.
 For more details about this parameter, please refer to `zlib manual <https://www.zlib.net/manual.html>`_ > inflateInit2.
      .google.protobuf.UInt32Value window_bits = 1 [(.validate.rules) = { ... }

    • hasChunkSize

      boolean hasChunkSize()
       Value for zlib's decompressor output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details.
      .google.protobuf.UInt32Value chunk_size = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the chunkSize field is set.

    • getChunkSize

      com.google.protobuf.UInt32Value getChunkSize()
       Value for zlib's decompressor output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details.
      .google.protobuf.UInt32Value chunk_size = 2 [(.validate.rules) = { ... }
      Returns:
      The chunkSize.

    • getChunkSizeOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getChunkSizeOrBuilder()
       Value for zlib's decompressor output buffer. If not set, defaults to 4096.
 See https://www.zlib.net/manual.html for more details.
      .google.protobuf.UInt32Value chunk_size = 2 [(.validate.rules) = { ... }

    • hasMaxInflateRatio

      boolean hasMaxInflateRatio()
       An upper bound to the number of times the output buffer is allowed to be bigger than the size of
 the accumulated input. This value is used to prevent decompression bombs. If not set, defaults to 100.
 [#comment:TODO(rojkov): Re-design the Decompressor interface to handle compression bombs gracefully instead of this quick solution.
 See https://github.com/envoyproxy/envoy/commit/d4c39e635603e2f23e1e08ddecf5a5fb5a706338 for details.]
      .google.protobuf.UInt32Value max_inflate_ratio = 3 [(.validate.rules) = { ... }
      Returns:
      Whether the maxInflateRatio field is set.

    • getMaxInflateRatio

      com.google.protobuf.UInt32Value getMaxInflateRatio()
       An upper bound to the number of times the output buffer is allowed to be bigger than the size of
 the accumulated input. This value is used to prevent decompression bombs. If not set, defaults to 100.
 [#comment:TODO(rojkov): Re-design the Decompressor interface to handle compression bombs gracefully instead of this quick solution.
 See https://github.com/envoyproxy/envoy/commit/d4c39e635603e2f23e1e08ddecf5a5fb5a706338 for details.]
      .google.protobuf.UInt32Value max_inflate_ratio = 3 [(.validate.rules) = { ... }
      Returns:
      The maxInflateRatio.

    • getMaxInflateRatioOrBuilder

      com.google.protobuf.UInt32ValueOrBuilder getMaxInflateRatioOrBuilder()
       An upper bound to the number of times the output buffer is allowed to be bigger than the size of
 the accumulated input. This value is used to prevent decompression bombs. If not set, defaults to 100.
 [#comment:TODO(rojkov): Re-design the Decompressor interface to handle compression bombs gracefully instead of this quick solution.
 See https://github.com/envoyproxy/envoy/commit/d4c39e635603e2f23e1e08ddecf5a5fb5a706338 for details.]
      .google.protobuf.UInt32Value max_inflate_ratio = 3 [(.validate.rules) = { ... }