Package com.verisign.epp.codec.domain
Class EPPDomainCreateCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPCreateCmd
-
- com.verisign.epp.codec.domain.EPPDomainCreateCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPDomainCreateCmd extends EPPCreateCmd
Represents an EPP Domain <create> command, which provides a transform operation that allows a client to create a domain object. In addition to the standard EPP command elements, the <create> command MUST contain a <domain:create> element that identifies the domain namespace and the location of the domain schema. The <domain:create> element MUST contain the following child elements:
- A <domain:name> element that contains the fully qualified domain
name of the object to be created. Use
getName
andsetName
to get and set the element. - An OPTIONAL <domain:period> element that contains the initial
registration period of the domain object. Use
getPeriod
andsetPeriod
to get and set the element. If returnnull
, period has not been specified yet. - Zero or more <domain:ns> elements that contain the fully qualified
host name of a known host object to provide resolution services for the
domain. A host object MUST be known to the server before a domain can be
delegated to the host. A server MUST provide host object services to provide
domain name services. The EPP mapping for host objects is described in
[EPP-H]. Use
getServers
andsetServers
to get and set the elements. - An OPTIONAL <domain:registrant> element that contains the
identifier for the human or organizational social information (contact)
object to be associated with the domain object as the object registrant. This
object identifier MUST be known to the server before the contact object can
be associated with the domain object. Use
getRegistrant
andsetRegistrant
to get and set the elements. - Zero or more <domain:contact> elements that contain the registrant,
administrative, technical, and billing contact identifiers to be associated
with the domain. A contact identifier MUST be known to the server before the
contact can be associated with the domain. Only one contact identifier of
each type MAY be specified. A server MAY provide contact object services when
providing domain name object services. The EPP mapping for contact objects is
described in [EPP-C]. Use
getContacts
andsetContacts
to get and set the elements. Contacts should only be specified if the Contact Mapping is supported. - A <domain:authInfo> element that contains authorization information to be associated with the domain object.
It is important to note that the transaction identifier associated with successful creation of a domain object becomes the authorization identifier required to transfer sponsorship of the domain object. A client MUST retain all transaction identifiers associated with domain object creation and protect them from disclosure. A client MUST also provide a copy of the transaction identifier information to the domain registrant, who will need this information to request a domain transfer through a different client.
EPPDomainCreateResp
is the concreteEPPReponse
associated withEPPDomainCreateCmd
.
- See Also:
EPPDomainCreateResp
, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPDomainCreateCmd
.static java.lang.String
ELM_NAME
XML Element Name ofEPPDomainCreateCmd
root element.-
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE
-
-
Constructor Summary
Constructors Constructor Description EPPDomainCreateCmd()
Allocates a newEPPDomainCreateCmd
with default attribute values.EPPDomainCreateCmd(java.lang.String aTransId, java.lang.String aName, EPPAuthInfo aAuthInfo)
Allocates a newEPPDomainCreateCmd
with a domain name.EPPDomainCreateCmd(java.lang.String aTransId, java.lang.String aName, java.util.Vector<java.lang.String> aServers, java.util.Vector<EPPDomainContact> aContacts, EPPDomainPeriod aPeriod, EPPAuthInfo aAuthInfo)
Allocates a newEPPDomainCreateCmd
with all attributes specified by the arguments.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addContact(EPPDomainContact aContact)
Adds a contact to the list of domain contacts.void
addServer(java.lang.String aServer)
Add a name serve instance that is a fully qualified name of a known name server host object.void
addServerAttr(EPPHostAttr aServerAttr)
Add a name serve attribute instance that is a fully qualified name of a host and optionally the host IP addresses.java.lang.Object
clone()
CloneEPPDomainCreateCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode the EPPDomainCreateCmd attributes from the aElement DOM Element tree.protected org.w3c.dom.Element
doEncode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the EPPDomainCreateCmd instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPDomainCreateCmd
with this instance.EPPAuthInfo
getAuthInfo()
Get authorization informationjava.util.Vector<EPPDomainContact>
getContacts()
Gets the contacts.java.lang.String
getName()
Get the domain name to create.java.lang.String
getNamespace()
Get the EPP command Namespace associated with EPPDomainCreateCmd.EPPDomainPeriod
getPeriod()
Gets the registration period in years.java.lang.String
getRegistrant()
Get registrant.java.util.Vector<EPPHostAttr>
getServerAttrs()
Gets the name server attributes.java.util.Vector<java.lang.String>
getServers()
Gets the name servers.boolean
hasContacts()
Are there contacts set?boolean
hasServerAttrs()
Are there name server attributes set?boolean
hasServers()
Are there name servers set?void
setAuthInfo(EPPAuthInfo aAuthInfo)
Set authorization informationvoid
setContacts(java.util.Vector<EPPDomainContact> aContacts)
Sets the contacts.void
setName(java.lang.String aName)
Set the domain name to create.void
setPeriod(EPPDomainPeriod aPeriod)
Sets the registration period in years.void
setRegistrant(java.lang.String newRegistrant)
Set registrant.void
setServerAttrs(java.util.Vector<EPPHostAttr> aServerAttrs)
Sets the name server attributes.void
setServers(java.util.Vector<java.lang.String> aServers)
Sets the name servers.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.-
Methods inherited from class com.verisign.epp.codec.gen.EPPCreateCmd
doGenDecode, doGenEncode, getType
-
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId
-
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPDomainCreateCmd
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML Element Name ofEPPDomainCreateCmd
root element.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPDomainCreateCmd
public EPPDomainCreateCmd()
Allocates a newEPPDomainCreateCmd
with default attribute values. the defaults include the following:
- name is set to
null
- period is set to
UNSPEC_PERIOD
- servers is set to to
null
- contacts is set to to
null
- transaction id is set to
null
.
The name must be set before invokingencode
. - name is set to
-
EPPDomainCreateCmd
public EPPDomainCreateCmd(java.lang.String aTransId, java.lang.String aName, EPPAuthInfo aAuthInfo)
Allocates a newEPPDomainCreateCmd
with a domain name. The other attributes are initialized as follows:
- period is set to
UNSPEC_PERIOD
- servers is set to
null
- contacts is set to
null
- Parameters:
aTransId
- Transaction Id associated with command.aName
- Domain nameaAuthInfo
- EPPAuthInfo authorization information
- period is set to
-
EPPDomainCreateCmd
public EPPDomainCreateCmd(java.lang.String aTransId, java.lang.String aName, java.util.Vector<java.lang.String> aServers, java.util.Vector<EPPDomainContact> aContacts, EPPDomainPeriod aPeriod, EPPAuthInfo aAuthInfo)
Allocates a newEPPDomainCreateCmd
with all attributes specified by the arguments.- Parameters:
aTransId
- Transaction Id associated with command.aName
- Domain nameaServers
- Domain name servers names. Set tonull
if undefined.aContacts
- Domain contacts. Should benull
if the Contact Mapping is not supported.aPeriod
- Value greater than or equal toMIN_PERIOD
or less than or equal toMAX_PERIOD
.aAuthInfo
- EPPAuthInfo authorization information.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Get the EPP command Namespace associated with EPPDomainCreateCmd.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPDomainMapFactory.NS
-
getName
public java.lang.String getName()
Get the domain name to create.- Returns:
- Domain Name
-
setName
public void setName(java.lang.String aName)
Set the domain name to create.- Parameters:
aName
- Domain Name
-
hasServers
public boolean hasServers()
Are there name servers set?- Returns:
true
if name servers have been set;false
otherwise.
-
getServers
public java.util.Vector<java.lang.String> getServers()
Gets the name servers. The name servers can either beString
instances containing the fully qualified name of a known name server host object, orEPPHostAttr
instances containing the fully qualified name of a host and optionally the host IP addresses.- Returns:
Vector
of name serverString
instances for host object references orEPPHostAttr
instances for host attribute values if exists;null
otherwise.
-
setServers
public void setServers(java.util.Vector<java.lang.String> aServers)
Sets the name servers. The name servers can either beString
instances containing the fully qualified name of a known name server host object, orEPPHostAttr
instances containing the fully qualified name of a host and optionally the host IP addresses.- Parameters:
aServers
-Vector
of name serverString
instances for host object references orEPPHostAttr
instances for host attribute values.
-
addServer
public void addServer(java.lang.String aServer)
Add a name serve instance that is a fully qualified name of a known name server host object.- Parameters:
aServer
- Fully qualified name of a known name server host object.
-
hasServerAttrs
public boolean hasServerAttrs()
Are there name server attributes set?- Returns:
true
if name server attributes have been set;false
otherwise.
-
getServerAttrs
public java.util.Vector<EPPHostAttr> getServerAttrs()
Gets the name server attributes. The name servers attributes areEPPHostAttr
instances containing the fully qualified name of a host and optionally the host IP addresses.- Returns:
Vector
of name serverEPPHostAttr
instances for host attribute values if exists;null
otherwise.
-
setServerAttrs
public void setServerAttrs(java.util.Vector<EPPHostAttr> aServerAttrs)
Sets the name server attributes. The name servers attributes areEPPHostAttr
instances containing the fully qualified name of a host and optionally the host IP addresses.- Parameters:
aServerAttrs
-Vector
of name serverEPPHostAttr
instances for host attribute values.
-
addServerAttr
public void addServerAttr(EPPHostAttr aServerAttr)
Add a name serve attribute instance that is a fully qualified name of a host and optionally the host IP addresses.- Parameters:
aServerAttr
- A fully qualified name of a host and optionally the host IP addresses.
-
hasContacts
public boolean hasContacts()
Are there contacts set?- Returns:
true
if contacts have been set;false
otherwise.
-
getContacts
public java.util.Vector<EPPDomainContact> getContacts()
Gets the contacts.- Returns:
Vector
ofEPPDomainContact
instances if defined;null
otherwise.
-
setContacts
public void setContacts(java.util.Vector<EPPDomainContact> aContacts)
Sets the contacts.- Parameters:
aContacts
-Vector
ofEPPDomainContact
instances.
-
addContact
public void addContact(EPPDomainContact aContact)
Adds a contact to the list of domain contacts.- Parameters:
aContact
- Contact to add to the domain.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPDomainCreateCmd
with this instance.- Overrides:
equals
in classEPPCreateCmd
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPDomainCreateCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPDomainCreateCmd
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classEPPCommand
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getAuthInfo
public EPPAuthInfo getAuthInfo()
Get authorization information- Returns:
- EPPAuthInfo
-
getPeriod
public EPPDomainPeriod getPeriod()
Gets the registration period in years.- Returns:
- Registration Period in years.
-
getRegistrant
public java.lang.String getRegistrant()
Get registrant.- Returns:
- String
-
setAuthInfo
public void setAuthInfo(EPPAuthInfo aAuthInfo)
Set authorization information- Parameters:
aAuthInfo
- String
-
setPeriod
public void setPeriod(EPPDomainPeriod aPeriod)
Sets the registration period in years.- Parameters:
aPeriod
- Registration Period in years.
-
setRegistrant
public void setRegistrant(java.lang.String newRegistrant)
Set registrant.- Parameters:
newRegistrant
- String
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of the EPPDomainCreateCmd instance.- Specified by:
doEncode
in classEPPCreateCmd
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the EPPDomainCreateCmd instance.
- Throws:
EPPEncodeException
- Unable to encode EPPDomainCreateCmd instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode the EPPDomainCreateCmd attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPCreateCmd
- Parameters:
aElement
- Root DOM Element to decode EPPDomainCreateCmd from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
-