Add support for a domain transfer request superuser EPP extension

Allow superusers to change the transfer period to zero years and allow
superusers to change the automatic transfer length.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=167598314

java/google/registry/model/domain/DomainResource.java

@@ -245,9 +245,11 @@ public class DomainResource extends DomainBase
       // If we are within an autorenew grace period, the transfer will subsume the autorenew. There
       // will already be a cancellation written in advance by the transfer request flow, so we don't
       // need to worry about billing, but we do need to cancel out the expiration time increase.
-      int extraYears = 1;  // All transfers are one year.
+      // The transfer period saved in the transfer data will be one year, unless the superuser
+      // extension set the transfer period to zero.
+      int extraYears = transferData.getTransferPeriod().getValue();
       if (domainAtTransferTime.getGracePeriodStatuses().contains(GracePeriodStatus.AUTO_RENEW)) {
-        extraYears--;
+        extraYears = 0;
       }
       // Set the expiration, autorenew events, and grace period for the transfer. (Transfer ends
       // all other graces).
@@ -261,14 +263,22 @@ public class DomainResource extends DomainBase
               extraYears))
           // Set the speculatively-written new autorenew events as the domain's autorenew events.
           .setAutorenewBillingEvent(transferData.getServerApproveAutorenewEvent())
-          .setAutorenewPollMessage(transferData.getServerApproveAutorenewPollMessage())
-          // Set the grace period using a key to the prescheduled transfer billing event.  Not using
-          // GracePeriod.forBillingEvent() here in order to avoid the actual Datastore fetch.
-          .setGracePeriods(ImmutableSet.of(GracePeriod.create(
-              GracePeriodStatus.TRANSFER,
-              transferExpirationTime.plus(Registry.get(getTld()).getTransferGracePeriodLength()),
-              transferData.getGainingClientId(),
-              transferData.getServerApproveBillingEvent())));
+          .setAutorenewPollMessage(transferData.getServerApproveAutorenewPollMessage());
+      if (transferData.getTransferPeriod().getValue() == 1) {
+        // Set the grace period using a key to the prescheduled transfer billing event.  Not using
+        // GracePeriod.forBillingEvent() here in order to avoid the actual Datastore fetch.
+        builder.setGracePeriods(
+            ImmutableSet.of(
+                GracePeriod.create(
+                    GracePeriodStatus.TRANSFER,
+                    transferExpirationTime.plus(
+                        Registry.get(getTld()).getTransferGracePeriodLength()),
+                    transferData.getGainingClientId(),
+                    transferData.getServerApproveBillingEvent())));
+      } else {
+        // There won't be a billing event, so we don't need a grace period
+        builder.setGracePeriods(ImmutableSet.of());
+      }
       // Set all remaining transfer properties.
       setAutomaticTransferSuccessProperties(builder, transferData);
       // Finish projecting to now.

java/google/registry/model/domain/superuser/DomainTransferRequestSuperuserExtension.java

@@ -0,0 +1,40 @@
+// 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.model.domain.superuser;
+
+import google.registry.model.domain.Period;
+import javax.xml.bind.annotation.XmlElement;
+import javax.xml.bind.annotation.XmlRootElement;
+
+/** A superuser extension that may be present on domain transfer request commands. */
+@XmlRootElement(name = "domainTransferRequest")
+public class DomainTransferRequestSuperuserExtension extends SuperuserExtension {
+  // We need to specify the period here because the transfer object's period cannot be set to zero.
+  @XmlElement(name = "renewalPeriod")
+  Period renewalPeriod;
+
+  // The number of days before the transfer will be automatically approved by the server. A value of
+  // zero means the transfer will happen immediately.
+  @XmlElement(name = "automaticTransferLength")
+  int automaticTransferLength;
+
+  public Period getRenewalPeriod() {
+    return renewalPeriod;
+  }
+
+  public int getAutomaticTransferLength() {
+    return automaticTransferLength;
+  }
+}

java/google/registry/model/domain/superuser/SuperuserExtension.java

@@ -0,0 +1,23 @@
+// 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.model.domain.superuser;
+
+import google.registry.model.ImmutableObject;
+import google.registry.model.eppinput.EppInput.CommandExtension;
+import javax.xml.bind.annotation.XmlTransient;
+
+/** Base class for superuser EPP extensions. */
+@XmlTransient
+public abstract class SuperuserExtension extends ImmutableObject implements CommandExtension {}

java/google/registry/model/domain/superuser/package-info.java

@@ -0,0 +1,26 @@
+// 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.
+
+@XmlSchema(
+    namespace = "urn:google:params:xml:ns:superuser-1.0",
+    xmlns = @XmlNs(prefix = "superuser", namespaceURI = "urn:google:params:xml:ns:superuser-1.0"),
+    elementFormDefault = XmlNsForm.QUALIFIED)
+@XmlAccessorType(XmlAccessType.FIELD)
+package google.registry.model.domain.superuser;
+
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlNs;
+import javax.xml.bind.annotation.XmlNsForm;
+import javax.xml.bind.annotation.XmlSchema;

java/google/registry/model/eppinput/EppInput.java

@@ -51,6 +51,7 @@ import google.registry.model.domain.metadata.MetadataExtension;
 import google.registry.model.domain.rgp.RgpUpdateExtension;
 import google.registry.model.domain.secdns.SecDnsCreateExtension;
 import google.registry.model.domain.secdns.SecDnsUpdateExtension;
+import google.registry.model.domain.superuser.DomainTransferRequestSuperuserExtension;
 import google.registry.model.eppinput.ResourceCommand.ResourceCheck;
 import google.registry.model.eppinput.ResourceCommand.SingleResourceCommand;
 import google.registry.model.host.HostCommand;
@@ -345,7 +346,8 @@ public class EppInput extends ImmutableObject {
         @XmlElementRef(type = MetadataExtension.class),
         @XmlElementRef(type = RgpUpdateExtension.class),
         @XmlElementRef(type = SecDnsCreateExtension.class),
-        @XmlElementRef(type = SecDnsUpdateExtension.class) })
+        @XmlElementRef(type = SecDnsUpdateExtension.class),
+        @XmlElementRef(type = DomainTransferRequestSuperuserExtension.class) })
     @XmlElementWrapper
     List<CommandExtension> extension;
 

java/google/registry/model/transfer/TransferData.java

@@ -25,6 +25,8 @@ import com.googlecode.objectify.condition.IfNull;
 import google.registry.model.Buildable;
 import google.registry.model.EppResource;
 import google.registry.model.billing.BillingEvent;
+import google.registry.model.domain.Period;
+import google.registry.model.domain.Period.Unit;
 import google.registry.model.eppcommon.Trid;
 import google.registry.model.poll.PollMessage;
 import java.util.Set;
@@ -81,6 +83,14 @@ public class TransferData extends BaseTransferObject implements Buildable {
   /** The transaction id of the most recent transfer request (or null if there never was one). */
   Trid transferRequestTrid;
 
+  /**
+   * The period to extend the registration upon completion of the transfer.
+   *
+   * <p>By default, domain transfers are for one year. This can be changed to zero by using the
+   * superuser EPP extension.
+   */
+  Period transferPeriod = Period.create(1, Unit.YEARS);
+
   public ImmutableSet<Key<? extends TransferServerApproveEntity>> getServerApproveEntities() {
     return nullToEmptyImmutableCopy(serverApproveEntities);
   }
@@ -101,6 +111,10 @@ public class TransferData extends BaseTransferObject implements Buildable {
     return transferRequestTrid;
   }
 
+  public Period getTransferPeriod() {
+    return transferPeriod;
+  }
+
   @Override
   public Builder asBuilder() {
     return new Builder(clone(this));
@@ -145,6 +159,11 @@ public class TransferData extends BaseTransferObject implements Buildable {
       getInstance().transferRequestTrid = transferRequestTrid;
       return this;
     }
+
+    public Builder setTransferPeriod(Period transferPeriod) {
+      getInstance().transferPeriod = transferPeriod;
+      return this;
+    }
   }
 
   /**