Class

play.filters.gzip

GzipFilter

Related Doc: package gzip

Permalink

class GzipFilter extends EssentialFilter

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()
Source
GzipFilter.scala
Linear Supertypes
EssentialFilter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. GzipFilter
  2. EssentialFilter
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GzipFilter(bufferSize: Int = 8192, chunkedThreshold: Int = 102400, shouldGzip: (RequestHeader, Result) ⇒ Boolean = (_, _) => true)(implicit mat: Materializer)

    Permalink
  2. new GzipFilter(config: GzipFilterConfig)(implicit mat: Materializer)

    Permalink
    Annotations
    @Inject()

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply(next: EssentialAction): EssentialAction

    Permalink
    Definition Classes
    GzipFilterEssentialFilter
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def asJava: EssentialFilter

    Permalink
    Definition Classes
    EssentialFilter
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  18. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from EssentialFilter

Inherited from AnyRef

Inherited from Any

Ungrouped