Modifier and Type	Class and Description
public static interface	ServletRegistration.Dynamic Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further configured.

Method Summary

Modifier and Type	Method and Description
public Set<String>	Returns: the (possibly empty) Set of URL patterns that are already mapped to a different Servlet addMapping(String... The URL patterns that this Servlet should be mapped to urlPatterns) Adds a servlet mapping with the given URL patterns for the Servlet represented by this ServletRegistration.
public Collection<String>	Returns: a (possibly empty) Collection of the currently available mappings of the Servlet represented by this ServletRegistration getMappings() Gets the currently available mappings of the Servlet represented by this ServletRegistration.
public String	Returns: the name of the user / group or `null` if none has been specified getRunAsRole() Obtain the name of the user / group under which the Servlet has been configured to run.

Inherited from jakarta.servlet.Registration:: getClassName getInitParameter getInitParameters getName setInitParameter setInitParameters

Method Detail

addMapping	back to summary
public 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. 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. Parameters urlPatterns:String[] The URL patterns that this Servlet should be mapped to Returns:Set<String> the (possibly empty) Set of URL patterns that are already mapped to a different Servlet Exceptions IllegalArgumentException: if urlPattern is null or empty IllegalStateException: if the associated ServletContext has already been initialised

addMapping

back to summary

public 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. 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.

Parameters

urlPatterns:String[]: The URL patterns that this Servlet should be mapped to

Returns:Set<String>

the (possibly empty) Set of URL patterns that are already mapped to a different Servlet

Exceptions

IllegalArgumentException:: if urlPattern is null or empty
IllegalStateException:: if the associated ServletContext has already been initialised

getMappings	back to summary
public Collection<String> getMappings() 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. Returns:Collection<String> a (possibly empty) Collection of the currently available mappings of the Servlet represented by this ServletRegistration

getMappings

back to summary

public Collection<String> getMappings()

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.

Returns:Collection<String>: a (possibly empty) Collection of the currently available mappings of the Servlet represented by this ServletRegistration

getRunAsRole back to summary

getRunAsRole	back to summary
public String getRunAsRole() Obtain the name of the user / group under which the Servlet has been configured to run. Returns:String the name of the user / group or `null` if none has been specified

public String getRunAsRole()

Obtain the name of the user / group under which the Servlet has been configured to run.

Returns:String: the name of the user / group or null if none has been specified

jakarta.servlet back to summary

public Interface ServletRegistration.Dynamic

Known Direct Implementers: org.apache.catalina.core.ApplicationServletRegistration

Interface through which a Servlet registered via one of the addServlet methods on ServletContext may be further configured.

Method Summary

Modifier and Type	Method and Description
public void	setLoadOnStartup(int The position in the order the Servlet should be started (higher numbers are started after lower numbers) loadOnStartup) Set the loadOnStartup order for the Servlet
public void	setMultipartConfig(MultipartConfigElement The configuration to associate with the Servlet multipartConfig) Set the multi-part configuration for the associated Servlet.
public void	setRunAsRole(String name of the user / group or `null` if none roleName) Set the name of the user / group under which the Servlet should be configured to run.
public Set<String>	Returns: urls currently mapped to this registration that are already present in web.xml setServletSecurity(ServletSecurityElement new security constraints for this Servlet constraint) Add security constraints to this Servlet.

Inherited from jakarta.servlet.Registration.Dynamic:: setAsyncSupported
Inherited from jakarta.servlet.ServletRegistration:: addMapping getMappings getRunAsRole

Method Detail

setLoadOnStartup	back to summary
public void setLoadOnStartup(int loadOnStartup) Set the loadOnStartup order for the Servlet Parameters loadOnStartup:int The position in the order the Servlet should be started (higher numbers are started after lower numbers)

setLoadOnStartup

back to summary

public void setLoadOnStartup(int loadOnStartup)

Set the loadOnStartup order for the Servlet

Parameters

loadOnStartup:int: The position in the order the Servlet should be started (higher numbers are started after lower numbers)

setMultipartConfig back to summary

setMultipartConfig	back to summary
public void setMultipartConfig(MultipartConfigElement multipartConfig) Set the multi-part configuration for the associated Servlet. To clear the multi-part configuration specify `null` as the new value. Parameters multipartConfig:MultipartConfigElement The configuration to associate with the Servlet

public void setMultipartConfig(MultipartConfigElement multipartConfig)

Set the multi-part configuration for the associated Servlet. To clear the multi-part configuration specify null as the new value.

Parameters

multipartConfig:MultipartConfigElement: The configuration to associate with the Servlet

setRunAsRole back to summary

setRunAsRole	back to summary
public void setRunAsRole(String roleName) Set the name of the user / group under which the Servlet should be configured to run. Parameters roleName:String name of the user / group or `null` if none

public void setRunAsRole(String roleName)

Set the name of the user / group under which the Servlet should be configured to run.

Parameters

roleName:String: name of the user / group or null if none

setServletSecurity	back to summary
public Set<String> setServletSecurity(ServletSecurityElement constraint) Add security constraints to this Servlet. Parameters constraint:ServletSecurityElement new security constraints for this Servlet Returns:Set<String> urls currently mapped to this registration that are already present in web.xml

setServletSecurity

back to summary

public Set<String> setServletSecurity(ServletSecurityElement constraint)

Add security constraints to this Servlet.

Parameters

constraint:ServletSecurityElement: new security constraints for this Servlet

Returns:Set<String>

urls currently mapped to this registration that are already present in web.xml

public Interface ServletRegistration

Nested and Inner Type Summary

Method Summary

Method Detail

public Interface ServletRegistration.Dynamic

Method Summary

Method Detail