options

options

Matches requests with HTTP method OPTIONS.

Description

This directive filters the incoming request by its HTTP method. Only requests with method OPTIONS are passed on to the inner route. All others are rejected with a MethodRejection, which is translated into a 405 Method Not Allowed response by the default RejectionHandler.

Example

final Route route = options(() -> complete("This is a OPTIONS request."));

testRoute(route).run(HttpRequest.OPTIONS("/")).assertEntity(
    "This is a OPTIONS request.");

Contents