Class RequestDecompressionPolicy.Builder

java.lang.Object

com.soklet.RequestDecompressionPolicy.Builder

Enclosing class:

RequestDecompressionPolicy

@NotThreadSafe
public static final class RequestDecompressionPolicy.Builder
extends Object

Builder for enabled RequestDecompressionPolicy instances.

Author:

Mark Allen

Method Summary

Modifier and Type	Method	Description
@NonNull RequestDecompressionPolicy	build()	Builds an enabled RequestDecompressionPolicy.
@NonNull RequestDecompressionPolicy.Builder	maximumCompressionRatio(@Nullable Integer maximumCompressionRatio)	Sets the maximum permitted expansion ratio between decompressed and compressed body sizes, or null for the default of 100.
@NonNull RequestDecompressionPolicy.Builder	maximumDecompressedBodySizeInBytes(@Nullable Integer maximumDecompressedBodySizeInBytes)	Sets the maximum permitted decompressed body size in bytes, or null to use the server's maximumRequestSizeInBytes.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

maximumDecompressedBodySizeInBytes

public @NonNull RequestDecompressionPolicy.Builder maximumDecompressedBodySizeInBytes(@Nullable Integer maximumDecompressedBodySizeInBytes)

Sets the maximum permitted decompressed body size in bytes, or null to use the server's maximumRequestSizeInBytes.

Parameters:

maximumDecompressedBodySizeInBytes - the maximum decompressed body size, or null for the server default

Returns:

this builder

maximumCompressionRatio

public @NonNull RequestDecompressionPolicy.Builder maximumCompressionRatio(@Nullable Integer maximumCompressionRatio)

Sets the maximum permitted expansion ratio between decompressed and compressed body sizes, or null for the default of 100. Must be between 1 and 10_000; the upper bound keeps ratio arithmetic safely within long range for any legal body size (gzip's theoretical maximum expansion is roughly 1032:1).

Parameters:

maximumCompressionRatio - the maximum compression ratio, or null for the default

Returns:

this builder

build

public @NonNull RequestDecompressionPolicy build()

Builds an enabled RequestDecompressionPolicy.

Returns:

the request decompression policy

Throws:

IllegalArgumentException - if a limit is zero or negative