Package google.registry.model.domain

Class DomainBase

java.lang.Object

google.registry.model.ImmutableObject

google.registry.model.UpdateAutoTimestampEntity

google.registry.model.EppResource

google.registry.model.domain.DomainBase

All Implemented Interfaces:

Buildable, EppResource.ResourceWithTransferData<DomainTransferData>, UnsafeSerializable, Serializable, Cloneable

Direct Known Subclasses:

Domain

@MappedSuperclass
@Embeddable
public class DomainBase
extends EppResource
implements EppResource.ResourceWithTransferData<DomainTransferData>

A persistable domain resource including mutable and non-mutable fields.

This class deliberately does not include an Id so that any foreign-keyed fields can refer to the proper parent entity's ID, whether we're storing this in the DB itself or as part of another entity.

See Also:

• RFC 5731
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DomainBase.Builder<T extends DomainBase,B extends DomainBase.Builder<T,B>>	A builder for constructing Domain, since it is immutable.

Nested classes/interfaces inherited from class google.registry.model.EppResource

EppResource.BuilderWithTransferData<T extends TransferData,B extends EppResource.BuilderWithTransferData<T,B>>, EppResource.ForeignKeyedEppResource, EppResource.ResourceWithTransferData<T extends TransferData>

Nested classes/interfaces inherited from class google.registry.model.ImmutableObject

ImmutableObject.DoNotHydrate, ImmutableObject.IgnoredInDiffableMap, ImmutableObject.Insignificant

Nested classes/interfaces inherited from interface google.registry.model.Buildable

Buildable.GenericBuilder<S,B extends Buildable.GenericBuilder<?,?>>, Buildable.Overlayable<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_REGISTRATION_YEARS	The max number of years that a domain can be registered for, as set by ICANN policy.

Fields inherited from class google.registry.model.ImmutableObject

hashCode

Constructor Summary

Constructors

Constructor	Description
DomainBase()

Method Summary

Modifier and Type	Method	Description
DomainBase.Builder<? extends DomainBase,?>	asBuilder()	An override of EppResource.asBuilder() with tighter typing.
DomainBase	cloneProjectedAtTime(org.joda.time.DateTime now)	Return a clone of the resource with timed status values modified using the given time.
VKey<Domain>	createVKey()	Create the VKey for the specified EPP resource.
static org.joda.time.DateTime	extendRegistrationWithCap(org.joda.time.DateTime now, org.joda.time.DateTime currentExpirationTime, Integer extendedRegistrationYears)	Return what the expiration time would be if the given number of years were added to it.
Optional<VKey<Contact>>	getAdminContact()
com.google.common.collect.ImmutableSet<DesignatedContact>	getAllContacts()	Gets all associated contacts for the domain, including the registrant.
DomainAuthInfo	getAuthInfo()
VKey<BillingRecurrence>	getAutorenewBillingEvent()
Optional<org.joda.time.DateTime>	getAutorenewEndTime()	Returns the autorenew end time if there is one, otherwise empty.
VKey<PollMessage.Autorenew>	getAutorenewPollMessage()
Optional<VKey<Contact>>	getBillingContact()
com.google.common.collect.ImmutableSet<DesignatedContact>	getContacts()	Associated contacts for the domain (other than registrant).
Optional<VKey<AllocationToken>>	getCurrentBulkToken()
final String	getCurrentSponsorRegistrarId()
VKey<PollMessage.OneTime>	getDeletePollMessage()
String	getDomainName()
com.google.common.collect.ImmutableSet<DomainDsData>	getDsData()
String	getForeignKey()	Get the foreign key string for this resource.
com.google.common.collect.ImmutableSet<GracePeriod>	getGracePeriods()
com.google.common.collect.ImmutableSet<GracePeriod>	getGracePeriodsOfType(GracePeriodStatus gracePeriodType)	Returns the subset of grace periods having the specified type.
com.google.common.collect.ImmutableSet<GracePeriodStatus>	getGracePeriodStatuses()	Returns the Registry Grace Period Statuses for this domain.
String	getIdnTableName()
org.joda.time.DateTime	getLastTransferTime()	The time that this resource was last transferred.
LaunchNotice	getLaunchNotice()
LordnTaskUtils.LordnPhase	getLordnPhase()
com.google.common.collect.ImmutableSet<VKey<Host>>	getNameservers()
com.google.common.collect.ImmutableSet<VKey<Contact>>	getReferencedContacts()	Returns all referenced contacts from this domain.
Optional<VKey<Contact>>	getRegistrant()	A key to the registrant who registered this domain.
org.joda.time.DateTime	getRegistrationExpirationTime()
String	getSmdId()
com.google.common.collect.ImmutableSet<String>	getSubordinateHosts()
Optional<VKey<Contact>>	getTechContact()
String	getTld()
DomainTransferData	getTransferData()
com.google.common.collect.ImmutableSortedSet<String>	loadNameserverHostNames()	Loads and returns the fully qualified host names of all linked nameservers.
boolean	shouldPublishToDns()	Returns true if DNS information should be published for the given domain.

Methods inherited from class google.registry.model.EppResource

getCreationRegistrarId, getCreationTime, getDeletionTime, getLastEppUpdateRegistrarId, getLastEppUpdateTime, getPersistedCurrentSponsorRegistrarId, getRepoId, getStatusValues, loadByCache, loadByCacheIfEnabled, setCacheForTest, setRepoId

Methods inherited from class google.registry.model.UpdateAutoTimestampEntity

copyUpdateTimestamp, getUpdateTimestamp, resetUpdateTimestamp, setUpdateTimestamp

Methods inherited from class google.registry.model.ImmutableObject

clone, cloneEmptyToNull, equals, getSignificantFields, hashCode, toDiffableFieldMap, toHydratedString, toString, toStringHelper

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

MAX_REGISTRATION_YEARS

public static final int MAX_REGISTRATION_YEARS

The max number of years that a domain can be registered for, as set by ICANN policy.

See Also:

• Constant Field Values

Constructor Details

DomainBase

public DomainBase()

Method Details

getLordnPhase

public LordnTaskUtils.LordnPhase getLordnPhase()

getSubordinateHosts

public com.google.common.collect.ImmutableSet<String> getSubordinateHosts()

getRegistrationExpirationTime

public org.joda.time.DateTime getRegistrationExpirationTime()

getDeletePollMessage

public VKey<PollMessage.OneTime> getDeletePollMessage()

getAutorenewBillingEvent

public VKey<BillingRecurrence> getAutorenewBillingEvent()

getAutorenewPollMessage

public VKey<PollMessage.Autorenew> getAutorenewPollMessage()

getGracePeriods

public com.google.common.collect.ImmutableSet<GracePeriod> getGracePeriods()

getSmdId

public String getSmdId()

getCurrentBulkToken

public Optional<VKey<AllocationToken>> getCurrentBulkToken()

getAutorenewEndTime

public Optional<org.joda.time.DateTime> getAutorenewEndTime()

Returns the autorenew end time if there is one, otherwise empty.

Note that DateTimeUtils.END_OF_TIME is used as a sentinel value in the database representation to signify that autorenew doesn't end, and is mapped to empty here for the purposes of more legible business logic.

getTransferData

public DomainTransferData getTransferData()

Specified by:

getTransferData in interface EppResource.ResourceWithTransferData<DomainTransferData>

getLastTransferTime

public org.joda.time.DateTime getLastTransferTime()

Description copied from interface: EppResource.ResourceWithTransferData

The time that this resource was last transferred.

Can be null if the resource has never been transferred.

Specified by:

getLastTransferTime in interface EppResource.ResourceWithTransferData<DomainTransferData>

getForeignKey

public String getForeignKey()

Description copied from class: EppResource

Get the foreign key string for this resource.

Specified by:

getForeignKey in class EppResource

getDomainName

public String getDomainName()

getDsData

public com.google.common.collect.ImmutableSet<DomainDsData> getDsData()

getLaunchNotice

public LaunchNotice getLaunchNotice()

getIdnTableName

public String getIdnTableName()

getNameservers

public com.google.common.collect.ImmutableSet<VKey<Host>> getNameservers()

getCurrentSponsorRegistrarId

public final String getCurrentSponsorRegistrarId()

shouldPublishToDns

public boolean shouldPublishToDns()

Returns true if DNS information should be published for the given domain.

getGracePeriodStatuses

public com.google.common.collect.ImmutableSet<GracePeriodStatus> getGracePeriodStatuses()

Returns the Registry Grace Period Statuses for this domain.

This collects all statuses from the domain's GracePeriod entries and also adds the PENDING_DELETE status if needed.

getGracePeriodsOfType

public com.google.common.collect.ImmutableSet<GracePeriod> getGracePeriodsOfType(GracePeriodStatus gracePeriodType)

Returns the subset of grace periods having the specified type.

cloneProjectedAtTime

public DomainBase cloneProjectedAtTime(org.joda.time.DateTime now)

Description copied from class: EppResource

Return a clone of the resource with timed status values modified using the given time.

Specified by:

cloneProjectedAtTime in class EppResource

extendRegistrationWithCap

public static org.joda.time.DateTime extendRegistrationWithCap(org.joda.time.DateTime now,
 org.joda.time.DateTime currentExpirationTime,
 @Nullable
 Integer extendedRegistrationYears)

Return what the expiration time would be if the given number of years were added to it.

loadNameserverHostNames

public com.google.common.collect.ImmutableSortedSet<String> loadNameserverHostNames()

Loads and returns the fully qualified host names of all linked nameservers.

getRegistrant

public Optional<VKey<Contact>> getRegistrant()

A key to the registrant who registered this domain.

getAdminContact

public Optional<VKey<Contact>> getAdminContact()

getBillingContact

public Optional<VKey<Contact>> getBillingContact()

getTechContact

public Optional<VKey<Contact>> getTechContact()

getContacts

public com.google.common.collect.ImmutableSet<DesignatedContact> getContacts()

Associated contacts for the domain (other than registrant).

Note: This can be an empty set if no contacts are present for the domain.

getAllContacts

public com.google.common.collect.ImmutableSet<DesignatedContact> getAllContacts()

Gets all associated contacts for the domain, including the registrant.

Note: This can be an empty set if no contacts are present for the domain.

getAuthInfo

@Nullable
public DomainAuthInfo getAuthInfo()

getReferencedContacts

public com.google.common.collect.ImmutableSet<VKey<Contact>> getReferencedContacts()

Returns all referenced contacts from this domain.

Note: This can be an empty set if no contacts are present for the domain.

getTld

public String getTld()

createVKey

public VKey<Domain> createVKey()

Description copied from class: EppResource

Create the VKey for the specified EPP resource.

Specified by:

createVKey in class EppResource

asBuilder

public DomainBase.Builder<? extends DomainBase,?> asBuilder()

An override of EppResource.asBuilder() with tighter typing.

Specified by:

asBuilder in interface Buildable

Specified by:

asBuilder in class EppResource