Package google.registry.model.registrar

Class Registrar

    • Field Detail

      • PHONE_PASSCODE_PATTERN

        public static final com.google.re2j.Pattern PHONE_PASSCODE_PATTERN
        Regex for telephone support passcode (5 digit string).

    • Constructor Detail

      • Registrar

        public Registrar()

    • Method Detail

      • getRegistrarId

        public java.lang.String getRegistrarId()

      • getCreationTime

        public org.joda.time.DateTime getCreationTime()

      • getIanaIdentifier

        @Nullable
public java.lang.Long getIanaIdentifier()

      • getPoNumber

        public java.util.Optional<java.lang.String> getPoNumber()

      • getBillingAccountMap

        public com.google.common.collect.ImmutableSortedMap<org.joda.money.CurrencyUnit,​java.lang.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

        public java.lang.String getRegistrarName()

      • getAllowedTlds

        public com.google.common.collect.ImmutableSortedSet<java.lang.String> getAllowedTlds()

      • isLive

        public boolean isLive()
        Returns true 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()
        Returns true if registrar should be visible in WHOIS results.

      • getClientCertificate

        public java.util.Optional<java.lang.String> getClientCertificate()
        Returns the client certificate string if it has been set, or empty otherwise.

      • getClientCertificateHash

        public java.util.Optional<java.lang.String> getClientCertificateHash()
        Returns the client certificate hash if it has been set, or empty otherwise.

      • getFailoverClientCertificate

        public java.util.Optional<java.lang.String> getFailoverClientCertificate()
        Returns the failover client certificate string if it has been set, or empty otherwise.

      • getFailoverClientCertificateHash

        public java.util.Optional<java.lang.String> getFailoverClientCertificateHash()
        Returns the failover client certificate hash if it has been set, or empty otherwise.

      • getIpAddressAllowList

        public com.google.common.collect.ImmutableList<CidrAddressBlock> getIpAddressAllowList()

      • getInternationalizedAddress

        public RegistrarAddress getInternationalizedAddress()

      • getPhoneNumber

        public java.lang.String getPhoneNumber()

      • getFaxNumber

        public java.lang.String getFaxNumber()

      • getEmailAddress

        public java.lang.String getEmailAddress()

      • getWhoisServer

        public java.lang.String getWhoisServer()

      • getRdapBaseUrls

        public com.google.common.collect.ImmutableSet<java.lang.String> getRdapBaseUrls()

      • getBlockPremiumNames

        public boolean getBlockPremiumNames()

      • getContactsRequireSyncing

        public boolean getContactsRequireSyncing()

      • isRegistryLockAllowed

        public boolean isRegistryLockAllowed()

      • getUrl

        public java.lang.String getUrl()

      • getIcannReferralEmail

        public java.lang.String getIcannReferralEmail()

      • getDriveFolderId

        public java.lang.String getDriveFolderId()

      • getContacts

        public com.google.common.collect.ImmutableSortedSet<RegistrarPoc> getContacts()
        Returns a list of all RegistrarPoc objects for this registrar sorted by their email address.

      • getContactsOfType

        public com.google.common.collect.ImmutableSortedSet<RegistrarPoc> getContactsOfType​(RegistrarPoc.Type type)
        Returns a list of RegistrarPoc objects of a given type for this registrar sorted by their email address.

      • getWhoisAbuseContact

        public java.util.Optional<RegistrarPoc> getWhoisAbuseContact()
        Returns the RegistrarPoc that is the WHOIS abuse contact for this registrar, or empty if one does not exist.

      • toJsonMap

        public java.util.Map<java.lang.String,​java.lang.Object> 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 interface Jsonifiable

      • verifyPassword

        public boolean verifyPassword​(java.lang.String password)

      • getPhonePasscode

        public java.lang.String getPhonePasscode()

      • createVKey

        public static VKey<Registrar> createVKey​(java.lang.String registrarId)
        Creates a VKey for the given registrarId.

      • checkValidEmail

        public static java.lang.String checkValidEmail​(java.lang.String email)
        Verifies that the email address in question is not null and has a valid format.

      • loadAll

        public static java.lang.Iterable<Registrar> loadAll()
        Loads all registrar entities directly from the database.

      • loadAllCached

        public static java.lang.Iterable<Registrar> loadAllCached()
        Loads all registrar entities using an in-memory cache.

      • loadAllKeysCached

        public static com.google.common.collect.ImmutableSet<VKey<Registrar>> loadAllKeysCached()
        Loads all registrar keys using an in-memory cache.

      • loadByRegistrarId

        public static java.util.Optional<Registrar> loadByRegistrarId​(java.lang.String registrarId)
        Loads and returns a registrar entity by its id directly from the database.

      • loadByRegistrarIdCached

        public static java.util.Optional<Registrar> loadByRegistrarIdCached​(java.lang.String registrarId)
        Loads and returns a registrar entity by its id using an in-memory cache.

        Returns empty if the registrar isn't found.

      • loadRequiredRegistrarCached

        public static Registrar loadRequiredRegistrarCached​(java.lang.String registrarId)
        Loads and returns a registrar entity by its id using an in-memory cache.

        Throws if the registrar isn't found.