summaryrefslogtreecommitdiffstats
path: root/modules/monitoring/library/Monitoring/Command/IcingaApiCommand.php
blob: c33157f65176f2db27e6e2d34117b976c56c576f (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
<?php
/* Icinga Web 2 | (c) 2016 Icinga Development Team | GPLv2+ */

namespace Icinga\Module\Monitoring\Command;

class IcingaApiCommand
{
    /**
     * Command data
     *
     * @var array
     */
    protected $data;

    /**
     * Name of the endpoint
     *
     * @var string
     */
    protected $endpoint;

    /**
     * Next Icinga API command to be sent, if any
     *
     * @var static
     */
    protected $next;

    /**
     * Create a new Icinga 2 API command
     *
     * @param   string  $endpoint
     * @param   array   $data
     *
     * @return  static
     */
    public static function create($endpoint, array $data)
    {
        $command = new static();
        $command
            ->setEndpoint($endpoint)
            ->setData($data);
        return $command;
    }

    /**
     * Get the command data
     *
     * @return array
     */
    public function getData()
    {
        return $this->data;
    }

    /**
     * Set the command data
     *
     * @param   array   $data
     *
     * @return  $this
     */
    public function setData($data)
    {
        $this->data = $data;

        return $this;
    }

    /**
     * Get the name of the endpoint
     *
     * @return string
     */
    public function getEndpoint()
    {
        return $this->endpoint;
    }

    /**
     * Set the name of the endpoint
     *
     * @param   string  $endpoint
     *
     * @return  $this
     */
    public function setEndpoint($endpoint)
    {
        $this->endpoint = $endpoint;

        return $this;
    }

    /**
     * Get whether another Icinga API command should be sent after this one
     *
     * @return bool
     */
    public function hasNext()
    {
        return $this->next !== null;
    }

    /**
     * Get the next Icinga API command
     *
     * @return IcingaApiCommand
     */
    public function getNext()
    {
        return $this->next;
    }

    /**
     * Set the next Icinga API command
     *
     * @param   IcingaApiCommand    $next
     *
     * @return  IcingaApiCommand
     */
    public function setNext(IcingaApiCommand $next)
    {
        $this->next = $next;
        return $next;
    }
}