package gzip
- Alphabetic
- Public
- All
Type Members
-
class
GzipFilter extends EssentialFilter
A gzip filter.
A gzip filter.
This filter may gzip the responses for any requests that aren't HEAD requests and specify an accept encoding of gzip.
It won't gzip under the following conditions:
- The response code is 204 or 304 (these codes MUST NOT contain a body, and an empty gzipped response is 20 bytes long) - The response already defines a Content-Encoding header - A custom shouldGzip function is supplied and it returns false
Since gzipping changes the content length of the response, this filter may do some buffering - it will buffer any streamed responses that define a content length less than the configured chunked threshold. Responses that are greater in length, or that don't define a content length, will not be buffered, but will be sent as chunked responses.
- Annotations
- @Singleton()
-
trait
GzipFilterComponents extends AnyRef
The gzip filter components.
-
case class
GzipFilterConfig(bufferSize: Int = 8192, chunkedThreshold: Int = 102400, shouldGzip: (RequestHeader, Result) ⇒ Boolean = (_, _) => true, compressionLevel: Int = Deflater.DEFAULT_COMPRESSION) extends Product with Serializable
Configuration for the gzip filter
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.
- 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.
-
class
GzipFilterConfigProvider extends Provider[GzipFilterConfig]
The gzip filter configuration provider.
The gzip filter configuration provider.
- Annotations
- @Singleton()
-
class
GzipFilterModule extends SimpleModule
The gzip filter module.
Value Members
- object GzipFilterConfig extends Serializable