Package jakarta.servlet.annotation

Annotation Type WebFilter

  • @Target(TYPE)
@Retention(RUNTIME)
@Documented
public @interface WebFilter
    Annotation used to declare a servlet filter.

    This annotation is processed by the container at deployment time, and the corresponding filter applied to the specified URL patterns, servlets, and dispatcher types.

    Since:
    Servlet 3.0
    See Also:
    Filter

    • Element Detail

      • description

        String description
        The description of the filter
        Returns:
        the description of the filter
        Default:
        ""

      • displayName

        String displayName
        The display name of the filter
        Returns:
        the display name of the filter
        Default:
        ""

      • initParams

        WebInitParam[] initParams
        The init parameters of the filter
        Returns:
        the init parameters of the filter
        Default:
        {}

      • filterName

        String filterName
        The name of the filter
        Returns:
        the name of the filter
        Default:
        ""

      • smallIcon

        String smallIcon
        The small-icon of the filter
        Returns:
        the small-icon of the filter
        Default:
        ""

      • largeIcon

        String largeIcon
        The large-icon of the filter
        Returns:
        the large-icon of the filter
        Default:
        ""

      • 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

        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

        String[] urlPatterns
        The URL patterns to which the filter applies
        Returns:
        the URL patterns to which the filter applies
        Default:
        {}

      • dispatcherTypes

        DispatcherType[] dispatcherTypes
        The dispatcher types to which the filter applies
        Returns:
        the dispatcher types to which the filter applies
        Default:
        {jakarta.servlet.DispatcherType.REQUEST}