Package io.micronaut.http.server

Class OptionsFilter

java.lang.Object

io.micronaut.http.server.OptionsFilter

All Implemented Interfaces:

Ordered

@Requires(property="micronaut.server.dispatch-options-requests",
          value="true",
          defaultValue="false")
@ServerFilter("/**")
@Internal
public final class OptionsFilter
extends Object
implements Ordered

This Filter intercepts HTTP OPTIONS requests which are not CORS Preflight requests. It responds with a NO_CONTENT(204) response, and it populates the Allow HTTP Header with the supported HTTP methods for the request URI.

Since:

4.2.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
OptionsFilter(Router router)

Method Summary

Modifier and Type	Method	Description
@Nullable HttpResponse<?>	filterRequest(HttpRequest<?> request)
int	getOrder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

Constructor Details

OptionsFilter

public OptionsFilter(Router router)

Parameters:

router - Router

Method Details

filterRequest

@RequestFilter
@Nullable
@Internal
public @Nullable HttpResponse<?> filterRequest(HttpRequest<?> request)

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

Returns:

The order of the object. Defaults to zero (no order).