shibsp::TemplateParameters Class Reference

Supplies xmltooling TemplateEngine with additional parameters from a PropertySet. More...

#include <shibsp/util/TemplateParameters.h>

Collaboration diagram for shibsp::TemplateParameters:

[legend]
List of all members.

Public Member Functions

 TemplateParameters (const std::exception *e=NULL, const PropertySet *props=NULL)
 Constructor.
void setPropertySet (const PropertySet *props)
 Sets a PropertySet to supply additional parameters.
const xmltooling::XMLToolingException * getRichException () const
 Returns the exception passed to the object, if it contains rich information.
const char * getParameter (const char *name) const
std::string toQueryString () const
 Returns a set of query string name/value pairs, URL-encoded, representing all known parameters.

Detailed Description

Supplies xmltooling TemplateEngine with additional parameters from a PropertySet.


Constructor & Destructor Documentation

shibsp::TemplateParameters::TemplateParameters ( const std::exception *  e = NULL,
const PropertySet props = NULL 
) [inline]

Constructor.

Parameters:
e an exception to supply additional parameters
props a PropertySet to supply additional parameters


Member Function Documentation

const xmltooling::XMLToolingException* shibsp::TemplateParameters::getRichException (  )  const [inline]

Returns the exception passed to the object, if it contains rich information.

Returns:
an exception, or NULL

void shibsp::TemplateParameters::setPropertySet ( const PropertySet props  ) 

Sets a PropertySet to supply additional parameters.

Parameters:
props a PropertySet to supply additional parameters

std::string shibsp::TemplateParameters::toQueryString (  )  const

Returns a set of query string name/value pairs, URL-encoded, representing all known parameters.

If an exception is present, it's type, message, and parameters will be included.

Returns:
the query string representation


The documentation for this class was generated from the following file:
Generated on Tue Apr 7 16:14:53 2009 for shibboleth-2.1 by  doxygen 1.4.7