deleteCookie

Description

Adds a header to the response to request the removal of the cookie with the given name on the client.

Use the setCookie directive to update a cookie.

Example

final Route route = deleteCookie("userName", () ->
  complete("The user was logged out")
);

// tests:
final HttpHeader expected = SetCookie.create(
  HttpCookie.create(
    "userName",
    "deleted",
    Optional.of(DateTime.MinValue()),
    OptionalLong.empty(),
    Optional.empty(),
    Optional.empty(),
    false,
    false,
    Optional.empty()));

testRoute(route).run(HttpRequest.GET("/"))
  .assertEntity("The user was logged out")
  .assertHeaderExists(expected);
The source code for this page can be found here.