java.lang.Object
- google.registry.flows.domain.token.AllocationTokenFlowUtils

```
public class AllocationTokenFlowUtils
extends java.lang.Object
```
Utility functions for dealing with AllocationTokens in domain flows.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AllocationTokenFlowUtils.AllocationTokenNotInPromotionException`	The allocation token is not currently valid.
`static class`	`AllocationTokenFlowUtils.AllocationTokenNotValidForDomainException`	The allocation token is not valid for this domain.
`static class`	`AllocationTokenFlowUtils.AllocationTokenNotValidForRegistrarException`	The allocation token is not valid for this registrar.
`static class`	`AllocationTokenFlowUtils.AllocationTokenNotValidForTldException`	The allocation token is not valid for this TLD.
`static class`	`AllocationTokenFlowUtils.AlreadyRedeemedAllocationTokenException`	The allocation token was already redeemed.
`static class`	`AllocationTokenFlowUtils.InvalidAllocationTokenException`	The allocation token is invalid.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AllocationTokenDomainCheckResults`	`checkDomainsWithToken(java.util.List<com.google.common.net.InternetDomainName> domainNames, java.lang.String token, java.lang.String clientId, org.joda.time.DateTime now)`	Checks if the allocation token applies to the given domain names, used for domain checks.
`AllocationToken`	`loadTokenAndValidateDomainCreate(DomainCommand.Create command, java.lang.String token, Registry registry, java.lang.String clientId, org.joda.time.DateTime now)`	Loads an allocation token given a string and verifies that the token is valid for the domain create request.
`AllocationToken`	`redeemToken(AllocationToken token, VKey<? extends HistoryEntry> redemptionHistoryEntry)`	Redeems a SINGLE_USE `AllocationToken`, returning the redeemed copy.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

loadTokenAndValidateDomainCreate

public AllocationToken loadTokenAndValidateDomainCreate(DomainCommand.Create command,
                                                        java.lang.String token,
                                                        Registry registry,
                                                        java.lang.String clientId,
                                                        org.joda.time.DateTime now)
                                                 throws EppException

Loads an allocation token given a string and verifies that the token is valid for the domain create request.

Returns:: the loaded AllocationToken for that string.
Throws:: EppException - if the token doesn't exist, is already redeemed, or is otherwise invalid for this request.

checkDomainsWithToken

public AllocationTokenDomainCheckResults checkDomainsWithToken(java.util.List<com.google.common.net.InternetDomainName> domainNames,
                                                               java.lang.String token,
                                                               java.lang.String clientId,
                                                               org.joda.time.DateTime now)

Checks if the allocation token applies to the given domain names, used for domain checks.

Returns:: A map of domain names to domain check error response messages. If a message is present for a a given domain then it does not validate with this allocation token; domains that do validate have blank messages (i.e. no error).

redeemToken

public AllocationToken redeemToken(AllocationToken token,
                                   VKey<? extends HistoryEntry> redemptionHistoryEntry)

Redeems a SINGLE_USE AllocationToken, returning the redeemed copy.