Package google.registry.tools

Class MutatingEppToolCommand

  • All Implemented Interfaces:
    Command, CommandWithConnection
    public abstract class MutatingEppToolCommand
extends ConfirmingCommand
    A command to execute an epp command that intends to mutate objects (i.e. enables a dry run option).

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addSoyRecord​(java.lang.String clientId, com.google.template.soy.data.SoyRecord record)  
      protected void addXmlCommand​(java.lang.String clientId, java.lang.String xml)  
      protected boolean checkExecutionState()
      Run any pre-execute command checks and return true if they all pass.
      protected boolean dontRunCommand()
      Whether to NOT run the command.
      java.lang.String execute()
      Perform the command and return a result description.
      protected void init()
      Initializes the command.
      protected void initEppToolCommand()  
      protected abstract void initMutatingEppToolCommand()  
      protected boolean isDryRun()
      Subclasses can override to implement a dry run flag.
      java.lang.String prompt()
      Returns the optional extra confirmation prompt for the command.
      void setConnection​(ServiceConnection connection)  
      protected void setSoyTemplate​(com.google.template.soy.parseinfo.SoyFileInfo soyFileInfo, com.google.template.soy.parseinfo.SoyTemplateInfo soyRenderer)  
      protected static com.google.common.collect.Multimap<java.lang.String,​java.lang.String> validateAndGroupDomainNamesByTld​(java.util.List<java.lang.String> names)
      Helper function for grouping sets of domain names into respective TLDs.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface google.registry.tools.Command

        run

    • Constructor Detail

      • MutatingEppToolCommand

        public MutatingEppToolCommand()

    • Method Detail

      • isDryRun

        protected boolean isDryRun()
        Subclasses can override to implement a dry run flag. False by default.

      • initEppToolCommand

        protected void initEppToolCommand()
                           throws java.lang.Exception
        Throws:
        java.lang.Exception

      • initMutatingEppToolCommand

        protected abstract void initMutatingEppToolCommand()
                                            throws java.lang.Exception
        Throws:
        java.lang.Exception

      • validateAndGroupDomainNamesByTld

        protected static com.google.common.collect.Multimap<java.lang.String,​java.lang.String> validateAndGroupDomainNamesByTld​(java.util.List<java.lang.String> names)
        Helper function for grouping sets of domain names into respective TLDs. Useful for batched EPP calls when invoking commands (i.e. domain check) with sets of domains across multiple TLDs.

      • setSoyTemplate

        protected void setSoyTemplate​(com.google.template.soy.parseinfo.SoyFileInfo soyFileInfo,
                              com.google.template.soy.parseinfo.SoyTemplateInfo soyRenderer)

      • addXmlCommand

        protected void addXmlCommand​(java.lang.String clientId,
                             java.lang.String xml)

      • addSoyRecord

        protected void addSoyRecord​(java.lang.String clientId,
                            com.google.template.soy.data.SoyRecord record)

      • prompt

        public java.lang.String prompt()
                        throws java.io.IOException
        Description copied from class: ConfirmingCommand
        Returns the optional extra confirmation prompt for the command.
        Overrides:
        prompt in class ConfirmingCommand
        Throws:
        java.io.IOException

      • execute

        public java.lang.String execute()
                         throws java.lang.Exception
        Description copied from class: ConfirmingCommand
        Perform the command and return a result description.
        Specified by:
        execute in class ConfirmingCommand
        Throws:
        java.lang.Exception

      • init

        protected final void init()
                   throws java.lang.Exception
        Description copied from class: ConfirmingCommand
        Initializes the command.
        Overrides:
        init in class ConfirmingCommand
        Throws:
        java.lang.Exception