-
- 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
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/servlet/filterregistration.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.