icinga2/lib/config/configitem.h

93 lines
3.4 KiB
C
Raw Normal View History

/******************************************************************************
* Icinga 2 *
* Copyright (C) 2012 Icinga Development Team (http://www.icinga.org/) *
* *
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License *
* as published by the Free Software Foundation; either version 2 *
* of the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the Free Software Foundation *
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA. *
******************************************************************************/
#ifndef CONFIGITEM_H
#define CONFIGITEM_H
namespace icinga
{
2012-09-17 14:47:43 +02:00
/**
2012-09-19 12:32:39 +02:00
* A configuration item. Non-abstract configuration items can be used to
* create configuration objects at runtime.
2012-09-17 14:47:43 +02:00
*
* @ingroup config
*/
class I2_CONFIG_API ConfigItem : public Object {
public:
typedef shared_ptr<ConfigItem> Ptr;
typedef weak_ptr<ConfigItem> WeakPtr;
ConfigItem(const String& type, const String& name,
const ExpressionList::Ptr& exprl, const vector<String>& parents,
2012-07-06 14:33:10 +02:00
const DebugInfo& debuginfo);
String GetType(void) const;
String GetName(void) const;
vector<String> GetParents(void) const;
ExpressionList::Ptr GetExpressionList(void) const;
2012-07-30 10:17:29 +02:00
DynamicObject::Ptr Commit(void);
void Unregister(void);
void Dump(ostream& fp) const;
2012-07-30 10:17:29 +02:00
DynamicObject::Ptr GetDynamicObject(void) const;
DebugInfo GetDebugInfo(void) const;
2012-09-19 12:32:39 +02:00
static ConfigItem::Ptr GetObject(const String& type,
const String& name);
static boost::signal<void (const ConfigItem::Ptr&)> OnCommitted;
static boost::signal<void (const ConfigItem::Ptr&)> OnRemoved;
private:
void CalculateProperties(const Dictionary::Ptr& dictionary) const;
void RegisterChild(const ConfigItem::Ptr& child);
void UnregisterChild(const ConfigItem::Ptr& child);
void UnregisterFromParents(void);
void OnParentCommitted(void);
2012-09-19 12:32:39 +02:00
String m_Type; /**< The object type. */
String m_Name; /**< The name. */
2012-07-06 14:33:10 +02:00
ExpressionList::Ptr m_ExpressionList;
2012-09-19 12:32:39 +02:00
vector<String> m_Parents; /**< The names of parent configuration
items. */
DebugInfo m_DebugInfo; /**< Debug information. */
2012-09-19 12:32:39 +02:00
DynamicObject::WeakPtr m_DynamicObject; /**< The instantiated version
* of this configuration
* item */
set<ConfigItem::WeakPtr> m_ChildObjects; /**< Instantiated items
* that inherit from this item */
typedef map<pair<String, String>, ConfigItem::Ptr> ItemMap;
2012-09-19 12:32:39 +02:00
static ItemMap m_Items; /**< All registered configuration items. */
};
}
#endif /* CONFIGITEM_H */