Package google.registry.model.poll

Class PollMessage

java.lang.Object

google.registry.model.ImmutableObject

google.registry.model.poll.PollMessage

All Implemented Interfaces:

Buildable, TransferData.TransferServerApproveEntity, UnsafeSerializable, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

PollMessage.Autorenew, PollMessage.OneTime

@Entity
public abstract class PollMessage
extends ImmutableObject
implements Buildable, TransferData.TransferServerApproveEntity, UnsafeSerializable

A poll message that is pending for a registrar.

Poll messages are not delivered until their eventTime has passed. Poll messages can be speculatively enqueued for future delivery, and then modified or deleted before that date has passed. Unlike most other entities in Datastore, which are marked as deleted but otherwise retained for historical purposes, poll messages are truly deleted once they have been delivered and ACKed.

Poll messages have a reference to the revision id of the HistoryEntry that resulted in their creation or re-creation, in case of transfer cancellation/rejection. The revision ids are not used directly by the Java code, but their presence in the database makes it easier to diagnose potential issues related to poll messages.

Poll messages are identified externally by registrars using the format defined in PollMessageExternalKeyConverter.

See Also:

RFC5730 - EPP - <poll> Command, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PollMessage.Autorenew	An autorenew poll message which recurs annually.
static class	PollMessage.Builder<T extends PollMessage,B extends PollMessage.Builder<?,?>>	Builder for PollMessage because it is immutable.
static class	PollMessage.OneTime	A one-time poll message.
static class	PollMessage.Type	Indicates the type of entity the poll message is for.

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

ImmutableObject.DoNotHydrate, ImmutableObject.EmptySetToNull, 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 inherited from class google.registry.model.ImmutableObject

hashCode

Constructor Summary

Constructors

Constructor	Description
PollMessage()

Method Summary

Modifier and Type	Method	Description
abstract PollMessage.Builder<?,?>	asBuilder()	Override Buildable.asBuilder() to give this method stronger typing.
abstract VKey<? extends PollMessage>	createVKey()
java.lang.String	getContactRepoId()	Returns the contact repo id.
java.lang.String	getDomainRepoId()	Returns the domain repo id.
org.joda.time.DateTime	getEventTime()
java.lang.Long	getHistoryRevisionId()	Gets the underlying history revision id, regardless of the type of the resource.
java.lang.String	getHostRepoId()	Returns the host repo id.
java.lang.Long	getId()
java.lang.String	getMsg()
java.lang.String	getRegistrarId()
java.lang.String	getResourceId()	Gets the repo ID of the underlying resource that the PollMessage is for, regardless of the type of the resource.
abstract com.google.common.collect.ImmutableList<EppResponse.ResponseData>	getResponseData()
PollMessage.Type	getType()

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

Constructor Detail

PollMessage

public PollMessage()

Method Detail

getId

public java.lang.Long getId()

getRegistrarId

public java.lang.String getRegistrarId()

getEventTime

public org.joda.time.DateTime getEventTime()

getMsg

public java.lang.String getMsg()

getDomainRepoId

public java.lang.String getDomainRepoId()

Returns the domain repo id.

This may only be used on a Domain poll event.

getContactRepoId

public java.lang.String getContactRepoId()

Returns the contact repo id.

This may only be used on a Contact poll event.

getHostRepoId

public java.lang.String getHostRepoId()

Returns the host repo id.

This may only be used on a Host poll event.

getResourceId

public java.lang.String getResourceId()

Gets the repo ID of the underlying resource that the PollMessage is for, regardless of the type of the resource.

getHistoryRevisionId

public java.lang.Long getHistoryRevisionId()

Gets the underlying history revision id, regardless of the type of the resource.

getType

public PollMessage.Type getType()

createVKey

public abstract VKey<? extends PollMessage> createVKey()

Specified by:

createVKey in interface TransferData.TransferServerApproveEntity

Overrides:

createVKey in class ImmutableObject

getResponseData

public abstract com.google.common.collect.ImmutableList<EppResponse.ResponseData> getResponseData()

asBuilder

public abstract PollMessage.Builder<?,?> asBuilder()

Override Buildable.asBuilder() to give this method stronger typing.

Specified by:

asBuilder in interface Buildable