icinga2/lib/icinga/notification.h

124 lines
4.3 KiB
C
Raw Normal View History

2013-02-09 11:42:22 +01:00
/******************************************************************************
* Icinga 2 *
2013-09-25 07:43:57 +02:00
* Copyright (C) 2012-2013 Icinga Development Team (http://www.icinga.org/) *
2013-02-09 11:42:22 +01:00
* *
* 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 NOTIFICATION_H
#define NOTIFICATION_H
2013-03-17 20:19:29 +01:00
#include "icinga/i2-icinga.h"
#include "icinga/user.h"
#include "icinga/usergroup.h"
#include "icinga/timeperiod.h"
2013-03-17 20:19:29 +01:00
#include "base/array.h"
2013-02-09 11:42:22 +01:00
namespace icinga
{
/**
* The notification type.
*
* @ingroup icinga
*/
enum NotificationType
{
NotificationDowntimeStart = 0,
NotificationDowntimeEnd = 1,
NotificationDowntimeRemoved = 2,
NotificationCustom = 3,
NotificationAcknowledgement = 4,
NotificationProblem = 5,
NotificationRecovery = 6,
NotificationFlappingStart = 7 ,
NotificationFlappingEnd = 8,
2013-02-09 11:42:22 +01:00
};
class Service;
class NotificationCommand;
2013-02-09 11:42:22 +01:00
/**
* An Icinga notification specification.
*
* @ingroup icinga
*/
class I2_ICINGA_API Notification : public DynamicObject, public MacroResolver
2013-02-09 11:42:22 +01:00
{
public:
DECLARE_PTR_TYPEDEFS(Notification);
DECLARE_TYPENAME(Notification);
2013-02-09 11:42:22 +01:00
shared_ptr<Service> GetService(void) const;
shared_ptr<NotificationCommand> GetNotificationCommand(void) const;
double GetNotificationInterval(void) const;
TimePeriod::Ptr GetNotificationPeriod(void) const;
2013-02-09 11:42:22 +01:00
Dictionary::Ptr GetMacros(void) const;
Array::Ptr GetExportMacros(void) const;
2013-03-16 21:18:53 +01:00
std::set<User::Ptr> GetUsers(void) const;
std::set<UserGroup::Ptr> GetUserGroups(void) const;
2013-05-13 13:44:57 +02:00
Dictionary::Ptr GetTimes(void) const;
unsigned long GetNotificationTypeFilter(void) const;
unsigned long GetNotificationStateFilter(void) const;
2013-02-09 11:42:22 +01:00
double GetLastNotification(void) const;
void SetLastNotification(double time);
double GetNextNotification(void) const;
2013-08-28 14:59:41 +02:00
void SetNextNotification(double time, const String& authority = String());
long GetNotificationNumber(void) const;
2013-07-18 17:04:09 +02:00
void UpdateNotificationNumber(void);
void ResetNotificationNumber(void);
void BeginExecuteNotification(NotificationType type, const Dictionary::Ptr& cr, bool force, const String& author = "", const String& text = "");
2013-02-24 01:10:34 +01:00
static String NotificationTypeToString(NotificationType type);
2013-02-09 11:42:22 +01:00
virtual bool ResolveMacro(const String& macro, const Dictionary::Ptr& cr, String *result) const;
2013-08-28 14:59:41 +02:00
static boost::signals2::signal<void (const Notification::Ptr&, double, const String&)> OnNextNotificationChanged;
protected:
virtual void Start(void);
virtual void Stop(void);
virtual void InternalSerialize(const Dictionary::Ptr& bag, int attributeTypes) const;
virtual void InternalDeserialize(const Dictionary::Ptr& bag, int attributeTypes);
2013-02-26 10:13:54 +01:00
private:
String m_NotificationCommand;
Value m_NotificationInterval;
String m_NotificationPeriod;
Value m_LastNotification;
Value m_NextNotification;
Value m_NotificationNumber;
Dictionary::Ptr m_Macros;
Array::Ptr m_ExportMacros;
Array::Ptr m_Users;
Array::Ptr m_UserGroups;
Dictionary::Ptr m_Times;
Value m_NotificationTypeFilter;
Value m_NotificationStateFilter;
String m_HostName;
String m_Service;
2013-07-18 17:04:09 +02:00
void ExecuteNotificationHelper(NotificationType type, const User::Ptr& user, const Dictionary::Ptr& cr, bool force, const String& author = "", const String& text = "");
2013-02-09 11:42:22 +01:00
};
}
#endif /* NOTIFICATION_H */