cn.imaq.tompuss.servlet

类 TPServletRegistration

java.lang.Object

cn.imaq.tompuss.core.TPRegistration<javax.servlet.Servlet>

cn.imaq.tompuss.servlet.TPServletRegistration

所有已实现的接口:

javax.servlet.Registration, javax.servlet.Registration.Dynamic, javax.servlet.ServletRegistration, javax.servlet.ServletRegistration.Dynamic

public class TPServletRegistration
extends TPRegistration<javax.servlet.Servlet>
implements javax.servlet.ServletRegistration.Dynamic

嵌套类概要

从接口继承的嵌套类/接口 javax.servlet.ServletRegistration

javax.servlet.ServletRegistration.Dynamic

字段概要

从类继承的字段 cn.imaq.tompuss.core.TPRegistration

context, instance, name

构造器概要

构造器

构造器和说明
TPServletRegistration(TPServletContext context, java.lang.String name, javax.servlet.Servlet instance)

方法概要

限定符和类型	方法和说明
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 this ServletRegistration.
java.lang.String	getRunAsRole() Gets the name of the runAs role of the Servlet represented by this ServletRegistration.
javax.servlet.Servlet	getServletInstance()
void	loadAnnotation(javax.servlet.annotation.WebServlet ws)
void	setLoadOnStartup(int loadOnStartup) Sets the loadOnStartup priority on the Servlet represented by this dynamic ServletRegistration.
void	setMultipartConfig(javax.servlet.MultipartConfigElement multipartConfig) Sets the MultipartConfigElement to be applied to the mappings defined for this ServletRegistration.
void	setRunAsRole(java.lang.String roleName) Sets the name of the runAs role for this ServletRegistration.
java.util.Set<java.lang.String>	setServletSecurity(javax.servlet.ServletSecurityElement constraint) Sets the ServletSecurityElement to be applied to the mappings defined for this ServletRegistration.

从类继承的方法 cn.imaq.tompuss.core.TPRegistration

getClassName, getInitParameter, getInitParameters, getName, setAsyncSupported, setInitParameter, setInitParameters

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 javax.servlet.Registration.Dynamic

setAsyncSupported

从接口继承的方法 javax.servlet.Registration

getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters

构造器详细资料

TPServletRegistration

public TPServletRegistration(TPServletContext context,
                             java.lang.String name,
                             javax.servlet.Servlet instance)

方法详细资料

loadAnnotation

public void loadAnnotation(javax.servlet.annotation.WebServlet ws)

getServletInstance

public javax.servlet.Servlet getServletInstance()

setLoadOnStartup

public void setLoadOnStartup(int loadOnStartup)

Sets the loadOnStartup priority on the Servlet represented by this dynamic ServletRegistration.

A loadOnStartup value of greater than or equal to zero indicates to the container the initialization priority of the Servlet. In this case, the container must instantiate and initialize the Servlet during the initialization phase of the ServletContext, that is, after it has invoked all of the ServletContextListener objects configured for the ServletContext at their ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent) method.

If loadOnStartup is a negative integer, the container is free to instantiate and initialize the Servlet lazily.

The default value for loadOnStartup is -1.

A call to this method overrides any previous setting.

指定者:

setLoadOnStartup 在接口中 javax.servlet.ServletRegistration.Dynamic

参数:

loadOnStartup - the initialization priority of the Servlet

抛出:

java.lang.IllegalStateException - if the ServletContext from which this ServletRegistration was obtained has already been initialized

setServletSecurity

public java.util.Set<java.lang.String> setServletSecurity(javax.servlet.ServletSecurityElement constraint)

Sets the ServletSecurityElement to be applied to the mappings defined for this ServletRegistration.

This method applies to all mappings added to this ServletRegistration up until the point that the ServletContext from which it was obtained has been initialized.

If a URL pattern of this ServletRegistration is an exact target of a security-constraint that was established via the portable deployment descriptor, then this method does not change the security-constraint for that pattern, and the pattern will be included in the return value.

If a URL pattern of this ServletRegistration is an exact target of a security constraint that was established via the ServletSecurity annotation or a previous call to this method, then this method replaces the security constraint for that pattern.

If a URL pattern of this ServletRegistration is neither the exact target of a security constraint that was established via the ServletSecurity annotation or a previous call to this method, nor the exact target of a security-constraint in the portable deployment descriptor, then this method establishes the security constraint for that pattern from the argument ServletSecurityElement.

The returned set is not backed by the Dynamic object, so changes in the returned set are not reflected in the Dynamic object, and vice-versa.

指定者:

setServletSecurity 在接口中 javax.servlet.ServletRegistration.Dynamic

参数:

constraint - the ServletSecurityElement to be applied to the patterns mapped to this ServletRegistration

返回:

the (possibly empty) Set of URL patterns that were already the exact target of a security-constraint that was established via the portable deployment descriptor. This method has no effect on the patterns included in the returned set

抛出:

java.lang.IllegalArgumentException - if constraint is null

java.lang.IllegalStateException - if the ServletContext from which this ServletRegistration was obtained has already been initialized

setMultipartConfig

public void setMultipartConfig(javax.servlet.MultipartConfigElement multipartConfig)

Sets the MultipartConfigElement to be applied to the mappings defined for this ServletRegistration. If this method is called multiple times, each successive call overrides the effects of the former.

指定者:

setMultipartConfig 在接口中 javax.servlet.ServletRegistration.Dynamic

参数:

multipartConfig - the MultipartConfigElement to be applied to the patterns mapped to the registration

抛出:

java.lang.IllegalArgumentException - if multipartConfig is null

java.lang.IllegalStateException - if the ServletContext from which this ServletRegistration was obtained has already been initialized

setRunAsRole

public void setRunAsRole(java.lang.String roleName)

Sets the name of the runAs role for this ServletRegistration.

指定者:

setRunAsRole 在接口中 javax.servlet.ServletRegistration.Dynamic

参数:

roleName - the name of the runAs role

抛出:

java.lang.IllegalArgumentException - if roleName is null

java.lang.IllegalStateException - if the ServletContext from which this ServletRegistration was obtained has already been initialized

addMapping

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

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.

指定者:

addMapping 在接口中 javax.servlet.ServletRegistration

参数:

urlPatterns - the URL patterns of the servlet mapping

返回:

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

抛出:

java.lang.IllegalArgumentException - if urlPatterns is null or empty

java.lang.IllegalStateException - if the ServletContext from which this ServletRegistration was obtained has already been initialized

getMappings

public java.util.Collection<java.lang.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.

指定者:

getMappings 在接口中 javax.servlet.ServletRegistration

返回:

a (possibly empty) Collection of the currently available mappings of the Servlet represented by this ServletRegistration

getRunAsRole

public java.lang.String getRunAsRole()

Gets the name of the runAs role of the Servlet represented by this ServletRegistration.

指定者:

getRunAsRole 在接口中 javax.servlet.ServletRegistration

返回:

the name of the runAs role, or null if the Servlet is configured to run as its caller