shibsp/util/TemplateParameters.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/util/TemplateParameters.h
  19  *
  20  * Supplies xmltooling TemplateEngine with additional parameters from a PropertySet.
  21  */
  22
  23 #ifndef __shibsp_tempparams_h__
  24 #define __shibsp_tempparams_h__
  25
  26 #include <shibsp/util/PropertySet.h>
  27 #include <xmltooling/util/TemplateEngine.h>
  28
  29 namespace shibsp {
  30
  31     /**
  32      * Supplies xmltooling TemplateEngine with additional parameters from a PropertySet.
  33      */
  34     class SHIBSP_API TemplateParameters : public xmltooling::TemplateEngine::TemplateParameters
  35     {
  36     public:
  37         /**
  38          * Constructor
  39          *
  40          * @param e     an exception to supply additional parameters
  41          * @param props a PropertySet to supply additional parameters
  42          */
  43         TemplateParameters(const std::exception* e=NULL, const PropertySet* props=NULL)
  44             : m_exception(e), m_toolingException(dynamic_cast<const xmltooling::XMLToolingException*>(e)) {
  45             setPropertySet(props);
  46         }
  47
  48         virtual ~TemplateParameters() {}
  49
  50         /**
  51          * Sets a PropertySet to supply additional parameters.
  52          *
  53          * @param props a PropertySet to supply additional parameters
  54          */
  55         void setPropertySet(const PropertySet* props);
  56
  57         /**
  58          * Returns the exception passed to the object, if it contains rich information.
  59          *
  60          * @return  an exception, or NULL
  61          */
  62         const xmltooling::XMLToolingException* getRichException() const {
  63             return m_toolingException;
  64         }
  65
  66         const char* getParameter(const char* name) const;
  67
  68         /**
  69          * Returns a set of query string name/value pairs, URL-encoded,
  70          * representing all known parameters. If an exception is
  71          * present, it's type, message, and parameters will be included.
  72          *
  73          * @return  the query string representation
  74          */
  75         std::string toQueryString() const;
  76
  77     private:
  78         const PropertySet* m_props;
  79         const std::exception* m_exception;
  80         const xmltooling::XMLToolingException* m_toolingException;
  81     };
  82 };
  83
  84 #endif /* __shibsp_tempparams_h__ */