respondWithDefaultHeaders
Description
Adds the given HTTP headers to all responses coming back from its inner route only if a respective header with the same name doesn't exist yet in the response.
This directive transforms HttpResponse and ChunkedResponseStart messages coming back from its inner route by
potentially adding the given HttpHeader instances to the headers list.
A header is only added if there is no header instance with the same name (case insensitively) already present in the
response.
See also respondWithDefaultHeader if you'd like to add only a single header.
Example
The respondWithDefaultHeaders directive is equivalent to the respondWithDefaultHeader directive which
is shown in the example below, however it allows including multiple default headers at once in the directive, like so:
respondWithDefaultHeaders(
Origin(HttpOrigin("http://akka.io"),
RawHeader("X-Fish-Name", "Blippy"))) { /*...*/ }
The semantics remain the same however, as explained by the following example:
//custom headers
final RawHeader blippy = RawHeader.create("X-Fish-Name", "Blippy");
final HttpHeader akka = Origin.create(HttpOrigin.parse("http://akka.io"));
final List<HttpHeader> defaultHeaders = Lists.newArrayList(blippy, akka);
final RawHeader elTonno = RawHeader.create("X-Fish-Name", "El Tonno");
// format: OFF
// by default always include the Blippy and Akka headers,
// unless a more specific X-Fish-Name is given by the inner route
final Route route =
respondWithDefaultHeaders(defaultHeaders, () -> // blippy and akka
respondWithHeader(elTonno, () -> // / el tonno
path("el-tonno", () -> // | /
complete("¡Ay blippy!") // | |- el tonno
).orElse( // | |
path("los-tonnos", () -> // | |
complete("¡Ay ay blippy!") // | |- el tonno
) // | |
) // | |
).orElse( // | x
complete("Blip!") // |- blippy and akka
) // x
);
//format: ON
testRoute(route).run(HttpRequest.GET("/"))
.assertHeaderExists("X-Fish-Name", "Blippy")
.assertHeaderExists("Origin", "http://akka.io")
.assertEntity("Blip!");
testRoute(route).run(HttpRequest.GET("/el-tonno"))
.assertHeaderExists("X-Fish-Name", "El Tonno")
.assertEntity("¡Ay blippy!");
testRoute(route).run(HttpRequest.GET("/los-tonnos"))
.assertHeaderExists("X-Fish-Name", "El Tonno")
.assertEntity("¡Ay ay blippy!");
See the respondWithDefaultHeader directive for an example with only one header.
Contents
