mirror of
https://github.com/google/nomulus.git
synced 2025-05-09 16:28:21 +02:00
5098b03af4
This change replaces all Ref objects in the code with Key objects. These are
stored in datastore as the same object (raw datastore keys), so this is not
a model change.
Our best practices doc says to use Keys not Refs because:
* The .get() method obscures what's actually going on
- Much harder to visually audit the code for datastore loads
- Hard to distinguish Ref<T> get()'s from Optional get()'s and Supplier get()'s
* Implicit ofy().load() offers much less control
- Antipattern for ultimate goal of making Ofy injectable
- Can't control cache use or batch loading without making ofy() explicit anyway
* Serialization behavior is surprising and could be quite dangerous/incorrect
- Can lead to serialization errors. If it actually worked "as intended",
it would lead to a Ref<> on a serialized object being replaced upon
deserialization with a stale copy of the old value, which could potentially
break all kinds of transactional expectations
* Having both Ref<T> and Key<T> introduces extra boilerplate everywhere
- E.g. helper methods all need to have Ref and Key overloads, or you need to
call .key() to get the Key<T> for every Ref<T> you want to pass in
- Creating a Ref<T> is more cumbersome, since it doesn't have all the create()
overloads that Key<T> has, only create(Key<T>) and create(Entity) - no way to
create directly from kind+ID/name, raw Key, websafe key string, etc.
(Note that Refs are treated specially by Objectify's @Load method and Keys are not;
we don't use that feature, but it is the one advantage Refs have over Keys.)
The direct impetus for this change is that I am trying to audit our use of memcache,
and the implicit .get() calls to datastore were making that very hard.
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=131965491
115 lines
4.5 KiB
Java
115 lines
4.5 KiB
Java
// Copyright 2016 The Domain Registry 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.domain;
|
|
|
|
import static google.registry.model.ofy.ObjectifyService.ofy;
|
|
import static google.registry.util.DateTimeUtils.END_OF_TIME;
|
|
import static google.registry.util.DateTimeUtils.leapSafeAddYears;
|
|
|
|
import com.google.common.collect.ImmutableList;
|
|
import com.google.common.collect.ImmutableSet;
|
|
import com.googlecode.objectify.Key;
|
|
import google.registry.dns.DnsQueue;
|
|
import google.registry.flows.EppException;
|
|
import google.registry.model.billing.BillingEvent;
|
|
import google.registry.model.billing.BillingEvent.Flag;
|
|
import google.registry.model.billing.BillingEvent.Reason;
|
|
import google.registry.model.domain.DomainResource;
|
|
import google.registry.model.domain.DomainResource.Builder;
|
|
import google.registry.model.domain.Period;
|
|
import google.registry.model.eppoutput.CreateData.DomainCreateData;
|
|
import google.registry.model.eppoutput.EppOutput;
|
|
import google.registry.model.eppoutput.Result;
|
|
import google.registry.model.poll.PollMessage;
|
|
import org.joda.time.DateTime;
|
|
|
|
/** An EPP flow that creates or allocates a new domain resource. */
|
|
public abstract class DomainCreateOrAllocateFlow
|
|
extends BaseDomainCreateFlow<DomainResource, Builder> {
|
|
|
|
protected boolean isAnchorTenantViaExtension;
|
|
|
|
@Override
|
|
protected final void initDomainCreateFlow() {
|
|
isAnchorTenantViaExtension =
|
|
(metadataExtension != null && metadataExtension.getIsAnchorTenant());
|
|
initDomainCreateOrAllocateFlow();
|
|
}
|
|
|
|
protected abstract void initDomainCreateOrAllocateFlow();
|
|
|
|
@Override
|
|
protected final void setDomainCreateProperties(Builder builder) throws EppException {
|
|
DateTime registrationExpirationTime = leapSafeAddYears(now, command.getPeriod().getValue());
|
|
// Create a new autorenew billing event and poll message starting at the expiration time.
|
|
BillingEvent.Recurring autorenewEvent = new BillingEvent.Recurring.Builder()
|
|
.setReason(Reason.RENEW)
|
|
.setFlags(ImmutableSet.of(Flag.AUTO_RENEW))
|
|
.setTargetId(targetId)
|
|
.setClientId(getClientId())
|
|
.setEventTime(registrationExpirationTime)
|
|
.setRecurrenceEndTime(END_OF_TIME)
|
|
.setParent(historyEntry)
|
|
.build();
|
|
PollMessage.Autorenew autorenewPollMessage = new PollMessage.Autorenew.Builder()
|
|
.setTargetId(targetId)
|
|
.setClientId(getClientId())
|
|
.setEventTime(registrationExpirationTime)
|
|
.setMsg("Domain was auto-renewed.")
|
|
.setParent(historyEntry)
|
|
.build();
|
|
ofy().save().<Object>entities(autorenewEvent, autorenewPollMessage);
|
|
|
|
builder
|
|
.setRegistrationExpirationTime(registrationExpirationTime)
|
|
.setAutorenewBillingEvent(Key.create(autorenewEvent))
|
|
.setAutorenewPollMessage(Key.create(autorenewPollMessage));
|
|
setDomainCreateOrAllocateProperties(builder);
|
|
}
|
|
|
|
/** Subclasses must override this to set more fields, like any grace period. */
|
|
protected abstract void setDomainCreateOrAllocateProperties(Builder builder) throws EppException;
|
|
|
|
@Override
|
|
protected final void enqueueTasks() {
|
|
if (newResource.shouldPublishToDns()) {
|
|
DnsQueue.create().addDomainRefreshTask(newResource.getFullyQualifiedDomainName());
|
|
}
|
|
enqueueLordnTaskIfNeeded();
|
|
}
|
|
|
|
/** Subclasses must override this to enqueue any additional tasks. */
|
|
protected abstract void enqueueLordnTaskIfNeeded();
|
|
|
|
@Override
|
|
protected final Period getCommandPeriod() {
|
|
return command.getPeriod();
|
|
}
|
|
|
|
@Override
|
|
protected final EppOutput getOutput() {
|
|
return createOutput(
|
|
Result.Code.Success,
|
|
DomainCreateData.create(
|
|
newResource.getFullyQualifiedDomainName(),
|
|
now,
|
|
newResource.getRegistrationExpirationTime()),
|
|
(feeCreate == null) ? null : ImmutableList.of(
|
|
feeCreate.createResponseBuilder()
|
|
.setCurrency(commandOperations.getCurrency())
|
|
.setFees(commandOperations.getFees())
|
|
.build()));
|
|
}
|
|
}
|