-
- All Superinterfaces:
- Registration
- All Known Subinterfaces:
- FilterRegistration.Dynamic
public interface FilterRegistration extends Registration
Interface through which aFilter
may be further configured.- Since:
- Servlet 3.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static interface
FilterRegistration.Dynamic
Interface through which aFilter
registered via one of the addFilter methods onServletContext
may be further configured.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description 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.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.Collection<String>
getServletNameMappings()
Gets the currently available servlet name mappings of the Filter represented by thisFilterRegistration
.Collection<String>
getUrlPatternMappings()
Gets the currently available URL pattern mappings of the Filter represented by thisFilterRegistration
.-
Methods inherited from interface javax.servlet.Registration
getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters
-
-
-
-
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 usedisMatchAfter
- 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 obtainedservletNames
- the servlet names of the filter mapping- Throws:
IllegalArgumentException
- if servletNames is null or emptyIllegalStateException
- 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 thisFilterRegistration
.If permitted, any changes to the returned
Collection
must not affect thisFilterRegistration
.- Returns:
- a (possibly empty)
Collection
of the currently available servlet name mappings of the Filter represented by thisFilterRegistration
-
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 usedisMatchAfter
- 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 obtainedurlPatterns
- the url patterns of the filter mapping- Throws:
IllegalArgumentException
- if urlPatterns is null or emptyIllegalStateException
- 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 thisFilterRegistration
.If permitted, any changes to the returned
Collection
must not affect thisFilterRegistration
.- Returns:
- a (possibly empty)
Collection
of the currently available URL pattern mappings of the Filter represented by thisFilterRegistration
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
21/08/2025 15:06:55 Cette version de la page est en cache (à la date du 21/08/2025 15:06:55) afin d'accélérer le traitement.Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la version plus récente de la page.
Document créé le 11/06/2005, dernière modification le 18/08/2025
Source du document imprimé : https://www.gaudry.be/java-api-javaee-rf-javax/servlet/filterregistration.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.