Package javax.servlet
Interface ServletRegistration
-
- 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 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 Description java.util.Set<java.lang.String>
addMapping(java.lang.String... urlPatterns)
Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.java.util.Collection<java.lang.String>
getMappings()
Gets the currently available mappings of the Servlet represented by thisServletRegistration
.java.lang.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
java.util.Set<java.lang.String> addMapping(java.lang.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:
java.lang.IllegalArgumentException
- if urlPatterns is null or emptyjava.lang.IllegalStateException
- if the ServletContext from which this ServletRegistration was obtained has already been initialized
-
getMappings
java.util.Collection<java.lang.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
java.lang.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
-
-