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 and Inner Type Summary

Modifier and Type	Class and Description
public 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

Modifier and Type	Method and Description
public String	Returns: the fully qualified class name of the Servlet or Filter that is represented by this Registration, or null if this Registration is preliminary getClassName() Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration.
public String	Returns: the value of the initialization parameter with the given name, or `null` if no initialization parameter with the given name exists getInitParameter(String the name of the initialization parameter whose value is requested 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.
public Map<String, String>	Returns: Map containing the currently available initialization parameters that will be used to initialize the Servlet or Filter represented by this Registration object 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.
public String	Returns: the name of the Servlet or Filter that is represented by this Registration getName() Gets the name of the Servlet or Filter that is represented by this Registration.
public boolean	Returns: true if the update was successful, i.e., an initialization parameter with the given name did not already exist for the Servlet or Filter represented by this Registration, and false otherwise setInitParameter(String the initialization parameter name name, String the initialization parameter value value) Sets the initialization parameter with the given name and value on the Servlet or Filter that is represented by this Registration.
public Set<String>	Returns: the (possibly empty) Set of initialization parameter names that are in conflict setInitParameters(Map<String, String> the initialization parameters initParameters) Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration.

Method Detail

getClassName	back to summary
public String getClassName() Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration. Returns:String the fully qualified class name of the Servlet or Filter that is represented by this Registration, or null if this Registration is preliminary

getClassName

back to summary

public String getClassName()

Gets the fully qualified class name of the Servlet or Filter that is represented by this Registration.

Returns:String: the fully qualified class name of the Servlet or Filter that is represented by this Registration, or null if this Registration is preliminary

getInitParameter back to summary

getInitParameter	back to summary
public 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. Parameters name:String the name of the initialization parameter whose value is requested Returns:String the value of the initialization parameter with the given name, or `null` if no initialization parameter with the given name exists

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

Parameters

name:String: the name of the initialization parameter whose value is requested

Returns:String

the value of the initialization parameter with the given name, or null if no initialization parameter with the given name exists

getInitParameters	back to summary
public 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. Returns:Map<String, String> Map containing the currently available initialization parameters that will be used to initialize the Servlet or Filter represented by this Registration object

getInitParameters

back to summary

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

Returns:Map<String, String>: Map containing the currently available initialization parameters that will be used to initialize the Servlet or Filter represented by this Registration object

getName	back to summary
public String getName() Gets the name of the Servlet or Filter that is represented by this Registration. Returns:String the name of the Servlet or Filter that is represented by this Registration

getName

back to summary

public String getName()

Gets the name of the Servlet or Filter that is represented by this Registration.

Returns:String: the name of the Servlet or Filter that is represented by this Registration

setInitParameter back to summary

setInitParameter	back to summary
public 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. Parameters name:String the initialization parameter name value:String the initialization parameter value Returns:boolean true if the update was successful, i.e., an initialization parameter with the given name did not already exist for the Servlet or Filter represented by this Registration, and false otherwise Exceptions IllegalStateException: if the ServletContext from which this Registration was obtained has already been initialized IllegalArgumentException: if the given name or value is `null`

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

Parameters

name:String: the initialization parameter name
value:String: the initialization parameter value

Returns:boolean

true if the update was successful, i.e., an initialization parameter with the given name did not already exist for the Servlet or Filter represented by this Registration, and false otherwise

Exceptions

IllegalStateException:: if the ServletContext from which this Registration was obtained has already been initialized
IllegalArgumentException:: if the given name or value is null

setInitParameters back to summary

setInitParameters	back to summary
public Set<String> setInitParameters(Map<String, String> initParameters) Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration. 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. The returned set is not backed by the `Registration` object, so changes in the returned set are not reflected in the `Registration` object, and vice-versa. Parameters initParameters:Map<String, String> the initialization parameters Returns:Set<String> the (possibly empty) Set of initialization parameter names that are in conflict Exceptions 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 value

public Set<String> setInitParameters(Map<String, String> initParameters)

Sets the given initialization parameters on the Servlet or Filter that is represented by this Registration.

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.

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

Parameters

initParameters:Map<String, String>: the initialization parameters

Returns:Set<String>

the (possibly empty) Set of initialization parameter names that are in conflict

Exceptions

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 value

jakarta.servlet back to summary

public Interface Registration.Dynamic

Known Direct Subinterfaces: jakarta.servlet.ServletRegistration.Dynamic, jakarta.servlet.FilterRegistration.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

Modifier and Type	Method and Description
public void	setAsyncSupported(boolean true if the Servlet or Filter represented by this dynamic Registration supports asynchronous operations, false otherwise isAsyncSupported) Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or not.

Inherited from jakarta.servlet.Registration:: getClassName getInitParameter getInitParameters getName setInitParameter setInitParameters

Method Detail

setAsyncSupported	back to summary
public void setAsyncSupported(boolean isAsyncSupported) Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or not. By default, servlet and filters do not support asynchronous operations. A call to this method overrides any previous setting. Parameters isAsyncSupported:boolean true if the Servlet or Filter represented by this dynamic Registration supports asynchronous operations, false otherwise Exceptions IllegalStateException: if the ServletContext from which this dynamic Registration was obtained has already been initialized

setAsyncSupported

back to summary

public void setAsyncSupported(boolean isAsyncSupported)

Configures the Servlet or Filter represented by this dynamic Registration as supporting asynchronous operations or not.

By default, servlet and filters do not support asynchronous operations.

A call to this method overrides any previous setting.

Parameters

isAsyncSupported:boolean: true if the Servlet or Filter represented by this dynamic Registration supports asynchronous operations, false otherwise

Exceptions

IllegalStateException:: if the ServletContext from which this dynamic Registration was obtained has already been initialized