io.micronaut.http.annotation

Annotation Type Filter

@Singleton
 @Documented
 @Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface Filter

An annotation that can be applied to classes that implement HttpFilter to specify the patterns.

Used as an alternative to applying filters manually via the {code Router} API

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
HttpMethod[]	methods
String[]	patterns Same as value().
FilterPatternStyle	patternStyle
String[]	serviceId The service identifiers this filter applies to.
String[]	value

Field Detail

MATCH_ALL_PATTERN

public static final String MATCH_ALL_PATTERN

Pattern used to match all requests.

Element Detail

value

public abstract String[] value

Returns:

The patterns this filter should match

Default:

{}

patternStyle

public abstract FilterPatternStyle patternStyle

Returns:

The style of pattern this filter uses

Default:

io.micronaut.http.filter.FilterPatternStyle.ANT

patterns

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

Same as value().

Returns:

The patterns

Default:

{}

methods

public abstract HttpMethod[] methods

Returns:

The methods to match. Defaults to all

Default:

{}

serviceId

public abstract String[] serviceId

The service identifiers this filter applies to. Currently, applies only to HttpClientFilter instances. Equivalent to the id() of io.micronaut.http.client.Client.

Returns:

The service identifiers

Default:

{}