zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-05-20 19:29:35 +02:00
Code Issues Projects Releases Packages Wiki Activity

Fix stale documentation on {ForeignKeyed,}DesignatedContact

Browse source 
Noticed that this is a bit out-out-date ever since these were
split into two types versus using the converters.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=150352102
This commit is contained in:
nickfelt 2017-03-16 12:18:10 -07:00 • committed by Ben McIlwain
parent 2d3e77ebee
commit bd6a2d02dd
2 changed files with 16 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

15
java/google/registry/model/domain/DesignatedContact.java
View file

@ -20,14 +20,22 @@ import com.googlecode.objectify.annotation.Embed;
import com.googlecode.objectify.annotation.Index; import com.googlecode.objectify.annotation.Index;
import google.registry.model.ImmutableObject; import google.registry.model.ImmutableObject;
import google.registry.model.contact.ContactResource; import google.registry.model.contact.ContactResource;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlEnumValue; import javax.xml.bind.annotation.XmlEnumValue;
/** /**
* XML type for contact identifiers associated with a domain. * Persisted type for storing a domain's contact associations.
*
* <p>A contact association on a domain consists of the contact key and the contact "type", which is
* the designated role of this contact with respect to this domain. When converting to and from
* EPP XML, we use {@link ForeignKeyedDesignatedContact} to replace the contact's Datastore key
* with its foreign key, since that is what EPP exposes.
*
* <p>Note one could in principle store contact foreign keys here in addition to keys, unlike the
* situation with hosts where client-side renames would make that data stale. However, we sometimes
* rename contacts internally ourselves, and it's easier to use the same model for both cases.
* *
* @see <a href="http://tools.ietf.org/html/rfc5731#section-2.2"> * @see <a href="http://tools.ietf.org/html/rfc5731#section-2.2">
* RFC 5731 - EPP Domain Name Mapping- Contact and Client Identifiers</a> * RFC 5731 - EPP Domain Name Mapping - Contact and Client Identifiers</a>
*/ */
@Embed @Embed
public class DesignatedContact extends ImmutableObject { public class DesignatedContact extends ImmutableObject {
@ -55,7 +63,6 @@ public class DesignatedContact extends ImmutableObject {
return instance; return instance;
} }
@XmlAttribute(required = true)
Type type; Type type;
@Index @Index

7
java/google/registry/model/domain/ForeignKeyedDesignatedContact.java
View file

@ -19,8 +19,11 @@ import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlValue; import javax.xml.bind.annotation.XmlValue;
/** /**
* EPP-compatible version of XML type for contact identifiers associated with a domain, which can * EPP-XML-serializable equivalent of {@link DesignatedContact}.
* be converted to a storable {@link DesignatedContact}. *
* <p>This type is used on the wire for EPP XML, where only the contact ID (foreign key) is exposed.
* This is converted to and from the persisted type, {@link DesignatedContact}, which stores the
* Datastore key instead of the foreign key.
* *
* @see <a href="http://tools.ietf.org/html/rfc5731#section-2.2"> * @see <a href="http://tools.ietf.org/html/rfc5731#section-2.2">
* RFC 5731 - EPP Domain Name Mapping - Contact and Client Identifiers</a> * RFC 5731 - EPP Domain Name Mapping - Contact and Client Identifiers</a>