servlet::ServletConfig Class Reference

#include <ServletConfig.h>

Inheritance diagram for servlet::ServletConfig:

[legend]

List of all members.

Public Member Functions
virtual	~ServletConfig ()
virtual std::string	getServletName () const =0
virtual ServletContext &	getServletContext () const =0
virtual std::string	getInitParameter (const std::string &name) const =0
virtual std::auto_ptr < std::vector< std::string > >	getInitParameterNames () const =0

---

Detailed Description

ServletConfig

A servlet configuration object used by a servlet container to pass information to a servlet during initialization.

Definition at line 73 of file ServletConfig.h.

---

Constructor & Destructor Documentation

virtual servlet::ServletConfig::~ServletConfig

(

)

[inline, virtual]

Definition at line 75 of file ServletConfig.h.

---

Member Function Documentation

virtual std::string servlet::ServletConfig::getInitParameter

(

const std::string &

name

)

const [pure virtual]

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

Parameters:

name

a String specifying the name of the initialization parameter

Returns:

a String containing the value of the initialization parameter

Implemented in container::ServletConfigImpl, and servlet::GenericServlet.

virtual std::auto_ptr< std::vector<std::string> > servlet::ServletConfig::getInitParameterNames

(

)

const [pure virtual]

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

Returns:

an Enumeration of String objects containing the names of the servlet's initialization parameters

Implemented in container::ServletConfigImpl, and servlet::GenericServlet.

Referenced by servlet::GenericServlet::getInitParameterNames().

virtual ServletContext& servlet::ServletConfig::getServletContext

(

)

const [pure virtual]

Returns a reference to the servlet::ServletContext in which the caller is executing.

Returns:

a servlet::ServletContext object, used by the caller to interact with its servlet container

See also:

ServletContext

Implemented in container::ServletConfigImpl, and servlet::GenericServlet.

Referenced by servlet::GenericServlet::getServletContext().

virtual std::string servlet::ServletConfig::getServletName

(

)

const [pure virtual]

Returns the name of this servlet instance. The name may be provided via server administration, assigned in the web application deployment descriptor, or for an unregistered (and thus unnamed) servlet instance it will be the servlet's class name.

Returns:

the name of the servlet instance

Implemented in container::ServletConfigImpl, and servlet::GenericServlet.

Referenced by servlet::GenericServlet::getServletName().

---

The documentation for this class was generated from the following file:

• include/servlet/ServletConfig.h