Embodies the "life-cycle" required to carry out a DDNS Add update. More...

#include <nc_add.h>

Inheritance diagram for isc::d2::NameAddTransaction:

Public Member Functions
	NameAddTransaction (asiolink::IOServicePtr &io_service, dhcp_ddns::NameChangeRequestPtr &ncr, DdnsDomainPtr &forward_domain, DdnsDomainPtr &reverse_domain, D2CfgMgrPtr &cfg_mgr)
	Constructor.

virtual	~NameAddTransaction ()
	Destructor.

Public Member Functions inherited from isc::d2::NameChangeTransaction
	NameChangeTransaction (asiolink::IOServicePtr &io_service, dhcp_ddns::NameChangeRequestPtr &ncr, DdnsDomainPtr &forward_domain, DdnsDomainPtr &reverse_domain, D2CfgMgrPtr &cfg_mgr)
	Constructor.

virtual	~NameChangeTransaction ()
	Destructor.

const dns::RRType &	getAddressRRType () const
	Returns the DHCP data type for the lease address.

const DnsServerInfoPtr &	getCurrentServer () const
	Fetches the currently selected server.

const DNSClientPtr &	getDNSClient () const
	Fetches the DNSClient instance.

const D2UpdateMessagePtr &	getDnsUpdateRequest () const
	Fetches the current DNS update request packet.

const D2UpdateMessagePtr &	getDnsUpdateResponse () const
	Fetches the most recent DNS update response packet.

DNSClient::Status	getDnsUpdateStatus () const
	Fetches the most recent DNS update status.

bool	getForwardChangeCompleted () const
	Returns whether the forward change has completed or not.

DdnsDomainPtr &	getForwardDomain ()
	Fetches the forward DdnsDomain.

const dhcp_ddns::NameChangeRequestPtr &	getNcr () const
	Fetches the NameChangeRequest for this transaction.

dhcp_ddns::NameChangeStatus	getNcrStatus () const
	Fetches the NameChangeRequest status of the transaction.

std::string	getRequestId () const
	Fetches the request id that identifies this transaction.

bool	getReverseChangeCompleted () const
	Returns whether the reverse change has completed or not.

DdnsDomainPtr &	getReverseDomain ()
	Fetches the reverse DdnsDomain.

const TransactionKey &	getTransactionKey () const
	Fetches the unique key that identifies this transaction.

size_t	getUpdateAttempts () const
	Fetches the update attempt count for the current update.

virtual void	operator() (DNSClient::Status status)
	Serves as the DNSClient IO completion event handler.

void	startTransaction ()
	Begins execution of the transaction.

Public Member Functions inherited from isc::d2::DNSClient::Callback
virtual	~Callback ()
	Virtual destructor.

Public Member Functions inherited from isc::util::StateModel
	StateModel ()
	Constructor.

virtual	~StateModel ()
	Destructor.

bool	didModelFail () const
	Returns whether or not the model failed.

void	endModel ()
	Conducts a normal transition to the end of the model.

std::string	getContextStr () const
	Convenience method which returns a string rendition of the current state and next event.

unsigned int	getCurrState () const
	Fetches the model's current state.

std::string	getEventLabel (const int event) const
	Fetches the label associated with an event value.

unsigned int	getLastEvent () const
	Fetches the model's last event.

unsigned int	getNextEvent () const
	Fetches the model's next event.

std::string	getPrevContextStr () const
	Convenience method which returns a string rendition of the previous state and last event.

unsigned int	getPrevState () const
	Fetches the model's previous state.

std::string	getStateLabel (const int state) const
	Fetches the label associated with an state value.

bool	isModelDone () const
	Returns whether or not the model has finished execution.

bool	isModelNew () const
	Returns whether or not the model is new.

bool	isModelPaused () const
	Returns whether or not the model is paused.

bool	isModelRunning () const
	Returns whether or not the model is running.

bool	isModelWaiting () const
	Returns whether or not the model is waiting.

void	nopStateHandler ()
	An empty state handler.

virtual void	runModel (unsigned int event)
	Processes events through the state model.

void	startModel (const int start_state)
	Begins execution of the model.

void	unpauseModel ()
	Unpauses state model.

Static Public Attributes
static const int	ADDING_FWD_ADDRS_ST = NCT_DERIVED_STATE_MIN + 1
	State that attempts to add forward address records.

static const int	FQDN_IN_USE_EVT = NCT_DERIVED_EVENT_MIN + 1
	Event sent when an add attempt fails with address in use.

static const int	FQDN_NOT_IN_USE_EVT = NCT_DERIVED_EVENT_MIN + 2
	Event sent when replace attempt to fails with address not in use.

static const int	REPLACING_FWD_ADDRS_ST = NCT_DERIVED_STATE_MIN + 2
	State that attempts to replace forward address records.

static const int	REPLACING_REV_PTRS_ST = NCT_DERIVED_STATE_MIN + 3
	State that attempts to replace reverse PTR records.

Static Public Attributes inherited from isc::d2::NameChangeTransaction
static const unsigned int	DNS_UPDATE_DEFAULT_TIMEOUT = 100
	Default time to assign to a single DNS update.

static const int	IO_COMPLETED_EVT = SM_DERIVED_EVENT_MIN + 5
	Issued when a DNS update packet exchange has completed.

static const unsigned int	MAX_UPDATE_TRIES_PER_SERVER = 3
	Maximum times to attempt a single update on a given server.

static const int	NCT_DERIVED_EVENT_MIN = SM_DERIVED_EVENT_MIN + 101
	Value at which custom events in a derived class should begin.

static const int	NCT_DERIVED_STATE_MIN = SM_DERIVED_STATE_MIN + 101
	Value at which custom states in a derived class should begin.

static const int	NO_MORE_SERVERS_EVT =SM_DERIVED_EVENT_MIN + 4
	Issued when there are no more servers from which to select.

static const int	PROCESS_TRANS_FAILED_ST = SM_DERIVED_STATE_MIN + 5
	State which processes an unsuccessful transaction conclusion.

static const int	PROCESS_TRANS_OK_ST = SM_DERIVED_STATE_MIN + 4
	State which processes successful transaction conclusion.

static const int	READY_ST = SM_DERIVED_STATE_MIN + 1
	State from which a transaction is started.

static const int	SELECT_SERVER_EVT = SM_DERIVED_EVENT_MIN + 1
	Issued when a server needs to be selected.

static const int	SELECTING_FWD_SERVER_ST = SM_DERIVED_STATE_MIN + 2
	State in which forward DNS server selection is done.

static const int	SELECTING_REV_SERVER_ST = SM_DERIVED_STATE_MIN + 3
	State in which reverse DNS server selection is done.

static const int	SERVER_IO_ERROR_EVT = SM_DERIVED_EVENT_MIN + 3
	Issued when an update fails due to an IO error.

static const int	SERVER_SELECTED_EVT = SM_DERIVED_EVENT_MIN + 2
	Issued when a server has been selected.

static const int	UPDATE_FAILED_EVT = SM_DERIVED_EVENT_MIN + 7
	Issued when the attempted update fails to complete.

static const int	UPDATE_OK_EVT = SM_DERIVED_EVENT_MIN + 6
	Issued when the attempted update successfully completed.

Static Public Attributes inherited from isc::util::StateModel
static const int	END_EVT = 2
	Event issued to end the model execution.

static const int	END_ST = 1
	Final state, all the state model has reached its conclusion.

static const int	FAIL_EVT = 3
	Event issued to abort the model execution.

static const int	NEW_ST = 0
	State that a state model is in immediately after construction.

static const int	NOP_EVT = 0
	Signifies that no event has occurred.

static const int	SM_DERIVED_EVENT_MIN = 11
	Value at which custom events in a derived class should begin.

static const int	SM_DERIVED_STATE_MIN = 11
	Value at which custom states in a derived class should begin.

static const int	START_EVT = 1
	Event issued to start the model execution.

Protected Member Functions
void	addingFwdAddrsHandler ()
	State handler for ADD_FWD_ADDRS_ST.

void	buildAddFwdAddressRequest ()
	Builds a DNS request to add an forward DNS entry for an FQDN.

void	buildReplaceFwdAddressRequest ()
	Builds a DNS request to replace forward DNS entry for an FQDN.

void	buildReplaceRevPtrsRequest ()
	Builds a DNS request to replace a reverse DNS entry for an FQDN.

virtual void	defineEvents ()
	Adds events defined by NameAddTransaction to the event set.

virtual void	defineStates ()
	Adds states defined by NameAddTransaction to the state set.

void	processAddFailedHandler ()
	State handler for PROCESS_TRANS_FAILED_ST.

void	processAddOkHandler ()
	State handler for PROCESS_TRANS_OK_ST.

void	readyHandler ()
	State handler for READY_ST.

void	replacingFwdAddrsHandler ()
	State handler for REPLACING_FWD_ADDRS_ST.

void	replacingRevPtrsHandler ()
	State handler for REPLACING_REV_PTRS_ST.

void	selectingFwdServerHandler ()
	State handler for SELECTING_FWD_SERVER_ST.

void	selectingRevServerHandler ()
	State handler for SELECTING_REV_SERVER_ST.

virtual void	verifyEvents ()
	Validates the contents of the set of events.

virtual void	verifyStates ()
	Validates the contents of the set of states.

Protected Member Functions inherited from isc::d2::NameChangeTransaction
void	addDhcidRdata (dns::RRsetPtr &rrset)
	Adds an RData for the lease client's DHCID to the given RRset.

void	addLeaseAddressRdata (dns::RRsetPtr &rrset)
	Adds an RData for the lease address to the given RRset.

void	addPtrRdata (dns::RRsetPtr &rrset)
	Adds an RData for the lease FQDN to the given RRset.

void	clearDnsUpdateRequest ()
	Destroys the current update request packet.

void	clearDnsUpdateResponse ()
	Destroys the current update response packet.

void	clearUpdateAttempts ()
	Resets the update attempts count.

const asiolink::IOServicePtr &	getIOService ()
	Fetches the IOService the transaction uses for IO processing.

void	initServerSelection (const DdnsDomainPtr &domain)
	Initializes server selection from the given DDNS domain.

virtual void	onModelFailure (const std::string &explanation)
	Handler for fatal model execution errors.

virtual D2UpdateMessagePtr	prepNewRequest (DdnsDomainPtr domain)
	Creates a new DNS update request based on the given domain.

std::string	responseString () const
	Returns a string version of the current response status and rcode.

void	retryTransition (const int fail_to_state)
	Determines the state and next event based on update attempts.

bool	selectNextServer ()
	Selects the next server in the current server list.

bool	selectTSIGKey ()
	Selects the TSIG key.

virtual void	sendUpdate (const std::string &comment="")
	Send the update request to the current server.

void	setDnsUpdateRequest (D2UpdateMessagePtr &request)
	Sets the update request packet to the given packet.

void	setDnsUpdateResponse (D2UpdateMessagePtr &response)
	Sets the update response packet to the given packet.

void	setDnsUpdateStatus (const DNSClient::Status &status)
	Sets the update status to the given status value.

void	setForwardChangeCompleted (const bool value)
	Sets the forward change completion flag to the given value.

void	setNcrStatus (const dhcp_ddns::NameChangeStatus &status)
	Sets the status of the transaction's NameChangeRequest.

void	setReverseChangeCompleted (const bool value)
	Sets the reverse change completion flag to the given value.

void	setUpdateAttempts (const size_t value)
	Sets the update attempt count to the given value.

std::string	transactionOutcomeString () const
	Returns a string version of transaction outcome.

Protected Member Functions inherited from isc::util::StateModel
void	abortModel (const std::string &explanation)
	Aborts model execution.

void	defineEvent (unsigned int value, const std::string &label)
	Adds an event value and associated label to the set of events.

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.

bool	doOnEntry ()
	Checks if on entry flag is true.

bool	doOnExit ()
	Checks if on exit flag is true.

const EventPtr &	getEvent (unsigned int value)
	Fetches the event referred to by value.

const StatePtr	getState (unsigned int value)
	Fetches the state referred to by value.

const StatePtr	getStateInternal (unsigned int value)
	Fetches the state referred to by value.

void	initDictionaries ()
	Initializes the event and state dictionaries.

void	postNextEvent (unsigned int event)
	Sets the next event to the given event value.

void	setState (unsigned int state)
	Sets the current state to the given state value.

void	transition (unsigned int state, unsigned int event)
	Sets up the model to transition into given state with a given event.

Detailed Description

Embodies the "life-cycle" required to carry out a DDNS Add update.

NameAddTransaction implements a state machine for adding (or replacing) a forward and/or reverse DNS mapping. This state machine is based upon the processing logic described in RFC 4703, Sections 5.3 and 5.4. That logic may be paraphrased as follows:

If the request includes a forward change:
    Select a forward server
    Send the server a request to add the forward entry
    If the server responds with already in use:
        Send a server a request to delete and then add forward entry
 
    If the forward update is unsuccessful:
        abandon the update
 
If the request includes a reverse change:
    Select a reverse server
    Send a server a request to delete and then add reverse entry

This class derives from NameChangeTransaction from which it inherits states, events, and methods common to NameChangeRequest processing.

Definition at line 52 of file nc_add.h.

Constructor & Destructor Documentation

◆ NameAddTransaction()

isc::d2::NameAddTransaction::NameAddTransaction	(	asiolink::IOServicePtr &	io_service,
		dhcp_ddns::NameChangeRequestPtr &	ncr,
		DdnsDomainPtr &	forward_domain,
		DdnsDomainPtr &	reverse_domain,
		D2CfgMgrPtr &	cfg_mgr )

Constructor.

Instantiates an Add transaction that is ready to be started.

Parameters

io_service	IO service to be used for IO processing
ncr	is the NameChangeRequest to fulfill
forward_domain	is the domain to use for forward DNS updates
reverse_domain	is the domain to use for reverse DNS updates
cfg_mgr	pointer to the configuration manager

Exceptions

NameAddTransaction error if given request is not a CHG_ADD, NameChangeTransaction error for base class construction errors.

Definition at line 30 of file nc_add.cc.

References isc::dhcp_ddns::CHG_ADD.

◆ ~NameAddTransaction()

isc::d2::NameAddTransaction::~NameAddTransaction ( )

virtual

Destructor.

Definition at line 44 of file nc_add.cc.

Member Function Documentation

◆ addingFwdAddrsHandler()

void isc::d2::NameAddTransaction::addingFwdAddrsHandler ( )

protected

State handler for ADD_FWD_ADDRS_ST.

Entered from:

SELECTING_FWD_SERVER with next event of SERVER_SELECTED_EVT
REPLACING_FWD_ADDRS_ST with next event of SERVER_SELECTED_EVT

Attempts to add a forward DNS entry for a given FQDN. If this is first invocation of the handler after transitioning into this state, any previous update request context is deleted. If next event is SERVER_SELECTED_EVT, the handler builds the forward add request, schedules an asynchronous send via sendUpdate(), and returns. Note that sendUpdate will post NOP_EVT as next event.

Posting the NOP_EVT will cause runModel() to suspend execution of the state model thus affecting a "wait" for the update IO to complete. Update completion occurs via the DNSClient callback operator() method inherited from NameChangeTransaction. When invoked this callback will post a next event of IO_COMPLETED_EVT and then invoke runModel which resumes execution of the state model.

When the handler is invoked with a next event of IO_COMPLETED_EVT, the DNS update status is checked and acted upon accordingly:

Transitions to:

SELECTING_REV_SERVER_ST with next event of SELECT_SERVER_EVT upon successful addition and the request includes a reverse DNS update.
PROCESS_TRANS_OK_ST with next event of UPDATE_OK_EVT upon successful addition and no reverse DNS update is required.
REPLACING_FWD_ADDRS_ST with next event of FQDN_IN_USE_EVT if the DNS server response indicates that an entry for the given FQDN already exists.
PROCESS_TRANS_FAILED_ST with next event of UPDATE_FAILED_EVT if the DNS server rejected the update for any other reason or the IO completed with an unrecognized status.
RE-ENTER this states with next event of SERVER_SELECTED_EVT_EVT if there was an IO error communicating with the server and the number of per server retries has not been exhausted.
SELECTING_FWD_SERVER_ST with next event of SERVER_IO_ERROR_EVT if there was an IO error communicating with the server and the number of per server retries has been exhausted.

Exceptions

NameAddTransactionError if upon entry next event is not SERVER_SELECTED_EVT or IO_COMPLETE_EVT.

Definition at line 172 of file nc_add.cc.

Referenced by defineStates().

Here is the call graph for this function:

◆ buildAddFwdAddressRequest()

void isc::d2::NameAddTransaction::buildAddFwdAddressRequest ( )

protected

Builds a DNS request to add an forward DNS entry for an FQDN.

Constructs a DNS update request, based upon the NCR, for adding a forward DNS mapping. Once constructed, the request is stored as the transaction's DNS update request.

The request content is adherent to RFC 4703 section 5.3.1:

Prerequisite RRsets:

An assertion that the FQDN does not exist

Updates RRsets:

An FQDN/IP RR addition (type A for IPv4, AAAA for IPv6)
An FQDN/DHCID RR addition (type DHCID)

Exceptions

This	method does not throw but underlying methods may.

Definition at line 599 of file nc_add.cc.

References isc::d2::NameChangeTransaction::addDhcidRdata(), isc::d2::NameChangeTransaction::addLeaseAddressRdata(), isc::dns::RRType::ANY(), isc::dns::RRType::DHCID(), isc::d2::NameChangeTransaction::getAddressRRType(), isc::d2::NameChangeTransaction::getForwardDomain(), isc::d2::NameChangeTransaction::getNcr(), isc::dns::RRClass::IN(), isc::dns::RRClass::NONE(), isc::d2::NameChangeTransaction::prepNewRequest(), isc::d2::D2UpdateMessage::SECTION_PREREQUISITE, isc::d2::D2UpdateMessage::SECTION_UPDATE, and isc::d2::NameChangeTransaction::setDnsUpdateRequest().

Referenced by addingFwdAddrsHandler().

Here is the call graph for this function:

◆ buildReplaceFwdAddressRequest()

void isc::d2::NameAddTransaction::buildReplaceFwdAddressRequest ( )

protected

Builds a DNS request to replace forward DNS entry for an FQDN.

Constructs a DNS update request, based upon the NCR, for replacing a forward DNS mapping. Once constructed, the request is stored as the transaction's DNS update request.

The request content is adherent to RFC 4703 section 5.3.2:

Prerequisite RRsets:

An assertion that the FQDN is in use
An assertion that the FQDN/DHCID RR exists for the lease client's DHCID.

Updates RRsets:

A deletion of any existing FQDN RRs (type A for IPv4, AAAA for IPv6)
A FQDN/IP RR addition (type A for IPv4, AAAA for IPv6)

Exceptions

This	method does not throw but underlying methods may.

Definition at line 641 of file nc_add.cc.

References isc::d2::NameChangeTransaction::addDhcidRdata(), isc::d2::NameChangeTransaction::addLeaseAddressRdata(), isc::dns::RRClass::ANY(), isc::dns::RRType::ANY(), isc::dns::RRType::DHCID(), isc::d2::NameChangeTransaction::getAddressRRType(), isc::d2::NameChangeTransaction::getForwardDomain(), isc::d2::NameChangeTransaction::getNcr(), isc::dns::RRClass::IN(), isc::d2::NameChangeTransaction::prepNewRequest(), isc::d2::D2UpdateMessage::SECTION_PREREQUISITE, isc::d2::D2UpdateMessage::SECTION_UPDATE, and isc::d2::NameChangeTransaction::setDnsUpdateRequest().

Referenced by replacingFwdAddrsHandler().

Here is the call graph for this function:

◆ buildReplaceRevPtrsRequest()

void isc::d2::NameAddTransaction::buildReplaceRevPtrsRequest ( )

protected

Builds a DNS request to replace a reverse DNS entry for an FQDN.

Constructs a DNS update request, based upon the NCR, for replacing a reverse DNS mapping. Once constructed, the request is stored as the transaction's DNS update request.

The request content is adherent to RFC 4703 section 5.4:

Prerequisite RRsets:

There are not prerequisites.

Updates RRsets:

A delete of any existing PTR RRs for the lease address
A delete of any existing DHCID RRs for the lease address
A PTR RR addition for the lease address and FQDN
A DHCID RR addition for the lease address and lease client DHCID

Exceptions

This	method does not throw but underlying methods may.

Definition at line 689 of file nc_add.cc.

References isc::d2::NameChangeTransaction::addDhcidRdata(), isc::d2::NameChangeTransaction::addPtrRdata(), isc::dns::RRClass::ANY(), isc::dns::RRType::DHCID(), isc::d2::NameChangeTransaction::getNcr(), isc::d2::NameChangeTransaction::getReverseDomain(), isc::dns::RRClass::IN(), isc::d2::NameChangeTransaction::prepNewRequest(), isc::dns::RRType::PTR(), isc::d2::D2CfgMgr::reverseIpAddress(), isc::d2::D2UpdateMessage::SECTION_UPDATE, and isc::d2::NameChangeTransaction::setDnsUpdateRequest().

Referenced by replacingRevPtrsHandler().

Here is the call graph for this function:

◆ defineEvents()

void isc::d2::NameAddTransaction::defineEvents ( )

protectedvirtual

Adds events defined by NameAddTransaction to the event set.

Invokes NameChangeTransaction's implementation and then defines the events unique to NCR Add transaction processing.

Exceptions

StateModelError if an event definition is invalid or a duplicate.

Reimplemented from isc::d2::NameChangeTransaction.

Definition at line 48 of file nc_add.cc.

References isc::util::StateModel::defineEvent(), isc::d2::NameChangeTransaction::defineEvents(), FQDN_IN_USE_EVT, and FQDN_NOT_IN_USE_EVT.

Here is the call graph for this function:

◆ defineStates()

void isc::d2::NameAddTransaction::defineStates ( )

protectedvirtual

Adds states defined by NameAddTransaction to the state set.

Invokes NameChangeTransaction's implementation and then defines the states unique to NCR Add transaction processing.

Exceptions

StateModelError if an state definition is invalid or a duplicate.

Reimplemented from isc::d2::NameChangeTransaction.

Definition at line 76 of file nc_add.cc.

References ADDING_FWD_ADDRS_ST, addingFwdAddrsHandler(), isc::util::StateModel::defineState(), isc::d2::NameChangeTransaction::defineStates(), isc::d2::NameChangeTransaction::PROCESS_TRANS_FAILED_ST, isc::d2::NameChangeTransaction::PROCESS_TRANS_OK_ST, processAddFailedHandler(), processAddOkHandler(), isc::d2::NameChangeTransaction::READY_ST, readyHandler(), REPLACING_FWD_ADDRS_ST, REPLACING_REV_PTRS_ST, replacingFwdAddrsHandler(), replacingRevPtrsHandler(), isc::d2::NameChangeTransaction::SELECTING_FWD_SERVER_ST, isc::d2::NameChangeTransaction::SELECTING_REV_SERVER_ST, selectingFwdServerHandler(), and selectingRevServerHandler().

Here is the call graph for this function:

◆ processAddFailedHandler()

void isc::d2::NameAddTransaction::processAddFailedHandler ( )

protected

State handler for PROCESS_TRANS_FAILED_ST.

Entered from:

SELECTING_FWD_SERVER_ST with a next event of NO_MORE_SERVERS
ADDING_FWD_ADDRS_ST with a next event of UPDATE_FAILED_EVT
REPLACING_FWD_ADDRS_ST with a next event of UPDATE_FAILED_EVT
SELECTING_REV_SERVER_ST with a next event of NO_MORE_SERVERS
REPLACING_REV_PTRS_ST with a next event of UPDATE_FAILED_EVT

Sets the transaction status to indicate failure and ends model execution.

Transitions to:

END_ST with a next event of FAIL_EVT.

Exceptions

NameAddTransactionError if upon entry next event is not: UPDATE_FAILED_EVT

Definition at line 581 of file nc_add.cc.

References isc::d2::d2_to_dns_logger, isc::d2::DHCP_DDNS_ADD_FAILED, isc::util::StateModel::endModel(), isc::util::StateModel::getContextStr(), isc::util::StateModel::getNextEvent(), isc::d2::NameChangeTransaction::getRequestId(), isc_throw, LOG_ERROR, isc::d2::NameChangeTransaction::NO_MORE_SERVERS_EVT, isc::d2::NameChangeTransaction::setNcrStatus(), isc::dhcp_ddns::ST_FAILED, isc::d2::NameChangeTransaction::transactionOutcomeString(), and isc::d2::NameChangeTransaction::UPDATE_FAILED_EVT.

Referenced by defineStates().

Here is the call graph for this function:

◆ processAddOkHandler()

void isc::d2::NameAddTransaction::processAddOkHandler ( )

protected

State handler for PROCESS_TRANS_OK_ST.

Entered from:

ADDING_FWD_ADDRS_ST with a next event of UPDATE_OK_EVT
REPLACING_FWD_ADDRS_ST with a next event of UPDATE_OK_EVT
REPLACING_REV_PTRS_ST with a next event of UPDATE_OK_EVT

Sets the transaction action status to indicate success and ends model execution.

Transitions to:

END_ST with a next event of END_EVT.

Exceptions

NameAddTransactionError if upon entry next event is not: UPDATE_OK_EVT

Definition at line 564 of file nc_add.cc.

References isc::d2::d2_to_dns_logger, isc::d2::DHCP_DDNS_ADD_SUCCEEDED, isc::util::StateModel::endModel(), isc::util::StateModel::getContextStr(), isc::d2::NameChangeTransaction::getNcr(), isc::util::StateModel::getNextEvent(), isc::d2::NameChangeTransaction::getRequestId(), isc_throw, LOG_INFO, isc::d2::NameChangeTransaction::setNcrStatus(), isc::dhcp_ddns::ST_COMPLETED, and isc::d2::NameChangeTransaction::UPDATE_OK_EVT.

Referenced by defineStates().

Here is the call graph for this function:

◆ readyHandler()

void isc::d2::NameAddTransaction::readyHandler ( )

protected

State handler for READY_ST.

Entered from:

INIT_ST with next event of START_EVT

The READY_ST is the state the model transitions into when the inherited method, startTransaction() is invoked. This handler, therefore, is the entry point into the state model execution.h Its primary task is to determine whether to start with a forward DNS change or a reverse DNS change.

Transitions to:

SELECTING_FWD_SERVER_ST with next event of SERVER_SELECT_ST if request includes a forward change.
SELECTING_REV_SERVER_ST with next event of SERVER_SELECT_ST if request includes only a reverse change.

Exceptions

NameAddTransactionError if upon entry next event is not START_EVT.

Definition at line 124 of file nc_add.cc.

References isc::util::StateModel::getContextStr(), isc::d2::NameChangeTransaction::getForwardDomain(), isc::util::StateModel::getNextEvent(), isc_throw, isc::d2::NameChangeTransaction::SELECT_SERVER_EVT, isc::d2::NameChangeTransaction::SELECTING_FWD_SERVER_ST, isc::d2::NameChangeTransaction::SELECTING_REV_SERVER_ST, isc::util::StateModel::START_EVT, and isc::util::StateModel::transition().

Referenced by defineStates().

Here is the call graph for this function:

◆ replacingFwdAddrsHandler()

void isc::d2::NameAddTransaction::replacingFwdAddrsHandler ( )

protected

State handler for REPLACING_FWD_ADDRS_ST.

Entered from:

ADDING_FWD_ADDRS_ST with next event of FQDN_IN_USE_EVT

Attempts to delete and then add a forward DNS entry for a given FQDN. If this is first invocation of the handler after transitioning into this state, any previous update request context is deleted. If next event is FDQN_IN_USE_EVT or SERVER_SELECTED_EVT, the handler builds the forward replacement request, schedules an asynchronous send via sendUpdate(), and returns. Note that sendUpdate will post NOP_EVT as the next event.

Posting the NOP_EVT will cause runModel() to suspend execution of the state model thus affecting a "wait" for the update IO to complete. Update completion occurs via the DNSClient callback operator() method inherited from NameChangeTransaction. When invoked this callback will post a next event of IO_COMPLETED_EVT and then invoke runModel which resumes execution of the state model.

When the handler is invoked with a next event of IO_COMPLETED_EVT, the DNS update status is checked and acted upon accordingly:

Transitions to:

SELECTING_REV_SERVER_ST with a next event of SELECT_SERVER_EVT upon successful replacement and the request includes a reverse DNS update.
PROCESS_TRANS_OK_ST with next event of UPDATE_OK_EVT upon successful replacement and the request does not include a reverse DNS update.
ADDING_FWD_ADDR_STR with a next event of SERVER_SELECTED_EVT if the DNS server response indicates that the FQDN is not in use. This could occur if a previous add attempt indicated the FQDN was in use, but that entry has since been removed by another entity prior to this replacement attempt.
PROCESS_TRANS_FAILED_ST with a next event of UPDATE_FAILED_EVT if the DNS server rejected the update for any other reason or the IO completed with an unrecognized status.
RE-ENTER this state with a next event of SERVER_SELECTED_EVT if there was an IO error communicating with the server and the number of per server retries has not been exhausted.
SELECTING_FWD_SERVER_ST with next event of SERVER_IO_ERROR_EVT if there was an IO error communicating with the server and the number of per server retries has been exhausted.

Exceptions

NameAddTransactionError if upon entry next event is not: FQDN_IN_USE_EVT, SERVER_SELECTED_EVT or IO_COMPLETE_EVT.

Definition at line 294 of file nc_add.cc.

Referenced by defineStates().

Here is the call graph for this function:

◆ replacingRevPtrsHandler()

void isc::d2::NameAddTransaction::replacingRevPtrsHandler ( )

protected

State handler for REPLACING_REV_PTRS_ST.

Entered from:

SELECTING_REV_SERVER_ST with a next event of SERVER_SELECTED_EVT

Attempts to delete and then add a reverse DNS entry for a given FQDN. If this is first invocation of the handler after transitioning into this state, any previous update request context is deleted. If next event is SERVER_SELECTED_EVT, the handler builds the reverse replacement add request, schedules an asynchronous send via sendUpdate(), and returns. Note that sendUpdate will post NOP_EVT as next event.

Posting the NOP_EVT will cause runModel() to suspend execution of the state model thus affecting a "wait" for the update IO to complete. Update completion occurs via the DNSClient callback operator() method inherited from NameChangeTransaction. When invoked this callback will post a next event of IO_COMPLETED_EVT and then invoke runModel which resumes execution of the state model.

When the handler is invoked with a next event of IO_COMPLETED_EVT, the DNS update status is checked and acted upon accordingly:

Transitions to:

PROCESS_TRANS_OK_ST with a next event of UPDATE_OK_EVT upon successful replacement.
PROCESS_TRANS_FAILED_ST with a next event of UPDATE_FAILED_EVT If the DNS server rejected the update for any reason or the IO completed with an unrecognized status.
RE-ENTER this state with a next event of SERVER_SELECTED_EVT if there was an IO error communicating with the server and the number of per server retries has not been exhausted.
SELECTING_REV_SERVER_ST with next event of SERVER_IO_ERROR_EVT if there was an IO error communicating with the server and the number of per server retries has been exhausted.

Exceptions

NameAddTransactionError if upon entry next event is not: SERVER_SELECTED_EVT or IO_COMPLETED_EVT

Definition at line 450 of file nc_add.cc.

Referenced by defineStates().

Here is the call graph for this function:

◆ selectingFwdServerHandler()

void isc::d2::NameAddTransaction::selectingFwdServerHandler ( )

protected

State handler for SELECTING_FWD_SERVER_ST.

Entered from:

READY_ST with next event of SELECT_SERVER_EVT
ADDING_FWD_ADDRS_ST with next event of SERVER_IO_ERROR_EVT
REPLACING_FWD_ADDRS_ST with next event of SERVER_IO_ERROR_EVT

Selects the server to be used from the forward domain for the forward DNS update. If next event is SELECT_SERVER_EVT the handler initializes the forward domain's server selection mechanism and then attempts to select the next server. If next event is SERVER_IO_ERROR_EVT then the handler simply attempts to select the next server.

Transitions to:

ADDING_FWD_ADDRS_ST with next event of SERVER_SELECTED upon successful server selection
PROCESS_TRANS_FAILED with next event of NO_MORE_SERVERS_EVT upon failure to select a server

Exceptions

NameAddTransactionError if upon entry next event is not SELECT_SERVER_EVT or SERVER_IO_ERROR_EVT.

Definition at line 144 of file nc_add.cc.

Referenced by defineStates().

Here is the call graph for this function:

◆ selectingRevServerHandler()

void isc::d2::NameAddTransaction::selectingRevServerHandler ( )

protected

State handler for SELECTING_REV_SERVER_ST.

Entered from:

READY_ST with next event of SELECT_SERVER_EVT
ADDING_FWD_ADDRS_ST with next event of SELECT_SERVER_EVT
REPLACING_FWD_ADDRS_ST with next event of SELECT_SERVER_EVT
REPLACING_REV_PTRS_ST with next event of SERVER_IO_ERROR_EVT

Selects the server to be used from the reverse domain for the reverse DNS update. If next event is SELECT_SERVER_EVT the handler initializes the reverse domain's server selection mechanism and then attempts to select the next server. If next event is SERVER_IO_ERROR_EVT then the handler simply attempts to select the next server.

Transitions to:

ADDING_REV_PTRS_ST with next event of SERVER_SELECTED upon successful server selection
PROCESS_TRANS_FAILED with next event of NO_MORE_SERVERS_EVT upon failure to select a server

Exceptions

NameAddTransactionError if upon entry next event is not SELECT_SERVER_EVT or SERVER_IO_ERROR_EVT.

Definition at line 421 of file nc_add.cc.

Referenced by defineStates().

Here is the call graph for this function:

◆ verifyEvents()

void isc::d2::NameAddTransaction::verifyEvents ( )

protectedvirtual

Validates the contents of the set of events.

Invokes NameChangeTransaction's implementation and then verifies the Add transaction's. This tests that the needed events are in the event dictionary.

Exceptions

StateModelError if an event value is undefined.

Reimplemented from isc::d2::NameChangeTransaction.

Definition at line 58 of file nc_add.cc.

References FQDN_IN_USE_EVT, FQDN_NOT_IN_USE_EVT, isc::util::StateModel::getEvent(), and isc::d2::NameChangeTransaction::verifyEvents().

Here is the call graph for this function:

◆ verifyStates()

void isc::d2::NameAddTransaction::verifyStates ( )

protectedvirtual

Validates the contents of the set of states.

Invokes NameChangeTransaction's implementation and then verifies the Add transaction's states. This tests that the needed states are in the state dictionary.

Exceptions

StateModelError if an event value is undefined.

Reimplemented from isc::d2::NameChangeTransaction.

Definition at line 107 of file nc_add.cc.

References ADDING_FWD_ADDRS_ST, isc::util::StateModel::getStateInternal(), REPLACING_FWD_ADDRS_ST, REPLACING_REV_PTRS_ST, and isc::d2::NameChangeTransaction::verifyStates().

Here is the call graph for this function:

Member Data Documentation

◆ ADDING_FWD_ADDRS_ST

const int isc::d2::NameAddTransaction::ADDING_FWD_ADDRS_ST = NCT_DERIVED_STATE_MIN + 1

static

State that attempts to add forward address records.

Definition at line 57 of file nc_add.h.

Referenced by defineStates(), replacingFwdAddrsHandler(), selectingFwdServerHandler(), and verifyStates().

◆ FQDN_IN_USE_EVT

const int isc::d2::NameAddTransaction::FQDN_IN_USE_EVT = NCT_DERIVED_EVENT_MIN + 1

static

Event sent when an add attempt fails with address in use.

Definition at line 68 of file nc_add.h.

Referenced by addingFwdAddrsHandler(), defineEvents(), replacingFwdAddrsHandler(), and verifyEvents().

◆ FQDN_NOT_IN_USE_EVT

const int isc::d2::NameAddTransaction::FQDN_NOT_IN_USE_EVT = NCT_DERIVED_EVENT_MIN + 2

static

Event sent when replace attempt to fails with address not in use.

Definition at line 71 of file nc_add.h.

Referenced by defineEvents(), and verifyEvents().

◆ REPLACING_FWD_ADDRS_ST

const int isc::d2::NameAddTransaction::REPLACING_FWD_ADDRS_ST = NCT_DERIVED_STATE_MIN + 2

static

State that attempts to replace forward address records.

Definition at line 60 of file nc_add.h.

Referenced by addingFwdAddrsHandler(), defineStates(), and verifyStates().

◆ REPLACING_REV_PTRS_ST

const int isc::d2::NameAddTransaction::REPLACING_REV_PTRS_ST = NCT_DERIVED_STATE_MIN + 3

static

State that attempts to replace reverse PTR records.

Definition at line 63 of file nc_add.h.

Referenced by defineStates(), selectingRevServerHandler(), and verifyStates().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NameAddTransaction()

◆ ~NameAddTransaction()

Member Function Documentation

◆ addingFwdAddrsHandler()

◆ buildAddFwdAddressRequest()

◆ buildReplaceFwdAddressRequest()

◆ buildReplaceRevPtrsRequest()

◆ defineEvents()

◆ defineStates()

◆ processAddFailedHandler()

◆ processAddOkHandler()

◆ readyHandler()

◆ replacingFwdAddrsHandler()

◆ replacingRevPtrsHandler()

◆ selectingFwdServerHandler()

◆ selectingRevServerHandler()

◆ verifyEvents()

◆ verifyStates()

Member Data Documentation

◆ ADDING_FWD_ADDRS_ST

◆ FQDN_IN_USE_EVT

◆ FQDN_NOT_IN_USE_EVT

◆ REPLACING_FWD_ADDRS_ST

◆ REPLACING_REV_PTRS_ST