2 * Copyright 2001-2009 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file shibsp/util/TemplateParameters.h
20 * Supplies xmltooling TemplateEngine with additional parameters from a PropertySet.
23 #ifndef __shibsp_tempparams_h__
24 #define __shibsp_tempparams_h__
26 #include <shibsp/base.h>
28 #include <xmltooling/util/TemplateEngine.h>
32 class SHIBSP_API PropertySet;
35 * Supplies xmltooling TemplateEngine with additional parameters from a PropertySet.
37 class SHIBSP_API TemplateParameters : public xmltooling::TemplateEngine::TemplateParameters
43 * @param e an exception to supply additional parameters
44 * @param props a PropertySet to supply additional parameters
46 TemplateParameters(const std::exception* e=NULL, const PropertySet* props=NULL);
48 virtual ~TemplateParameters();
51 * Sets a PropertySet to supply additional parameters.
53 * @param props a PropertySet to supply additional parameters
55 void setPropertySet(const PropertySet* props);
58 * Returns the exception passed to the object, if it contains rich information.
60 * @return an exception, or NULL
62 const xmltooling::XMLToolingException* getRichException() const;
64 const char* getParameter(const char* name) const;
67 * Returns a set of query string name/value pairs, URL-encoded,
68 * representing all known parameters. If an exception is
69 * present, it's type, message, and parameters will be included.
71 * @return the query string representation
73 std::string toQueryString() const;
76 const PropertySet* m_props;
77 const std::exception* m_exception;
78 const xmltooling::XMLToolingException* m_toolingException;
82 #endif /* __shibsp_tempparams_h__ */