mirror of
https://github.com/google/nomulus.git
synced 2025-05-01 20:47:52 +02:00
d5ac03aae4
Right now - if there's an error during DnsWriter.publish*, all the publish from before that error will be committed, while all the publish after that error will not. More than that - in some writers partial publishes can be committed, depending on implementation. This defines a new contract that publish* are only committed when .commit is called. That way any error will simply mean no publish is committed. ------------- Created by MOE: https://github.com/google/moe MOE_MIGRATED_REVID=165708063
78 lines
3.1 KiB
Java
78 lines
3.1 KiB
Java
// Copyright 2017 The Nomulus Authors. All Rights Reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package google.registry.dns.writer;
|
|
|
|
/**
|
|
* Transaction object for sending an atomic batch of updates for a single zone to the DNS server.
|
|
*
|
|
* <p>All updates are tentative until commit is called. If commit isn't called, no change will
|
|
* happen.
|
|
*
|
|
* <p>Here's an example of how you would publish updates for a domain and host:
|
|
* <pre>
|
|
* @Inject Provider<DnsWriter> dnsWriter;
|
|
* writer.publishDomain(domainName);
|
|
* writer.publishHost(hostName);
|
|
* writer.commit();
|
|
* </pre>
|
|
*/
|
|
public interface DnsWriter {
|
|
|
|
/**
|
|
* Loads {@code domainName} from Datastore and publishes its NS/DS records to the DNS server.
|
|
* Replaces existing records for the exact name supplied with an NS record for each name server
|
|
* and a DS record for each delegation signer stored in the registry for the supplied domain name.
|
|
* If the domain is deleted or is in a "non-publish" state then any existing records are deleted.
|
|
*
|
|
* This must NOT actually perform any action, instead it should stage the action so that it's
|
|
* performed when {@link #commit()} is called.
|
|
*
|
|
* @param domainName the fully qualified domain name, with no trailing dot
|
|
*/
|
|
void publishDomain(String domainName);
|
|
|
|
/**
|
|
* Loads {@code hostName} from Datastore and publishes its A/AAAA glue records to the DNS server,
|
|
* if it is used as an in-bailiwick nameserver. Orphaned glue records are prohibited. Replaces
|
|
* existing records for the exact name supplied, with an A or AAAA record (as appropriate) for
|
|
* each address stored in the registry, for the supplied host name. If the host is deleted then
|
|
* the existing records are deleted. Assumes that this method will only be called for in-bailiwick
|
|
* hosts. The registry does not have addresses for other hosts.
|
|
*
|
|
* This must NOT actually perform any action, instead it should stage the action so that it's
|
|
* performed when {@link #commit()} is called.
|
|
*
|
|
* @param hostName the fully qualified host name, with no trailing dot
|
|
*/
|
|
void publishHost(String hostName);
|
|
|
|
/**
|
|
* Commits the updates to the DNS server atomically.
|
|
*
|
|
* <p>The user is responsible for making sure commit() isn't called twice. Implementations are
|
|
* encouraged to throw an error if commit() is called twice.
|
|
*
|
|
* <p>Here's an example of how you would do that
|
|
* <pre>
|
|
* private boolean committed = false;
|
|
* void commit() {
|
|
* checkState(!committed, "commit() has already been called");
|
|
* committed = true;
|
|
* // ... actual commit implementation
|
|
* }
|
|
* </pre>
|
|
*/
|
|
void commit();
|
|
}
|