Annotation Interface 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
Author:
Graeme Rocher

  • Field Details

  • 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:
      {}

    • serviceId

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

    • excludeServiceId

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