Package io.micronaut.web.router

Interface FilterRoute

All Superinterfaces:
AnnotationMetadataProvider, AnnotationSource, HttpFilterResolver.FilterEntry
public interface FilterRoute extends HttpFilterResolver.FilterEntry
A filter route is a route that matches an HttpFilter.
Since:
1.0
Author:
Graeme Rocher

  • Method Details

    • isPreMatching

      default boolean isPreMatching()
      If it's a pre-matching filter, the one being executed before the route is resolved.
      Returns:
      true if pre-matching
      Since:
      4.6

    • findMatchingAnnotation

      default @Nullable String findMatchingAnnotation()
      Returns the matching annotation. See FilterMatcher.
      Returns:
      The matching annotation or null
      Since:
      4.6

    • getFilter

      @NonNull GenericHttpFilter getFilter()
      Specified by:
      getFilter in interface HttpFilterResolver.FilterEntry
      Returns:
      The filter for this FilterRoute

    • match

      @Deprecated(forRemoval=true, since="4.3.0") Optional<GenericHttpFilter> match(HttpMethod method, URI uri)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Replaced with match(HttpMethod, String).
      Matches the given path to this filter route.
      Parameters:
      method - The HTTP method
      uri - The URI
      Returns:
      An Optional of HttpFilter

    • match

      Optional<GenericHttpFilter> match(HttpMethod method, String path)
      Matches the given path to this filter route.
      Parameters:
      method - The HTTP method
      path - The path
      Returns:
      An Optional of HttpFilter
      Since:
      4.3.0

    • 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

    • patternStyle

      FilterRoute patternStyle(FilterPatternStyle patternStyle)
      Sets the pattern style that this filter route matches.
      Parameters:
      patternStyle - The pattern style
      Returns:
      This route