-
- All Superinterfaces:
- Registration
- All Known Subinterfaces:
- ServletRegistration.Dynamic
public interface ServletRegistration extends Registration
Interface through which aServlet
may be further configured.- Since:
- Servlet 3.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface and Description static interface
ServletRegistration.Dynamic
Interface through which aServlet
registered via one of the addServlet methods onServletContext
may be further configured.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description Set<String>
addMapping(String... urlPatterns)
Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.Collection<String>
getMappings()
Gets the currently available mappings of the Servlet represented by thisServletRegistration
.String
getRunAsRole()
Gets the name of the runAs role of the Servlet represented by thisServletRegistration
.-
Methods inherited from interface javax.servlet.Registration
getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters
-
-
-
-
Method Detail
-
addMapping
Set<String> addMapping(String... urlPatterns)
Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.If any of the specified URL patterns are already mapped to a different Servlet, no updates will be performed.
If this method is called multiple times, each successive call adds to the effects of the former.
- Parameters:
urlPatterns
- the URL patterns of the servlet mapping- Returns:
- the (possibly empty) Set of URL patterns that are already mapped to a different Servlet
- Throws:
IllegalArgumentException
- if urlPatterns is null or emptyIllegalStateException
- if the ServletContext from which this ServletRegistration was obtained has already been initialized
-
getMappings
Collection<String> getMappings()
Gets the currently available mappings of the Servlet represented by thisServletRegistration
.If permitted, any changes to the returned
Collection
must not affect thisServletRegistration
.- Returns:
- a (possibly empty)
Collection
of the currently available mappings of the Servlet represented by thisServletRegistration
-
getRunAsRole
String getRunAsRole()
Gets the name of the runAs role of the Servlet represented by thisServletRegistration
.- Returns:
- the name of the runAs role, or null if the Servlet is configured to run as its caller
-
-
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/servletregistration.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
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.