zydronium/google-nomulus
1
0
Fork 0
mirror of https://github.com/google/nomulus.git synced 2025-05-21 11:49:37 +02:00
Code Issues Projects Releases Packages Wiki Activity

Add documentation on poll messages and an outline of Code structure

Browse source 
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=133713736
This commit is contained in:
mcilwain 2016-09-20 09:19:42 -07:00 • committed by Ben McIlwain
parent 5c9e34ea55
commit 65ff6b45d1
5 changed files with 107 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

8
java/google/registry/flows/poll/PollAckFlow.java
View file

@ -35,12 +35,18 @@ import google.registry.flows.TransactionalFlow;
import google.registry.model.eppoutput.EppOutput;
import google.registry.model.poll.MessageQueueInfo;
import google.registry.model.poll.PollMessage;
import google.registry.model.poll.PollMessageExternalKeyConverter;
import google.registry.model.poll.PollMessageExternalKeyConverter.PollMessageExternalKeyParseException;
import javax.inject.Inject;
import org.joda.time.DateTime;
/**
* An EPP flow for acknowledging poll messages.
* An EPP flow for acknowledging {@link PollMessage}s.
*
* <p>Registrars refer to poll messages using an externally visible id generated by
* {@link PollMessageExternalKeyConverter}. One-time poll messages are deleted from Datastore once
* they are ACKed, whereas autorenew poll messages are simply marked as read, and won't be delivered
* again until the next year of their recurrence.
*
* @error {@link PollAckFlow.InvalidMessageIdException}
* @error {@link PollAckFlow.MessageDoesNotExistException}

9
java/google/registry/flows/poll/PollRequestFlow.java
View file

@ -28,10 +28,17 @@ import google.registry.flows.LoggedInFlow;
import google.registry.model.eppoutput.EppOutput;
import google.registry.model.poll.MessageQueueInfo;
import google.registry.model.poll.PollMessage;
import google.registry.model.poll.PollMessageExternalKeyConverter;
import javax.inject.Inject;
/**
* An EPP flow for requesting poll messages.
* An EPP flow for requesting {@link PollMessage}s.
*
* <p>This flow uses an eventually consistent Datastore query to return the oldest poll message for
* the registrar, as well as the total number of pending messages. Note that poll messages whose
* event time is in the future (i.e. they are speculative and could still be changed or rescinded)
* are ignored. The externally visible id for the poll message that the registrar sees is generated
* by {@link PollMessageExternalKeyConverter}.
*
* @error {@link PollRequestFlow.UnexpectedMessageIdException}
*/