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 props a PropertySet to supply additional parameters
  41          */
  42         TemplateParameters(const PropertySet* props=NULL) {
  43             setPropertySet(props);
  44         }
  45
  46         virtual ~TemplateParameters() {}
  47
  48         /**
  49          * Sets a PropertySet to supply additional parameters.
  50          *
  51          * @param props a PropertySet to supply additional parameters
  52          */
  53         void setPropertySet(const PropertySet* props);
  54
  55         const char* getParameter(const char* name) const;
  56
  57     private:
  58         const PropertySet* m_props;
  59     };
  60 };
  61
  62 #endif /* __shibsp_tempparams_h__ */