io.micronaut.web.router

Interface FilterRoute

public interface FilterRoute

A filter route is a route that matches an HttpFilter.

Since:

1.0

Author:

Graeme Rocher

Method Summary

Modifier and Type	Method and Description
HttpFilter	getFilter()
Optional<HttpFilter>	match(HttpMethod method, URI uri) Matches the given path to this filter route.
FilterRoute	methods(HttpMethod... methods) Restrict the methods this filter route matches.
FilterRoute	pattern(String pattern) Add an addition pattern to this filter route.

Method Detail

getFilter

HttpFilter getFilter()

Returns:

The filter for this FilterRoute

match

Optional<HttpFilter> match(HttpMethod method,
                           URI uri)

Matches the given path to this filter route.

Parameters:

method - The HTTP method

uri - The URI

Returns:

An Optional of HttpFilter

pattern

FilterRoute pattern(String pattern)

Add an addition pattern to this filter route.

Parameters:

pattern - The pattern

Returns:

This route

methods

FilterRoute methods(HttpMethod... methods)

Restrict the methods this filter route matches.

Parameters:

methods - The methods

Returns:

This route