HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions
rwsf::ServletConfig Class Reference

Contains configuration information for a servlet instance. More...

#include <rwsf/servlet/ServletConfig.h>

Inheritance diagram for rwsf::ServletConfig:
rwsf::Config rwsf::HandleBase

Public Member Functions

 ServletConfig ()
 ServletConfig (const ServletConfig &second)
virtual ~ServletConfig ()
rwsf::ServletContext getServletContext () const
std::string getServletName () const
ServletConfigoperator= (const ServletConfig &second)
- Public Member Functions inherited from rwsf::Config
 Config ()
 Config (const Config &config)
virtual ~Config ()
bool containsParameter (const std::string &name) const
bool getBoolInitParameter (const std::string &key, bool def=false) const
std::string getInitParameter (const std::string &name) const
rwsf::Enumeration< std::string > getInitParameterNames () const
long getLongInitParameter (const std::string &key, long def=0) const
Configoperator= (const Config &rhs)
void setBoolInitParameter (const std::string &key, bool value)
void setInitParameter (const std::string &key, const std::string &value)
void setLongInitParameter (const std::string &key, long value)
- Public Member Functions inherited from rwsf::HandleBase
bool isValid (void) const
bool operator!= (const HandleBase &second) const
bool operator== (const HandleBase &second) const

Additional Inherited Members

- Protected Member Functions inherited from rwsf::HandleBase
 HandleBase (void)
 HandleBase (StaticCtor)
 HandleBase (BodyBase *body)
 HandleBase (const HandleBase &second)
virtual ~HandleBase (void)
BodyBase & body (void) const
HandleBaseoperator= (const HandleBase &second)

Detailed Description

rwsf::ServletConfig holds servlet configuration information. The Agent passes an instance of this class to the init() method of a servlet.

The behavior of the following functions are inconsistent with or not defined in the Java Servlet Specification v2.3.

getInitParameter(std::string) In the HydraExpress implementation, this member inherits from base class rwsf::Config
getInitParameterNames() In the HydraExpress implementation, this member inherits from base class rwsf::Config

Constructor & Destructor Documentation

rwsf::ServletConfig::ServletConfig ( )

Creates an empty instance; that is, a default rwsf::ServletConfig contains no information.

rwsf::ServletConfig::ServletConfig ( const ServletConfig second)

Creates a new ServletConfig handle to the body instance of second.

virtual rwsf::ServletConfig::~ServletConfig ( )

Detaches from the current body (if any), decrements its reference count, and deletes it if there are no other references.

Member Function Documentation

rwsf::ServletContext rwsf::ServletConfig::getServletContext ( ) const

Returns the servlet context for this object.

std::string rwsf::ServletConfig::getServletName ( ) const

Returns the name of this servlet instance as defined by the servlet-name element of the deployment descriptor.

ServletConfig& rwsf::ServletConfig::operator= ( const ServletConfig second)

Associates this handle with the body instance of second. Returns a reference to self.

Copyright © 2020 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.