summaryrefslogtreecommitdiffstats
path: root/modules/monitoring/library/Monitoring/Command/Object/ProcessCheckResultCommand.php
blob: cd2db33ff8631e1b4ecae584a79b33d559e4c58f (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php
/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */

namespace Icinga\Module\Monitoring\Command\Object;

use InvalidArgumentException;
use LogicException;

/**
 * Submit a passive check result for a host or service
 */
class ProcessCheckResultCommand extends ObjectCommand
{
    /**
     * (non-PHPDoc)
     * @see \Icinga\Module\Monitoring\Command\Object\ObjectCommand::$allowedObjects For the property documentation.
     */
    protected $allowedObjects = array(
        self::TYPE_HOST,
        self::TYPE_SERVICE
    );

    /**
     * Host up
     */
    const HOST_UP = 0;

    /**
     * Host down
     */
    const HOST_DOWN = 1;

    /**
     * Host unreachable
     */
    const HOST_UNREACHABLE = 2; // TODO: Icinga 2.x does not support submitting results with this state, yet

    /**
     * Service ok
     */
    const SERVICE_OK = 0;

    /**
     * Service warning
     */
    const SERVICE_WARNING = 1;

    /**
     * Service critical
     */
    const SERVICE_CRITICAL = 2;

    /**
     * Service unknown
     */
    const SERVICE_UNKNOWN = 3;

    /**
     * Possible status codes for passive host and service checks
     *
     * @var array
     */
    public static $statusCodes = array(
        self::TYPE_HOST => array(
            self::HOST_UP, self::HOST_DOWN, self::HOST_UNREACHABLE
        ),
        self::TYPE_SERVICE => array(
            self::SERVICE_OK, self::SERVICE_WARNING, self::SERVICE_CRITICAL, self::SERVICE_UNKNOWN
        )
    );

    /**
     * Status code of the host or service check result
     *
     * @var int
     */
    protected $status;

    /**
     * Text output of the host or service check result
     *
     * @var string
     */
    protected $output;

    /**
     * Optional performance data of the host or service check result
     *
     * @var string
     */
    protected $performanceData;


    /**
     * Set the status code of the host or service check result
     *
     * @param   int $status
     *
     * @return  $this
     *
     * @throws  LogicException              If the object is null
     * @throws  InvalidArgumentException    If status is not one of the valid status codes for the object's type
     */
    public function setStatus($status)
    {
        if ($this->object === null) {
            throw new LogicException('You\'re required to call setObject() before calling setStatus()');
        }
        $status = (int) $status;
        if (! in_array($status, self::$statusCodes[$this->object->getType()])) {
            throw new InvalidArgumentException(sprintf(
                'The status code %u you provided is not one of the valid status codes for type %s',
                $status,
                $this->object->getType()
            ));
        }
        $this->status = $status;
        return $this;
    }

    /**
     * Get the status code of the host or service check result
     *
     * @return int
     */
    public function getStatus()
    {
        return $this->status;
    }

    /**
     * Set the text output of the host or service check result
     *
     * @param   string $output
     *
     * @return  $this
     */
    public function setOutput($output)
    {
        $this->output = (string) $output;
        return $this;
    }

    /**
     * Get the text output of the host or service check result
     *
     * @return string
     */
    public function getOutput()
    {
        return $this->output;
    }

    /**
     * Set the performance data of the host or service check result
     *
     * @param   string $performanceData
     *
     * @return  $this
     */
    public function setPerformanceData($performanceData)
    {
        $this->performanceData = (string) $performanceData;
        return $this;
    }

    /**
     * Get the performance data of the host or service check result
     *
     * @return string
     */
    public function getPerformanceData()
    {
        return $this->performanceData;
    }
}