encodeResponseWith

encodeResponseWith

Description

Encodes the response with the encoding that is requested by the client via the Accept-Encoding if it is among the provided encoders or rejects the request with an UnacceptedResponseEncodingRejection(supportedEncodings).

The response encoding is determined by the rules specified in RFC7231.

If the Accept-Encoding header is missing then the response is encoded using the first encoder.

If the Accept-Encoding header is empty and NoCoding is part of the encoders then no response encoding is used. Otherwise the request is rejected.

Example

final Route route = encodeResponseWith(
  Collections.singletonList(Coder.Gzip),
  () -> complete("content")
);

// tests:
testRoute(route).run(HttpRequest.GET("/"))
  .assertHeaderExists(ContentEncoding.create(HttpEncodings.GZIP));

testRoute(route).run(
  HttpRequest.GET("/")
    .addHeader(AcceptEncoding.create(HttpEncodings.GZIP))
    .addHeader(AcceptEncoding.create(HttpEncodings.DEFLATE))
).assertHeaderExists(ContentEncoding.create(HttpEncodings.GZIP));

runRouteUnSealed(route,
  HttpRequest.GET("/")
    .addHeader(AcceptEncoding.create(HttpEncodings.DEFLATE))
).assertRejections(Rejections.unacceptedResponseEncoding(HttpEncodings.GZIP));

runRouteUnSealed(route,
  HttpRequest.GET("/")
    .addHeader(AcceptEncoding.create(HttpEncodings.IDENTITY))
).assertRejections(Rejections.unacceptedResponseEncoding(HttpEncodings.GZIP));

Contents