Package io.micronaut.http.annotation

Annotation Interface ServerFilter

@Documented
@Retention(RUNTIME)
@Target(TYPE)
@Bean
@DefaultScope(jakarta.inject.Singleton.class)
public @interface ServerFilter

Mark a bean as a filter for the HTTP server. The bean may declare RequestFilters and ResponseFilters.

Since:

4.0.0

Author:

Jonas Konrad

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	appendContextPath
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:

{}

appendContextPath

boolean appendContextPath

Returns:

Whether the contextPath should be concatenated into the filter pattern

Since:

4.5.1

Default:

true