Package org.ops4j.pax.web.service.whiteboard

Interface FilterMapping

  • All Superinterfaces:
    ContextRelated
    public interface FilterMapping
extends ContextRelated

    Filter mapping contains all the information required to register a Filter.

    Since:
    0.4.0, April 05, 2008
    Author:
    Alin Dreghiciu, Grzegorz Grzybek

    • Method Detail

      • getFilter

        javax.servlet.Filter getFilter()

        Get an actual Filter instance to register.

        Returns:
        the filter to register

      • getFilterClass

        Class<? extends javax.servlet.Filter> getFilterClass()

        Get a class of Filter to register. Matches <filter>/<filter-class> element from web.xml. If getFilter() is also specified, servlet class isn't used.

        There's no whiteboard specific method to specify this class.

        Returns:
        the filter's class to instantiate and register

      • getFilterName

        String getFilterName()

        Get a name of the filter being registered. Matches <filter>/<filter-name> element from web.xml.

        In whiteboard method, this can be specified as:

        • HttpWhiteboardConstants.HTTP_WHITEBOARD_FILTER_NAME property
        • filter-name service registration property (legacy Pax Web Whiteboard approach)

        If not specified, the name defaults to fully qualified class name of the filter.

        Returns:
        name of the Servlet being mapped.

      • getUrlPatterns

        String[] getUrlPatterns()

        Get URL patterns for the filter mapping.

        Returns:
        an array of url patterns filter maps to

      • getRegexPatterns

        String[] getRegexPatterns()

        Get Regex patterns for the filter mapping.

        Returns:
        an array of regex patterns filter maps to

      • getServletNames

        String[] getServletNames()

        Get Servlet names for the filter mapping.

        Returns:
        an array of servlet names the filter was registered for

      • getDispatcherTypes

        javax.servlet.DispatcherType[] getDispatcherTypes()

        Get an array of DispatcherType for this filter.

        Returns:

      • getAsyncSupported

        Boolean getAsyncSupported()

        Get flag for supporting asynchronous filter invocation.

        Returns:
        Filter async-supported flag

      • getInitParameters

        Map<String,​String> getInitParameters()

        Get init parameters for the filter being registered.

        Returns:
        map of initialization parameters.