Package io.micronaut.http.annotation

Annotation Interface RequestFilter

@Documented
@Retention(RUNTIME)
@Target(METHOD)
@Inherited
@Executable
public @interface RequestFilter

Method annotation for a request filter. A request filter is called before the request is sent out. Possible parameter types are:

• HttpRequest or MutableHttpRequest, to access the request
• FilterContinuation<HttpResponse>, FilterContinuation<Publisher<HttpResponse>>. A call to the continuation (and, for the reactive variant, subscribing to the Publisher) will trigger execution of downstream filters, and finally perform the request. The response returned by the continuation will be the response produced by the downstream, and can be modified and returned. Note that if you call a non-reactive continuation, the call will block, which may block the netty event loop. For that reason, always mark such a filter with ExecuteOn
• A @Header, @QueryValue or @CookieValue parameter
• A @Body parameter of type byte[], String or ByteBuffer. Only supported for some HTTP server implementations.

The return value may be:

• void or null to immediately continue execution, without changing the request or response
• An updated HttpRequest
• A HttpResponse to skip execution of the request
• A Publisher (or other reactive type) that produces any of these return types, to delay further execution

Since:

4.0.0

Author:

Jonas Konrad

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
HttpMethod[]	methods
String[]	patterns	Same as value().
FilterPatternStyle	patternStyle
String[]	value

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MATCH_ALL_PATTERN	Pattern used to match all requests.

Field Details

MATCH_ALL_PATTERN

static final String MATCH_ALL_PATTERN

Pattern used to match all requests.

See Also:

• Constant Field Values

Element Details

value

String[] value

Returns:

The patterns this filter should match

Default:

{}

patternStyle

FilterPatternStyle patternStyle

Returns:

The style of pattern this filter uses

Default:

ANT

patterns

@AliasFor(member="value")
String[] patterns

Same as value().

Returns:

The patterns

Default:

{}

methods

HttpMethod[] methods

Returns:

The methods to match. Defaults to all

Default:

{}