Kea  2.1.7-git
nc_remove.cc
Go to the documentation of this file.
1 // Copyright (C) 2013-2022 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/nc_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 // NameRemoveTransaction states
23 
24 // NameRemoveTransaction events
25 // Currently NameRemoveTransaction does not define any events.
26 
30  DdnsDomainPtr& forward_domain,
31  DdnsDomainPtr& reverse_domain,
32  D2CfgMgrPtr& cfg_mgr)
33  : NameChangeTransaction(io_service, ncr, forward_domain, reverse_domain,
34  cfg_mgr) {
35  if (ncr->getChangeType() != isc::dhcp_ddns::CHG_REMOVE) {
37  "NameRemoveTransaction, request type must be CHG_REMOVE");
38  }
39 }
40 
42 }
43 
44 void
46  // Call superclass impl first.
48 
49  // Define NameRemoveTransaction events.
50  // Currently NameRemoveTransaction does not define any events.
51  // defineEvent(TBD_EVENT, "TBD_EVT");
52 }
53 
54 void
56  // Call superclass implementation first to verify its events. These are
57  // events common to all transactions, and they must be defined.
58  // SELECT_SERVER_EVT
59  // SERVER_SELECTED_EVT
60  // SERVER_IO_ERROR_EVT
61  // NO_MORE_SERVERS_EVT
62  // IO_COMPLETED_EVT
63  // UPDATE_OK_EVT
64  // UPDATE_FAILED_EVT
66 
67  // Verify NameRemoveTransaction events by attempting to fetch them.
68  // Currently NameRemoveTransaction does not define any events.
69  // getEvent(TBD_EVENT);
70 }
71 
72 void
74  // Call superclass impl first.
76 
77  // Define NameRemoveTransaction states.
78  defineState(READY_ST, "READY_ST",
79  std::bind(&NameRemoveTransaction::readyHandler, this));
80 
81  defineState(SELECTING_FWD_SERVER_ST, "SELECTING_FWD_SERVER_ST",
83  this));
84 
85  defineState(SELECTING_REV_SERVER_ST, "SELECTING_REV_SERVER_ST",
87  this));
88 
89  defineState(REMOVING_FWD_ADDRS_ST, "REMOVING_FWD_ADDRS_ST",
91  this));
92 
93  defineState(REMOVING_FWD_RRS_ST, "REMOVING_FWD_RRS_ST",
95  this));
96 
97  defineState(REMOVING_REV_PTRS_ST, "REMOVING_REV_PTRS_ST",
99  this));
100 
101  defineState(PROCESS_TRANS_OK_ST, "PROCESS_TRANS_OK_ST",
103  this));
104 
105  defineState(PROCESS_TRANS_FAILED_ST, "PROCESS_TRANS_FAILED_ST",
107  this));
108 }
109 
110 void
112  // Call superclass implementation first to verify its states. These are
113  // states common to all transactions, and they must be defined.
114  // READY_ST
115  // SELECTING_FWD_SERVER_ST
116  // SELECTING_REV_SERVER_ST
117  // PROCESS_TRANS_OK_ST
118  // PROCESS_TRANS_FAILED_ST
120 
121  // Verify NameRemoveTransaction states by attempting to fetch them.
125 }
126 
127 void
129  switch(getNextEvent()) {
130  case START_EVT:
131  if (getForwardDomain()) {
132  // Request includes a forward change, do that first.
134  } else {
135  // Reverse change only, transition accordingly.
137  }
138 
139  break;
140  default:
141  // Event is invalid.
143  "Wrong event for context: " << getContextStr());
144  }
145 }
146 
147 void
149  switch(getNextEvent()) {
150  case SELECT_SERVER_EVT:
151  // First time through for this transaction, so initialize server
152  // selection.
154  break;
155  case SERVER_IO_ERROR_EVT:
156  // We failed to communicate with current server. Attempt to select
157  // another one below.
158  break;
159  default:
160  // Event is invalid.
162  "Wrong event for context: " << getContextStr());
163  }
164 
165  // Select the next server from the list of forward servers.
166  if (selectNextServer()) {
167  // We have a server to try.
169  } else {
170  // Server list is exhausted, so fail the transaction.
172  }
173 }
174 
175 void
177  if (doOnEntry()) {
178  // Clear the update attempts count on initial transition.
180  }
181 
182  switch(getNextEvent()) {
183  case SERVER_SELECTED_EVT:
184  try {
187  } catch (const std::exception& ex) {
188  // While unlikely, the build might fail if we have invalid
189  // data. Should that be the case, we need to fail the
190  // transaction.
193  .arg(getRequestId())
194  .arg(getNcr()->toText())
195  .arg(ex.what());
197  break;
198  }
199 
200  // Call sendUpdate() to initiate the async send. Note it also sets
201  // next event to NOP_EVT.
202  sendUpdate("Forward A/AAAA Remove");
203  break;
204 
205  case IO_COMPLETED_EVT: {
206  switch (getDnsUpdateStatus()) {
207  case DNSClient::SUCCESS: {
208  // We successfully received a response packet from the server.
209  // The RCODE will be based on a value-dependent RRset search,
210  // see RFC 2136 section 3.2.3/3.2.4.
211  const dns::Rcode& rcode = getDnsUpdateResponse()->getRcode();
212  if ((rcode == dns::Rcode::NOERROR()) ||
213  (rcode == dns::Rcode::NXRRSET())) {
214  // We were able to remove it or it wasn't there, now we
215  // need to remove any other RRs for this FQDN.
217  } else {
218  // Per RFC4703 any other value means cease.
219  // If we get not authorized should we try the next server in
220  // the list? @todo This needs some discussion perhaps.
222  .arg(getRequestId())
223  .arg(getCurrentServer()->toText())
224  .arg(getNcr()->getFqdn())
225  .arg(rcode.getCode());
227  }
228 
229  break;
230  }
231 
232  case DNSClient::TIMEOUT:
233  case DNSClient::OTHER:
234  // We couldn't send to the current server, log it and set up
235  // to select the next server for a retry.
236  // @note For now we treat OTHER as an IO error like TIMEOUT. It
237  // is not entirely clear if this is accurate.
239  .arg(getRequestId())
240  .arg(getNcr()->getFqdn())
241  .arg(getCurrentServer()->toText());
242 
244  break;
245 
247  // A response was received but was corrupt. Retry it like an IO
248  // error.
250  .arg(getRequestId())
251  .arg(getCurrentServer()->toText())
252  .arg(getNcr()->getFqdn());
253 
255  break;
256 
257  default:
258  // Any other value and we will fail this transaction, something
259  // bigger is wrong.
262  .arg(getRequestId())
263  .arg(getDnsUpdateStatus())
264  .arg(getNcr()->getFqdn())
265  .arg(getCurrentServer()->toText());
266 
268  break;
269  } // end switch on dns_status
270 
271  break;
272  } // end case IO_COMPLETE_EVT
273 
274  default:
275  // Event is invalid.
277  "Wrong event for context: " << getContextStr());
278  }
279 }
280 
281 
282 void
284  if (doOnEntry()) {
285  // Clear the update attempts count on initial transition.
287  }
288 
289  switch(getNextEvent()) {
290  case UPDATE_OK_EVT:
291  case SERVER_SELECTED_EVT:
292  try {
295  } catch (const std::exception& ex) {
296  // While unlikely, the build might fail if we have invalid
297  // data. Should that be the case, we need to fail the
298  // transaction.
301  .arg(getRequestId())
302  .arg(getNcr()->toText())
303  .arg(ex.what());
305  break;
306  }
307 
308  // Call sendUpdate() to initiate the async send. Note it also sets
309  // next event to NOP_EVT.
310  sendUpdate("Forward RR Remove");
311  break;
312 
313  case IO_COMPLETED_EVT: {
314  switch (getDnsUpdateStatus()) {
315  case DNSClient::SUCCESS: {
316  // We successfully received a response packet from the server.
317  // The RCODE will be based on a value-dependent RRset search,
318  // see RFC 2136 section 3.2.3/3.2.4.
319  const dns::Rcode& rcode = getDnsUpdateResponse()->getRcode();
320  if ((rcode == dns::Rcode::NOERROR()) ||
321  (rcode == dns::Rcode::NXRRSET())) {
322  // We were able to remove them or they were not there (
323  // Rcode of NXRRSET means there are no matching RRsets).
324  // In either case, we consider it success and mark it as done.
326 
327  // If request calls for reverse update then do that next,
328  // otherwise we can process ok.
329  if (getReverseDomain()) {
331  } else {
333  }
334  } else {
335  // Per RFC4703 any other value means cease.
336  // If we get not authorized should try the next server in
337  // the list? @todo This needs some discussion perhaps.
339  .arg(getRequestId())
340  .arg(getCurrentServer()->toText())
341  .arg(getNcr()->getFqdn())
342  .arg(rcode.getCode());
344  }
345 
346  break;
347  }
348 
349  case DNSClient::TIMEOUT:
350  case DNSClient::OTHER:
351  // We couldn't send to the current server, log it and set up
352  // to select the next server for a retry.
353  // @note For now we treat OTHER as an IO error like TIMEOUT. It
354  // is not entirely clear if this is accurate.
356  .arg(getRequestId())
357  .arg(getNcr()->getFqdn())
358  .arg(getCurrentServer()->toText());
359 
360  // @note If we exhaust the IO retries for the current server
361  // due to IO failures, we will abort the remaining updates.
362  // The rational is that we are only in this state, if the remove
363  // of the forward address RR succeeded (removingFwdAddrsHandler)
364  // on the current server. Therefore we should not attempt another
365  // removal on a different server. This is perhaps a point
366  // for discussion.
367  // @todo Should we go ahead with the reverse remove?
369  break;
370 
372  // A response was received but was corrupt. Retry it like an IO
373  // error.
375  .arg(getRequestId())
376  .arg(getCurrentServer()->toText())
377  .arg(getNcr()->getFqdn());
378 
379  // If we are out of retries on this server abandon the transaction.
380  // (Same logic as the case for TIMEOUT above).
382  break;
383 
384  default:
385  // Any other value and we will fail this transaction, something
386  // bigger is wrong.
389  .arg(getRequestId())
390  .arg(getDnsUpdateStatus())
391  .arg(getNcr()->getFqdn())
392  .arg(getCurrentServer()->toText());
393 
395  break;
396  } // end switch on dns_status
397 
398  break;
399  } // end case IO_COMPLETE_EVT
400 
401  default:
402  // Event is invalid.
404  "Wrong event for context: " << getContextStr());
405  }
406 }
407 
408 
409 void
411  switch(getNextEvent()) {
412  case SELECT_SERVER_EVT:
413  // First time through for this transaction, so initialize server
414  // selection.
416  break;
417  case SERVER_IO_ERROR_EVT:
418  // We failed to communicate with current server. Attempt to select
419  // another one below.
420  break;
421  default:
422  // Event is invalid.
424  "Wrong event for context: " << getContextStr());
425  }
426 
427  // Select the next server from the list of forward servers.
428  if (selectNextServer()) {
429  // We have a server to try.
431  } else {
432  // Server list is exhausted, so fail the transaction.
434  }
435 }
436 
437 
438 void
440  if (doOnEntry()) {
441  // Clear the update attempts count on initial transition.
443  }
444 
445  switch(getNextEvent()) {
446  case SERVER_SELECTED_EVT:
447  try {
450  } catch (const std::exception& ex) {
451  // While unlikely, the build might fail if we have invalid
452  // data. Should that be the case, we need to fail the
453  // transaction.
455  .arg(getRequestId())
456  .arg(getNcr()->toText())
457  .arg(ex.what());
459  break;
460  }
461 
462  // Call sendUpdate() to initiate the async send. Note it also sets
463  // next event to NOP_EVT.
464  sendUpdate("Reverse Remove");
465  break;
466 
467  case IO_COMPLETED_EVT: {
468  switch (getDnsUpdateStatus()) {
469  case DNSClient::SUCCESS: {
470  // We successfully received a response packet from the server.
471  // The RCODE will be based on a value-dependent RRset search,
472  // see RFC 2136 section 3.2.3/3.2.4.
473  const dns::Rcode& rcode = getDnsUpdateResponse()->getRcode();
474  if ((rcode == dns::Rcode::NOERROR()) ||
475  (rcode == dns::Rcode::NXRRSET())) {
476  // We were able to remove the reverse mapping or they were
477  // not there (Rcode of NXRRSET means there are no matching
478  // RRsets). In either case, mark it as done.
481  } else {
482  // Per RFC4703 any other value means cease.
483  // If we get not authorized should try the next server in
484  // the list? @todo This needs some discussion perhaps.
486  .arg(getRequestId())
487  .arg(getCurrentServer()->toText())
488  .arg(getNcr()->getFqdn())
489  .arg(rcode.getCode());
491  }
492 
493  break;
494  }
495 
496  case DNSClient::TIMEOUT:
497  case DNSClient::OTHER:
498  // We couldn't send to the current server, log it and set up
499  // to select the next server for a retry.
500  // @note For now we treat OTHER as an IO error like TIMEOUT. It
501  // is not entirely clear if this is accurate.
503  .arg(getRequestId())
504  .arg(getNcr()->getFqdn())
505  .arg(getCurrentServer()->toText());
506 
507  // If we are out of retries on this server, we go back and start
508  // all over on a new server.
510  break;
511 
513  // A response was received but was corrupt. Retry it like an IO
514  // error.
516  .arg(getRequestId())
517  .arg(getCurrentServer()->toText())
518  .arg(getNcr()->getFqdn());
519 
520  // If we are out of retries on this server, we go back and start
521  // all over on a new server.
523  break;
524 
525  default:
526  // Any other value and we will fail this transaction, something
527  // bigger is wrong.
530  .arg(getRequestId())
531  .arg(getDnsUpdateStatus())
532  .arg(getNcr()->getFqdn())
533  .arg(getCurrentServer()->toText());
534 
536  break;
537  } // end switch on dns_status
538 
539  break;
540  } // end case IO_COMPLETE_EVT
541 
542  default:
543  // Event is invalid.
545  "Wrong event for context: " << getContextStr());
546  }
547 }
548 
549 
550 void
552  switch(getNextEvent()) {
553  case UPDATE_OK_EVT:
555  .arg(getRequestId())
556  .arg(getNcr()->toText());
558  endModel();
559  break;
560  default:
561  // Event is invalid.
563  "Wrong event for context: " << getContextStr());
564  }
565 }
566 
567 void
569  switch(getNextEvent()) {
570  case UPDATE_FAILED_EVT:
571  case NO_MORE_SERVERS_EVT:
572  case SERVER_IO_ERROR_EVT:
575  .arg(getRequestId())
576  .arg(transactionOutcomeString());
577  endModel();
578  break;
579  default:
580  // Event is invalid.
582  "Wrong event for context: " << getContextStr());
583  }
584 }
585 
586 void
588  // Construct an empty request.
590 
591  // Content on this request is based on RFC 4703, section 5.5, paragraph 4.
592  // Construct dns::Name from NCR fqdn.
593  dns::Name fqdn(dns::Name(getNcr()->getFqdn()));
594  // First build the Prerequisite Section
595 
596  // Create an DHCID matches prerequisite RR and add it to the
597  // pre-requisite section
598  // Based on RFC 2136, section 2.4.2.
599  dns::RRsetPtr prereq(new dns::RRset(fqdn, dns::RRClass::IN(),
601  addDhcidRdata(prereq);
602  request->addRRset(D2UpdateMessage::SECTION_PREREQUISITE, prereq);
603 
604  // Next build the Update Section
605 
606  // Create the FQDN/IP 'delete' RR and add it to the update section.
607  // Add the RR to update section.
608  // Based on 2136 section 2.5.4
609  dns::RRsetPtr update(new dns::RRset(fqdn, dns::RRClass::NONE(),
611  addLeaseAddressRdata(update);
612  request->addRRset(D2UpdateMessage::SECTION_UPDATE, update);
613 
614  // Set the transaction's update request to the new request.
615  setDnsUpdateRequest(request);
616 }
617 
618 void
620  // Construct an empty request.
622 
623  // Construct dns::Name from NCR fqdn.
624  dns::Name fqdn(dns::Name(getNcr()->getFqdn()));
625 
626  // Content on this request is based on RFC 4703, section 5.5, paragraph 5.
627  // First build the Prerequisite Section.
628 
629  // Now create an DHCID matches prerequisite RR.
630  // Set the RR's RData to DHCID.
631  // Add it to the pre-requisite section.
632  // Based on RFC 2136, section 2.4.2.
633  dns::RRsetPtr prereq(new dns::RRset(fqdn, dns::RRClass::IN(),
635  addDhcidRdata(prereq);
636  request->addRRset(D2UpdateMessage::SECTION_PREREQUISITE, prereq);
637 
638  // Create an assertion that there are no A RRs for the FQDN.
639  // Add it to the pre-reqs.
640  // Based on RFC 2136, section 2.4.3.
641  prereq.reset(new dns::RRset(fqdn, dns::RRClass::NONE(),
642  dns::RRType::A(), dns::RRTTL(0)));
643  request->addRRset(D2UpdateMessage::SECTION_PREREQUISITE, prereq);
644 
645  // Create an assertion that there are no A RRs for the FQDN.
646  // Add it to the pre-reqs.
647  // Based on RFC 2136, section 2.4.3.
648  prereq.reset(new dns::RRset(fqdn, dns::RRClass::NONE(),
650  request->addRRset(D2UpdateMessage::SECTION_PREREQUISITE, prereq);
651 
652  // Next build the Update Section.
653 
654  // Create the 'delete' of all RRs for FQDN.
655  // Set the message RData to lease address.
656  // Add the RR to update section.
657  // Based on RFC 2136, section 2.5.3.
658  dns::RRsetPtr update(new dns::RRset(fqdn, dns::RRClass::ANY(),
660  request->addRRset(D2UpdateMessage::SECTION_UPDATE, update);
661 
662  // Set the transaction's update request to the new request.
663  setDnsUpdateRequest(request);
664 }
665 
666 void
668  // Construct an empty request.
670 
671  // Create the reverse IP address "FQDN".
672  std::string rev_addr = D2CfgMgr::reverseIpAddress(getNcr()->getIpAddress());
673  dns::Name rev_ip(rev_addr);
674 
675  // Content on this request is based on RFC 4703, section 5.5, paragraph 2.
676  // First build the Prerequisite Section.
677  // (Note that per RFC 4703, section 5.4, there is no need to validate
678  // DHCID RR for PTR entries.)
679 
680  // Create an assertion that the PTRDNAME in the PTR record matches the
681  // client's FQDN for the address that was released.
682  // Based on RFC 2136, section 3.2.3
683  dns::RRsetPtr prereq(new dns::RRset(rev_ip, dns::RRClass::IN(),
685  addPtrRdata(prereq);
686  request->addRRset(D2UpdateMessage::SECTION_PREREQUISITE, prereq);
687 
688  // Now, build the Update section.
689 
690  // Create a delete of any RRs for the FQDN and add it to update section.
691  // Based on RFC 2136, section 3.4.2.3
692  dns::RRsetPtr update(new dns::RRset(rev_ip, dns::RRClass::ANY(),
694  request->addRRset(D2UpdateMessage::SECTION_UPDATE, update);
695 
696  // Set the transaction's update request to the new request.
697  setDnsUpdateRequest(request);
698 }
699 
700 } // namespace isc::d2
701 } // namespace isc
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
virtual D2UpdateMessagePtr prepNewRequest(DdnsDomainPtr domain)
Creates a new DNS update request based on the given domain.
Definition: nc_trans.cc:343
The Name class encapsulates DNS names.
Definition: name.h:223
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_IO_ERROR
Definition: d2_messages.h:35
virtual void sendUpdate(const std::string &comment="")
Send the update request to the current server.
Definition: nc_trans.cc:192
void processRemoveFailedHandler()
State handler for PROCESS_TRANS_FAILED_ST.
Definition: nc_remove.cc:568
static const RRType & DHCID()
Definition: rrtype.h:503
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_REJECTED
Definition: d2_messages.h:36
void buildRemoveFwdAddressRequest()
Builds a DNS request to remove a forward DNS address for a FQDN.
Definition: nc_remove.cc:587
static const int PROCESS_TRANS_OK_ST
State which processes successful transaction conclusion.
Definition: nc_trans.h:102
NameRemoveTransaction(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: nc_remove.cc:28
virtual void verifyEvents()
Validates the contents of the set of events.
Definition: nc_remove.cc:55
std::string getContextStr() const
Convenience method which returns a string rendition of the current state and next event...
Definition: state_model.cc:443
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_ADDRS_BUILD_FAILURE
Definition: d2_messages.h:29
static const RRType & PTR()
Definition: rrtype.h:443
#define LOG_INFO(LOGGER, MESSAGE)
Macro to conveniently test info output and log it.
Definition: macros.h:20
static std::string reverseIpAddress(const std::string &address)
Generate a reverse order string for the given IP address.
Definition: d2_cfg_mgr.cc:170
boost::shared_ptr< DdnsDomain > DdnsDomainPtr
Defines a pointer for DdnsDomain instances.
Definition: d2_config.h:612
static const Rcode & NOERROR()
A constant object for the NOERROR Rcode (see Rcode::NOERROR_CODE).
Definition: rcode.h:220
const dhcp_ddns::NameChangeRequestPtr & getNcr() const
Fetches the NameChangeRequest for this transaction.
Definition: nc_trans.cc:425
boost::shared_ptr< D2UpdateMessage > D2UpdateMessagePtr
Pointer to the DNS Update Message.
void selectingRevServerHandler()
State handler for SELECTING_REV_SERVER_ST.
Definition: nc_remove.cc:410
void setNcrStatus(const dhcp_ddns::NameChangeStatus &status)
Sets the status of the transaction&#39;s NameChangeRequest.
Definition: nc_trans.cc:538
static const RRClass & IN()
Definition: rrclass.h:319
static const int START_EVT
Event issued to start the model execution.
Definition: state_model.h:295
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_IO_ERROR
Definition: d2_messages.h:70
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_ADDRS_BAD_DNSCLIENT_STATUS
Definition: d2_messages.h:28
#define LOG_ERROR(LOGGER, MESSAGE)
Macro to conveniently test error output and log it.
Definition: macros.h:32
No response, timeout.
Definition: dns_client.h:60
static const int SELECTING_FWD_SERVER_ST
State in which forward DNS server selection is done.
Definition: nc_trans.h:91
DNS Response Codes (RCODEs) class.
Definition: rcode.h:40
boost::shared_ptr< NameChangeRequest > NameChangeRequestPtr
Defines a pointer to a NameChangeRequest.
Definition: ncr_msg.h:212
void endModel()
Conducts a normal transition to the end of the model.
Definition: state_model.cc:271
static const int SERVER_IO_ERROR_EVT
Issued when an update fails due to an IO error.
Definition: nc_trans.h:119
static const int IO_COMPLETED_EVT
Issued when a DNS update packet exchange has completed.
Definition: nc_trans.h:130
const DnsServerInfoPtr & getCurrentServer() const
Fetches the currently selected server.
Definition: nc_trans.cc:533
Other, unclassified error.
Definition: dns_client.h:63
#define isc_throw(type, stream)
A shortcut macro to insert known values into exception arguments.
void setForwardChangeCompleted(const bool value)
Sets the forward change completion flag to the given value.
Definition: nc_trans.cc:328
virtual ~NameRemoveTransaction()
Destructor.
Definition: nc_remove.cc:41
void addDhcidRdata(dns::RRsetPtr &rrset)
Adds an RData for the lease client&#39;s DHCID to the given RRset.
Definition: nc_trans.cc:388
isc::log::Logger d2_to_dns_logger("d2-to-dns")
Definition: d2_log.h:20
static const int REMOVING_FWD_ADDRS_ST
State that attempts to remove specific forward address record.
Definition: nc_remove.h:56
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_BUILD_FAILURE
Definition: d2_messages.h:34
static const int SERVER_SELECTED_EVT
Issued when a server has been selected.
Definition: nc_trans.h:116
void retryTransition(const int fail_to_state)
Determines the state and next event based on update attempts.
Definition: nc_trans.cc:286
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_RESP_CORRUPT
Definition: d2_messages.h:37
static const RRType & A()
Definition: rrtype.h:341
bool doOnEntry()
Checks if on entry flag is true.
Definition: state_model.cc:339
static const int REMOVING_FWD_RRS_ST
State that attempts to remove any other forward RRs for the DHCID.
Definition: nc_remove.h:59
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_RRS_BAD_DNSCLIENT_STATUS
Definition: d2_messages.h:33
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_BUILD_FAILURE
Definition: d2_messages.h:69
boost::shared_ptr< D2CfgMgr > D2CfgMgrPtr
Defines a shared pointer to D2CfgMgr.
Definition: d2_cfg_mgr.h:334
const dns::RRType & getAddressRRType() const
Returns the DHCP data type for the lease address.
Definition: nc_trans.cc:573
virtual void defineStates()
Adds states defined by NameChangeTransaction to the state set.
Definition: nc_trans.cc:257
This file defines the class NameRemoveTransaction.
The RRTTL class encapsulates TTLs used in DNS resource records.
Definition: rrttl.h:55
unsigned int getNextEvent() const
Fetches the model&#39;s next event.
Definition: state_model.cc:373
void setReverseChangeCompleted(const bool value)
Sets the reverse change completion flag to the given value.
Definition: nc_trans.cc:333
Thrown if the NameRemoveTransaction encounters a general error.
Definition: nc_remove.h:18
void selectingFwdServerHandler()
State handler for SELECTING_FWD_SERVER_ST.
Definition: nc_remove.cc:148
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_BAD_DNSCLIENT_STATUS
Definition: d2_messages.h:68
virtual void defineEvents()
Adds events defined by NameRemoveTransaction to the event set.
Definition: nc_remove.cc:45
Response received and is ok.
Definition: dns_client.h:59
static const RRClass & ANY()
Definition: rrclass.h:301
static const int SELECTING_REV_SERVER_ST
State in which reverse DNS server selection is done.
Definition: nc_trans.h:99
DdnsDomainPtr & getForwardDomain()
Fetches the forward DdnsDomain.
Definition: nc_trans.cc:445
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_RESP_CORRUPT
Definition: d2_messages.h:72
void clearUpdateAttempts()
Resets the update attempts count.
Definition: nc_trans.cc:308
Defines the logger used by the top-level component of kea-lfc.
void addPtrRdata(dns::RRsetPtr &rrset)
Adds an RData for the lease FQDN to the given RRset.
Definition: nc_trans.cc:408
virtual void verifyStates()
Validates the contents of the set of states.
Definition: nc_remove.cc:111
static const int NO_MORE_SERVERS_EVT
Issued when there are no more servers from which to select.
Definition: nc_trans.h:125
void processRemoveOkHandler()
State handler for PROCESS_TRANS_OK_ST.
Definition: nc_remove.cc:551
std::string getRequestId() const
Fetches the request id that identifies this transaction.
Definition: nc_trans.cc:435
void buildRemoveFwdRRsRequest()
Builds a DNS request to remove all forward DNS RRs for a FQDN.
Definition: nc_remove.cc:619
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
DNSClient::Status getDnsUpdateStatus() const
Fetches the most recent DNS update status.
Definition: nc_trans.cc:548
The RRset class is a concrete derived class of BasicRRset which contains a pointer to an additional R...
Definition: rrset.h:847
Response received but invalid.
Definition: dns_client.h:62
const isc::log::MessageID DHCP_DDNS_REMOVE_SUCCEEDED
Definition: d2_messages.h:66
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_ADDRS_RESP_CORRUPT
Definition: d2_messages.h:32
void buildRemoveRevPtrsRequest()
Builds a DNS request to remove a reverse DNS entry for a FQDN.
Definition: nc_remove.cc:667
static const int PROCESS_TRANS_FAILED_ST
State which processes an unsuccessful transaction conclusion.
Definition: nc_trans.h:105
std::string transactionOutcomeString() const
Returns a string version of transaction outcome.
Definition: nc_trans.cc:170
const isc::log::MessageID DHCP_DDNS_REMOVE_FAILED
Definition: d2_messages.h:65
static const int SELECT_SERVER_EVT
Issued when a server needs to be selected.
Definition: nc_trans.h:113
void clearDnsUpdateRequest()
Destroys the current update request packet.
Definition: nc_trans.cc:303
static const int READY_ST
State from which a transaction is started.
Definition: nc_trans.h:83
void setDnsUpdateRequest(D2UpdateMessagePtr &request)
Sets the update request packet to the given packet.
Definition: nc_trans.cc:298
static const RRClass & NONE()
Definition: rrclass.h:325
void removingFwdRRsHandler()
State handler for REMOVING_FWD_RRS_ST.
Definition: nc_remove.cc:283
const isc::log::MessageID DHCP_DDNS_REVERSE_REMOVE_REJECTED
Definition: d2_messages.h:71
virtual void defineEvents()
Adds events defined by NameChangeTransaction to the event set.
Definition: nc_trans.cc:227
Embodies the "life-cycle" required to carry out a DDNS update.
Definition: nc_trans.h:77
const StatePtr getStateInternal(unsigned int value)
Fetches the state referred to by value.
Definition: state_model.cc:219
static const int UPDATE_OK_EVT
Issued when the attempted update successfully completed.
Definition: nc_trans.h:135
boost::shared_ptr< AbstractRRset > RRsetPtr
A pointer-like type pointing to an RRset object.
Definition: rrset.h:47
DdnsDomainPtr & getReverseDomain()
Fetches the reverse DdnsDomain.
Definition: nc_trans.cc:450
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_ADDRS_REJECTED
Definition: d2_messages.h:31
static const RRType & ANY()
Definition: rrtype.h:527
static const int UPDATE_FAILED_EVT
Issued when the attempted update fails to complete.
Definition: nc_trans.h:141
virtual void verifyEvents()
Validates the contents of the set of events.
Definition: nc_trans.cc:242
void addLeaseAddressRdata(dns::RRsetPtr &rrset)
Adds an RData for the lease address to the given RRset.
Definition: nc_trans.cc:366
static const RRType & AAAA()
Definition: rrtype.h:497
static const Rcode & NXRRSET()
A constant object for the NXRRSET Rcode (see Rcode::NXRRSET_CODE).
Definition: rcode.h:268
void removingFwdAddrsHandler()
State handler for REMOVING_FWD_ADDRS_ST.
Definition: nc_remove.cc:176
const D2UpdateMessagePtr & getDnsUpdateResponse() const
Fetches the most recent DNS update response packet.
Definition: nc_trans.cc:553
void initServerSelection(const DdnsDomainPtr &domain)
Initializes server selection from the given DDNS domain.
Definition: nc_trans.cc:455
uint16_t getCode() const
Returns the Rcode code value.
Definition: rcode.h:106
void readyHandler()
State handler for READY_ST.
Definition: nc_remove.cc:128
bool selectNextServer()
Selects the next server in the current server list.
Definition: nc_trans.cc:467
virtual void defineStates()
Adds states defined by NameRemoveTransaction to the state set.
Definition: nc_remove.cc:73
static const int REMOVING_REV_PTRS_ST
State that attempts to remove reverse PTR records.
Definition: nc_remove.h:62
virtual void verifyStates()
Validates the contents of the set of states.
Definition: nc_trans.cc:265
const isc::log::MessageID DHCP_DDNS_FORWARD_REMOVE_ADDRS_IO_ERROR
Definition: d2_messages.h:30
void removingRevPtrsHandler()
State handler for REMOVING_REV_PTRS_ST.
Definition: nc_remove.cc:439