org::xmlBlaster::util::qos::AccessFilterQos

org::xmlBlaster::util::qos::AccessFilterQos Class Reference

Collaboration diagram for org::xmlBlaster::util::qos::AccessFilterQos:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 AccessFilterQos (org::xmlBlaster::util::Global &global)
 AccessFilterQos (org::xmlBlaster::util::Global &global, const std::string &type, const std::string &version, const std::string &query)
 
Parameters:
glob The global handle holding environment and logging objects

 AccessFilterQos (org::xmlBlaster::util::Global &global, const std::string &type, const std::string &version, const Query &query)
 
Parameters:
glob The global handle holding environment and logging objects

 AccessFilterQos (const AccessFilterQos &qos)
AccessFilterQos & operator= (const AccessFilterQos &qos)
void setType (const std::string &type)
 
Parameters:
type The plugin name, as used in xmlBlaster.properties e.g.

std::string getType () const
 Returns the plugins name.
void setVersion (const std::string &version)
 
Parameters:
version The version of the plugin, defaults to "1.0", but can anything you like.

std::string getVersion () const
 Returns the plugins version.
void setQuery (const Query &query)
 Set the filter query, it should fit to the protocol-type.
Query getQuery () const
 Returns the query, the syntax is depending on what your plugin supports.
std::string toXml (const std::string &extraOffset="") const
 Dump state of this object into a XML ASCII std::string.

Detailed Description

Definition at line 40 of file AccessFilterQos.h.

Constructor & Destructor Documentation

org::xmlBlaster::util::qos::AccessFilterQos::AccessFilterQos ( org::xmlBlaster::util::Global &  global  ) 

Definition at line 46 of file AccessFilterQos.cpp.

References org::xmlBlaster::util::qos::ACCESSFILTER_DEFAULT_type, org::xmlBlaster::util::qos::ACCESSFILTER_DEFAULT_version, org::xmlBlaster::util::Global::getProperty(), org::xmlBlaster::util::Property::getStringProperty(), setType(), and setVersion().

org::xmlBlaster::util::qos::AccessFilterQos::AccessFilterQos ( org::xmlBlaster::util::Global &  global,
const std::string &  type,
const std::string &  version,
const std::string &  query 
)

Parameters:
glob The global handle holding environment and logging objects

Parameters:
type The plugin name, as used in xmlBlaster.properties e.g. "ContentLenFilter".
version The plugin version, defaults to "1.0"
query Your filter rule

org::xmlBlaster::util::qos::AccessFilterQos::AccessFilterQos ( org::xmlBlaster::util::Global &  global,
const std::string &  type,
const std::string &  version,
const Query &  query 
)

Parameters:
glob The global handle holding environment and logging objects

Parameters:
type The plugin name, as used in xmlBlaster.properties e.g. "ContentLenFilter".
version The plugin version, defaults to "1.0"
query Your filter rule

org::xmlBlaster::util::qos::AccessFilterQos::AccessFilterQos ( const AccessFilterQos &  qos  ) 

Member Function Documentation

AccessFilterQos& org::xmlBlaster::util::qos::AccessFilterQos::operator= ( const AccessFilterQos &  qos  ) 

void org::xmlBlaster::util::qos::AccessFilterQos::setType ( const std::string &  type  ) 

Parameters:
type The plugin name, as used in xmlBlaster.properties e.g.

"ContentLenFilter".

Referenced by AccessFilterQos().

std::string org::xmlBlaster::util::qos::AccessFilterQos::getType (  )  const

Returns the plugins name.

Returns:
e.g. "ContentLenFilter"

void org::xmlBlaster::util::qos::AccessFilterQos::setVersion ( const std::string &  version  ) 

Parameters:
version The version of the plugin, defaults to "1.0", but can anything you like.

Referenced by AccessFilterQos().

std::string org::xmlBlaster::util::qos::AccessFilterQos::getVersion (  )  const

Returns the plugins version.

Returns:
e.g. "1.0"

void org::xmlBlaster::util::qos::AccessFilterQos::setQuery ( const Query &  query  ) 

Set the filter query, it should fit to the protocol-type.

Parameters:
query The filter query, e.g. "8000" for max length of a content with "ContentLenFilter" plugin

Query org::xmlBlaster::util::qos::AccessFilterQos::getQuery (  )  const

Returns the query, the syntax is depending on what your plugin supports.

Returns:
e.g. "a>12 AND b<15"

std::string org::xmlBlaster::util::qos::AccessFilterQos::toXml ( const std::string &  extraOffset = ""  )  const

Dump state of this object into a XML ASCII std::string.


Only none default values are dumped for performance reasons

Parameters:
extraOffset indenting of tags for nice output
Returns:
The xml representation

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