geronimo-spec-servlet 2.4-rc4 · javax.servlet.ServletContext

Method Summary

Modifier and Type	Method and Description
public Object	Returns: an `Object` containing the value of the attribute, or `null` if no attribute exists matching the given name getAttribute(String a `String` specifying the name of the attribute name) Returns the servlet container attribute with the given name, or `null` if there is no attribute by that name.
public Enumeration<E>	Returns: an `Enumeration` of attribute names getAttributeNames() Returns an `Enumeration` containing the attribute names available within this servlet context.
public ServletContext	Returns: the `ServletContext` object that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access. getContext(String a `String` specifying the context path of another web application in the container. uripath) Returns a `ServletContext` object that corresponds to a specified URL on the server.
public String	Returns: a `String` containing at least the servlet container name and version number getInitParameter(String a `String` containing the name of the parameter whose value is requested name) Returns a `String` containing the value of the named context-wide initialization parameter, or `null` if the parameter does not exist.
public Enumeration<E>	Returns: an `Enumeration` of `String` objects containing the names of the context's initialization parameters getInitParameterNames() Returns the names of the context's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the context has no initialization parameters.
public int	Returns: 2 getMajorVersion() Returns the major version of the Java Servlet API that this servlet container supports.
public String	Returns: a `String` specifying the file's MIME type getMimeType(String a `String` specifying the name of a file file) Returns the MIME type of the specified file, or `null` if the MIME type is not known.
public int	Returns: 4 getMinorVersion() Returns the minor version of the Servlet API that this servlet container supports.
public RequestDispatcher	Returns: a `RequestDispatcher` object that acts as a wrapper for the named servlet, or `null` if the `ServletContext` cannot return a `RequestDispatcher` getNamedDispatcher(String a `String` specifying the name of a servlet to wrap name) Returns a `RequestDispatcher` object that acts as a wrapper for the named servlet.
public String	Returns: a `String` specifying the real path, or null if the translation cannot be performed getRealPath(String a `String` specifying a virtual path path) Returns a `String` containing the real path for a given virtual path.
public RequestDispatcher	Returns: a `RequestDispatcher` object that acts as a wrapper for the resource at the specified path, or `null` if the `ServletContext` cannot return a `RequestDispatcher` getRequestDispatcher(String a `String` specifying the pathname to the resource path) Returns a `RequestDispatcher` object that acts as a wrapper for the resource located at the given path.
public URL	Returns: the resource located at the named path, or `null` if there is no resource at that path getResource(String a `String` specifying the path to the resource path) Returns a URL to the resource that is mapped to a specified path.
public InputStream	Returns: the `InputStream` returned to the servlet, or `null` if no resource exists at the specified path getResourceAsStream(String a `String` specifying the path to the resource path) Returns the resource located at the named path as an `InputStream` object.
public Set<E>	Returns: a Set containing the directory listing, or null if there are no resources in the web application whose path begins with the supplied path. getResourcePaths(String the partial path used to match the resources, which must start with a / path) Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument.
public String	Returns: a `String` containing at least the servlet container name and version number getServerInfo() Returns the name and version of the servlet container on which the servlet is running.
public Servlet	getServlet(String name) Deprecated As of Java Servlet API 2.1, with no direct replacement.
public String	Returns: The name of the web application or null if no name has been declared in the deployment descriptor. getServletContextName() Returns the name of this web application correponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.
public Enumeration<E>	getServletNames() Deprecated As of Java Servlet API 2.1, with no replacement.
public Enumeration<E>	getServlets() Deprecated As of Java Servlet API 2.0, with no replacement.
public void	log(String a `String` specifying the message to be written to the log file msg) Writes the specified message to a servlet log file, usually an event log.
public void	log(Exception exception, String msg) Deprecated As of Java Servlet API 2.1, use `log(String message, Throwable throwable)` instead.
public void	log(String a `String` that describes the error or exception message, Throwable the `Throwable` error or exception throwable) Writes an explanatory message and a stack trace for a given `Throwable` exception to the servlet log file.
public void	removeAttribute(String a `String` specifying the name of the attribute to be removed name) Removes the attribute with the given name from the servlet context.
public void	setAttribute(String a `String` specifying the name of the attribute name, Object an `Object` representing the attribute to be bound object) Binds an object to a given attribute name in this servlet context.

Method Detail

getAttribute back to summary

getAttribute	back to summary
public Object getAttribute(String name) Returns the servlet container attribute with the given name, or `null` if there is no attribute by that name. An attribute allows a servlet container to give the servlet additional information not already provided by this interface. See your server documentation for information about its attributes. A list of supported attributes can be retrieved using `getAttributeNames`. The attribute is returned as a `java.lang.Object` or some subclass. Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching `java.`, `javax.`, and `sun.*`. Parameters name:String a `String` specifying the name of the attribute Returns:Object an `Object` containing the value of the attribute, or `null` if no attribute exists matching the given name See Also `ServletContext#getAttributeNames`

public Object getAttribute(String name)

Returns the servlet container attribute with the given name, or null if there is no attribute by that name. An attribute allows a servlet container to give the servlet additional information not already provided by this interface. See your server documentation for information about its attributes. A list of supported attributes can be retrieved using getAttributeNames.

The attribute is returned as a java.lang.Object or some subclass. Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

Parameters

name:String: a String specifying the name of the attribute

Returns:Object

an Object containing the value of the attribute, or null if no attribute exists matching the given name

See Also

ServletContext#getAttributeNames

getAttributeNames back to summary

getAttributeNames	back to summary
public Enumeration<E> getAttributeNames() Returns an `Enumeration` containing the attribute names available within this servlet context. Use the `getAttribute` method with an attribute name to get the value of an attribute. Returns:Enumeration<E> an `Enumeration` of attribute names See Also `getAttribute`

public Enumeration<E> getAttributeNames()

Returns an Enumeration containing the attribute names available within this servlet context. Use the getAttribute method with an attribute name to get the value of an attribute.

Returns:Enumeration<E>: an Enumeration of attribute names
See Also: getAttribute

getContext back to summary

getContext	back to summary
public ServletContext getContext(String uripath) Returns a `ServletContext` object that corresponds to a specified URL on the server. This method allows servlets to gain access to the context for various parts of the server, and as needed obtain `RequestDispatcher` objects from the context. The given path must be begin with "/", is interpreted relative to the server's document root and is matched against the context roots of other web applications hosted on this container. In a security conscious environment, the servlet container may return `null` for a given URL. Parameters uripath:String a `String` specifying the context path of another web application in the container. Returns:ServletContext the `ServletContext` object that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access. See Also `RequestDispatcher`

public ServletContext getContext(String uripath)

Returns a ServletContext object that corresponds to a specified URL on the server.

This method allows servlets to gain access to the context for various parts of the server, and as needed obtain RequestDispatcher objects from the context. The given path must be begin with "/", is interpreted relative to the server's document root and is matched against the context roots of other web applications hosted on this container.

In a security conscious environment, the servlet container may return null for a given URL.

Parameters

uripath:String: a String specifying the context path of another web application in the container.

Returns:ServletContext

the ServletContext object that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access.

See Also

RequestDispatcher

getInitParameter back to summary

getInitParameter	back to summary
public String getInitParameter(String name) Returns a `String` containing the value of the named context-wide initialization parameter, or `null` if the parameter does not exist. This method can make available configuration information useful to an entire "web application". For example, it can provide a webmaster's email address or the name of a system that holds critical data. Parameters name:String a `String` containing the name of the parameter whose value is requested Returns:String a `String` containing at least the servlet container name and version number See Also `ServletConfig#getInitParameter`

public String getInitParameter(String name)

Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.

This method can make available configuration information useful to an entire "web application". For example, it can provide a webmaster's email address or the name of a system that holds critical data.

Parameters

name:String: a String containing the name of the parameter whose value is requested

Returns:String

a String containing at least the servlet container name and version number

See Also

ServletConfig#getInitParameter

getInitParameterNames back to summary

getInitParameterNames	back to summary
public Enumeration<E> getInitParameterNames() Returns the names of the context's initialization parameters as an `Enumeration` of `String` objects, or an empty `Enumeration` if the context has no initialization parameters. Returns:Enumeration<E> an `Enumeration` of `String` objects containing the names of the context's initialization parameters See Also `ServletConfig#getInitParameter`

public Enumeration<E> getInitParameterNames()

Returns the names of the context's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.

Returns:Enumeration<E>: an Enumeration of String objects containing the names of the context's initialization parameters
See Also: ServletConfig#getInitParameter

getMajorVersion	back to summary
public int getMajorVersion() Returns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 2.4 must have this method return the integer 2. Returns:int 2

getMajorVersion

back to summary

public int getMajorVersion()

Returns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 2.4 must have this method return the integer 2.

Returns:int: 2

getMimeType back to summary

getMimeType	back to summary
public String getMimeType(String file) Returns the MIME type of the specified file, or `null` if the MIME type is not known. The MIME type is determined by the configuration of the servlet container, and may be specified in a web application deployment descriptor. Common MIME types are `"text/html"` and `"image/gif"`. Parameters file:String a `String` specifying the name of a file Returns:String a `String` specifying the file's MIME type

public String getMimeType(String file)

Returns the MIME type of the specified file, or null if the MIME type is not known. The MIME type is determined by the configuration of the servlet container, and may be specified in a web application deployment descriptor. Common MIME types are "text/html" and "image/gif".

Parameters

file:String: a String specifying the name of a file

Returns:String

a String specifying the file's MIME type

getMinorVersion	back to summary
public int getMinorVersion() Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 2.4 must have this method return the integer 4. Returns:int 4

getMinorVersion

back to summary

public int getMinorVersion()

Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 2.4 must have this method return the integer 4.

Returns:int: 4

getNamedDispatcher back to summary

getNamedDispatcher	back to summary
public RequestDispatcher getNamedDispatcher(String name) Returns a `RequestDispatcher` object that acts as a wrapper for the named servlet. Servlets (and JSP pages also) may be given names via server administration or via a web application deployment descriptor. A servlet instance can determine its name using `ServletConfig#getServletName`. This method returns `null` if the `ServletContext` cannot return a `RequestDispatcher` for any reason. Parameters name:String a `String` specifying the name of a servlet to wrap Returns:RequestDispatcher a `RequestDispatcher` object that acts as a wrapper for the named servlet, or `null` if the `ServletContext` cannot return a `RequestDispatcher` See Also `RequestDispatcher`, `ServletContext#getContext`, `ServletConfig#getServletName`

public RequestDispatcher getNamedDispatcher(String name)

Returns a RequestDispatcher object that acts as a wrapper for the named servlet.

Servlets (and JSP pages also) may be given names via server administration or via a web application deployment descriptor. A servlet instance can determine its name using ServletConfig#getServletName.

This method returns null if the ServletContext cannot return a RequestDispatcher for any reason.

Parameters

name:String: a String specifying the name of a servlet to wrap

Returns:RequestDispatcher

a RequestDispatcher object that acts as a wrapper for the named servlet, or null if the ServletContext cannot return a RequestDispatcher

getRealPath back to summary

getRealPath	back to summary
public String getRealPath(String path) Returns a `String` containing the real path for a given virtual path. For example, the path "/index.html" returns the absolute file path on the server's filesystem would be served by a request for "http://host/contextPath/index.html", where contextPath is the context path of this ServletContext.. The real path returned will be in a form appropriate to the computer and operating system on which the servlet container is running, including the proper path separators. This method returns `null` if the servlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a `.war` archive). Parameters path:String a `String` specifying a virtual path Returns:String a `String` specifying the real path, or null if the translation cannot be performed

public String getRealPath(String path)

Returns a String containing the real path for a given virtual path. For example, the path "/index.html" returns the absolute file path on the server's filesystem would be served by a request for "http://host/contextPath/index.html", where contextPath is the context path of this ServletContext..

The real path returned will be in a form appropriate to the computer and operating system on which the servlet container is running, including the proper path separators. This method returns null if the servlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a .war archive).

Parameters

path:String: a String specifying a virtual path

Returns:String

a String specifying the real path, or null if the translation cannot be performed

getRequestDispatcher back to summary

getRequestDispatcher	back to summary
public RequestDispatcher getRequestDispatcher(String path) Returns a `RequestDispatcher` object that acts as a wrapper for the resource located at the given path. A `RequestDispatcher` object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static. The pathname must begin with a "/" and is interpreted as relative to the current context root. Use `getContext` to obtain a `RequestDispatcher` for resources in foreign contexts. This method returns `null` if the `ServletContext` cannot return a `RequestDispatcher`. Parameters path:String a `String` specifying the pathname to the resource Returns:RequestDispatcher a `RequestDispatcher` object that acts as a wrapper for the resource at the specified path, or `null` if the `ServletContext` cannot return a `RequestDispatcher` See Also `RequestDispatcher`, `ServletContext#getContext`

public RequestDispatcher getRequestDispatcher(String path)

Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

The pathname must begin with a "/" and is interpreted as relative to the current context root. Use getContext to obtain a RequestDispatcher for resources in foreign contexts. This method returns null if the ServletContext cannot return a RequestDispatcher.

Parameters

path:String: a String specifying the pathname to the resource

Returns:RequestDispatcher

a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the ServletContext cannot return a RequestDispatcher

getResource back to summary

getResource	back to summary
public URL getResource(String path) throws MalformedURLException Returns a URL to the resource that is mapped to a specified path. The path must begin with a "/" and is interpreted as relative to the current context root. This method allows the servlet container to make a resource available to servlets from any source. Resources can be located on a local or remote file system, in a database, or in a `.war` file. The servlet container must implement the URL handlers and `URLConnection` objects that are necessary to access the resource. This method returns `null` if no resource is mapped to the pathname. Some containers may allow writing to the URL returned by this method using the methods of the URL class. The resource content is returned directly, so be aware that requesting a `.jsp` page returns the JSP source code. Use a `RequestDispatcher` instead to include results of an execution. This method has a different purpose than `java.lang.Class.getResource`, which looks up resources based on a class loader. This method does not use class loaders. Parameters path:String a `String` specifying the path to the resource Returns:URL the resource located at the named path, or `null` if there is no resource at that path Exceptions MalformedURLException: if the pathname is not given in the correct form

public URL getResource(String path) throws MalformedURLException

Returns a URL to the resource that is mapped to a specified path. The path must begin with a "/" and is interpreted as relative to the current context root.

This method allows the servlet container to make a resource available to servlets from any source. Resources can be located on a local or remote file system, in a database, or in a .war file.

The servlet container must implement the URL handlers and URLConnection objects that are necessary to access the resource.

This method returns null if no resource is mapped to the pathname.

Some containers may allow writing to the URL returned by this method using the methods of the URL class.

The resource content is returned directly, so be aware that requesting a .jsp page returns the JSP source code. Use a RequestDispatcher instead to include results of an execution.

This method has a different purpose than java.lang.Class.getResource, which looks up resources based on a class loader. This method does not use class loaders.

Parameters

path:String: a String specifying the path to the resource

Returns:URL

the resource located at the named path, or null if there is no resource at that path

Exceptions

MalformedURLException:: if the pathname is not given in the correct form

getResourceAsStream back to summary

getResourceAsStream	back to summary
public InputStream getResourceAsStream(String path) Returns the resource located at the named path as an `InputStream` object. The data in the `InputStream` can be of any type or length. The path must be specified according to the rules given in `getResource`. This method returns `null` if no resource exists at the specified path. Meta-information such as content length and content type that is available via `getResource` method is lost when using this method. The servlet container must implement the URL handlers and `URLConnection` objects necessary to access the resource. This method is different from `java.lang.Class.getResourceAsStream`, which uses a class loader. This method allows servlet containers to make a resource available to a servlet from any location, without using a class loader. Parameters path:String a `String` specifying the path to the resource Returns:InputStream the `InputStream` returned to the servlet, or `null` if no resource exists at the specified path

public InputStream getResourceAsStream(String path)

Returns the resource located at the named path as an InputStream object.

The data in the InputStream can be of any type or length. The path must be specified according to the rules given in getResource. This method returns null if no resource exists at the specified path.

Meta-information such as content length and content type that is available via getResource method is lost when using this method.

The servlet container must implement the URL handlers and URLConnection objects necessary to access the resource.

This method is different from java.lang.Class.getResourceAsStream, which uses a class loader. This method allows servlet containers to make a resource available to a servlet from any location, without using a class loader.

Parameters

path:String: a String specifying the path to the resource

Returns:InputStream

the InputStream returned to the servlet, or null if no resource exists at the specified path

getResourcePaths	back to summary
public Set<E> getResourcePaths(String path) Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all relative to the root of the web application and have a leading '/'. For example, for a web application containing /welcome.html /catalog/index.html /catalog/products.html /catalog/offers/books.html /catalog/offers/music.html /customer/login.jsp /WEB-INF/web.xml /WEB-INF/classes/com.acme.OrderServlet.class, getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"} getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}. Parameters path:String the partial path used to match the resources, which must start with a / Returns:Set<E> a Set containing the directory listing, or null if there are no resources in the web application whose path begins with the supplied path. Since Servlet 2.3

getResourcePaths

back to summary

public Set<E> getResourcePaths(String path)

Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all relative to the root of the web application and have a leading '/'. For example, for a web application containing

/welcome.html
/catalog/index.html
/catalog/products.html
/catalog/offers/books.html
/catalog/offers/music.html
/customer/login.jsp
/WEB-INF/web.xml
/WEB-INF/classes/com.acme.OrderServlet.class,

getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}
getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.

Parameters

path:String: the partial path used to match the resources, which must start with a /

Returns:Set<E>

a Set containing the directory listing, or null if there are no resources in the web application whose path begins with the supplied path.

Since

Servlet 2.3

getServerInfo back to summary

getServerInfo	back to summary
public String getServerInfo() Returns the name and version of the servlet container on which the servlet is running. The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string `JavaServer Web Dev Kit/1.0`. The servlet container may return other optional information after the primary string in parentheses, for example, `JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)`. Returns:String a `String` containing at least the servlet container name and version number

public String getServerInfo()

Returns the name and version of the servlet container on which the servlet is running.

The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string JavaServer Web Dev Kit/1.0.

The servlet container may return other optional information after the primary string in parentheses, for example, JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86).

Returns:String: a String containing at least the servlet container name and version number

getServlet back to summary

getServlet	back to summary
public Servlet getServlet(String name) throws ServletException Deprecated As of Java Servlet API 2.1, with no direct replacement. This method was originally defined to retrieve a servlet from a `ServletContext`. In this version, this method always returns `null` and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API. In lieu of this method, servlets can share information using the `ServletContext` class and can perform shared business logic by invoking methods on common non-servlet classes.

public Servlet getServlet(String name) throws ServletException

Deprecated

As of Java Servlet API 2.1, with no direct replacement.

This method was originally defined to retrieve a servlet from a ServletContext. In this version, this method always returns null and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.

In lieu of this method, servlets can share information using the ServletContext class and can perform shared business logic by invoking methods on common non-servlet classes.

getServletContextName	back to summary
public String getServletContextName() Returns the name of this web application correponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element. Returns:String The name of the web application or null if no name has been declared in the deployment descriptor. Since Servlet 2.3

getServletContextName

back to summary

public String getServletContextName()

Returns the name of this web application correponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.

Returns:String: The name of the web application or null if no name has been declared in the deployment descriptor.
Since: Servlet 2.3

getServletNames back to summary

getServletNames	back to summary
public Enumeration<E> getServletNames() Deprecated As of Java Servlet API 2.1, with no replacement. This method was originally defined to return an `Enumeration` of all the servlet names known to this context. In this version, this method always returns an empty `Enumeration` and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.

public Enumeration<E> getServletNames()

Deprecated

As of Java Servlet API 2.1, with no replacement.

This method was originally defined to return an Enumeration of all the servlet names known to this context. In this version, this method always returns an empty Enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.

getServlets back to summary

getServlets	back to summary
public Enumeration<E> getServlets() Deprecated As of Java Servlet API 2.0, with no replacement. This method was originally defined to return an `Enumeration` of all the servlets known to this servlet context. In this version, this method always returns an empty enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.

public Enumeration<E> getServlets()

Deprecated

As of Java Servlet API 2.0, with no replacement.

This method was originally defined to return an Enumeration of all the servlets known to this servlet context. In this version, this method always returns an empty enumeration and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.

log back to summary

log	back to summary
public void log(String msg) Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container. Parameters msg:String a `String` specifying the message to be written to the log file

public void log(String msg)

Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.

Parameters

msg:String: a String specifying the message to be written to the log file

log	back to summary
public void log(Exception exception, String msg) Deprecated As of Java Servlet API 2.1, use `log(String message, Throwable throwable)` instead. This method was originally defined to write an exception's stack trace and an explanatory error message to the servlet log file.

log back to summary

log	back to summary
public void log(String message, Throwable throwable) Writes an explanatory message and a stack trace for a given `Throwable` exception to the servlet log file. The name and type of the servlet log file is specific to the servlet container, usually an event log. Parameters message:String a `String` that describes the error or exception throwable:Throwable the `Throwable` error or exception

public void log(String message, Throwable throwable)

Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file. The name and type of the servlet log file is specific to the servlet container, usually an event log.

Parameters

message:String: a String that describes the error or exception
throwable:Throwable: the Throwable error or exception

removeAttribute back to summary

removeAttribute	back to summary
public void removeAttribute(String name) Removes the attribute with the given name from the servlet context. After removal, subsequent calls to `getAttribute` to retrieve the attribute's value will return `null`. If listeners are configured on the `ServletContext` the container notifies them accordingly. Parameters name:String a `String` specifying the name of the attribute to be removed

public void removeAttribute(String name)

Removes the attribute with the given name from the servlet context. After removal, subsequent calls to getAttribute to retrieve the attribute's value will return null.

If listeners are configured on the ServletContext the container notifies them accordingly.

Parameters

name:String: a String specifying the name of the attribute to be removed

setAttribute back to summary

setAttribute	back to summary
public void setAttribute(String name, Object object) Binds an object to a given attribute name in this servlet context. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute. If listeners are configured on the `ServletContext` the container notifies them accordingly. If a null value is passed, the effect is the same as calling `removeAttribute()`. Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching `java.`, `javax.`, and `sun.*`. Parameters name:String a `String` specifying the name of the attribute object:Object an `Object` representing the attribute to be bound

public void setAttribute(String name, Object object)

Binds an object to a given attribute name in this servlet context. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.

If listeners are configured on the ServletContext the container notifies them accordingly.

If a null value is passed, the effect is the same as calling removeAttribute().

Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

Parameters

name:String: a String specifying the name of the attribute
object:Object: an Object representing the attribute to be bound

public Interface ServletContext

Method Summary

Method Detail