| Kea 3.0.2-git

nc_add.h
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#ifndef NC_ADD_H
8#define NC_ADD_H
9
11
12#include <d2srv/nc_trans.h>
13#include <dns/rdata.h>
14
15 namespace isc {
16 namespace d2 {
17
19 class NameAddTransactionError : public isc::Exception {
20 public:
21 NameAddTransactionError(const char* file, size_t line,
22 const char* what) :
23 isc::Exception(file, line, what) { }
24};
25
52 class NameAddTransaction : public NameChangeTransaction {
53 public:
54
56
57 static const int ADDING_FWD_ADDRS_ST = NCT_DERIVED_STATE_MIN + 1;
58
60 static const int REPLACING_FWD_ADDRS_ST = NCT_DERIVED_STATE_MIN + 2;
61
63 static const int REPLACING_REV_PTRS_ST = NCT_DERIVED_STATE_MIN + 3;
65
67
68 static const int FQDN_IN_USE_EVT = NCT_DERIVED_EVENT_MIN + 1;
69
71 static const int FQDN_NOT_IN_USE_EVT = NCT_DERIVED_EVENT_MIN + 2;
73
86 NameAddTransaction(asiolink::IOServicePtr& io_service,
87 dhcp_ddns::NameChangeRequestPtr& ncr,
88 DdnsDomainPtr& forward_domain,
89 DdnsDomainPtr& reverse_domain,
90 D2CfgMgrPtr& cfg_mgr);
91
93 virtual ~NameAddTransaction();
94
95 protected:
102 virtual void defineEvents();
103
111 virtual void verifyEvents();
112
119 virtual void defineStates();
120
128 virtual void verifyStates();
129
150 void readyHandler();
151
174 void selectingFwdServerHandler();
175
199 void selectingRevServerHandler();
200
249 void addingFwdAddrsHandler();
250
301 void replacingFwdAddrsHandler();
302
343 void replacingRevPtrsHandler();
344
360 void processAddOkHandler();
361
379 void processAddFailedHandler();
380
397 void buildAddFwdAddressRequest();
398
417 void buildReplaceFwdAddressRequest();
418
437 void buildReplaceRevPtrsRequest();
438};
439
441 typedef boost::shared_ptr<NameAddTransaction> NameAddTransactionPtr;
442
443} // namespace isc::d2
444} // namespace isc
445#endif
isc::Exception
This is a base class for exceptions thrown from the DNS library module.
Definition exceptions/exceptions.h:23
isc::Exception::Exception
Exception(const char *file, size_t line, const char *what)
Constructor for a given type for exceptions with file name and file line number.
Definition exceptions/exceptions.cc:17
isc::Exception::what
virtual const char * what() const
Returns a C-style character string of the cause of the exception.
Definition exceptions/exceptions.cc:32
isc::d2::NameAddTransactionError::NameAddTransactionError
NameAddTransactionError(const char *file, size_t line, const char *what)
Definition nc_add.h:21
isc::d2::NameAddTransaction::processAddFailedHandler
void processAddFailedHandler()
State handler for PROCESS_TRANS_FAILED_ST.
Definition nc_add.cc:581
isc::d2::NameAddTransaction::defineEvents
virtual void defineEvents()
Adds events defined by NameAddTransaction to the event set.
Definition nc_add.cc:48
isc::d2::NameAddTransaction::ADDING_FWD_ADDRS_ST
static const int ADDING_FWD_ADDRS_ST
State that attempts to add forward address records.
Definition nc_add.h:57
isc::d2::NameAddTransaction::~NameAddTransaction
virtual ~NameAddTransaction()
Destructor.
Definition nc_add.cc:44
isc::d2::NameAddTransaction::buildReplaceFwdAddressRequest
void buildReplaceFwdAddressRequest()
Builds a DNS request to replace forward DNS entry for an FQDN.
Definition nc_add.cc:641
isc::d2::NameAddTransaction::verifyStates
virtual void verifyStates()
Validates the contents of the set of states.
Definition nc_add.cc:107
isc::d2::NameAddTransaction::FQDN_NOT_IN_USE_EVT
static const int FQDN_NOT_IN_USE_EVT
Event sent when replace attempt to fails with address not in use.
Definition nc_add.h:71
isc::d2::NameAddTransaction::replacingFwdAddrsHandler
void replacingFwdAddrsHandler()
State handler for REPLACING_FWD_ADDRS_ST.
Definition nc_add.cc:294
isc::d2::NameAddTransaction::processAddOkHandler
void processAddOkHandler()
State handler for PROCESS_TRANS_OK_ST.
Definition nc_add.cc:564
isc::d2::NameAddTransaction::REPLACING_FWD_ADDRS_ST
static const int REPLACING_FWD_ADDRS_ST
State that attempts to replace forward address records.
Definition nc_add.h:60
isc::d2::NameAddTransaction::verifyEvents
virtual void verifyEvents()
Validates the contents of the set of events.
Definition nc_add.cc:58
isc::d2::NameAddTransaction::addingFwdAddrsHandler
void addingFwdAddrsHandler()
State handler for ADD_FWD_ADDRS_ST.
Definition nc_add.cc:172
isc::d2::NameAddTransaction::selectingRevServerHandler
void selectingRevServerHandler()
State handler for SELECTING_REV_SERVER_ST.
Definition nc_add.cc:421
isc::d2::NameAddTransaction::replacingRevPtrsHandler
void replacingRevPtrsHandler()
State handler for REPLACING_REV_PTRS_ST.
Definition nc_add.cc:450
isc::d2::NameAddTransaction::readyHandler
void readyHandler()
State handler for READY_ST.
Definition nc_add.cc:124
isc::d2::NameAddTransaction::NameAddTransaction
NameAddTransaction(asiolink::IOServicePtr &io_service, dhcp_ddns::NameChangeRequestPtr &ncr, DdnsDomainPtr &forward_domain, DdnsDomainPtr &reverse_domain, D2CfgMgrPtr &cfg_mgr)
Constructor.
Definition nc_add.cc:31
isc::d2::NameAddTransaction::FQDN_IN_USE_EVT
static const int FQDN_IN_USE_EVT
Event sent when an add attempt fails with address in use.
Definition nc_add.h:68
isc::d2::NameAddTransaction::defineStates
virtual void defineStates()
Adds states defined by NameAddTransaction to the state set.
Definition nc_add.cc:76
isc::d2::NameAddTransaction::selectingFwdServerHandler
void selectingFwdServerHandler()
State handler for SELECTING_FWD_SERVER_ST.
Definition nc_add.cc:144
isc::d2::NameAddTransaction::buildReplaceRevPtrsRequest
void buildReplaceRevPtrsRequest()
Builds a DNS request to replace a reverse DNS entry for an FQDN.
Definition nc_add.cc:689
isc::d2::NameAddTransaction::buildAddFwdAddressRequest
void buildAddFwdAddressRequest()
Builds a DNS request to add an forward DNS entry for an FQDN.
Definition nc_add.cc:599
isc::d2::NameAddTransaction::REPLACING_REV_PTRS_ST
static const int REPLACING_REV_PTRS_ST
State that attempts to replace reverse PTR records.
Definition nc_add.h:63
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::NCT_DERIVED_STATE_MIN
static const int NCT_DERIVED_STATE_MIN
Value at which custom states in a derived class should begin.
Definition nc_trans.h:108
isc::d2::NameChangeTransaction::NCT_DERIVED_EVENT_MIN
static const int NCT_DERIVED_EVENT_MIN
Value at which custom events in a derived class should begin.
Definition nc_trans.h:144
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::DdnsDomainPtr
boost::shared_ptr< DdnsDomain > DdnsDomainPtr
Defines a pointer for DdnsDomain instances.
Definition d2_config.h:624
isc::d2::D2CfgMgrPtr
boost::shared_ptr< D2CfgMgr > D2CfgMgrPtr
Defines a shared pointer to D2CfgMgr.
Definition d2_cfg_mgr.h:367
isc::d2::NameAddTransactionPtr
boost::shared_ptr< NameAddTransaction > NameAddTransactionPtr
Defines a pointer to a NameAddTransaction.
Definition nc_add.h:441
isc::dhcp_ddns::NameChangeRequestPtr
boost::shared_ptr< NameChangeRequest > NameChangeRequestPtr
Defines a pointer to a NameChangeRequest.
Definition ncr_msg.h:241
isc::util::file
Definition filesystem.cc:28
isc
Defines the logger used by the top-level component of kea-lfc.
Definition agent_parser.cc:148
nc_trans.h
This file defines the class NameChangeTransaction.
rdata.h