X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=xmltooling%2FPluginManager.h;h=2f37c809435bfaf5a83e6bf283d29d3b8231514d;hb=d1c1478d26cfd9b87a4deb80c3638dc42e111735;hp=d876ccea179049daac5c7e81d60316e7c68e67d1;hpb=26a08e6ab6631b2a5f91ac84ead591752434a9bc;p=shibboleth%2Fcpp-xmltooling.git diff --git a/xmltooling/PluginManager.h b/xmltooling/PluginManager.h index d876cce..2f37c80 100644 --- a/xmltooling/PluginManager.h +++ b/xmltooling/PluginManager.h @@ -1,95 +1,112 @@ -/* - * 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 - * - * 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. - */ - -/** - * @file PluginManager.h - * - * Plugin management template - */ - -#ifndef __xmltooling_plugin_h__ -#define __xmltooling_plugin_h__ - -#include - -#include -#include -#include - -using namespace xercesc; - -namespace xmltooling { - - /** - * Template for management/access to plugins constructed based on a string type - * and arbitrary parameters. - * - * @param T class of plugin to manage - * @param Params parameters for plugin construction - */ - template class XMLTOOL_API PluginManager - { - public: - PluginManager() {} - ~PluginManager() {} - - /** Factory function for plugin. */ - typedef T* Factory(typename Params&); - - /** - * Registers the factory for a given type. - * - * @param type the name of the plugin type - * @param factory the factory function for the plugin type - */ - void registerFactory(const char* type, typename Factory* factory) { - if (type && factory) - m_map[type]=factory; - } - - /** - * Unregisters the factory for a given type. - * - * @param type the name of the plugin type - */ - void deregisterFactory(const char* type) { - if (type) { - m_map.erase(type); - } - } - - /** - * Builds a new instance of a plugin of a given type, configuring it - * with the supplied element, if any. - * - * @param type the name of the plugin type - * @param p parameters to configure plugin - * @return the constructed plugin - */ - T* newPlugin(const char* type, typename Params& p) { - std::map::const_iterator i=m_map.find(type); - if (i==m_map.end()) - throw UnknownExtensionException("Unable to build plugin of type '$1'",params(1,type)); - return i->second(p); - } - - private: - std::map m_map; - }; - -}; - -#endif /* __xmltooling_plugin_h__ */ +/** + * 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 + * + * 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 xmltooling/PluginManager.h + * + * Plugin management template + */ + +#ifndef __xmltooling_plugin_h__ +#define __xmltooling_plugin_h__ + +#include +#include + +#include +#include + +#if defined (_MSC_VER) + #pragma warning( push ) + #pragma warning( disable : 4250 4251 ) +#endif + +namespace xmltooling { + + /** + * 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 PluginManager + { + public: + PluginManager() {} + ~PluginManager() {} + + /** Factory function for plugin. */ + typedef T* Factory(const Params&); + + /** + * Registers the factory for a given type. + * + * @param type the key to the plugin type + * @param factory the factory function for the plugin type + */ + 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 key to the plugin type + */ + void deregisterFactory(const Key& type) { + m_map.erase(type); + } + + /** + * Unregisters all registered factories. + */ + void deregisterFactories() { + m_map.clear(); + } + + /** + * Builds a new instance of a plugin of a given type, configuring it + * with the supplied parameters. + * + * @param type the key to the plugin type + * @param p parameters to configure plugin + * @return the constructed plugin + */ + T* newPlugin(const Key& type, const Params& p) { + typename std::map::const_iterator i=m_map.find(type); + if (i==m_map.end()) + throw UnknownExtensionException("Unknown plugin type."); + return i->second(p); + } + + private: + std::map m_map; + }; + +}; + +#if defined (_MSC_VER) + #pragma warning( pop ) +#endif + +#endif /* __xmltooling_plugin_h__ */