granicus.if.org Git - icinga2/blob - lib/icinga/comment.hpp

   1 /******************************************************************************
   2  * Icinga 2                                                                   *
   3  * Copyright (C) 2012-2017 Icinga Development Team (https://www.icinga.com/)  *
   4  *                                                                            *
   5  * This program is free software; you can redistribute it and/or              *
   6  * modify it under the terms of the GNU General Public License                *
   7  * as published by the Free Software Foundation; either version 2             *
   8  * of the License, or (at your option) any later version.                     *
   9  *                                                                            *
  10  * This program is distributed in the hope that it will be useful,            *
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
  13  * GNU General Public License for more details.                               *
  14  *                                                                            *
  15  * You should have received a copy of the GNU General Public License          *
  16  * along with this program; if not, write to the Free Software Foundation     *
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
  18  ******************************************************************************/
  19
  20 #ifndef COMMENT_H
  21 #define COMMENT_H
  22
  23 #include "icinga/i2-icinga.hpp"
  24 #include "icinga/comment.thpp"
  25 #include "icinga/checkable.thpp"
  26 #include "remote/messageorigin.hpp"
  27
  28 namespace icinga
  29 {
  30
  31 /**
  32  * A comment.
  33  *
  34  * @ingroup icinga
  35  */
  36 class I2_ICINGA_API Comment : public ObjectImpl<Comment>
  37 {
  38 public:
  39         DECLARE_OBJECT(Comment);
  40         DECLARE_OBJECTNAME(Comment);
  41
  42         static boost::signals2::signal<void (const Comment::Ptr&)> OnCommentAdded;
  43         static boost::signals2::signal<void (const Comment::Ptr&)> OnCommentRemoved;
  44
  45         intrusive_ptr<Checkable> GetCheckable(void) const;
  46
  47         bool IsExpired(void) const;
  48
  49         static int GetNextCommentID(void);
  50
  51         static String AddComment(const intrusive_ptr<Checkable>& checkable, CommentType entryType,
  52             const String& author, const String& text, bool persistent, double expireTime,
  53             const String& id = String(), const MessageOrigin::Ptr& origin = nullptr);
  54
  55         static void RemoveComment(const String& id, const MessageOrigin::Ptr& origin = nullptr);
  56
  57         static String GetCommentIDFromLegacyID(int id);
  58
  59 protected:
  60         virtual void OnAllConfigLoaded(void) override;
  61         virtual void Start(bool runtimeCreated) override;
  62         virtual void Stop(bool runtimeRemoved) override;
  63
  64 private:
  65         ObjectImpl<Checkable>::Ptr m_Checkable;
  66
  67         static void CommentsExpireTimerHandler(void);
  68 };
  69
  70 }
  71
  72 #endif /* COMMENT_H */