javax.servlet

Interface Registration

All Known Subinterfaces:

FilterRegistration, FilterRegistration.Dynamic, Registration.Dynamic, ServletRegistration, ServletRegistration.Dynamic

public interface Registration

Base interface for configuring a servlet or filter.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Registration.Dynamic Dynamic registration support.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClassName() Returns the class name of the servlet or filter.
java.lang.String	getInitParameter(java.lang.String name) Returns the specified initialization parameter.
java.util.Map<java.lang.String,java.lang.String>	getInitParameters() Returns the initialization parameters set for this registration.
java.lang.String	getName() Returns the servlet or filter name.
boolean	setInitParameter(java.lang.String name, java.lang.String value) Sets the specified initialization parameter.
java.util.Set<java.lang.String>	setInitParameters(java.util.Map<java.lang.String,java.lang.String> params) Bulk set operation.

Method Detail

getName

java.lang.String getName()

Returns the servlet or filter name.

getClassName

java.lang.String getClassName()

Returns the class name of the servlet or filter.

setInitParameter

boolean setInitParameter(java.lang.String name,
                       java.lang.String value)

Sets the specified initialization parameter.

Throws:

java.lang.IllegalArgumentException - if name or value is null

java.lang.IllegalStateException - if the context is already initialized

getInitParameter

java.lang.String getInitParameter(java.lang.String name)

Returns the specified initialization parameter.

setInitParameters

java.util.Set<java.lang.String> setInitParameters(java.util.Map<java.lang.String,java.lang.String> params)

Bulk set operation.

Throws:

java.lang.IllegalArgumentException - if any name or value is null

java.lang.IllegalStateException - if the context is already initialized

getInitParameters

java.util.Map<java.lang.String,java.lang.String> getInitParameters()

Returns the initialization parameters set for this registration. The returned map will be immutable.