Package google.registry.model.eppinput

Class EppInput

java.lang.Object

google.registry.model.ImmutableObject

google.registry.model.eppinput.EppInput

All Implemented Interfaces:

Cloneable

public class EppInput
extends ImmutableObject

This class represents the root EPP XML element for input.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EppInput.Check	Epp envelope wrapper for check on some objects.
static interface	EppInput.CommandExtension	Marker interface for types that can go in the EppInput.CommandWrapper.extension field.
static class	EppInput.CommandWrapper	The "command" element that holds an actual command inside of it.
static class	EppInput.Create	Epp envelope wrapper for create of some object.
static class	EppInput.Delete	Epp envelope wrapper for delete of some object.
static class	EppInput.Hello	Empty type to represent the empty "hello" command.
static class	EppInput.Info	Epp envelope wrapper for info on some object.
static class	EppInput.InnerCommand	A tag that goes inside of an EPP <command>.
static class	EppInput.Login	Login command.
static class	EppInput.Logout	Logout command.
static class	EppInput.Options	An options object inside of EppInput.Login.
static class	EppInput.Poll	Poll command.
static class	EppInput.Renew	Epp envelope wrapper for renewing some object.
static class	EppInput.ResourceCommandWrapper	A command that has an extension inside of it.
static class	EppInput.Services	A services object inside of EppInput.Login.
static class	EppInput.Transfer	Epp envelope wrapper for transferring some object.
static class	EppInput.Update	Epp envelope wrapper for update of some object.
static class	EppInput.VersionAdapter	RFC 5730 says we should check the version and return special error code 2100 if it isn't what we support, but it also specifies a schema that only allows 1.0 in the version field, so any other version doesn't validate.
static class	EppInput.WrongProtocolVersionException	Exception to throw if encountering a protocol version other than "1.0".

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

ImmutableObject.DoNotHydrate, ImmutableObject.IgnoredInDiffableMap, ImmutableObject.Insignificant

Field Summary

Fields inherited from class google.registry.model.ImmutableObject

hashCode

Constructor Summary

Constructors

Constructor	Description
EppInput()

Method Summary

Modifier and Type	Method	Description
String	getCommandType()	Returns the EPP command name, defined as the name of the InnerCommand element within the <command> element (e.g.
EppInput.CommandWrapper	getCommandWrapper()
Optional<String>	getResourceType()	Returns the EPP resource type ("domain", "contact", or "host") for commands that operate on EPP resources, otherwise absent.
<E extends EppInput.CommandExtension> Optional<E>	getSingleExtension(Class<E> clazz)	Get the extension based on type, or null.
Optional<String>	getSingleTargetId()	Returns the target ID (name for domains and hosts, contact ID for contacts) if this command always acts on a single EPP resource, or absent otherwise (e.g.
com.google.common.collect.ImmutableList<String>	getTargetIds()	Returns all the target IDs (name for domains and hosts, contact ID for contacts) that this command references if it acts on EPP resources, or the empty list otherwise (e.g.
boolean	isDomainType()	Returns whether this EppInput represents a command that operates on domains.

Methods inherited from class google.registry.model.ImmutableObject

clone, cloneEmptyToNull, createVKey, equals, getSignificantFields, hashCode, toDiffableFieldMap, toHydratedString, toString, toStringHelper

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

EppInput

public EppInput()

Method Details

getCommandWrapper

public EppInput.CommandWrapper getCommandWrapper()

getCommandType

public String getCommandType()

Returns the EPP command name, defined as the name of the InnerCommand element within the <command> element (e.g. "create" or "poll"), or "hello" for the hello command.

getResourceType

public Optional<String> getResourceType()

Returns the EPP resource type ("domain", "contact", or "host") for commands that operate on EPP resources, otherwise absent.

isDomainType

public boolean isDomainType()

Returns whether this EppInput represents a command that operates on domains.

getSingleTargetId

public Optional<String> getSingleTargetId()

Returns the target ID (name for domains and hosts, contact ID for contacts) if this command always acts on a single EPP resource, or absent otherwise (e.g. for "check" or "poll").

getTargetIds

public com.google.common.collect.ImmutableList<String> getTargetIds()

Returns all the target IDs (name for domains and hosts, contact ID for contacts) that this command references if it acts on EPP resources, or the empty list otherwise (e.g. for "poll").

getSingleExtension

public <E extends EppInput.CommandExtension>
Optional<E> getSingleExtension(Class<E> clazz)

Get the extension based on type, or null. If there are multiple, it chooses the first.