Class RegistrarBase
- All Implemented Interfaces:
Buildable
,Jsonifiable
,UnsafeSerializable
,Serializable
,Cloneable
- Direct Known Subclasses:
Registrar
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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
RegistrarBase.Builder<T extends RegistrarBase,
B extends RegistrarBase.Builder<T, B>> A builder for constructingRegistrar
, since it is immutable.static enum
Represents the state of a persisted registrar entity.static enum
Represents the type of registrar entity.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
Modifier and TypeFieldDescriptionstatic final com.google.re2j.Pattern
Regex for telephone support passcode (5 digit string).Fields inherited from class google.registry.model.ImmutableObject
hashCode
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionRegistrarBase.Builder
<? extends RegistrarBase, ?> static String
checkValidEmail
(String email) Verifies that the email address in question is not null and has a valid format.createVKey
(String registrarId) Creates aVKey
for the givenregistrarId
.com.google.common.collect.ImmutableSortedSet
<String> com.google.common.collect.ImmutableSortedMap
<org.joda.money.CurrencyUnit, String> boolean
Returns the client certificate string if it has been set, or empty otherwise.Returns the client certificate hash if it has been set, or empty otherwise.com.google.common.collect.ImmutableSortedSet
<RegistrarPoc> Returns a list of allRegistrarPoc
objects for this registrar sorted by their email address.com.google.common.collect.ImmutableSortedSet
<RegistrarPoc> Returns a list ofRegistrarPoc
objects of a given type for this registrar sorted by their email address.boolean
org.joda.time.DateTime
Returns the failover client certificate string if it has been set, or empty otherwise.Returns the failover client certificate hash if it has been set, or empty otherwise.com.google.common.collect.ImmutableList
<CidrAddressBlock> org.joda.time.DateTime
org.joda.time.DateTime
org.joda.time.DateTime
org.joda.time.DateTime
com.google.common.collect.ImmutableSet
<String> getState()
getType()
getUrl()
Returns theRegistrarPoc
that is the WHOIS abuse contact for this registrar, or empty if one does not exist.boolean
isLive()
Returnstrue
if the registrar is live.boolean
Returnstrue
if registrar should be visible in WHOIS results.boolean
loadAll()
Loads all registrar entities directly from the database.Loads all registrar entities using an in-memory cache.Loads all registrar keys using an in-memory cache.loadByRegistrarId
(String registrarId) Loads and returns a registrar entity by its id directly from the database.loadByRegistrarIdCached
(String registrarId) Loads and returns a registrar entity by its id using an in-memory cache.static Registrar
loadRequiredRegistrarCached
(String registrarId) Loads and returns a registrar entity by its id using an in-memory cache.void
setRegistrarId
(String registrarId) Sets the registrar ID.Returns a JSON representation of this object.boolean
verifyPassword
(String password) 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
-
Field Details
-
PHONE_PASSCODE_PATTERN
public static final com.google.re2j.Pattern PHONE_PASSCODE_PATTERNRegex for telephone support passcode (5 digit string).
-
-
Constructor Details
-
RegistrarBase
public RegistrarBase()
-
-
Method Details
-
getRegistrarId
-
getCreationTime
public org.joda.time.DateTime getCreationTime() -
getIanaIdentifier
-
getPoNumber
-
getBillingAccountMap
public com.google.common.collect.ImmutableSortedMap<org.joda.money.CurrencyUnit,String> getBillingAccountMap() -
getLastUpdateTime
public org.joda.time.DateTime getLastUpdateTime() -
getLastCertificateUpdateTime
public org.joda.time.DateTime getLastCertificateUpdateTime() -
getLastExpiringCertNotificationSentDate
public org.joda.time.DateTime getLastExpiringCertNotificationSentDate() -
getLastExpiringFailoverCertNotificationSentDate
public org.joda.time.DateTime getLastExpiringFailoverCertNotificationSentDate() -
getRegistrarName
-
getType
-
getState
-
getAllowedTlds
-
isLive
public boolean isLive()Returnstrue
if the registrar is live.A live registrar is one that can have live domains/contacts/hosts in the registry, meaning that it is either currently active or used to be active (i.e. suspended).
-
isLiveAndPubliclyVisible
public boolean isLiveAndPubliclyVisible()Returnstrue
if registrar should be visible in WHOIS results. -
getClientCertificate
Returns the client certificate string if it has been set, or empty otherwise. -
getClientCertificateHash
Returns the client certificate hash if it has been set, or empty otherwise. -
getFailoverClientCertificate
Returns the failover client certificate string if it has been set, or empty otherwise. -
getFailoverClientCertificateHash
Returns the failover client certificate hash if it has been set, or empty otherwise. -
getIpAddressAllowList
-
getLocalizedAddress
-
getInternationalizedAddress
-
getPhoneNumber
-
getFaxNumber
-
getEmailAddress
-
getWhoisServer
-
getRdapBaseUrls
-
getBlockPremiumNames
public boolean getBlockPremiumNames() -
getContactsRequireSyncing
public boolean getContactsRequireSyncing() -
isRegistryLockAllowed
public boolean isRegistryLockAllowed() -
getUrl
-
getIcannReferralEmail
-
getDriveFolderId
-
getContacts
Returns a list of allRegistrarPoc
objects for this registrar sorted by their email address. -
getContactsOfType
public com.google.common.collect.ImmutableSortedSet<RegistrarPoc> getContactsOfType(RegistrarPocBase.Type type) Returns a list ofRegistrarPoc
objects of a given type for this registrar sorted by their email address. -
getWhoisAbuseContact
Returns theRegistrarPoc
that is the WHOIS abuse contact for this registrar, or empty if one does not exist. -
toJsonMap
Description copied from interface:Jsonifiable
Returns a JSON representation of this object.The returned value must not return sensitive fields, so that it may be safe to return to the client via an API response.
- Specified by:
toJsonMap
in interfaceJsonifiable
-
verifyPassword
-
getPhonePasscode
-
setRegistrarId
Sets the registrar ID.This should only be used for restoring the registrar ID of an object being loaded in a PostLoad method (effectively, when it is still under construction by Hibernate). In all other cases, the object should be regarded as immutable and changes should go through a Builder.
In addition to this special case use, this method must exist to satisfy Hibernate.
-
asBuilder
-
createVKey
- Overrides:
createVKey
in classImmutableObject
-
createVKey
Creates aVKey
for the givenregistrarId
. -
checkValidEmail
Verifies that the email address in question is not null and has a valid format. -
loadAll
Loads all registrar entities directly from the database. -
loadAllCached
Loads all registrar entities using an in-memory cache. -
loadAllKeysCached
Loads all registrar keys using an in-memory cache. -
loadByRegistrarId
Loads and returns a registrar entity by its id directly from the database. -
loadByRegistrarIdCached
Loads and returns a registrar entity by its id using an in-memory cache.Returns empty if the registrar isn't found.
-
loadRequiredRegistrarCached
Loads and returns a registrar entity by its id using an in-memory cache.Throws if the registrar isn't found.
-