Use shibboleth-sp as package name for compatibility.

[shibboleth/cpp-sp.git] / shibsp / util / TemplateParameters.h

diff --git a/shibsp/util/TemplateParameters.h b/shibsp/util/TemplateParameters.h
index f04f42a..dc7b12e 100644 (file)
--- a/shibsp/util/TemplateParameters.h
+++ b/shibsp/util/TemplateParameters.h
@@ -1,51 +1,59 @@
-/*
- *  Copyright 2001-2007 Internet2
- * 
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+/**
+ * Licensed to the University Corporation for Advanced Internet
+ * Development, Inc. (UCAID) under one or more contributor license
+ * agreements. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ *
+ * UCAID licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the
+ * License at
  *
- *     http://www.apache.org/licenses/LICENSE-2.0
+ * http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the License.
  */
 
 /**
  * @file shibsp/util/TemplateParameters.h
  * 
- * Supplies xmltooling TemplateEngine with additional parameters from a PropertySet. 
+ * Supplies xmltooling TemplateEngine with additional parameters.
  */
 
 #ifndef __shibsp_tempparams_h__
 #define __shibsp_tempparams_h__
 
-#include <shibsp/util/PropertySet.h>
+#include <shibsp/base.h>
+
 #include <xmltooling/util/TemplateEngine.h>
 
 namespace shibsp {
 
+    class SHIBSP_API PropertySet;
+    class SHIBSP_API Session;
+
     /**
-     * Supplies xmltooling TemplateEngine with additional parameters from a PropertySet.
+     * Supplies xmltooling TemplateEngine with additional parameters.
      */
     class SHIBSP_API TemplateParameters : public xmltooling::TemplateEngine::TemplateParameters
     {
     public:
         /**
-         * Constructor
+         * Constructor.
          * 
-         * @param e     an exception to supply additional parameters
-         * @param props a PropertySet to supply additional parameters
+         * @param e         an exception to supply additional parameters
+         * @param props     a PropertySet to supply additional parameters
+         * @param session   an active user session
          */
-        TemplateParameters(const std::exception* e=NULL, const PropertySet* props=NULL)
-            : m_exception(e), m_toolingException(dynamic_cast<const xmltooling::XMLToolingException*>(e)) {
-            setPropertySet(props);
-        }
+        TemplateParameters(
+            const std::exception* e=nullptr, const PropertySet* props=nullptr, const Session* session=nullptr
+            );
 
-        virtual ~TemplateParameters() {}
+        virtual ~TemplateParameters();
         
         /**
          * Sets a PropertySet to supply additional parameters.
@@ -57,11 +65,9 @@ namespace shibsp {
         /**
          * Returns the exception passed to the object, if it contains rich information.
          *
-         * @return  an exception, or NULL
+         * @return  an exception, or nullptr
          */
-        const xmltooling::XMLToolingException* getRichException() const {
-            return m_toolingException;
-        }
+        const xmltooling::XMLToolingException* getRichException() const;
 
         const char* getParameter(const char* name) const;
         
@@ -78,6 +84,7 @@ namespace shibsp {
         const PropertySet* m_props;
         const std::exception* m_exception;
         const xmltooling::XMLToolingException* m_toolingException;
+        const Session* m_session;
     };
 };