shibsp/util/TemplateParameters.h

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