mirror of
https://github.com/google/nomulus.git
synced 2025-05-30 17:24:03 +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
73 lines
2.3 KiB
Java
73 lines
2.3 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.model.domain;
|
|
|
|
import com.google.common.annotations.VisibleForTesting;
|
|
import com.googlecode.objectify.Key;
|
|
import com.googlecode.objectify.annotation.Embed;
|
|
import com.googlecode.objectify.annotation.Index;
|
|
import google.registry.model.ImmutableObject;
|
|
import google.registry.model.contact.ContactResource;
|
|
import javax.xml.bind.annotation.XmlAttribute;
|
|
import javax.xml.bind.annotation.XmlEnumValue;
|
|
import javax.xml.bind.annotation.XmlValue;
|
|
|
|
/**
|
|
* XML type for contact identifiers associated with a domain.
|
|
*
|
|
* @see "http://tools.ietf.org/html/rfc5731#section-2.2"
|
|
*/
|
|
@Embed
|
|
public class DesignatedContact extends ImmutableObject {
|
|
|
|
/**
|
|
* XML type for contact types. This can be either: {@code "admin"}, {@code "billing"}, or
|
|
* {@code "tech"} and corresponds to {@code contactAttrType} in {@code domain-1.0.xsd}.
|
|
*/
|
|
public enum Type {
|
|
@XmlEnumValue("admin")
|
|
ADMIN,
|
|
@XmlEnumValue("billing")
|
|
BILLING,
|
|
@XmlEnumValue("tech")
|
|
TECH,
|
|
/** The registrant type is not reflected in XML and exists only for internal use. */
|
|
REGISTRANT;
|
|
}
|
|
|
|
@VisibleForTesting
|
|
public static DesignatedContact create(Type type, Key<ContactResource> contact) {
|
|
DesignatedContact instance = new DesignatedContact();
|
|
instance.type = type;
|
|
instance.contactId = ReferenceUnion.create(contact);
|
|
return instance;
|
|
}
|
|
|
|
@XmlAttribute(required = true)
|
|
Type type;
|
|
|
|
@Index
|
|
@XmlValue
|
|
//TODO(b/28713909): Make this a Key<ContactResource>.
|
|
ReferenceUnion<ContactResource> contactId;
|
|
|
|
public Type getType() {
|
|
return type;
|
|
}
|
|
|
|
public Key<ContactResource> getContactKey() {
|
|
return contactId.getLinked();
|
|
}
|
|
}
|