File Coverage

blib/lib/Net/Whois/Object/Mntner/APNIC.pm
Criterion Covered Total %
statement 13 13 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod 1 1 100.0
total 18 18 100.0


line stmt bran cond sub pod time code
1             package Net::Whois::Object::Mntner::APNIC;
2              
3 1     1   7 use strict;
  1         2  
  1         32  
4 1     1   9 use warnings;
  1         2  
  1         26  
5 1     1   5 use base qw/Net::Whois::Object/;
  1         2  
  1         267  
6              
7             # whois -h whois.apnic.net -t mntner
8             # % [whois.apnic.net]
9             # % Whois data copyright terms http://www.apnic.net/db/dbcopyright.html
10             #
11             # mntner: [mandatory] [single] [primary/look-up key]
12             # descr: [mandatory] [multiple] [ ]
13             # country: [optional] [single] [ ]
14             # org: [optional] [multiple] [inverse key]
15             # admin-c: [mandatory] [multiple] [inverse key]
16             # tech-c: [optional] [multiple] [inverse key]
17             # upd-to: [mandatory] [multiple] [inverse key]
18             # mnt-nfy: [optional] [multiple] [inverse key]
19             # auth: [mandatory] [multiple] [inverse key]
20             # remarks: [optional] [multiple] [ ]
21             # notify: [optional] [multiple] [inverse key]
22             # abuse-mailbox: [optional] [multiple] [inverse key]
23             # mnt-by: [mandatory] [multiple] [inverse key]
24             # referral-by: [optional] [single] [inverse key]
25             # last-modified: [generated] [single] [ ]
26             # source: [mandatory] [single] [ ]
27             #
28             # % This query was served by the APNIC Whois Service version 1.88.15-46 (WHOIS-UK4)
29              
30             __PACKAGE__->attributes( 'primary', [ 'mntner' ] );
31             __PACKAGE__->attributes( 'mandatory', [ 'mntner', 'descr', 'admin_c', 'upd_to', 'auth', 'mnt_by', 'source' ] );
32             __PACKAGE__->attributes( 'optional', [ 'country', 'org', 'tech_c', 'mnt_nfy', 'remarks', 'notify', 'abuse_mailbox', 'referral_by', 'last_modified' ] );
33             __PACKAGE__->attributes( 'single', [ 'mntner', 'country', 'referral_by', 'last_modified', 'source' ] );
34             __PACKAGE__->attributes( 'multiple', [ 'descr', 'org', 'admin_c', 'tech_c', 'upd_to', 'mnt_nfy', 'auth', 'remarks', 'notify', 'abuse_mailbox', 'mnt_by' ] );
35              
36             =head1 NAME
37              
38             Net::Whois::Object::Mntner::APNIC - an object representation of the RPSL Mntner block
39              
40             =head1 DESCRIPTION
41              
42             Objects in the RIPE Database may be protected using Mntner (pronounced
43             "maintainer") objects. A Mntner object specifies authentication
44             information required to authorise creation, deletion or modification
45             of the objects protected by the Mntner.
46              
47             Objects are protected by a Mntner, if they contain a reference to the Mntner
48             in the object. This is done by including a mnt-by attribute. Other
49             attributes offer hierarchical protection. The mnt-by attribute is mandatory
50             in all object types. Most users set the mnt-by value in a Mntner to
51             reference itself.
52              
53             =head1 METHODS
54              
55             =head2 B
56              
57             Constructor for the Net::Whois::Object::Mntner::APNIC class
58              
59             =cut
60              
61             sub new {
62 1     1 1 4 my ( $class, @options ) = @_;
63              
64 1         2 my $self = bless {}, $class;
65 1         6 $self->_init(@options);
66              
67 1         3 return $self;
68             }
69              
70             =head2 B
71              
72             Accessor to the mntner attribute.
73             Accepts an optional mntner value to be added to the mntner array,
74             always return the current mntner.
75              
76             The unique name of a mntner object. APNIC recommends the following formats:
77              
78             Maintainer for resource registrations:
79              
80             --
81              
82             EXAMPLE
83             MAINT-WF-SPARKYNET
84              
85             =head2 B
86              
87             Accessor to the descr attribute.
88             Accepts an optional descr line to be added to the descr array,
89             always return the current descr array.
90              
91             A short description of the mntner object and the name of the organization
92             associated with it.
93              
94             =head2 B
95              
96             Accessor to the org attribute.
97             Accepts an optional org value to be added to the org array,
98             always return the current org array.
99              
100             The organisation this object is bound to.
101              
102             =head2 B
103              
104             Accessor to the admin_c attribute.
105             Accepts an optional contact to be added to the admin_c array,
106             always return the current admin_c array.
107              
108             The NIC-handle of an on-site contact Person object. As more than one
109             person often fulfills a role function, there may be more than one admin_c
110             listed.
111              
112             An administrative contact (admin_c) must be someone who is
113             physically located at the site of the network.
114              
115             =head2 B
116              
117             Accessor to the tech_c attribute.
118             Accepts an optional contact to be added to the tech_c array,
119             always return the current tech_c array.
120              
121             The NIC-handle of a technical contact Person or Role object. As more than
122             one person often fulfills a role function, there may be more than one tech_c
123             listed.
124              
125             A technical contact (tech_c) must be a person responsible for the
126             day-to-day operation of the network, but does not need to be
127             physically located at the site of the network.
128              
129             =head2 B
130              
131             Accessor to the upd_to attribute.
132             Accepts an optional upd_to value to be added to the upd_to array,
133             always return the current upd_to array.
134              
135             The upd_to attribute specifies the email address to be notified when an
136             attempt to update an object protected by this Mntner is unsuccessful.
137              
138             =head2 B
139              
140             Accessor to the mnt_nfy attribute.
141             Accepts an optional mnt_nfy value to be added to the mnt_nfy array,
142             always return the current mnt_nfy array.
143              
144             The mnt_nfy attribute specifies the email address to be notified when an
145             object protected by this Mntner is successfully updated.
146              
147             =head2 B
148              
149             Accessor to the auth attribute.
150             Accepts an optional auth value to be added to the auth array,
151             always return the current auth array.
152              
153             The auth attribute defines an authentication scheme to be used. . Any of
154             the current authentication schemes used by the RIPE Database are allowed.
155              
156             =head2 B
157              
158             Accessor to the remarks attribute.
159             Accepts an optional remark to be addedt to the remarks array,
160             always return the current remarks array.
161              
162             General remarks. May include a URL or email address.
163              
164             =head2 B
165              
166             Accessor to the notify attribute.
167             Accepts an optional notify value to be added to the notify array,
168             always return the current notify array.
169              
170             The email address to which notifications of changes to this object should
171             be sent.
172              
173             =head2 B
174              
175             Accessor to the mnt_by attribute.
176             Accepts an optional mnt_by value to be added to the mnt_by array,
177             always return the current mnt_by array.
178              
179             Lists a registered Mntner used to authorize and authenticate changes to
180             this object.
181              
182             Most users set the mnt-by value in a Mntner to reference itself.
183              
184             =head2 B
185              
186             Accessor to the auth_override attribute.
187             Accepts an optional auth_override, always return the current auth_override.
188              
189             Routing Policy System Security specification defines an auth_override attribute
190             in the Mntner object template. Together with referral-by attribute, they allow
191             for a Mntner to be modified if it becomes unresponsive.
192             As this is not part of the core functionality of the RIPE Database,
193             it has not been implemented in the current version of the database.
194              
195             =head2 B
196              
197             Accessor to the referral_by attribute.
198             Accepts an optional referral_by, always return the current referral_by.
199              
200             Routing Policy System Security specification defines an auth_override attribute
201             in the Mntner object template. Together with referral-by attribute, they allow
202             for a Mntner to be modified if it becomes unresponsive.
203             As this is not part of the core functionality of the RIPE Database,
204             it has not been implemented in the current version of the database.
205              
206             =head2 B
207              
208             Accessor to the changed attribute.
209             Accepts an optional changed value to be added to the changed array,
210             always return the current changed array.
211              
212             The email address of who last updated the database object and the date it
213             occurred.
214              
215             Every time a change is made to a database object, this attribute will show
216             the email address of the person who made those changes.
217             Please use the address format specified in RFC 822 - Standard for
218             the Format of ARPA Internet Text Message and provide the date
219             format using one of the following two formats: YYYYMMDD or YYMMDD.
220              
221             =head2 B
222              
223             Accessor to the source attribute.
224             Accepts an optional source, always return the current source.
225              
226             The name of the database from which the data was obtained.
227              
228             =head2 B
229              
230             Accessor to the country attribute.
231             Accepts an optional value, always return the current 'country'.
232             Two letter ISO 3166 code of the country or economy where the admin-c is based.
233              
234             Please use UPPERCASE letters.
235              
236             =head2 B
237              
238             Accessor to the abuse_mailbox attribute.
239             Accepts an optional abuse_mailbox value to be added to the abuse_mailbox array,
240             always return the current abuse_mailbox array.
241              
242             =cut
243              
244             1;