From d282c35c6455f9da8ec996d2876aa0df59366305 Mon Sep 17 00:00:00 2001 From: sarahcaseybot Date: Mon, 13 Sep 2021 18:02:41 -0400 Subject: [PATCH] Remove "Datastore" from comments when using both DBs (#1310) * Change datastore references in comments to be more generic * Update flows doc --- .../google/registry/dns/writer/DnsWriter.java | 18 +++++++++--------- .../export/SyncGroupMembersAction.java | 3 ++- .../export/sheet/SyncRegistrarsSheet.java | 2 +- .../custom/DomainCreateFlowCustomLogic.java | 8 ++++---- .../custom/DomainDeleteFlowCustomLogic.java | 8 ++++---- .../custom/DomainRenewFlowCustomLogic.java | 8 ++++---- .../custom/DomainUpdateFlowCustomLogic.java | 8 ++++---- .../registry/flows/custom/EntityChanges.java | 2 +- .../domain/token/AllocationTokenFlowUtils.java | 2 +- .../registry/flows/poll/PollRequestFlow.java | 10 +++++----- docs/flows.md | 10 +++++----- 11 files changed, 40 insertions(+), 39 deletions(-) diff --git a/core/src/main/java/google/registry/dns/writer/DnsWriter.java b/core/src/main/java/google/registry/dns/writer/DnsWriter.java index 34da900fe..447c6852b 100644 --- a/core/src/main/java/google/registry/dns/writer/DnsWriter.java +++ b/core/src/main/java/google/registry/dns/writer/DnsWriter.java @@ -31,12 +31,12 @@ package google.registry.dns.writer; public interface DnsWriter { /** - * Loads {@code domainName} from Datastore and publishes its NS/DS records to the DNS server. + * Loads {@code domainName} from the database 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 + *

This must NOT actually perform any action, instead it should stage the action so that it's * performed when {@link #commit()} is called. * * @param domainName the fully qualified domain name, with no trailing dot @@ -44,14 +44,14 @@ public interface DnsWriter { void publishDomain(String domainName); /** - * Loads {@code 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. + * Loads {@code hostName} from the database 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 + *

This must NOT actually perform any action, instead it should stage the action so that it's * performed when {@link #commit()} is called. * * @param hostName the fully qualified host name, with no trailing dot diff --git a/core/src/main/java/google/registry/export/SyncGroupMembersAction.java b/core/src/main/java/google/registry/export/SyncGroupMembersAction.java index fa3e1634a..ad26ee2d0 100644 --- a/core/src/main/java/google/registry/export/SyncGroupMembersAction.java +++ b/core/src/main/java/google/registry/export/SyncGroupMembersAction.java @@ -150,7 +150,8 @@ public final class SyncGroupMembersAction implements Runnable { /** * Parses the results from Google Groups for each registrar, setting the dirty flag to false in - * Datastore for the calls that succeeded and accumulating the errors for the calls that failed. + * the database for the calls that succeeded and accumulating the errors for the calls that + * failed. */ private static List getErrorsAndUpdateFlagsForSuccesses( ImmutableMap> results) { diff --git a/core/src/main/java/google/registry/export/sheet/SyncRegistrarsSheet.java b/core/src/main/java/google/registry/export/sheet/SyncRegistrarsSheet.java index 4a4b567ce..7bffb7886 100644 --- a/core/src/main/java/google/registry/export/sheet/SyncRegistrarsSheet.java +++ b/core/src/main/java/google/registry/export/sheet/SyncRegistrarsSheet.java @@ -47,7 +47,7 @@ import javax.inject.Inject; import org.joda.time.DateTime; /** - * Class for synchronizing all {@link Registrar} Datastore objects to a Google Spreadsheet. + * Class for synchronizing all {@link Registrar} objects to a Google Spreadsheet. * * @see SyncRegistrarsSheetAction */ diff --git a/core/src/main/java/google/registry/flows/custom/DomainCreateFlowCustomLogic.java b/core/src/main/java/google/registry/flows/custom/DomainCreateFlowCustomLogic.java index 3675b63ae..b433b3cdc 100644 --- a/core/src/main/java/google/registry/flows/custom/DomainCreateFlowCustomLogic.java +++ b/core/src/main/java/google/registry/flows/custom/DomainCreateFlowCustomLogic.java @@ -56,10 +56,10 @@ public class DomainCreateFlowCustomLogic extends BaseFlowCustomLogic { /** * 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. + *

It returns the actual entity changes that should be persisted to the database. 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 { diff --git a/core/src/main/java/google/registry/flows/custom/DomainDeleteFlowCustomLogic.java b/core/src/main/java/google/registry/flows/custom/DomainDeleteFlowCustomLogic.java index 70a1b73a6..13c35a625 100644 --- a/core/src/main/java/google/registry/flows/custom/DomainDeleteFlowCustomLogic.java +++ b/core/src/main/java/google/registry/flows/custom/DomainDeleteFlowCustomLogic.java @@ -54,10 +54,10 @@ public class DomainDeleteFlowCustomLogic extends BaseFlowCustomLogic { /** * 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. + *

It returns the actual entity changes that should be persisted to the database. 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 { diff --git a/core/src/main/java/google/registry/flows/custom/DomainRenewFlowCustomLogic.java b/core/src/main/java/google/registry/flows/custom/DomainRenewFlowCustomLogic.java index adf6b1275..9403043ae 100644 --- a/core/src/main/java/google/registry/flows/custom/DomainRenewFlowCustomLogic.java +++ b/core/src/main/java/google/registry/flows/custom/DomainRenewFlowCustomLogic.java @@ -55,10 +55,10 @@ public class DomainRenewFlowCustomLogic extends BaseFlowCustomLogic { /** * 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. + *

It returns the actual entity changes that should be persisted to the database. 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 { diff --git a/core/src/main/java/google/registry/flows/custom/DomainUpdateFlowCustomLogic.java b/core/src/main/java/google/registry/flows/custom/DomainUpdateFlowCustomLogic.java index 92f07b91a..8355ed63f 100644 --- a/core/src/main/java/google/registry/flows/custom/DomainUpdateFlowCustomLogic.java +++ b/core/src/main/java/google/registry/flows/custom/DomainUpdateFlowCustomLogic.java @@ -51,10 +51,10 @@ public class DomainUpdateFlowCustomLogic extends BaseFlowCustomLogic { /** * 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. + *

It returns the actual entity changes that should be persisted to the database. 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 { diff --git a/core/src/main/java/google/registry/flows/custom/EntityChanges.java b/core/src/main/java/google/registry/flows/custom/EntityChanges.java index 263937e50..ea4acaa37 100644 --- a/core/src/main/java/google/registry/flows/custom/EntityChanges.java +++ b/core/src/main/java/google/registry/flows/custom/EntityChanges.java @@ -19,7 +19,7 @@ import com.google.common.collect.ImmutableSet; import google.registry.model.ImmutableObject; import google.registry.persistence.VKey; -/** A wrapper class that encapsulates Datastore entities to both save and delete. */ +/** A wrapper class that encapsulates database entities to both save and delete. */ @AutoValue public abstract class EntityChanges { diff --git a/core/src/main/java/google/registry/flows/domain/token/AllocationTokenFlowUtils.java b/core/src/main/java/google/registry/flows/domain/token/AllocationTokenFlowUtils.java index d302c91c0..e31122a22 100644 --- a/core/src/main/java/google/registry/flows/domain/token/AllocationTokenFlowUtils.java +++ b/core/src/main/java/google/registry/flows/domain/token/AllocationTokenFlowUtils.java @@ -149,7 +149,7 @@ public class AllocationTokenFlowUtils { private AllocationToken loadToken(String token) throws EppException { if (Strings.isNullOrEmpty(token)) { // We load the token directly from the input XML. If it's null or empty we should throw - // an InvalidAllocationTokenException before the Datastore load attempt fails. + // an InvalidAllocationTokenException before the database load attempt fails. // See https://tools.ietf.org/html/draft-ietf-regext-allocation-token-04#section-2.1 throw new InvalidAllocationTokenException(); } diff --git a/core/src/main/java/google/registry/flows/poll/PollRequestFlow.java b/core/src/main/java/google/registry/flows/poll/PollRequestFlow.java index bbe2f8849..1540e26d7 100644 --- a/core/src/main/java/google/registry/flows/poll/PollRequestFlow.java +++ b/core/src/main/java/google/registry/flows/poll/PollRequestFlow.java @@ -39,11 +39,11 @@ import org.joda.time.DateTime; /** * An EPP flow for requesting {@link PollMessage}s. * - *

This flow uses an eventually consistent Datastore query to return the oldest poll message for - * the registrar, as well as the total number of pending messages. Note that poll messages whose - * event time is in the future (i.e. they are speculative and could still be changed or rescinded) - * are ignored. The externally visible id for the poll message that the registrar sees is generated - * by {@link PollMessageExternalKeyConverter}. + *

This flow uses an eventually consistent query to return the oldest poll message for the + * registrar, as well as the total number of pending messages. Note that poll messages whose event + * time is in the future (i.e. they are speculative and could still be changed or rescinded) are + * ignored. The externally visible id for the poll message that the registrar sees is generated by + * {@link PollMessageExternalKeyConverter}. * * @error {@link PollRequestFlow.UnexpectedMessageIdException} */ diff --git a/docs/flows.md b/docs/flows.md index 10daa184a..d5fa52454 100644 --- a/docs/flows.md +++ b/docs/flows.md @@ -972,11 +972,11 @@ as read, and won't be delivered again until the next year of their recurrence. An EPP flow for requesting {@link PollMessage}s. -This flow uses an eventually consistent Datastore query to return the oldest -poll message for the registrar, as well as the total number of pending messages. -Note that poll messages whose event time is in the future (i.e. they are -speculative and could still be changed or rescinded) are ignored. The externally -visible id for the poll message that the registrar sees is generated by {@link +This flow uses an eventually consistent query to return the oldest poll message +for the registrar, as well as the total number of pending messages. Note that +poll messages whose event time is in the future (i.e. they are speculative and +could still be changed or rescinded) are ignored. The externally visible id for +the poll message that the registrar sees is generated by {@link PollMessageExternalKeyConverter}. ### Errors