HydraExpress™ C++ API Reference Guide

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

Holds configuration information from the deployment descriptor. More...

#include <rwsf/servlet/FilterConfig.h>

Inheritance diagram for rwsf::FilterConfig:
rwsf::Config rwsf::HandleBase

Public Member Functions

 FilterConfig ()
 FilterConfig (const FilterConfig &config)
virtual ~FilterConfig ()
std::string getFilterName () const
rwsf::ServletContext getServletContext () const
FilterConfigoperator= (const FilterConfig &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::FilterConfig contains the configuration information provided in the deployment descriptor of a given filter. After a filter is initialized, the filter accesses configuration information by using the method rwsf::Filter::getFilterConfig(). This class provides a function that returns the filter name, and inherits functions for working with initialization parameters and the filter context.

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 method inherits from base class rwsf::Config
getInitParameterNames() In the HydraExpress implementation, this method inherits from base class rwsf::Config

Constructor & Destructor Documentation

rwsf::FilterConfig::FilterConfig ( )

Creates an empty, invalid instance. Use the assignment operator or copy constructor to create a valid instance.

rwsf::FilterConfig::FilterConfig ( const FilterConfig config)

Creates a new FilterConfig handle to the config body instance.

virtual rwsf::FilterConfig::~FilterConfig ( )

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

Member Function Documentation

std::string rwsf::FilterConfig::getFilterName ( ) const

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

rwsf::ServletContext rwsf::FilterConfig::getServletContext ( ) const

Returns the servlet context for this object.

FilterConfig& rwsf::FilterConfig::operator= ( const FilterConfig 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.