public interface Registration
Servlet
or Filter
may be
further configured.
A Registration object whose getClassName()
method returns null
is considered preliminary. Servlets and Filters whose implementation
class is container implementation specific may be declared without
any servlet-class or filter-class elements, respectively,
and will be represented as preliminary Registration objects.
Preliminary registrations must be completed by calling one of the
addServlet or addFilter methods on
ServletContext
, and passing in the Servlet or Filter name
(obtained via getName()
) along with the supporting Servlet or Filter
implementation class name, Class object, or instance, respectively.
In most cases, preliminary registrations will be completed by an
appropriate, container-provided ServletContainerInitializer
.
Modifier and Type | Interface and Description |
---|---|
static interface |
Registration.Dynamic
Interface through which a
Servlet or Filter registered
via one of the addServlet or addFilter methods,
respectively, on ServletContext may be further configured. |
Modifier and Type | Method and Description |
---|---|
String |
getClassName()
Gets the fully qualified class name of the Servlet or Filter that
is represented by this Registration.
|
String |
getInitParameter(String name)
Gets the value of the initialization parameter with the given name
that will be used to initialize the Servlet or Filter represented
by this Registration object.
|
Map<String,String> |
getInitParameters()
Gets an immutable (and possibly empty) Map containing the
currently available initialization parameters that will be used to
initialize the Servlet or Filter represented by this Registration
object.
|
String |
getName()
Gets the name of the Servlet or Filter that is represented by this
Registration.
|
boolean |
setInitParameter(String name,
String value)
Sets the initialization parameter with the given name and value
on the Servlet or Filter that is represented by this Registration.
|
Set<String> |
setInitParameters(Map<String,String> initParameters)
Sets the given initialization parameters on the Servlet or Filter
that is represented by this Registration.
|
String getName()
String getClassName()
boolean setInitParameter(String name, String value)
name
- the initialization parameter namevalue
- the initialization parameter valueIllegalStateException
- if the ServletContext from which this
Registration was obtained has already been initializedIllegalArgumentException
- if the given name or value is
nullString getInitParameter(String name)
name
- the name of the initialization parameter whose value is
requestedSet<String> setInitParameters(Map<String,String> initParameters)
The given map of initialization parameters is processed
by-value, i.e., for each initialization parameter contained
in the map, this method calls setInitParameter(String,String)
.
If that method would return false for any of the
initialization parameters in the given map, no updates will be
performed, and false will be returned. Likewise, if the map contains
an initialization parameter with a null name or value, no
updates will be performed, and an IllegalArgumentException will be
thrown.
initParameters
- the initialization parametersIllegalStateException
- if the ServletContext from which this
Registration was obtained has already been initializedIllegalArgumentException
- if the given map contains an
initialization parameter with a null name or valueMap<String,String> getInitParameters()
Copyright © 2017 JBoss by Red Hat. All rights reserved.