summaryrefslogtreecommitdiffstats
path: root/modules/monitoring/library/Monitoring/Command/Object/ObjectCommand.php
blob: 43ab6459d8d4ef66dbd2c793f78ae122313f2370 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
<?php
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */

namespace Icinga\Module\Monitoring\Command\Object;

use Icinga\Module\Monitoring\Command\IcingaCommand;
use Icinga\Module\Monitoring\Object\MonitoredObject;

/**
 * Base class for commands that involve a monitored object, i.e. a host or service
 */
abstract class ObjectCommand extends IcingaCommand
{
    /**
     * Type host
     */
    const TYPE_HOST = MonitoredObject::TYPE_HOST;

    /**
     * Type service
     */
    const TYPE_SERVICE = MonitoredObject::TYPE_SERVICE;

    /**
     * Allowed Icinga object types for the command
     *
     * @var string[]
     */
    protected $allowedObjects = array();

    /**
     * Involved object
     *
     * @var MonitoredObject
     */
    protected $object;

    /**
     * Set the involved object
     *
     * @param   MonitoredObject $object
     *
     * @return  $this
     */
    public function setObject(MonitoredObject $object)
    {
        $object->assertOneOf($this->allowedObjects);
        $this->object = $object;
        return $this;
    }

    /**
     * Get the involved object
     *
     * @return MonitoredObject
     */
    public function getObject()
    {
        return $this->object;
    }
}