rwsf::FilterConfig

HydraExpress Servlet Reference Guide
Rogue Wave web site: Home Page | Main Documentation Page

rwsf::FilterConfig

Package: Servlet


rwsf::FilterConfig  rwsf::Config

Local Index
Header File
Description
Public Constructors
Public Destructor
Public Member Operators
Public Member Functions
See Also

Local Index

Members

FilterConfig()
getFilterName()

getServletContext()
operator=()

~FilterConfig()

Header File

#include <rwsf/servlet/FilterConfig.h>

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 getFilterConfig() method of rwsf::Filter. This class provides a function that returns the filter name, and inherits functions for working with initialization parameters and the filter context.

Table 2 lists methods that are either non-standard or not supported at this release.

Table 2: rwsf::FilterConfig deviation from Servlet Specification

Member	Description of Difference from Servlet Specification
`getInitParameter(std::string)`	In the HydraExpress implementation, this member is included in base class *rwsf::Config*
`getInitParameterName()`	In the HydraExpress implementation, this member is included in base class *rwsf::Config*
`getServletContext()`	In the HydraExpress implementation, this member is included in base class *rwsf::Config*

Public Constructors

FilterConfig();

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

FilterConfig(const FilterConfig& config);

Attaches to and increments the reference count on config's body.

tor or copy constructor to create valid instances.

FilterConfig(const FilterConfigImp& *impl);

Attaches to and increments the reference count on config's body.

Public Destructor

~FilterConfig();

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

Public Member Operators

rwsf::FilterConfig& 
operator=(const rwsf::FilterConfig& second);

Detaches from the current body (if any), decrements its reference count, deletes it if there are no other references, and then attaches to second's body and increments its reference count.

Public Member Functions

rwsf::ServletContext
getServletContext() const;

Returns the servlet context for this object. This is a convenience function equivalent to calling getServletConfig().getServletContext().

std::string 
getFilterName() const;

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