Packages

case class GzipFilterConfig(bufferSize: Int = 8192, chunkedThreshold: Int = 102400, threshold: Int = 0, shouldGzip: (RequestHeader, Result) => Boolean = (_, _) => true, compressionLevel: Int = Deflater.DEFAULT_COMPRESSION) extends Product with Serializable

Configuration for the gzip filter

bufferSize

The size of the buffer to use for gzipping.

chunkedThreshold

The content length threshold, after which the filter will switch to chunking the result.

threshold

The byte threshold for the response body size which controls if a response should be gzipped.

shouldGzip

Whether the given request/result should be gzipped. This can be used, for example, to implement black/white lists for gzipping by content type.

compressionLevel

Compression level to use for the underlying java.util.zip.Deflater instance.

Source
GzipFilter.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GzipFilterConfig
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GzipFilterConfig()
  2. new GzipFilterConfig(bufferSize: Int = 8192, chunkedThreshold: Int = 102400, threshold: Int = 0, shouldGzip: (RequestHeader, Result) => Boolean = (_, _) => true, compressionLevel: Int = Deflater.DEFAULT_COMPRESSION)

    bufferSize

    The size of the buffer to use for gzipping.

    chunkedThreshold

    The content length threshold, after which the filter will switch to chunking the result.

    threshold

    The byte threshold for the response body size which controls if a response should be gzipped.

    shouldGzip

    Whether the given request/result should be gzipped. This can be used, for example, to implement black/white lists for gzipping by content type.

    compressionLevel

    Compression level to use for the underlying java.util.zip.Deflater instance.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val bufferSize: Int
  6. val chunkedThreshold: Int
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. val compressionLevel: Int
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def productElementNames: Iterator[String]
    Definition Classes
    Product
  16. val shouldGzip: (RequestHeader, Result) => Boolean
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. val threshold: Int
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. def withBufferSize(size: Int): GzipFilterConfig
  23. def withChunkedThreshold(threshold: Int): GzipFilterConfig
  24. def withCompressionLevel(level: Int): GzipFilterConfig
  25. def withShouldGzip(shouldGzip: BiFunction[RequestHeader, Result, Boolean]): GzipFilterConfig
  26. def withShouldGzip(shouldGzip: (RequestHeader, Result) => Boolean): GzipFilterConfig
  27. def withThreshold(threshold: Int): GzipFilterConfig

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped