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, java.io.Serializable, java.lang.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 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

All Methods Static Methods Instance Methods Concrete Methods
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, java.lang.Integer extendedRegistrationYears)`	Return what the expiration time would be if the given number of years were added to it.
`VKey<Contact>`	`getAdminContact()`
`DomainAuthInfo`	`getAuthInfo()`
`VKey<BillingRecurrence>`	`getAutorenewBillingEvent()`
`java.util.Optional<org.joda.time.DateTime>`	`getAutorenewEndTime()`	Returns the autorenew end time if there is one, otherwise empty.
`VKey<PollMessage.Autorenew>`	`getAutorenewPollMessage()`
`VKey<Contact>`	`getBillingContact()`
`com.google.common.collect.ImmutableSet<DesignatedContact>`	`getContacts()`	Associated contacts for the domain (other than registrant).
`java.util.Optional<VKey<AllocationToken>>`	`getCurrentBulkToken()`
`java.lang.String`	`getCurrentSponsorRegistrarId()`
`VKey<PollMessage.OneTime>`	`getDeletePollMessage()`
`java.lang.String`	`getDomainName()`
`com.google.common.collect.ImmutableSet<DomainDsData>`	`getDsData()`
`java.lang.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.
`java.lang.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.
`VKey<Contact>`	`getRegistrant()`	A key to the registrant who registered this domain.
`org.joda.time.DateTime`	`getRegistrationExpirationTime()`
`java.lang.String`	`getSmdId()`
`com.google.common.collect.ImmutableSet<java.lang.String>`	`getSubordinateHosts()`
`VKey<Contact>`	`getTechContact()`
`java.lang.String`	`getTld()`
`DomainTransferData`	`getTransferData()`
`com.google.common.collect.ImmutableSortedSet<java.lang.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, loadCached, loadCached, 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 Detail
  - 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 Detail
  - DomainBase
```
public DomainBase()
```
- Method Detail
  - getLordnPhase
```
public LordnTaskUtils.LordnPhase getLordnPhase()
```
  - getSubordinateHosts
```
public com.google.common.collect.ImmutableSet<java.lang.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 java.lang.String getSmdId()
```
  - getCurrentBulkToken
```
public java.util.Optional<VKey<AllocationToken>> getCurrentBulkToken()
```
  - getAutorenewEndTime
```
public java.util.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 java.lang.String getForeignKey()
```
    Description copied from class: EppResource
    
    Get the foreign key string for this resource.
    
    Specified by:
    
    getForeignKey in class EppResource
  - getDomainName
```
public java.lang.String getDomainName()
```
  - getDsData
```
public com.google.common.collect.ImmutableSet<DomainDsData> getDsData()
```
  - getLaunchNotice
```
public LaunchNotice getLaunchNotice()
```
  - getIdnTableName
```
public java.lang.String getIdnTableName()
```
  - getNameservers
```
public com.google.common.collect.ImmutableSet<VKey<Host>> getNameservers()
```
  - getCurrentSponsorRegistrarId
```
public final java.lang.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
                                                               java.lang.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<java.lang.String> loadNameserverHostNames()
```
    Loads and returns the fully qualified host names of all linked nameservers.
  - getRegistrant
```
public VKey<Contact> getRegistrant()
```
    A key to the registrant who registered this domain.
  - getAdminContact
```
public VKey<Contact> getAdminContact()
```
  - getBillingContact
```
public VKey<Contact> getBillingContact()
```
  - getTechContact
```
public VKey<Contact> getTechContact()
```
  - getContacts
```
public com.google.common.collect.ImmutableSet<DesignatedContact> getContacts()
```
    Associated contacts for the domain (other than registrant).
  - getAuthInfo
```
public DomainAuthInfo getAuthInfo()
```
  - getReferencedContacts
```
public com.google.common.collect.ImmutableSet<VKey<Contact>> getReferencedContacts()
```
    Returns all referenced contacts from this domain.
  - getTld
```
public java.lang.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

Class DomainBase

Nested Class Summary

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

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

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

Field Summary

Fields inherited from class google.registry.model.ImmutableObject

Constructor Summary

Method Summary

Methods inherited from class google.registry.model.EppResource

Methods inherited from class google.registry.model.UpdateAutoTimestampEntity

Methods inherited from class google.registry.model.ImmutableObject

Methods inherited from class java.lang.Object

Field Detail

MAX_REGISTRATION_YEARS

Constructor Detail

DomainBase

Method Detail

getLordnPhase

getSubordinateHosts

getRegistrationExpirationTime

getDeletePollMessage

getAutorenewBillingEvent

getAutorenewPollMessage

getGracePeriods

getSmdId

getCurrentBulkToken

getAutorenewEndTime

getTransferData

getLastTransferTime

getForeignKey

getDomainName

getDsData

getLaunchNotice

getIdnTableName

getNameservers

getCurrentSponsorRegistrarId

shouldPublishToDns

getGracePeriodStatuses

getGracePeriodsOfType

cloneProjectedAtTime

extendRegistrationWithCap

loadNameserverHostNames

getRegistrant

getAdminContact

getBillingContact

getTechContact

getContacts

getAuthInfo

getReferencedContacts

getTld

createVKey

asBuilder