Annotation Type Filter


  • @Singleton
    @Documented
    @Retention(RUNTIME)
    @Target(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
    • Field Detail

      • MATCH_ALL_PATTERN

        static final java.lang.String MATCH_ALL_PATTERN
        Pattern used to match all requests.
    • Element Detail

      • value

        java.lang.String[] value
        Returns:
        The patterns this filter should match
        Default:
        {}
      • patternStyle

        FilterPatternStyle patternStyle
        Returns:
        The style of pattern this filter uses
        Default:
        io.micronaut.http.filter.FilterPatternStyle.ANT
      • patterns

        @AliasFor(member="value")
        java.lang.String[] patterns
        Same as value().
        Returns:
        The patterns
        Default:
        {}
      • methods

        HttpMethod[] methods
        Returns:
        The methods to match. Defaults to all
        Default:
        {}
      • serviceId

        java.lang.String[] serviceId
        The service identifiers this filter applies to. Currently, applies only to HttpClientFilter instances.
        Returns:
        The service identifiers
        Default:
        {}
      • excludeServiceId

        java.lang.String[] excludeServiceId
        The service identifiers this filter does not apply to. Currently, applies only to HttpClientFilter instances.
        Returns:
        The service identifiers
        Default:
        {}