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.RegistrationRegistration.Dynamic
 - 
Nested classes/interfaces inherited from interface javax.servlet.ServletRegistrationServletRegistration.Dynamic
 
- 
 - 
Constructor SummaryConstructors Constructor Description ApplicationServletRegistration(Wrapper wrapper, Context context)
 - 
Method SummaryAll 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.StringgetClassName()Obtain the name of the implementation class for the Servlet.java.lang.StringgetInitParameter(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.StringgetName()Obtain the name of the Servlet.java.lang.StringgetRunAsRole()Obtain the name of the user / group under which the Servlet has been configured to run.voidsetAsyncSupported(boolean asyncSupported)Mark this Servlet/Filter as supported asynchronous processing.booleansetInitParameter(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.voidsetLoadOnStartup(int loadOnStartup)Set the loadOnStartup order for the ServletvoidsetMultipartConfig(MultipartConfigElement multipartConfig)Set the multi-part configuration for the associated Servlet.voidsetRunAsRole(java.lang.String roleName)Set the name of the user / group under which the Servlet should be configured to run.java.util.Set<java.lang.String>setServletSecurity(ServletSecurityElement constraint)Add security constraints to this Servlet.
 
- 
- 
- 
Method Detail- 
getClassNamepublic java.lang.String getClassName() Description copied from interface:javax.servlet.RegistrationObtain the name of the implementation class for the Servlet.- Specified by:
- getClassNamein interface- Registration
- Returns:
- the name of the implementation class for the Servlet.
 
 - 
getInitParameterpublic java.lang.String getInitParameter(java.lang.String name) Description copied from interface:javax.servlet.RegistrationGet the value of an initialisation parameter.- Specified by:
- getInitParameterin interface- Registration
- Parameters:
- name- The initialisation parameter whose value is required
- Returns:
- The value of the named initialisation parameter
 
 - 
getInitParameterspublic java.util.Map<java.lang.String,java.lang.String> getInitParameters() Description copied from interface:javax.servlet.RegistrationGet the names and values of all the initialisation parameters.- Specified by:
- getInitParametersin interface- Registration
- Returns:
- A Map of initialisation parameter names and associated values keyed by name
 
 - 
getNamepublic java.lang.String getName() Description copied from interface:javax.servlet.RegistrationObtain the name of the Servlet.- Specified by:
- getNamein interface- Registration
- Returns:
- the name of the Servlet.
 
 - 
setInitParameterpublic boolean setInitParameter(java.lang.String name, java.lang.String value)Description copied from interface:javax.servlet.RegistrationAdd an initialisation parameter if not already added.- Specified by:
- setInitParameterin interface- Registration
- Parameters:
- name- Name of initialisation parameter
- value- Value of initialisation parameter
- Returns:
- trueif the initialisation parameter was set,- falseif the initialisation parameter was not set because an initialisation parameter of the same name already existed
 
 - 
setInitParameterspublic java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters) Description copied from interface:javax.servlet.RegistrationAdd multiple initialisation parameters. If any of the supplied initialisation parameter conflicts with an existing initialisation parameter, no updates will be performed.- Specified by:
- setInitParametersin interface- Registration
- 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.
 
 - 
setAsyncSupportedpublic void setAsyncSupported(boolean asyncSupported) Description copied from interface:javax.servlet.Registration.DynamicMark this Servlet/Filter as supported asynchronous processing.- Specified by:
- setAsyncSupportedin interface- Registration.Dynamic
- Parameters:
- asyncSupported- Should this Servlet/Filter support asynchronous processing
 
 - 
setLoadOnStartuppublic void setLoadOnStartup(int loadOnStartup) Description copied from interface:javax.servlet.ServletRegistration.DynamicSet the loadOnStartup order for the Servlet- Specified by:
- setLoadOnStartupin interface- ServletRegistration.Dynamic
- Parameters:
- loadOnStartup- The position in the order the Servlet should be started (higher numbers are started after lower numbers)
 
 - 
setMultipartConfigpublic void setMultipartConfig(MultipartConfigElement multipartConfig) Description copied from interface:javax.servlet.ServletRegistration.DynamicSet the multi-part configuration for the associated Servlet. To clear the multi-part configuration specifynullas the new value.- Specified by:
- setMultipartConfigin interface- ServletRegistration.Dynamic
- Parameters:
- multipartConfig- The configuration to associate with the Servlet
 
 - 
setRunAsRolepublic void setRunAsRole(java.lang.String roleName) Description copied from interface:javax.servlet.ServletRegistration.DynamicSet the name of the user / group under which the Servlet should be configured to run.- Specified by:
- setRunAsRolein interface- ServletRegistration.Dynamic
- Parameters:
- roleName- name of the user / group or- nullif none
 
 - 
setServletSecuritypublic java.util.Set<java.lang.String> setServletSecurity(ServletSecurityElement constraint) Description copied from interface:javax.servlet.ServletRegistration.DynamicAdd security constraints to this Servlet.- Specified by:
- setServletSecurityin interface- ServletRegistration.Dynamic
- Parameters:
- constraint- new security constraints for this Servlet
- Returns:
- urls currently mapped to this registration that are already present in web.xml
 
 - 
addMappingpublic java.util.Set<java.lang.String> addMapping(java.lang.String... urlPatterns) Description copied from interface:javax.servlet.ServletRegistrationAdds 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:
- addMappingin interface- ServletRegistration
- 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
 
 - 
getMappingspublic java.util.Collection<java.lang.String> getMappings() Description copied from interface:javax.servlet.ServletRegistrationGets 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:
- getMappingsin interface- ServletRegistration
- Returns:
- a (possibly empty) Collection of the currently available mappings of the Servlet represented by this ServletRegistration
 
 - 
getRunAsRolepublic java.lang.String getRunAsRole() Description copied from interface:javax.servlet.ServletRegistrationObtain the name of the user / group under which the Servlet has been configured to run.- Specified by:
- getRunAsRolein interface- ServletRegistration
- Returns:
- the name of the user / group or nullif none has been specified
 
 
- 
 
-