Extend this class and override the hook(s) to perform custom logic. + */ +public class DomainDeleteFlowCustomLogic extends BaseFlowCustomLogic { + + protected DomainDeleteFlowCustomLogic(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 Result.Code} and {@link ResponseExtension}s as input and returns + * them, potentially with modifications. + */ + + @SuppressWarnings("unused") + public BeforeResponseReturnData beforeResponse(BeforeResponseParameters parameters) + throws EppException { + return BeforeResponseReturnData.newBuilder() + .setResultCode(parameters.resultCode()) + .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 static Builder newBuilder() { + return new AutoValue_DomainDeleteFlowCustomLogic_AfterValidationParameters.Builder(); + } + + /** Builder for {@link AfterValidationParameters}. */ + @AutoValue.Builder + public abstract static class Builder { + + public abstract Builder setExistingDomain(DomainResource existingDomain); + + 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 static Builder newBuilder() {
+ return new AutoValue_DomainDeleteFlowCustomLogic_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 BeforeSaveParameters build();
+ }
+ }
+ /** A class to encapsulate parameters for a call to {@link #beforeResponse}. */
+ @AutoValue
+ public abstract static class BeforeResponseParameters extends ImmutableObject {
+
+ public abstract Result.Code resultCode();
+
+ public abstract ImmutableList responseExtensions();
+
+ public static Builder newBuilder() {
+ return new AutoValue_DomainDeleteFlowCustomLogic_BeforeResponseParameters.Builder();
+ }
+
+ /** Builder for {@link BeforeResponseParameters}. */
+ @AutoValue.Builder
+ public abstract static class Builder {
+
+ public abstract Builder setResultCode(Result.Code resultCode);
+
+ public abstract 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 Result.Code resultCode();
+
+ public abstract ImmutableList responseExtensions();
+
+ public static Builder newBuilder() {
+ return new AutoValue_DomainDeleteFlowCustomLogic_BeforeResponseReturnData.Builder();
+ }
+
+ /** Builder for {@link BeforeResponseReturnData}. */
+ @AutoValue.Builder
+ public abstract static class Builder {
+
+ public abstract Builder setResultCode(Result.Code resultCode);
+
+ public abstract Builder setResponseExtensions(
+ ImmutableList responseExtensions);
+
+ public abstract BeforeResponseReturnData build();
+ }
+ }
+}
diff --git a/java/google/registry/flows/domain/DomainDeleteFlow.java b/java/google/registry/flows/domain/DomainDeleteFlow.java
index 755312ffc..bf4316f9c 100644
--- a/java/google/registry/flows/domain/DomainDeleteFlow.java
+++ b/java/google/registry/flows/domain/DomainDeleteFlow.java
@@ -15,6 +15,7 @@
package google.registry.flows.domain;
import static com.google.common.base.Preconditions.checkNotNull;
+import static google.registry.flows.FlowUtils.persistEntityChanges;
import static google.registry.flows.FlowUtils.validateClientIsLoggedIn;
import static google.registry.flows.ResourceFlowUtils.handlePendingTransferOnDelete;
import static google.registry.flows.ResourceFlowUtils.loadAndVerifyExistence;
@@ -45,6 +46,12 @@ import google.registry.flows.FlowModule.TargetId;
import google.registry.flows.ResourceFlowUtils;
import google.registry.flows.SessionMetadata;
import google.registry.flows.TransactionalFlow;
+import google.registry.flows.custom.DomainDeleteFlowCustomLogic;
+import google.registry.flows.custom.DomainDeleteFlowCustomLogic.AfterValidationParameters;
+import google.registry.flows.custom.DomainDeleteFlowCustomLogic.BeforeResponseParameters;
+import google.registry.flows.custom.DomainDeleteFlowCustomLogic.BeforeResponseReturnData;
+import google.registry.flows.custom.DomainDeleteFlowCustomLogic.BeforeSaveParameters;
+import google.registry.flows.custom.EntityChanges;
import google.registry.model.ImmutableObject;
import google.registry.model.billing.BillingEvent;
import google.registry.model.domain.DomainResource;
@@ -106,11 +113,13 @@ public final class DomainDeleteFlow implements TransactionalFlow {
@Inject DnsQueue dnsQueue;
@Inject Trid trid;
@Inject EppResponse.Builder responseBuilder;
+ @Inject DomainDeleteFlowCustomLogic customLogic;
@Inject DomainDeleteFlow() {}
@Override
public final EppResponse run() throws EppException {
extensionManager.register(MetadataExtension.class, SecDnsCreateExtension.class);
+ customLogic.beforeValidation();
extensionManager.validate();
validateClientIsLoggedIn(clientId);
DateTime now = ofy().getTransactionTime();
@@ -118,6 +127,9 @@ public final class DomainDeleteFlow implements TransactionalFlow {
DomainResource existingDomain = loadAndVerifyExistence(DomainResource.class, targetId, now);
Registry registry = Registry.get(existingDomain.getTld());
verifyDeleteAllowed(existingDomain, registry, now);
+ customLogic.afterValidation(
+ AfterValidationParameters.newBuilder().setExistingDomain(existingDomain).build());
+ ImmutableSet.Builder