Set fourth file version digit to signify rebuild.

[shibboleth/cpp-xmltooling.git] / xmltooling / PluginManager.h

diff --git a/xmltooling/PluginManager.h b/xmltooling/PluginManager.h
index f882891..2f37c80 100644 (file)
--- a/xmltooling/PluginManager.h
+++ b/xmltooling/PluginManager.h
@@ -1,17 +1,21 @@
-/*
- *  Copyright 2001-2006 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.
  */
 
 /**
@@ -37,13 +41,14 @@
 namespace xmltooling {
 
     /**
-     * Template for management/access to plugins constructed based on a string type
+     * Template for management/access to plugins constructed based on a Key type
      * and arbitrary parameters.
      * 
      * @param T         class of plugin to manage
+     * @param Key       the key for type lookup
      * @param Params    parameters for plugin construction
      */
-    template <class T, typename Params> class PluginManager
+    template <class T, class Key, typename Params> class PluginManager
     {
     public:
         PluginManager() {}
@@ -55,22 +60,21 @@ namespace xmltooling {
         /**
          * Registers the factory for a given type.
          * 
-         * @param type      the name of the plugin type
+         * @param type      the key to the plugin type
          * @param factory   the factory function for the plugin type
          */
-        void registerFactory(const std::string& type, typename PluginManager::Factory* factory) {
-            if (!type.empty() && factory)
+        void registerFactory(const Key& type, typename PluginManager::Factory* factory) {
+            if (factory)
                 m_map[type]=factory;
         }
 
         /**
          * Unregisters the factory for a given type.
          * 
-         * @param type  the name of the plugin type
+         * @param type  the key to the plugin type
          */
-        void deregisterFactory(const std::string& type) {
-            if (!type.empty())
-                m_map.erase(type);
+        void deregisterFactory(const Key& type) {
+            m_map.erase(type);
         }
 
         /**
@@ -84,19 +88,19 @@ namespace xmltooling {
          * Builds a new instance of a plugin of a given type, configuring it
          * with the supplied parameters.
          * 
-         * @param type  the name of the plugin type
+         * @param type  the key to the plugin type
          * @param p     parameters to configure plugin
          * @return      the constructed plugin  
          */
-        T* newPlugin(const std::string& type, const Params& p) {
-            typename std::map<std::string, typename PluginManager::Factory*>::const_iterator i=m_map.find(type);
+        T* newPlugin(const Key& type, const Params& p) {
+            typename std::map<Key, typename PluginManager::Factory*>::const_iterator i=m_map.find(type);
             if (i==m_map.end())
-                throw UnknownExtensionException("Unable to build plugin of type '$1'",params(1,type.c_str()));
+                throw UnknownExtensionException("Unknown plugin type.");
             return i->second(p);
         }
         
     private:
-        std::map<std::string, typename PluginManager::Factory*> m_map;
+        std::map<Key, typename PluginManager::Factory*> m_map;
     };
 
 };