public static interface ServletRegistration.Dynamic extends ServletRegistration, Registration.Dynamic
Servlet
registered via one of the
addServlet methods on ServletContext
may be further
configured.ServletRegistration.Dynamic
Modifier and Type | Method and Description |
---|---|
void |
setLoadOnStartup(int loadOnStartup)
Sets the
loadOnStartup priority on the Servlet
represented by this dynamic ServletRegistration. |
void |
setMultipartConfig(MultipartConfigElement multipartConfig)
Sets the
MultipartConfigElement to be applied to the
mappings defined for this ServletRegistration . |
void |
setRunAsRole(String roleName)
Sets the name of the
runAs role for this
ServletRegistration . |
Set<String> |
setServletSecurity(ServletSecurityElement constraint)
Sets the
ServletSecurityElement to be applied to the
mappings defined for this ServletRegistration . |
addMapping, getMappings, getRunAsRole
setAsyncSupported
getClassName, getInitParameter, getInitParameters, getName, setInitParameter, setInitParameters
void setLoadOnStartup(int loadOnStartup)
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.
loadOnStartup
- the initialization priority of the ServletIllegalStateException
- if the ServletContext from which
this ServletRegistration was obtained has already been initializedSet<String> setServletSecurity(ServletSecurityElement constraint)
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
.
constraint
- the ServletSecurityElement
to be applied
to the patterns mapped to this ServletRegistrationsecurity-constraint
that was
established via the portable deployment descriptor. This method
has no effect on the patterns included in the returned setIllegalArgumentException
- if constraint is nullIllegalStateException
- if the ServletContext
from
which this ServletRegistration
was obtained has
already been initializedvoid setMultipartConfig(MultipartConfigElement multipartConfig)
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.multipartConfig
- the MultipartConfigElement
to be
applied to the patterns mapped to the registrationIllegalArgumentException
- if multipartConfig is
nullIllegalStateException
- if the ServletContext
from
which this ServletRegistration was obtained has already been
initializedvoid setRunAsRole(String roleName)
runAs
role for this
ServletRegistration
.roleName
- the name of the runAs
roleIllegalArgumentException
- if roleName is nullIllegalStateException
- if the ServletContext
from
which this ServletRegistration was obtained has already been
initializedCopyright © 1999-2013, Oracle and/or its affiliates. All Rights Reserved. Use is subject to license terms. Portions Copyright © 1999-2002 The Apache Software Foundation.