javax.servlet

Interface FilterRegistration

Contents

    • Method Detail

      • addMappingForServletNames

        void addMappingForServletNames(EnumSet<DispatcherType> dispatcherTypes,
                               boolean isMatchAfter,
                               String... servletNames)
        Adds a filter mapping with the given servlet names and dispatcher types for the Filter represented by this FilterRegistration.

        Filter mappings are matched in the order in which they were added.

        Depending on the value of the isMatchAfter parameter, the given filter mapping will be considered after or before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained.

        If this method is called multiple times, each successive call adds to the effects of the former.

        Parameters:
        dispatcherTypes - the dispatcher types of the filter mapping, or null if the default DispatcherType.REQUEST is to be used
        isMatchAfter - true if the given filter mapping should be matched after any declared filter mappings, and false if it is supposed to be matched before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained
        servletNames - the servlet names of the filter mapping
        Throws:
        IllegalArgumentException - if servletNames is null or empty
        IllegalStateException - if the ServletContext from which this FilterRegistration was obtained has already been initialized

      • getServletNameMappings

        Collection<String> getServletNameMappings()
        Gets the currently available servlet name mappings of the Filter represented by this FilterRegistration.

        If permitted, any changes to the returned Collection must not affect this FilterRegistration.

        Returns:
        a (possibly empty) Collection of the currently available servlet name mappings of the Filter represented by this FilterRegistration

      • addMappingForUrlPatterns

        void addMappingForUrlPatterns(EnumSet<DispatcherType> dispatcherTypes,
                              boolean isMatchAfter,
                              String... urlPatterns)
        Adds a filter mapping with the given url patterns and dispatcher types for the Filter represented by this FilterRegistration.

        Filter mappings are matched in the order in which they were added.

        Depending on the value of the isMatchAfter parameter, the given filter mapping will be considered after or before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained.

        If this method is called multiple times, each successive call adds to the effects of the former.

        Parameters:
        dispatcherTypes - the dispatcher types of the filter mapping, or null if the default DispatcherType.REQUEST is to be used
        isMatchAfter - true if the given filter mapping should be matched after any declared filter mappings, and false if it is supposed to be matched before any declared filter mappings of the ServletContext from which this FilterRegistration was obtained
        urlPatterns - the url patterns of the filter mapping
        Throws:
        IllegalArgumentException - if urlPatterns is null or empty
        IllegalStateException - if the ServletContext from which this FilterRegistration was obtained has already been initialized

      • getUrlPatternMappings

        Collection<String> getUrlPatternMappings()
        Gets the currently available URL pattern mappings of the Filter represented by this FilterRegistration.

        If permitted, any changes to the returned Collection must not affect this FilterRegistration.

        Returns:
        a (possibly empty) Collection of the currently available URL pattern mappings of the Filter represented by this FilterRegistration

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/servlet/filterregistration.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.