com.verisign.epp.codec.domain
Class EPPDomainCreateCmd

java.lang.Object
  extended by com.verisign.epp.codec.gen.EPPCommand
      extended by com.verisign.epp.codec.gen.EPPCreateCmd
          extended by 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:


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 concrete EPPReponse associated with EPPDomainCreateCmd.

Version:
$Revision: 1.5 $
Author:
$Author: jim $
See Also:
EPPDomainCreateResp, Serialized Form

Field Summary
 
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
EPPDomainCreateCmd()
          Allocates a new EPPDomainCreateCmd 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.
EPPDomainCreateCmd(java.lang.String aTransId, java.lang.String aName, EPPAuthInfo aAuthInfo)
          Allocates a new EPPDomainCreateCmd with a domain name.
EPPDomainCreateCmd(java.lang.String aTransId, java.lang.String aName, java.util.Vector someServers, java.util.Vector someContacts, EPPDomainPeriod aPeriod, EPPAuthInfo aAuthInfo)
          Allocates a new EPPDomainCreateCmd with all attributes specified by the arguments.
 
Method Summary
 java.lang.Object clone()
          Clone EPPDomainCreateCmd.
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 of EPPDomainCreateCmd with this instance.
 EPPAuthInfo getAuthInfo()
          Get authorization information
 java.util.Vector 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 getServers()
          Gets the name servers.
 void setAuthInfo(EPPAuthInfo newAuthInfo)
          Set authorization information
 void setContacts(java.util.Vector 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 setServers(java.util.Vector aServers)
          Sets the name servers.
 java.lang.String toString()
          Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
 
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, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EPPDomainCreateCmd

public EPPDomainCreateCmd()
Allocates a new EPPDomainCreateCmd with default attribute values. the defaults include the following:


The name must be set before invoking encode.


EPPDomainCreateCmd

public EPPDomainCreateCmd(java.lang.String aTransId,
                          java.lang.String aName,
                          EPPAuthInfo aAuthInfo)
Allocates a new EPPDomainCreateCmd with a domain name. The other attributes are initialized as follows:

Parameters:
aTransId - Transaction Id associated with command.
aName - Domain name
aAuthInfo - EPPAuthInfo authorization information

EPPDomainCreateCmd

public EPPDomainCreateCmd(java.lang.String aTransId,
                          java.lang.String aName,
                          java.util.Vector someServers,
                          java.util.Vector someContacts,
                          EPPDomainPeriod aPeriod,
                          EPPAuthInfo aAuthInfo)
Allocates a new EPPDomainCreateCmd with all attributes specified by the arguments.

Parameters:
aTransId - Transaction Id associated with command.
aName - Domain name
someServers - Domain name servers
someContacts - Domain contacts. Should be null if the Contact Mapping is not supported.
aPeriod - Value greater than or equal to MIN_PERIOD or less than or equal to MAX_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 interface EPPMessage
Specified by:
getNamespace in class EPPCommand
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

getServers

public java.util.Vector getServers()
Gets the name servers. The name servers can either be String instances containing the fully qualified name of a known name server host object, or EPPHostAttr instances containing the fully qualified name of a host and optionally the host IP addresses.

Returns:
Vector of name server String instances for host object references or EPPHostAttr instances for host attribute values if exists; null otherwise.

setServers

public void setServers(java.util.Vector aServers)
Sets the name servers. The name servers can either be String instances containing the fully qualified name of a known name server host object, or EPPHostAttr instances containing the fully qualified name of a host and optionally the host IP addresses.

Parameters:
aServers - Vector of name server String instances for host object references or EPPHostAttr instances for host attribute values.

getContacts

public java.util.Vector getContacts()
Gets the contacts.

Returns:
Vector of EPPDomainContact instances if defined; null otherwise.

setContacts

public void setContacts(java.util.Vector aContacts)
Sets the contacts.

Parameters:
aContacts - Vector of EPPDomainContact instances.

equals

public boolean equals(java.lang.Object aObject)
Compare an instance of EPPDomainCreateCmd with this instance.

Overrides:
equals in class EPPCreateCmd
Parameters:
aObject - Object to compare with.
Returns:
DOCUMENT ME!

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clone EPPDomainCreateCmd.

Specified by:
clone in interface EPPCodecComponent
Overrides:
clone in class EPPCommand
Returns:
clone of EPPDomainCreateCmd
Throws:
java.lang.CloneNotSupportedException - standard Object.clone exception

toString

public java.lang.String toString()
Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:
toString in class EPPCommand
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:
java.lang.String

setAuthInfo

public void setAuthInfo(EPPAuthInfo newAuthInfo)
Set authorization information

Parameters:
newAuthInfo - java.lang.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 - java.lang.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 class EPPCreateCmd
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 class EPPCreateCmd
Parameters:
aElement - Root DOM Element to decode EPPDomainCreateCmd from.
Throws:
EPPDecodeException - Unable to decode aElement


Copyright © VeriSign Inc. All Rights Reserved.