|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Registration
Interface through which a 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
.
Nested Class Summary | |
---|---|
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. |
Method Summary | |
---|---|
java.lang.String |
getClassName()
Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration. |
java.lang.String |
getInitParameter(java.lang.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. |
java.util.Map<java.lang.String,java.lang.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. |
java.lang.String |
getName()
Gets the name of the Servlet or Filter that is represented by this Registration. |
boolean |
setInitParameter(java.lang.String name,
java.lang.String value)
Sets the initialization parameter with the given name and value on the Servlet or Filter that is represented by this Registration. |
java.util.Set<java.lang.String> |
setInitParameters(java.util.Map<java.lang.String,java.lang.String> initParameters)
Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration. |
Method Detail |
---|
java.lang.String getName()
java.lang.String getClassName()
boolean setInitParameter(java.lang.String name, java.lang.String value)
name
- the initialization parameter namevalue
- the initialization parameter value
IllegalStateException
- if the ServletContext from which this
Registration was obtained has already been initialized
IllegalArgumentException
- if the given name or value is
nulljava.lang.String getInitParameter(java.lang.String name)
name
- the name of the initialization parameter whose value is
requested
java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.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 parameters
IllegalStateException
- if the ServletContext from which this
Registration was obtained has already been initialized
IllegalArgumentException
- if the given map contains an
initialization parameter with a null name or valuejava.util.Map<java.lang.String,java.lang.String> getInitParameters()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.
Generated on 10-February-2011 12:41