diff --git a/java/google/registry/flows/custom/CustomLogicFactory.java b/java/google/registry/flows/custom/CustomLogicFactory.java
index 5e43a2649..131610262 100644
--- a/java/google/registry/flows/custom/CustomLogicFactory.java
+++ b/java/google/registry/flows/custom/CustomLogicFactory.java
@@ -50,4 +50,9 @@ public class CustomLogicFactory {
EppInput eppInput, SessionMetadata sessionMetadata) {
return new DomainUpdateFlowCustomLogic(eppInput, sessionMetadata);
}
+
+ public DomainRenewFlowCustomLogic forDomainRenewFlow(
+ EppInput eppInput, SessionMetadata sessionMetadata) {
+ return new DomainRenewFlowCustomLogic(eppInput, sessionMetadata);
+ }
}
diff --git a/java/google/registry/flows/custom/CustomLogicModule.java b/java/google/registry/flows/custom/CustomLogicModule.java
index 8a7f45fc1..8fceea8d1 100644
--- a/java/google/registry/flows/custom/CustomLogicModule.java
+++ b/java/google/registry/flows/custom/CustomLogicModule.java
@@ -46,4 +46,10 @@ public class CustomLogicModule {
CustomLogicFactory factory, EppInput eppInput, SessionMetadata sessionMetadata) {
return factory.forDomainUpdateFlow(eppInput, sessionMetadata);
}
+
+ @Provides
+ static DomainRenewFlowCustomLogic provideDomainRenewFlowCustomLogic(
+ CustomLogicFactory factory, EppInput eppInput, SessionMetadata sessionMetadata) {
+ return factory.forDomainRenewFlow(eppInput, sessionMetadata);
+ }
}
diff --git a/java/google/registry/flows/custom/DomainRenewFlowCustomLogic.java b/java/google/registry/flows/custom/DomainRenewFlowCustomLogic.java
new file mode 100644
index 000000000..18eaf1879
--- /dev/null
+++ b/java/google/registry/flows/custom/DomainRenewFlowCustomLogic.java
@@ -0,0 +1,209 @@
+// Copyright 2016 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.flows.custom;
+
+import com.google.auto.value.AutoValue;
+import com.google.common.collect.ImmutableList;
+import google.registry.flows.EppException;
+import google.registry.flows.SessionMetadata;
+import google.registry.flows.domain.DomainRenewFlow;
+import google.registry.model.ImmutableObject;
+import google.registry.model.domain.DomainResource;
+import google.registry.model.eppinput.EppInput;
+import google.registry.model.eppoutput.EppResponse.ResponseData;
+import google.registry.model.eppoutput.EppResponse.ResponseExtension;
+import google.registry.model.reporting.HistoryEntry;
+import org.joda.time.DateTime;
+
+/**
+ * A no-op base class for {@link DomainRenewFlow} custom logic.
+ *
+ *
Extend this class and override the hook(s) to perform custom logic.
+ */
+public class DomainRenewFlowCustomLogic extends BaseFlowCustomLogic {
+
+ protected DomainRenewFlowCustomLogic(EppInput eppInput, SessionMetadata sessionMetadata) {
+ super(eppInput, sessionMetadata);
+ }
+
+ /** A hook that runs before any validation. This is useful to e.g. add allowable extensions. */
+ @SuppressWarnings("unused")
+ public void beforeValidation() throws EppException {
+ // Do nothing.
+ }
+
+ /** A hook that runs at the end of the validation step to perform additional validation. */
+ @SuppressWarnings("unused")
+ public void afterValidation(AfterValidationParameters parameters) throws EppException {
+ // Do nothing.
+ }
+
+ /**
+ * A hook that runs before new entities are persisted, allowing them to be changed.
+ *
+ *
It returns the actual entity changes that should be persisted to Datastore. It is important
+ * to be careful when changing the flow behavior for existing entities, because the core logic
+ * across many different flows expects the existence of these entities and many of the fields on
+ * them.
+ */
+ @SuppressWarnings("unused")
+ public EntityChanges beforeSave(BeforeSaveParameters parameters) throws EppException {
+ return parameters.entityChanges();
+ }
+
+ /**
+ * A hook that runs before the response is returned.
+ *
+ *
This takes the {@link DomainResource} and {@link ResponseExtension}s as input and returns
+ * them, potentially with modifications.
+ */
+ @SuppressWarnings("unused")
+ public BeforeResponseReturnData beforeResponse(BeforeResponseParameters parameters)
+ throws EppException {
+ return BeforeResponseReturnData.newBuilder()
+ .setResData(parameters.resData())
+ .setResponseExtensions(parameters.responseExtensions())
+ .build();
+ }
+
+ /** A class to encapsulate parameters for a call to {@link #afterValidation}. */
+ @AutoValue
+ public abstract static class AfterValidationParameters extends ImmutableObject {
+
+ public abstract DomainResource existingDomain();
+
+ public abstract int years();
+
+ public abstract DateTime now();
+
+ public static Builder newBuilder() {
+ return new AutoValue_DomainRenewFlowCustomLogic_AfterValidationParameters.Builder();
+ }
+
+ /** Builder for {@link AfterValidationParameters}. */
+ @AutoValue.Builder
+ public abstract static class Builder {
+
+ public abstract Builder setExistingDomain(DomainResource existingDomain);
+
+ public abstract Builder setYears(int years);
+
+ public abstract Builder setNow(DateTime now);
+
+ public abstract AfterValidationParameters build();
+ }
+ }
+
+ /**
+ * A class to encapsulate parameters for a call to {@link #beforeSave}.
+ *
+ *
Note that both newDomain and historyEntry are included in entityChanges. They are also
+ * passed separately for convenience, but they are the same instance, and changes to them will
+ * also affect what is persisted from entityChanges.
+ */
+ @AutoValue
+ public abstract static class BeforeSaveParameters extends ImmutableObject {
+
+ public abstract DomainResource existingDomain();
+
+ public abstract DomainResource newDomain();
+
+ public abstract HistoryEntry historyEntry();
+
+ public abstract EntityChanges entityChanges();
+
+ public abstract int years();
+
+ public abstract DateTime now();
+
+ public static Builder newBuilder() {
+ return new AutoValue_DomainRenewFlowCustomLogic_BeforeSaveParameters.Builder();
+ }
+
+ /** Builder for {@link BeforeSaveParameters}. */
+ @AutoValue.Builder
+ public abstract static class Builder {
+
+ public abstract Builder setExistingDomain(DomainResource existingDomain);
+
+ public abstract Builder setNewDomain(DomainResource newDomain);
+
+ public abstract Builder setHistoryEntry(HistoryEntry historyEntry);
+
+ public abstract Builder setEntityChanges(EntityChanges entityChanges);
+
+ public abstract Builder setYears(int years);
+
+ public abstract Builder setNow(DateTime now);
+
+ public abstract BeforeSaveParameters build();
+ }
+ }
+
+ /** A class to encapsulate parameters for a call to {@link #beforeResponse}. */
+ @AutoValue
+ public abstract static class BeforeResponseParameters extends ImmutableObject {
+
+ public abstract DomainResource domain();
+
+ public abstract ResponseData resData();
+
+ public abstract ImmutableList responseExtensions();
+
+ public static BeforeResponseParameters.Builder newBuilder() {
+ return new AutoValue_DomainRenewFlowCustomLogic_BeforeResponseParameters.Builder();
+ }
+
+ /** Builder for {@link BeforeResponseParameters}. */
+ @AutoValue.Builder
+ public abstract static class Builder {
+
+ public abstract BeforeResponseParameters.Builder setDomain(DomainResource domain);
+
+ public abstract BeforeResponseParameters.Builder setResData(ResponseData resData);
+
+ public abstract BeforeResponseParameters.Builder setResponseExtensions(
+ ImmutableList responseExtensions);
+
+ public abstract BeforeResponseParameters build();
+ }
+ }
+ /**
+ * A class to encapsulate parameters for the return values from a call to {@link #beforeResponse}.
+ */
+ @AutoValue
+ public abstract static class BeforeResponseReturnData extends ImmutableObject {
+
+ public abstract ResponseData resData();
+
+ public abstract ImmutableList responseExtensions();
+
+ public static Builder newBuilder() {
+ return new AutoValue_DomainRenewFlowCustomLogic_BeforeResponseReturnData.Builder();
+ }
+
+ /** Builder for {@link BeforeResponseReturnData}. */
+ @AutoValue.Builder
+ public abstract static class Builder {
+
+ public abstract Builder setResData(ResponseData resData);
+
+ public abstract Builder setResponseExtensions(
+ ImmutableList responseExtensions);
+
+ public abstract BeforeResponseReturnData build();
+ }
+ }
+}
diff --git a/java/google/registry/flows/domain/DomainCheckFlow.java b/java/google/registry/flows/domain/DomainCheckFlow.java
index 3b3f26538..bec65dc2a 100644
--- a/java/google/registry/flows/domain/DomainCheckFlow.java
+++ b/java/google/registry/flows/domain/DomainCheckFlow.java
@@ -141,6 +141,7 @@ public final class DomainCheckFlow implements Flow {
customLogic.afterValidation(
DomainCheckFlowCustomLogic.AfterValidationParameters.newBuilder()
.setDomainNames(domainNames)
+ // TODO: Use as of date from fee extension v0.12 instead of now, if specificed.
.setAsOfDate(now)
.build());
Set existingIds = checkResourcesExist(DomainResource.class, targetIds, now);
diff --git a/java/google/registry/flows/domain/DomainRenewFlow.java b/java/google/registry/flows/domain/DomainRenewFlow.java
index d0c7e7c65..deccd0b17 100644
--- a/java/google/registry/flows/domain/DomainRenewFlow.java
+++ b/java/google/registry/flows/domain/DomainRenewFlow.java
@@ -14,6 +14,7 @@
package google.registry.flows.domain;
+import static google.registry.flows.FlowUtils.persistEntityChanges;
import static google.registry.flows.FlowUtils.validateClientIsLoggedIn;
import static google.registry.flows.ResourceFlowUtils.loadAndVerifyExistence;
import static google.registry.flows.ResourceFlowUtils.verifyNoDisallowedStatuses;
@@ -42,7 +43,14 @@ import google.registry.flows.FlowModule.ClientId;
import google.registry.flows.FlowModule.Superuser;
import google.registry.flows.FlowModule.TargetId;
import google.registry.flows.TransactionalFlow;
+import google.registry.flows.custom.DomainRenewFlowCustomLogic;
+import google.registry.flows.custom.DomainRenewFlowCustomLogic.AfterValidationParameters;
+import google.registry.flows.custom.DomainRenewFlowCustomLogic.BeforeResponseParameters;
+import google.registry.flows.custom.DomainRenewFlowCustomLogic.BeforeResponseReturnData;
+import google.registry.flows.custom.DomainRenewFlowCustomLogic.BeforeSaveParameters;
+import google.registry.flows.custom.EntityChanges;
import google.registry.flows.domain.TldSpecificLogicProxy.EppCommandOperations;
+import google.registry.model.ImmutableObject;
import google.registry.model.billing.BillingEvent;
import google.registry.model.billing.BillingEvent.OneTime;
import google.registry.model.billing.BillingEvent.Reason;
@@ -112,11 +120,13 @@ public final class DomainRenewFlow implements TransactionalFlow {
@Inject @Superuser boolean isSuperuser;
@Inject HistoryEntry.Builder historyBuilder;
@Inject EppResponse.Builder responseBuilder;
+ @Inject DomainRenewFlowCustomLogic customLogic;
@Inject DomainRenewFlow() {}
@Override
public final EppResponse run() throws EppException {
extensionManager.register(FeeRenewCommandExtension.class, MetadataExtension.class);
+ customLogic.beforeValidation();
extensionManager.validate();
validateClientIsLoggedIn(clientId);
DateTime now = ofy().getTransactionTime();
@@ -131,6 +141,12 @@ public final class DomainRenewFlow implements TransactionalFlow {
Registry.get(existingDomain.getTld()), targetId, clientId, now, years, eppInput);
validateFeeChallenge(
targetId, existingDomain.getTld(), now, feeRenew, commandOperations.getTotalCost());
+ customLogic.afterValidation(
+ AfterValidationParameters.newBuilder()
+ .setExistingDomain(existingDomain)
+ .setNow(now)
+ .setYears(years)
+ .build());
HistoryEntry historyEntry = historyBuilder
.setType(HistoryEntry.Type.DOMAIN_RENEW)
.setPeriod(command.getPeriod())
@@ -170,11 +186,37 @@ public final class DomainRenewFlow implements TransactionalFlow {
.setAutorenewPollMessage(Key.create(newAutorenewPollMessage))
.addGracePeriod(GracePeriod.forBillingEvent(GracePeriodStatus.RENEW, explicitRenewEvent))
.build();
- ofy().save().