Interface DnsWriter

  • All Known Implementing Classes:
    BaseDnsWriter, CloudDnsWriter, DnsUpdateWriter, VoidDnsWriter

    public interface DnsWriter
    Transaction object for sending an atomic batch of updates for a single zone to the DNS server.

    All updates are tentative until commit is called. If commit isn't called, no change will happen.

    Here's an example of how you would publish updates for a domain and host:

     @Inject Provider<DnsWriter> dnsWriter;
     writer.publishDomain(domainName);
     writer.publishHost(hostName);
     writer.commit();
     
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void commit()
      Commits the updates to the DNS server atomically.
      void publishDomain​(java.lang.String domainName)
      Loads domainName from Datastore and publishes its NS/DS records to the DNS server.
      void publishHost​(java.lang.String hostName)
      Loads hostName from Datastore and publishes its A/AAAA glue records to the DNS server, if it is used as an in-bailiwick nameserver.
    • Method Detail

      • publishDomain

        void publishDomain​(java.lang.String domainName)
        Loads 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 commit() is called.
        Parameters:
        domainName - the fully qualified domain name, with no trailing dot
      • publishHost

        void publishHost​(java.lang.String hostName)
        Loads 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 commit() is called.
        Parameters:
        hostName - the fully qualified host name, with no trailing dot
      • commit

        void commit()
        Commits the updates to the DNS server atomically.

        The user is responsible for making sure commit() isn't called twice. Implementations are encouraged to throw an error if commit() is called twice.

        Here's an example of how you would do that

         private boolean committed = false;
         void commit() {
           checkState(!committed, "commit() has already been called");
           committed = true;
           // ... actual commit implementation
         }