Package io.micronaut.servlet.api.annotation

Annotation Interface ServletFilterBean

@Documented @Target(METHOD) @Retention(RUNTIME) @Bean public @interface ServletFilterBean
Variant of WebFilter applicable to factory methods.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    filterName
    The name of the filter.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    asyncSupported
    Declares whether the filter supports asynchronous operation mode.
    jakarta.servlet.DispatcherType[]
    dispatcherTypes
    The dispatcher types to which the filter applies.
    String[]
    servletNames
    The names of the servlets to which the filter applies.
    String[]
    urlPatterns
    The URL patterns to which the filter applies.
    String[]
    value
    The URL patterns to which the filter applies The default value is an empty array.

  • Element Details

    • filterName

      @AliasFor(annotation=jakarta.servlet.annotation.WebFilter.class, member="filterName") String filterName
      The name of the filter.
      Returns:
      the name of the filter

    • servletNames

      @AliasFor(annotation=jakarta.servlet.annotation.WebFilter.class, member="servletNames") String[] servletNames
      The names of the servlets to which the filter applies.
      Returns:
      the names of the servlets to which the filter applies
      Default:
      {}

    • value

      @AliasFor(annotation=jakarta.servlet.annotation.WebFilter.class, member="value") String[] value
      The URL patterns to which the filter applies The default value is an empty array.
      Returns:
      the URL patterns to which the filter applies
      Default:
      {}

    • urlPatterns

      @AliasFor(annotation=jakarta.servlet.annotation.WebFilter.class, member="value") String[] urlPatterns
      The URL patterns to which the filter applies.
      Returns:
      the URL patterns to which the filter applies
      Default:
      {}

    • dispatcherTypes

      @AliasFor(annotation=jakarta.servlet.annotation.WebFilter.class, member="dispatcherTypes") jakarta.servlet.DispatcherType[] dispatcherTypes
      The dispatcher types to which the filter applies.
      Returns:
      the dispatcher types to which the filter applies
      Default:
      {REQUEST}

    • asyncSupported

      @AliasFor(annotation=jakarta.servlet.annotation.WebFilter.class, member="asyncSupported") boolean asyncSupported
      Declares whether the filter supports asynchronous operation mode.
      Returns:
      true if the filter supports asynchronous operation mode
      See Also:
      • ServletRequest.startAsync()
      • ServletRequest.startAsync(jakarta.servlet.ServletRequest,jakarta.servlet.ServletResponse)
      Default:
      false