| Kea 3.0.2-git

simple_remove.cc
Go to the documentation of this file.
1// Copyright (C) 2013-2024 Internet Systems Consortium, Inc. ("ISC")
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7#include <config.h>
8
9#include <d2/simple_remove.h>
10#include <d2srv/d2_cfg_mgr.h>
11#include <d2srv/d2_log.h>
12
13#include <functional>
14
15 namespace isc {
16 namespace d2 {
17
18
19// SimpleRemoveTransaction states
20 const int SimpleRemoveTransaction::REMOVING_FWD_RRS_ST;
21 const int SimpleRemoveTransaction::REMOVING_REV_PTRS_ST;
22
23// SimpleRemoveTransaction events
24// Currently SimpleRemoveTransaction does not define any events.
25
26 SimpleRemoveTransaction::
27 SimpleRemoveTransaction(asiolink::IOServicePtr& io_service,
28 dhcp_ddns::NameChangeRequestPtr& ncr,
29 DdnsDomainPtr& forward_domain,
30 DdnsDomainPtr& reverse_domain,
31 D2CfgMgrPtr& cfg_mgr)
32 : NameChangeTransaction(io_service, ncr, forward_domain, reverse_domain,
33 cfg_mgr) {
34 if (ncr->getChangeType() != isc::dhcp_ddns::CHG_REMOVE) {
35 isc_throw (SimpleRemoveTransactionError,
36 "SimpleRemoveTransaction, request type must be CHG_REMOVE");
37 }
38}
39
40 SimpleRemoveTransaction::~SimpleRemoveTransaction(){
41}
42
43 void
44 SimpleRemoveTransaction::defineEvents() {
45 // Call superclass impl first.
46 NameChangeTransaction::defineEvents();
47
48 // Define SimpleRemoveTransaction events.
49 // Currently SimpleRemoveTransaction does not define any events.
50 // defineEvent(TBD_EVENT, "TBD_EVT");
51}
52
53 void
54 SimpleRemoveTransaction::verifyEvents() {
55 // Call superclass implementation first to verify its events. These are
56 // events common to all transactions, and they must be defined.
57 // SELECT_SERVER_EVT
58 // SERVER_SELECTED_EVT
59 // SERVER_IO_ERROR_EVT
60 // NO_MORE_SERVERS_EVT
61 // IO_COMPLETED_EVT
62 // UPDATE_OK_EVT
63 // UPDATE_FAILED_EVT
64 NameChangeTransaction::verifyEvents();
65
66 // Verify SimpleRemoveTransaction events by attempting to fetch them.
67 // Currently SimpleRemoveTransaction does not define any events.
68 // getEvent(TBD_EVENT);
69}
70
71 void
72 SimpleRemoveTransaction::defineStates() {
73 // Call superclass impl first.
74 NameChangeTransaction::defineStates();
75
76 // Define SimpleRemoveTransaction states.
77 defineState(READY_ST, "READY_ST",
78 std::bind(&SimpleRemoveTransaction::readyHandler, this));
79
80 defineState(SELECTING_FWD_SERVER_ST, "SELECTING_FWD_SERVER_ST",
81 std::bind(&SimpleRemoveTransaction::selectingFwdServerHandler,
82 this));
83
84 defineState(SELECTING_REV_SERVER_ST, "SELECTING_REV_SERVER_ST",
85 std::bind(&SimpleRemoveTransaction::selectingRevServerHandler,
86 this));
87
88 defineState(REMOVING_FWD_RRS_ST, "REMOVING_FWD_RRS_ST",
89 std::bind(&SimpleRemoveTransaction::removingFwdRRsHandler,
90 this));
91
92 defineState(REMOVING_REV_PTRS_ST, "REMOVING_REV_PTRS_ST",
93 std::bind(&SimpleRemoveTransaction::removingRevPtrsHandler,
94 this));
95
96 defineState(PROCESS_TRANS_OK_ST, "PROCESS_TRANS_OK_ST",
97 std::bind(&SimpleRemoveTransaction::processRemoveOkHandler,
98 this));
99
100 defineState(PROCESS_TRANS_FAILED_ST, "PROCESS_TRANS_FAILED_ST",
101 std::bind(&SimpleRemoveTransaction::processRemoveFailedHandler,
102 this));
103}
104
105 void
106 SimpleRemoveTransaction::verifyStates() {
107 // Call superclass implementation first to verify its states. These are
108 // states common to all transactions, and they must be defined.
109 // READY_ST
110 // SELECTING_FWD_SERVER_ST
111 // SELECTING_REV_SERVER_ST
112 // PROCESS_TRANS_OK_ST
113 // PROCESS_TRANS_FAILED_ST
114 NameChangeTransaction::verifyStates();
115
116 // Verify SimpleRemoveTransaction states by attempting to fetch them.
117 getStateInternal(REMOVING_FWD_RRS_ST);
118 getStateInternal(REMOVING_REV_PTRS_ST);
119}
120
121 void
122 SimpleRemoveTransaction::readyHandler() {
123 switch(getNextEvent()) {
124 case START_EVT:
125 if (getForwardDomain()) {
126 // Request includes a forward change, do that first.
127 transition(SELECTING_FWD_SERVER_ST, SELECT_SERVER_EVT);
128 } else {
129 // Reverse change only, transition accordingly.
130 transition(SELECTING_REV_SERVER_ST, SELECT_SERVER_EVT);
131 }
132
133 break;
134 default:
135 // Event is invalid.
136 isc_throw(SimpleRemoveTransactionError,
137 "Wrong event for context: " << getContextStr());
138 }
139}
140
141 void
142 SimpleRemoveTransaction::selectingFwdServerHandler() {
143 switch(getNextEvent()) {
144 case SELECT_SERVER_EVT:
145 // First time through for this transaction, so initialize server
146 // selection.
147 initServerSelection(getForwardDomain());
148 break;
149 case SERVER_IO_ERROR_EVT:
150 // We failed to communicate with current server. Attempt to select
151 // another one below.
152 break;
153 default:
154 // Event is invalid.
155 isc_throw(SimpleRemoveTransactionError,
156 "Wrong event for context: " << getContextStr());
157 }
158
159 // Select the next server from the list of forward servers.
160 if (selectNextServer()) {
161 // We have a server to try.
162 transition(REMOVING_FWD_RRS_ST, SERVER_SELECTED_EVT);
163 } else {
164 // Server list is exhausted, so fail the transaction.
165 transition(PROCESS_TRANS_FAILED_ST, NO_MORE_SERVERS_EVT);
166 }
167}
168
169 void
170 SimpleRemoveTransaction::removingFwdRRsHandler() {
171 if (doOnEntry()) {
172 // Clear the update attempts count on initial transition.
173 clearUpdateAttempts();
174 }
175
176 switch(getNextEvent()) {
177 case UPDATE_OK_EVT:
178 case SERVER_SELECTED_EVT:
179 try {
180 clearDnsUpdateRequest();
181 buildRemoveFwdRRsRequest();
182 } catch (const std::exception& ex) {
183 // While unlikely, the build might fail if we have invalid
184 // data. Should that be the case, we need to fail the
185 // transaction.
186 LOG_ERROR(d2_to_dns_logger,
187 DHCP_DDNS_FORWARD_REMOVE_RRS_BUILD_FAILURE)
188 .arg(getRequestId())
189 .arg(getNcr()->toText())
190 .arg(ex.what());
191 transition(PROCESS_TRANS_FAILED_ST, UPDATE_FAILED_EVT);
192 break;
193 }
194
195 // Call sendUpdate() to initiate the async send. Note it also sets
196 // next event to NOP_EVT.
197 sendUpdate("Forward RR Remove");
198 break;
199
200 case IO_COMPLETED_EVT: {
201 switch (getDnsUpdateStatus()) {
202 case DNSClient::SUCCESS: {
203 // We successfully received a response packet from the server.
204 // The RCODE will be based on a value-dependent RRset search,
205 // see RFC 2136 section 3.2.3/3.2.4.
206 const dns::Rcode& rcode = getDnsUpdateResponse()->getRcode();
207 if ((rcode == dns::Rcode::NOERROR()) ||
208 (rcode == dns::Rcode::NXRRSET())) {
209 // We were able to remove them or they were not there (
210 // Rcode of NXRRSET means there are no matching RRsets).
211 // In either case, we consider it success and mark it as done.
212 setForwardChangeCompleted(true);
213
214 // If request calls for reverse update then do that next,
215 // otherwise we can process ok.
216 if (getReverseDomain()) {
217 transition(SELECTING_REV_SERVER_ST, SELECT_SERVER_EVT);
218 } else {
219 transition(PROCESS_TRANS_OK_ST, UPDATE_OK_EVT);
220 }
221 } else {
222 // Any other value means cease.
223 // If we get not authorized should try the next server in
224 // the list? @todo This needs some discussion perhaps.
225 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_FORWARD_REMOVE_RRS_REJECTED)
226 .arg(getRequestId())
227 .arg(getCurrentServer()->toText())
228 .arg(getNcr()->getFqdn())
229 .arg(rcode.getCode());
230 transition(PROCESS_TRANS_FAILED_ST, UPDATE_FAILED_EVT);
231 }
232
233 break;
234 }
235
236 case DNSClient::TIMEOUT:
237 // No response from the server, log it and set up
238 // to select the next server for a retry.
239 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_FORWARD_REMOVE_RRS_TIMEOUT)
240 .arg(getRequestId())
241 .arg(getNcr()->getFqdn())
242 .arg(getCurrentServer()->toText());
243
244 retryTransition(SELECTING_FWD_SERVER_ST);
245 break;
246
247 case DNSClient::OTHER:
248 // We couldn't send to the current server, log it and set up
249 // to select the next server for a retry.
250 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_FORWARD_REMOVE_RRS_IO_ERROR)
251 .arg(getRequestId())
252 .arg(getNcr()->getFqdn())
253 .arg(getCurrentServer()->toText());
254
255 retryTransition(SELECTING_FWD_SERVER_ST);
256 break;
257
258 case DNSClient::INVALID_RESPONSE:
259 // A response was received but was corrupt. Retry it like an IO
260 // error.
261 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_FORWARD_REMOVE_RRS_RESP_CORRUPT)
262 .arg(getRequestId())
263 .arg(getCurrentServer()->toText())
264 .arg(getNcr()->getFqdn());
265
266 retryTransition(SELECTING_FWD_SERVER_ST);
267 break;
268
269 default:
270 // Any other value and we will fail this transaction, something
271 // bigger is wrong.
272 LOG_ERROR(d2_to_dns_logger,
273 DHCP_DDNS_FORWARD_REMOVE_RRS_BAD_DNSCLIENT_STATUS)
274 .arg(getRequestId())
275 .arg(getDnsUpdateStatus())
276 .arg(getNcr()->getFqdn())
277 .arg(getCurrentServer()->toText());
278
279 transition(PROCESS_TRANS_FAILED_ST, UPDATE_FAILED_EVT);
280 break;
281 } // end switch on dns_status
282
283 break;
284 } // end case IO_COMPLETE_EVT
285
286 default:
287 // Event is invalid.
288 isc_throw(SimpleRemoveTransactionError,
289 "Wrong event for context: " << getContextStr());
290 }
291}
292
293 void
294 SimpleRemoveTransaction::selectingRevServerHandler() {
295 switch(getNextEvent()) {
296 case SELECT_SERVER_EVT:
297 // First time through for this transaction, so initialize server
298 // selection.
299 initServerSelection(getReverseDomain());
300 break;
301 case SERVER_IO_ERROR_EVT:
302 // We failed to communicate with current server. Attempt to select
303 // another one below.
304 break;
305 default:
306 // Event is invalid.
307 isc_throw(SimpleRemoveTransactionError,
308 "Wrong event for context: " << getContextStr());
309 }
310
311 // Select the next server from the list of forward servers.
312 if (selectNextServer()) {
313 // We have a server to try.
314 transition(REMOVING_REV_PTRS_ST, SERVER_SELECTED_EVT);
315 } else {
316 // Server list is exhausted, so fail the transaction.
317 transition(PROCESS_TRANS_FAILED_ST, NO_MORE_SERVERS_EVT);
318 }
319}
320
321
322 void
323 SimpleRemoveTransaction::removingRevPtrsHandler() {
324 if (doOnEntry()) {
325 // Clear the update attempts count on initial transition.
326 clearUpdateAttempts();
327 }
328
329 switch(getNextEvent()) {
330 case SERVER_SELECTED_EVT:
331 try {
332 clearDnsUpdateRequest();
333 buildRemoveRevPtrsRequest();
334 } catch (const std::exception& ex) {
335 // While unlikely, the build might fail if we have invalid
336 // data. Should that be the case, we need to fail the
337 // transaction.
338 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_REVERSE_REMOVE_BUILD_FAILURE)
339 .arg(getRequestId())
340 .arg(getNcr()->toText())
341 .arg(ex.what());
342 transition(PROCESS_TRANS_FAILED_ST, UPDATE_FAILED_EVT);
343 break;
344 }
345
346 // Call sendUpdate() to initiate the async send. Note it also sets
347 // next event to NOP_EVT.
348 sendUpdate("Reverse Remove");
349 break;
350
351 case IO_COMPLETED_EVT: {
352 switch (getDnsUpdateStatus()) {
353 case DNSClient::SUCCESS: {
354 // We successfully received a response packet from the server.
355 // The RCODE will be based on a value-dependent RRset search,
356 // see RFC 2136 section 3.2.3/3.2.4.
357 const dns::Rcode& rcode = getDnsUpdateResponse()->getRcode();
358 if ((rcode == dns::Rcode::NOERROR()) ||
359 (rcode == dns::Rcode::NXRRSET())) {
360 // We were able to remove the reverse mapping or they were
361 // not there (Rcode of NXRRSET means there are no matching
362 // RRsets). In either case, mark it as done.
363 setReverseChangeCompleted(true);
364 transition(PROCESS_TRANS_OK_ST, UPDATE_OK_EVT);
365 } else {
366 // Per RFC4703 any other value means cease.
367 // If we get not authorized should try the next server in
368 // the list? @todo This needs some discussion perhaps.
369 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_REVERSE_REMOVE_REJECTED)
370 .arg(getRequestId())
371 .arg(getCurrentServer()->toText())
372 .arg(getNcr()->getFqdn())
373 .arg(rcode.getCode());
374 transition(PROCESS_TRANS_FAILED_ST, UPDATE_FAILED_EVT);
375 }
376
377 break;
378 }
379
380 case DNSClient::TIMEOUT:
381 // No response from the server, log it and set up
382 // to select the next server for a retry.
383 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_REVERSE_REMOVE_TIMEOUT)
384 .arg(getRequestId())
385 .arg(getNcr()->getFqdn())
386 .arg(getCurrentServer()->toText());
387
388 // If we are out of retries on this server, we go back and start
389 // all over on a new server.
390 retryTransition(SELECTING_REV_SERVER_ST);
391 break;
392
393
394 case DNSClient::OTHER:
395 // We couldn't send to the current server, log it and set up
396 // to select the next server for a retry.
397 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_REVERSE_REMOVE_IO_ERROR)
398 .arg(getRequestId())
399 .arg(getNcr()->getFqdn())
400 .arg(getCurrentServer()->toText());
401
402 // If we are out of retries on this server, we go back and start
403 // all over on a new server.
404 retryTransition(SELECTING_REV_SERVER_ST);
405 break;
406
407 case DNSClient::INVALID_RESPONSE:
408 // A response was received but was corrupt. Retry it like an IO
409 // error.
410 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_REVERSE_REMOVE_RESP_CORRUPT)
411 .arg(getRequestId())
412 .arg(getCurrentServer()->toText())
413 .arg(getNcr()->getFqdn());
414
415 // If we are out of retries on this server, we go back and start
416 // all over on a new server.
417 retryTransition(SELECTING_REV_SERVER_ST);
418 break;
419
420 default:
421 // Any other value and we will fail this transaction, something
422 // bigger is wrong.
423 LOG_ERROR(d2_to_dns_logger,
424 DHCP_DDNS_REVERSE_REMOVE_BAD_DNSCLIENT_STATUS)
425 .arg(getRequestId())
426 .arg(getDnsUpdateStatus())
427 .arg(getNcr()->getFqdn())
428 .arg(getCurrentServer()->toText());
429
430 transition(PROCESS_TRANS_FAILED_ST, UPDATE_FAILED_EVT);
431 break;
432 } // end switch on dns_status
433
434 break;
435 } // end case IO_COMPLETE_EVT
436
437 default:
438 // Event is invalid.
439 isc_throw(SimpleRemoveTransactionError,
440 "Wrong event for context: " << getContextStr());
441 }
442}
443
444
445 void
446 SimpleRemoveTransaction::processRemoveOkHandler() {
447 switch(getNextEvent()) {
448 case UPDATE_OK_EVT:
449 LOG_INFO(d2_to_dns_logger, DHCP_DDNS_REMOVE_SUCCEEDED)
450 .arg(getRequestId())
451 .arg(getNcr()->toText());
452 setNcrStatus(dhcp_ddns::ST_COMPLETED);
453 endModel();
454 break;
455 default:
456 // Event is invalid.
457 isc_throw(SimpleRemoveTransactionError,
458 "Wrong event for context: " << getContextStr());
459 }
460}
461
462 void
463 SimpleRemoveTransaction::processRemoveFailedHandler() {
464 switch(getNextEvent()) {
465 case UPDATE_FAILED_EVT:
466 case NO_MORE_SERVERS_EVT:
467 case SERVER_IO_ERROR_EVT:
468 setNcrStatus(dhcp_ddns::ST_FAILED);
469 LOG_ERROR(d2_to_dns_logger, DHCP_DDNS_REMOVE_FAILED)
470 .arg(getRequestId())
471 .arg(transactionOutcomeString());
472 endModel();
473 break;
474 default:
475 // Event is invalid.
476 isc_throw(SimpleRemoveTransactionError,
477 "Wrong event for context: " << getContextStr());
478 }
479}
480
481 void
482 SimpleRemoveTransaction::buildRemoveFwdRRsRequest() {
483 // Construct an empty request.
484 D2UpdateMessagePtr request = prepNewRequest(getForwardDomain());
485
486 // There are no pre-requisites.
487
488 // Build the Update Section
489 // Construct dns::Name from NCR fqdn.
490 dns::Name fqdn(dns::Name(getNcr()->getFqdn()));
491
492 // Build the Update Section.
493
494 // Create the FQDN/IP 'delete' RR and add it to update section.
495 dns::RRsetPtr update(new dns::RRset(fqdn, dns::RRClass::ANY(),
496 getAddressRRType(), dns::RRTTL(0)));
497
498 request->addRRset(D2UpdateMessage::SECTION_UPDATE, update);
499
500 // Create the DHCID 'delete' RR and add it to the update section.
501 update.reset(new dns::RRset(fqdn, dns::RRClass::ANY(),
502 dns::RRType::DHCID(), dns::RRTTL(0)));
503 request->addRRset(D2UpdateMessage::SECTION_UPDATE, update);
504
505 // Set the transaction's update request to the new request.
506 setDnsUpdateRequest(request);
507}
508
509 void
510 SimpleRemoveTransaction::buildRemoveRevPtrsRequest() {
511 // Construct an empty request.
512 D2UpdateMessagePtr request = prepNewRequest(getReverseDomain());
513
514 // Create the reverse IP address "FQDN".
515 std::string rev_addr = D2CfgMgr::reverseIpAddress(getNcr()->getIpAddress());
516 dns::Name rev_ip(rev_addr);
517
518 // There are no pre-requisites.
519
520 // Build the Update section.
521
522 // Create the FQDN/IP PTR 'delete' RR for this IP and add it to
523 // the update section.
524 dns::RRsetPtr update(new dns::RRset(rev_ip, dns::RRClass::ANY(),
525 dns::RRType::PTR(), dns::RRTTL(0)));
526 request->addRRset(D2UpdateMessage::SECTION_UPDATE, update);
527
528 // Create the DHCID 'delete' RR and add it to the update section.
529 update.reset(new dns::RRset(rev_ip, dns::RRClass::ANY(),
530 dns::RRType::DHCID(), dns::RRTTL(0)));
531 request->addRRset(D2UpdateMessage::SECTION_UPDATE, update);
532
533 // Set the transaction's update request to the new request.
534 setDnsUpdateRequest(request);
535}
536
537} // namespace isc::d2
538} // namespace isc
isc::d2::D2CfgMgr::reverseIpAddress
static std::string reverseIpAddress(const std::string &address)
Generate a reverse order string for the given IP address.
Definition d2_cfg_mgr.cc:183
isc::d2::D2UpdateMessage::SECTION_UPDATE
@ SECTION_UPDATE
Definition d2_update_message.h:120
isc::d2::DNSClient::TIMEOUT
@ TIMEOUT
No response, timeout.
Definition dns_client.h:60
isc::d2::DNSClient::OTHER
@ OTHER
Other, unclassified error.
Definition dns_client.h:63
isc::d2::DNSClient::INVALID_RESPONSE
@ INVALID_RESPONSE
Response received but invalid.
Definition dns_client.h:62
isc::d2::DNSClient::SUCCESS
@ SUCCESS
Response received and is ok.
Definition dns_client.h:59
isc::d2::NameChangeTransaction::SELECTING_FWD_SERVER_ST
static const int SELECTING_FWD_SERVER_ST
State in which forward DNS server selection is done.
Definition nc_trans.h:91
isc::d2::NameChangeTransaction::retryTransition
void retryTransition(const int fail_to_state)
Determines the state and next event based on update attempts.
Definition nc_trans.cc:287
isc::d2::NameChangeTransaction::PROCESS_TRANS_FAILED_ST
static const int PROCESS_TRANS_FAILED_ST
State which processes an unsuccessful transaction conclusion.
Definition nc_trans.h:105
isc::d2::NameChangeTransaction::READY_ST
static const int READY_ST
State from which a transaction is started.
Definition nc_trans.h:83
isc::d2::NameChangeTransaction::getDnsUpdateResponse
const D2UpdateMessagePtr & getDnsUpdateResponse() const
Fetches the most recent DNS update response packet.
Definition nc_trans.cc:554
isc::d2::NameChangeTransaction::PROCESS_TRANS_OK_ST
static const int PROCESS_TRANS_OK_ST
State which processes successful transaction conclusion.
Definition nc_trans.h:102
isc::d2::NameChangeTransaction::UPDATE_OK_EVT
static const int UPDATE_OK_EVT
Issued when the attempted update successfully completed.
Definition nc_trans.h:135
isc::d2::NameChangeTransaction::verifyStates
virtual void verifyStates()
Validates the contents of the set of states.
Definition nc_trans.cc:266
isc::d2::NameChangeTransaction::prepNewRequest
virtual D2UpdateMessagePtr prepNewRequest(DdnsDomainPtr domain)
Creates a new DNS update request based on the given domain.
Definition nc_trans.cc:344
isc::d2::NameChangeTransaction::NameChangeTransaction
NameChangeTransaction(asiolink::IOServicePtr &io_service, dhcp_ddns::NameChangeRequestPtr &ncr, DdnsDomainPtr &forward_domain, DdnsDomainPtr &reverse_domain, D2CfgMgrPtr &cfg_mgr)
Constructor.
Definition nc_trans.cc:69
isc::d2::NameChangeTransaction::UPDATE_FAILED_EVT
static const int UPDATE_FAILED_EVT
Issued when the attempted update fails to complete.
Definition nc_trans.h:141
isc::d2::NameChangeTransaction::getAddressRRType
const dns::RRType & getAddressRRType() const
Returns the DHCP data type for the lease address.
Definition nc_trans.cc:574
isc::d2::NameChangeTransaction::getNcr
const dhcp_ddns::NameChangeRequestPtr & getNcr() const
Fetches the NameChangeRequest for this transaction.
Definition nc_trans.cc:426
isc::d2::NameChangeTransaction::initServerSelection
void initServerSelection(const DdnsDomainPtr &domain)
Initializes server selection from the given DDNS domain.
Definition nc_trans.cc:456
isc::d2::NameChangeTransaction::IO_COMPLETED_EVT
static const int IO_COMPLETED_EVT
Issued when a DNS update packet exchange has completed.
Definition nc_trans.h:130
isc::d2::NameChangeTransaction::SELECT_SERVER_EVT
static const int SELECT_SERVER_EVT
Issued when a server needs to be selected.
Definition nc_trans.h:113
isc::d2::NameChangeTransaction::SERVER_IO_ERROR_EVT
static const int SERVER_IO_ERROR_EVT
Issued when an update fails due to an IO error.
Definition nc_trans.h:119
isc::d2::NameChangeTransaction::getRequestId
std::string getRequestId() const
Fetches the request id that identifies this transaction.
Definition nc_trans.cc:436
isc::d2::NameChangeTransaction::defineStates
virtual void defineStates()
Adds states defined by NameChangeTransaction to the state set.
Definition nc_trans.cc:258
isc::d2::NameChangeTransaction::sendUpdate
virtual void sendUpdate(const std::string &comment="")
Send the update request to the current server.
Definition nc_trans.cc:193
isc::d2::NameChangeTransaction::setForwardChangeCompleted
void setForwardChangeCompleted(const bool value)
Sets the forward change completion flag to the given value.
Definition nc_trans.cc:329
isc::d2::NameChangeTransaction::selectNextServer
bool selectNextServer()
Selects the next server in the current server list.
Definition nc_trans.cc:468
isc::d2::NameChangeTransaction::setNcrStatus
void setNcrStatus(const dhcp_ddns::NameChangeStatus &status)
Sets the status of the transaction's NameChangeRequest.
Definition nc_trans.cc:539
isc::d2::NameChangeTransaction::getForwardDomain
DdnsDomainPtr & getForwardDomain()
Fetches the forward DdnsDomain.
Definition nc_trans.cc:446
isc::d2::NameChangeTransaction::verifyEvents
virtual void verifyEvents()
Validates the contents of the set of events.
Definition nc_trans.cc:243
isc::d2::NameChangeTransaction::clearDnsUpdateRequest
void clearDnsUpdateRequest()
Destroys the current update request packet.
Definition nc_trans.cc:304
isc::d2::NameChangeTransaction::clearUpdateAttempts
void clearUpdateAttempts()
Resets the update attempts count.
Definition nc_trans.cc:309
isc::d2::NameChangeTransaction::SELECTING_REV_SERVER_ST
static const int SELECTING_REV_SERVER_ST
State in which reverse DNS server selection is done.
Definition nc_trans.h:99
isc::d2::NameChangeTransaction::getDnsUpdateStatus
DNSClient::Status getDnsUpdateStatus() const
Fetches the most recent DNS update status.
Definition nc_trans.cc:549
isc::d2::NameChangeTransaction::setDnsUpdateRequest
void setDnsUpdateRequest(D2UpdateMessagePtr &request)
Sets the update request packet to the given packet.
Definition nc_trans.cc:299
isc::d2::NameChangeTransaction::NO_MORE_SERVERS_EVT
static const int NO_MORE_SERVERS_EVT
Issued when there are no more servers from which to select.
Definition nc_trans.h:125
isc::d2::NameChangeTransaction::defineEvents
virtual void defineEvents()
Adds events defined by NameChangeTransaction to the event set.
Definition nc_trans.cc:228
isc::d2::NameChangeTransaction::setReverseChangeCompleted
void setReverseChangeCompleted(const bool value)
Sets the reverse change completion flag to the given value.
Definition nc_trans.cc:334
isc::d2::NameChangeTransaction::getCurrentServer
const DnsServerInfoPtr & getCurrentServer() const
Fetches the currently selected server.
Definition nc_trans.cc:534
isc::d2::NameChangeTransaction::SERVER_SELECTED_EVT
static const int SERVER_SELECTED_EVT
Issued when a server has been selected.
Definition nc_trans.h:116
isc::d2::NameChangeTransaction::getReverseDomain
DdnsDomainPtr & getReverseDomain()
Fetches the reverse DdnsDomain.
Definition nc_trans.cc:451
isc::d2::NameChangeTransaction::transactionOutcomeString
std::string transactionOutcomeString() const
Returns a string version of transaction outcome.
Definition nc_trans.cc:171
isc::d2::SimpleRemoveTransactionError
Thrown if the SimpleRemoveTransaction encounters a general error.
Definition simple_remove.h:18
isc::d2::SimpleRemoveTransaction::removingRevPtrsHandler
void removingRevPtrsHandler()
State handler for REMOVING_REV_PTRS_ST.
Definition simple_remove.cc:323
isc::d2::SimpleRemoveTransaction::defineEvents
virtual void defineEvents()
Adds events defined by SimpleRemoveTransaction to the event set.
Definition simple_remove.cc:44
isc::d2::SimpleRemoveTransaction::processRemoveOkHandler
void processRemoveOkHandler()
State handler for PROCESS_TRANS_OK_ST.
Definition simple_remove.cc:446
isc::d2::SimpleRemoveTransaction::verifyEvents
virtual void verifyEvents()
Validates the contents of the set of events.
Definition simple_remove.cc:54
isc::d2::SimpleRemoveTransaction::selectingFwdServerHandler
void selectingFwdServerHandler()
State handler for SELECTING_FWD_SERVER_ST.
Definition simple_remove.cc:142
isc::d2::SimpleRemoveTransaction::buildRemoveRevPtrsRequest
void buildRemoveRevPtrsRequest()
Builds a DNS request to remove a reverse DNS entry for a FQDN.
Definition simple_remove.cc:510
isc::d2::SimpleRemoveTransaction::verifyStates
virtual void verifyStates()
Validates the contents of the set of states.
Definition simple_remove.cc:106
isc::d2::SimpleRemoveTransaction::processRemoveFailedHandler
void processRemoveFailedHandler()
State handler for PROCESS_TRANS_FAILED_ST.
Definition simple_remove.cc:463
isc::d2::SimpleRemoveTransaction::~SimpleRemoveTransaction
virtual ~SimpleRemoveTransaction()
Destructor.
Definition simple_remove.cc:40
isc::d2::SimpleRemoveTransaction::SimpleRemoveTransaction
SimpleRemoveTransaction(asiolink::IOServicePtr &io_service, dhcp_ddns::NameChangeRequestPtr &ncr, DdnsDomainPtr &forward_domain, DdnsDomainPtr &reverse_domain, D2CfgMgrPtr &cfg_mgr)
Event sent when replace attempt to fails with address not in use.
Definition simple_remove.cc:27
isc::d2::SimpleRemoveTransaction::buildRemoveFwdRRsRequest
void buildRemoveFwdRRsRequest()
Builds a DNS request to remove all forward DNS RRs for a FQDN.
Definition simple_remove.cc:482
isc::d2::SimpleRemoveTransaction::REMOVING_REV_PTRS_ST
static const int REMOVING_REV_PTRS_ST
State that attempts to remove reverse PTR records.
Definition simple_remove.h:57
isc::d2::SimpleRemoveTransaction::readyHandler
void readyHandler()
State handler for READY_ST.
Definition simple_remove.cc:122
isc::d2::SimpleRemoveTransaction::defineStates
virtual void defineStates()
Adds states defined by SimpleRemoveTransaction to the state set.
Definition simple_remove.cc:72
isc::d2::SimpleRemoveTransaction::REMOVING_FWD_RRS_ST
static const int REMOVING_FWD_RRS_ST
State that attempts to remove FQDN/IP and DHCID RRs for an FQDN.
Definition simple_remove.h:54
isc::d2::SimpleRemoveTransaction::selectingRevServerHandler
void selectingRevServerHandler()
State handler for SELECTING_REV_SERVER_ST.
Definition simple_remove.cc:294
isc::d2::SimpleRemoveTransaction::removingFwdRRsHandler
void removingFwdRRsHandler()
State handler for REMOVING_FWD_RRS_ST.
Definition simple_remove.cc:170
isc::dns::Name
The Name class encapsulates DNS names.
Definition name.h:219
isc::dns::RRClass::ANY
static const RRClass & ANY()
Definition rrclass.h:298
isc::dns::RRTTL
The RRTTL class encapsulates TTLs used in DNS resource records.
Definition rrttl.h:51
isc::dns::RRType::PTR
static const RRType & PTR()
Definition rrtype.h:303
isc::dns::RRType::DHCID
static const RRType & DHCID()
Definition rrtype.h:327
isc::dns::RRset
The RRset class is a concrete derived class of BasicRRset which contains a pointer to an additional R...
Definition rrset.h:844
isc::dns::Rcode
DNS Response Codes (RCODEs) class.
Definition rcode.h:40
isc::dns::Rcode::NOERROR
static const Rcode & NOERROR()
A constant object for the NOERROR Rcode (see Rcode::NOERROR_CODE).
Definition rcode.h:228
isc::dns::Rcode::NXRRSET
static const Rcode & NXRRSET()
A constant object for the NXRRSET Rcode (see Rcode::NXRRSET_CODE).
Definition rcode.h:276
isc::dns::Rcode::getCode
uint16_t getCode() const
Returns the Rcode code value.
Definition rcode.h:106
isc::util::StateModel::endModel
void endModel()
Conducts a normal transition to the end of the model.
Definition state_model.cc:271
isc::util::StateModel::defineState
void defineState(unsigned int value, const std::string &label, StateHandler handler, const StatePausing &state_pausing=STATE_PAUSE_NEVER)
Adds an state value and associated label to the set of states.
Definition state_model.cc:196
isc::util::StateModel::getNextEvent
unsigned int getNextEvent() const
Fetches the model's next event.
Definition state_model.cc:373
isc::util::StateModel::transition
void transition(unsigned int state, unsigned int event)
Sets up the model to transition into given state with a given event.
Definition state_model.cc:264
isc::util::StateModel::doOnEntry
bool doOnEntry()
Checks if on entry flag is true.
Definition state_model.cc:339
isc::util::StateModel::START_EVT
static const int START_EVT
Event issued to start the model execution.
Definition state_model.h:295
isc::util::StateModel::getStateInternal
const StatePtr getStateInternal(unsigned int value)
Fetches the state referred to by value.
Definition state_model.cc:219
isc::util::StateModel::getContextStr
std::string getContextStr() const
Convenience method which returns a string rendition of the current state and next event.
Definition state_model.cc:443
d2_cfg_mgr.h
d2_log.h
isc_throw
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
Definition exceptions/exceptions.h:210
LOG_ERROR
#define LOG_ERROR(LOGGER, MESSAGE)
Macro to conveniently test error output and log it.
Definition macros.h:32
LOG_INFO
#define LOG_INFO(LOGGER, MESSAGE)
Macro to conveniently test info output and log it.
Definition macros.h:20
isc::asiolink::IOServicePtr
boost::shared_ptr< IOService > IOServicePtr
Defines a smart pointer to an IOService instance.
Definition io_service.h:28
isc::d2
Definition check_exists_add.cc:19
isc::d2::D2UpdateMessagePtr
boost::shared_ptr< D2UpdateMessage > D2UpdateMessagePtr
Pointer to the DNS Update Message.
Definition d2_update_message.h:73
isc::d2::DdnsDomainPtr
boost::shared_ptr< DdnsDomain > DdnsDomainPtr
Defines a pointer for DdnsDomain instances.
Definition d2_config.h:624
isc::d2::DHCP_DDNS_FORWARD_REMOVE_RRS_TIMEOUT
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_TIMEOUT
Definition d2_messages.h:38
isc::d2::DHCP_DDNS_REVERSE_REMOVE_RESP_CORRUPT
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_RESP_CORRUPT
Definition d2_messages.h:74
isc::d2::D2CfgMgrPtr
boost::shared_ptr< D2CfgMgr > D2CfgMgrPtr
Defines a shared pointer to D2CfgMgr.
Definition d2_cfg_mgr.h:367
isc::d2::DHCP_DDNS_FORWARD_REMOVE_RRS_RESP_CORRUPT
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_RESP_CORRUPT
Definition d2_messages.h:37
isc::d2::DHCP_DDNS_FORWARD_REMOVE_RRS_REJECTED
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_REJECTED
Definition d2_messages.h:36
isc::d2::DHCP_DDNS_REMOVE_SUCCEEDED
const isc::log::MessageID DHCP_DDNS_REMOVE_SUCCEEDED
Definition d2_messages.h:68
isc::d2::d2_to_dns_logger
isc::log::Logger d2_to_dns_logger("d2-to-dns")
Definition d2_log.h:20
isc::d2::DHCP_DDNS_FORWARD_REMOVE_RRS_BUILD_FAILURE
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_BUILD_FAILURE
Definition d2_messages.h:34
isc::d2::DHCP_DDNS_REVERSE_REMOVE_TIMEOUT
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_TIMEOUT
Definition d2_messages.h:75
isc::d2::DHCP_DDNS_FORWARD_REMOVE_RRS_BAD_DNSCLIENT_STATUS
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_BAD_DNSCLIENT_STATUS
Definition d2_messages.h:33
isc::d2::DHCP_DDNS_REVERSE_REMOVE_IO_ERROR
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_IO_ERROR
Definition d2_messages.h:72
isc::d2::DHCP_DDNS_REVERSE_REMOVE_BAD_DNSCLIENT_STATUS
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_BAD_DNSCLIENT_STATUS
Definition d2_messages.h:70
isc::d2::DHCP_DDNS_REVERSE_REMOVE_BUILD_FAILURE
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_BUILD_FAILURE
Definition d2_messages.h:71
isc::d2::DHCP_DDNS_REMOVE_FAILED
const isc::log::MessageID DHCP_DDNS_REMOVE_FAILED
Definition d2_messages.h:67
isc::d2::DHCP_DDNS_FORWARD_REMOVE_RRS_IO_ERROR
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_IO_ERROR
Definition d2_messages.h:35
isc::d2::DHCP_DDNS_REVERSE_REMOVE_REJECTED
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_REJECTED
Definition d2_messages.h:73
isc::dhcp_ddns::ST_COMPLETED
@ ST_COMPLETED
Definition ncr_msg.h:54
isc::dhcp_ddns::ST_FAILED
@ ST_FAILED
Definition ncr_msg.h:55
isc::dhcp_ddns::NameChangeRequestPtr
boost::shared_ptr< NameChangeRequest > NameChangeRequestPtr
Defines a pointer to a NameChangeRequest.
Definition ncr_msg.h:241
isc::dhcp_ddns::CHG_REMOVE
@ CHG_REMOVE
Definition ncr_msg.h:47
isc::dns::RRsetPtr
boost::shared_ptr< AbstractRRset > RRsetPtr
A pointer-like type pointing to an RRset object.
Definition rrset.h:50
isc
Defines the logger used by the top-level component of kea-lfc.
Definition agent_parser.cc:148
simple_remove.h