File Coverage

blib/lib/Siebel/Srvrmgr/Daemon/Action/Check/Component.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1             package Siebel::Srvrmgr::Daemon::Action::Check::Component;
2              
3 4     4   523706 use warnings;
  4         12  
  4         150  
4 4     4   25 use strict;
  4         9  
  4         113  
5 4     4   235 use Moose::Role 2.0401;
  4         4228  
  4         27  
6 4     4   21799 use Siebel::Srvrmgr::Types;
  4         10  
  4         582  
7             our $VERSION = '0.29'; # VERSION
8              
9             =pod
10              
11             =head1 NAME
12              
13             Siebel::Srvrmgr::Daemon::Action::Check::Component - role for classes that hold Siebel server components information
14              
15             =head1 DESCRIPTION
16              
17             This Moose Role is intended to be used by classes that provides information about which components are available in
18             a Siebel server and which is their expected status.
19              
20             =head1 ATTRIBUTES
21              
22             =head2 alias
23              
24             A string representing the alias of the component.
25              
26             =cut
27              
28             has alias => (
29             isa => 'NotNullStr',
30             is => 'ro',
31             reader => 'get_alias',
32             required => 1
33             );
34              
35             =pod
36              
37             =head2 description
38              
39             A string representing the description of the component.
40              
41             =cut
42              
43             has description =>
44             ( isa => 'Str', is => 'ro', required => 1, reader => 'get_description' );
45              
46             =pod
47              
48             =head2 componentGroup
49              
50             A string representing the Component Group alias that this component is part of.
51              
52             =cut
53              
54             has componentGroup => (
55             isa => 'NotNullStr',
56             is => 'ro',
57             required => 1,
58             reader => 'get_componentGroup',
59             );
60              
61             =pod
62              
63             =head2 OKStatus
64              
65             The status that the component is expected to have. It may be one or several (concatenated with a pipe character).
66              
67             This attribute is required during object creation.
68              
69             =cut
70              
71             has OKStatus => (
72             isa => 'NotNullStr',
73             is => 'ro',
74             reader => 'get_OKStatus',
75             required => 1
76             );
77              
78             =pod
79              
80             =head2 taskOKStatus
81              
82             The expected tasks status of the component. It may be one or several (concatenated with a pipe character).
83              
84             This attribute is required during object creation.
85              
86             =cut
87              
88             has taskOKStatus => (
89             isa => 'NotNullStr',
90             is => 'ro',
91             reader => 'get_taskOKStatus',
92             required => 1
93             );
94              
95             =pod
96              
97             =head2 criticality
98              
99             A integer indicating how critical it is if the component does not have the expected status: the largest the number,
100             the more critical it is.
101              
102             =cut
103              
104             has criticality => (
105             isa => 'Int',
106             is => 'ro',
107             reader => 'get_criticality',
108             required => 1
109             );
110              
111             =pod
112              
113             =head1 METHODS
114              
115             All attributes have their respective getter as C<get_><attribute name>.
116              
117             =head1 SEE ALSO
118              
119             =over
120              
121             =item *
122              
123             L<Siebel::Srvrmgr::Daemon::Action::Check::Server>
124              
125             =back
126              
127             =head1 AUTHOR
128              
129             Alceu Rodrigues de Freitas Junior, E<lt>arfreitas@cpan.orgE<gt>
130              
131             =head1 COPYRIGHT AND LICENSE
132              
133             This software is copyright (c) 2012 of Alceu Rodrigues de Freitas Junior, E<lt>arfreitas@cpan.orgE<gt>
134              
135             This file is part of Siebel Monitoring Tools.
136              
137             Siebel Monitoring Tools is free software: you can redistribute it and/or modify
138             it under the terms of the GNU General Public License as published by
139             the Free Software Foundation, either version 3 of the License, or
140             (at your option) any later version.
141              
142             Siebel Monitoring Tools is distributed in the hope that it will be useful,
143             but WITHOUT ANY WARRANTY; without even the implied warranty of
144             MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
145             GNU General Public License for more details.
146              
147             You should have received a copy of the GNU General Public License
148             along with Siebel Monitoring Tools. If not, see L<http://www.gnu.org/licenses/>.
149              
150             =cut
151              
152             1;