Package org.apache.catalina.core
Class ApplicationServletRegistration
- java.lang.Object
-
- org.apache.catalina.core.ApplicationServletRegistration
-
- All Implemented Interfaces:
Registration
,Registration.Dynamic
,ServletRegistration
,ServletRegistration.Dynamic
public class ApplicationServletRegistration extends java.lang.Object implements ServletRegistration.Dynamic
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javax.servlet.Registration
Registration.Dynamic
-
Nested classes/interfaces inherited from interface javax.servlet.ServletRegistration
ServletRegistration.Dynamic
-
-
Constructor Summary
Constructors Constructor Description ApplicationServletRegistration(Wrapper wrapper, Context context)
-
Method Summary
All Methods Instance Methods Concrete 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.lang.String
getClassName()
java.lang.String
getInitParameter(java.lang.String name)
Get the value of an initialisation parameter.java.util.Map<java.lang.String,java.lang.String>
getInitParameters()
Get the names and values of all the initialisation parameters.java.util.Collection<java.lang.String>
getMappings()
Gets the currently available mappings of the Servlet represented by this ServletRegistration.java.lang.String
getName()
java.lang.String
getRunAsRole()
void
setAsyncSupported(boolean asyncSupported)
Mark this Servlet/Filter as supported asynchronous processing.boolean
setInitParameter(java.lang.String name, java.lang.String value)
Add an initialisation parameter if not already added.java.util.Set<java.lang.String>
setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)
Add multiple initialisation parameters.void
setLoadOnStartup(int loadOnStartup)
void
setMultipartConfig(MultipartConfigElement multipartConfig)
void
setRunAsRole(java.lang.String roleName)
java.util.Set<java.lang.String>
setServletSecurity(ServletSecurityElement constraint)
-
-
-
Method Detail
-
getClassName
public java.lang.String getClassName()
- Specified by:
getClassName
in interfaceRegistration
-
getInitParameter
public java.lang.String getInitParameter(java.lang.String name)
Description copied from interface:javax.servlet.Registration
Get the value of an initialisation parameter.- Specified by:
getInitParameter
in interfaceRegistration
- Parameters:
name
- The initialisation parameter whose value is required- Returns:
- The value of the named initialisation parameter
-
getInitParameters
public java.util.Map<java.lang.String,java.lang.String> getInitParameters()
Description copied from interface:javax.servlet.Registration
Get the names and values of all the initialisation parameters.- Specified by:
getInitParameters
in interfaceRegistration
- Returns:
- A Map of initialisation parameter names and associated values keyed by name
-
getName
public java.lang.String getName()
- Specified by:
getName
in interfaceRegistration
-
setInitParameter
public boolean setInitParameter(java.lang.String name, java.lang.String value)
Description copied from interface:javax.servlet.Registration
Add an initialisation parameter if not already added.- Specified by:
setInitParameter
in interfaceRegistration
- Parameters:
name
- Name of initialisation parametervalue
- Value of initialisation parameter- Returns:
true
if the initialisation parameter was set,false
if the initialisation parameter was not set because an initialisation parameter of the same name already existed
-
setInitParameters
public java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)
Description copied from interface:javax.servlet.Registration
Add multiple initialisation parameters. If any of the supplied initialisation parameter conflicts with an existing initialisation parameter, no updates will be performed.- Specified by:
setInitParameters
in interfaceRegistration
- Parameters:
initParameters
- The initialisation parameters to add- Returns:
- The set of initialisation parameter names that conflicted with existing initialisation parameter. If there are no conflicts, this Set will be empty.
-
setAsyncSupported
public void setAsyncSupported(boolean asyncSupported)
Description copied from interface:javax.servlet.Registration.Dynamic
Mark this Servlet/Filter as supported asynchronous processing.- Specified by:
setAsyncSupported
in interfaceRegistration.Dynamic
- Parameters:
asyncSupported
- Should this Servlet/Filter support asynchronous processing
-
setLoadOnStartup
public void setLoadOnStartup(int loadOnStartup)
- Specified by:
setLoadOnStartup
in interfaceServletRegistration.Dynamic
-
setMultipartConfig
public void setMultipartConfig(MultipartConfigElement multipartConfig)
- Specified by:
setMultipartConfig
in interfaceServletRegistration.Dynamic
-
setRunAsRole
public void setRunAsRole(java.lang.String roleName)
- Specified by:
setRunAsRole
in interfaceServletRegistration.Dynamic
-
setServletSecurity
public java.util.Set<java.lang.String> setServletSecurity(ServletSecurityElement constraint)
- Specified by:
setServletSecurity
in interfaceServletRegistration.Dynamic
-
addMapping
public java.util.Set<java.lang.String> addMapping(java.lang.String... urlPatterns)
Description copied from interface:javax.servlet.ServletRegistration
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. The returned set is not backed by the ServletRegistration object, so changes in the returned set are not reflected in the ServletRegistration object, and vice-versa.- Specified by:
addMapping
in interfaceServletRegistration
- Parameters:
urlPatterns
- The URL patterns that this Servlet should be mapped to- Returns:
- the (possibly empty) Set of URL patterns that are already mapped to a different Servlet
-
getMappings
public java.util.Collection<java.lang.String> getMappings()
Description copied from interface:javax.servlet.ServletRegistration
Gets the currently available mappings of the Servlet represented by this ServletRegistration. If permitted, any changes to the returned Collection must not affect this ServletRegistration.- Specified by:
getMappings
in interfaceServletRegistration
- Returns:
- a (possibly empty) Collection of the currently available mappings of the Servlet represented by this ServletRegistration
-
getRunAsRole
public java.lang.String getRunAsRole()
- Specified by:
getRunAsRole
in interfaceServletRegistration
-
-