Source code for alignak.objects.serviceescalation
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# Copyright (C) 2015-2015: Alignak team, see AUTHORS.txt file for contributors
#
# This file is part of Alignak.
#
# Alignak is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Alignak 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with Alignak. If not, see <http://www.gnu.org/licenses/>.
#
#
# This file incorporates work covered by the following copyright and
# permission notice:
#
# Copyright (C) 2009-2014:
# Hartmut Goebel, h.goebel@goebel-consult.de
# Grégory Starck, g.starck@gmail.com
# Gerhard Lausser, gerhard.lausser@consol.de
# Sebastien Coavoux, s.coavoux@free.fr
# Jean Gabes, naparuba@gmail.com
# Romain Forlot, rforlot@yahoo.com
# This file is part of Shinken.
#
# Shinken is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Shinken 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with Shinken. If not, see <http://www.gnu.org/licenses/>.
"""This module provides Serviceescalation and Serviceescalations classes that
implements service escalation for notification. Basically used for parsing.
"""
from alignak.objects.item import Item, Items
from alignak.objects.escalation import Escalation
from alignak.property import IntegerProp, StringProp, ListProp
[docs]class Serviceescalation(Item):
"""Serviceescalation class is used to implement notification escalation for services
TODO: Why this class does not inherit from alignak.objects.Escalation.
Maybe we can merge it
"""
_id = 1 # zero is always special in database, so we do not take risk here
my_type = 'serviceescalation'
properties = Item.properties.copy()
properties.update({
'host_name': StringProp(),
'hostgroup_name': StringProp(),
'service_description': StringProp(),
'first_notification': IntegerProp(),
'last_notification': IntegerProp(),
'notification_interval': IntegerProp(default=30), # like Nagios value
'escalation_period': StringProp(default=''),
'escalation_options': ListProp(default=['d', 'u', 'r', 'w', 'c'], split_on_coma=True),
'contacts': StringProp(),
'contact_groups': StringProp(),
'first_notification_time': IntegerProp(),
'last_notification_time': IntegerProp(),
})
[docs] def get_name(self):
"""Get escalation name
:return: name
:rtype: str
TODO: Remove this function
"""
return ''
[docs]class Serviceescalations(Items):
"""Serviceescalations manage a list of Serviceescalation objects, used for parsing configuration
"""
name_property = ""
inner_class = Serviceescalation
[docs] def explode(self, escalations):
"""Create instance of Escalation for each ServiceEscalation object
:param escalations: list of escalation, used to add new ones
:type escalations: alignak.objects.escalation.Escalations
:return: None
"""
# Now we explode all escalations (host_name, service_description) to escalations
for svescal in self:
properties = svescal.__class__.properties
creation_dict = {'escalation_name': 'Generated-Serviceescalation-%d' % svescal._id}
for prop in properties:
if hasattr(svescal, prop):
creation_dict[prop] = getattr(svescal, prop)
# print "Creation an escalation with:", creation_dict
escalation = Escalation(creation_dict)
escalations.add_escalation(escalation)