com.neulevel.epp.core
Class EppDomain

java.lang.Object
  |
  +--com.neulevel.epp.core.EppEntity
        |
        +--com.neulevel.epp.core.EppObject
              |
              +--com.neulevel.epp.core.EppDomain

public class EppDomain

extends EppObject

This EppDomain class implements EPP Domain objects.

Version:

$Revision$ $Date$

Author:

Ning Zhang ning.zhang@neustar.com

Field Summary

static java.lang.String	CONTACT_TYPE_ADMIN Contact type for administration contact ("admin");
static java.lang.String	CONTACT_TYPE_BILLING Contact type for billing contact ("billing");
static java.lang.String	CONTACT_TYPE_TECH Contact type for technical contact ("tech")
static java.lang.String	STATUS_CLIENT_DELETE_PROHIBITED Domain status - clientDeleteProhibited
static java.lang.String	STATUS_CLIENT_HOLD Domain status - clientHold
static java.lang.String	STATUS_CLIENT_RENEW_PROHIBITED Domain status - clientRenewProhibited
static java.lang.String	STATUS_CLIENT_TRANSFER_PROHIBITED Domain status - clientTransferProhibited
static java.lang.String	STATUS_CLIENT_UPDATE_PROHIBITED Domain status - clientUpdateProhibited
static java.lang.String	STATUS_INACTIVE Domain status - inactive
static java.lang.String	STATUS_OK Domain status - ok
static java.lang.String	STATUS_PENDING_DELETE Domain status - pendingDelete
static java.lang.String	STATUS_PENDING_TRANSFER Domain status - pendingTransfer
static java.lang.String	STATUS_PENDING_VERIFICATION Domain status - pendingVerification
static java.lang.String	STATUS_SERVER_DELETE_PROHIBITED Domain status - serverDeleteProhibited
static java.lang.String	STATUS_SERVER_HOLD Domain status - serverHold
static java.lang.String	STATUS_SERVER_RENEW_PROHIBITED Domain status - serverRenewProhibited
static java.lang.String	STATUS_SERVER_TRANSFER_PROHIBITED Domain status - serverTransferProhibited
static java.lang.String	STATUS_SERVER_UPDATE_PROHIBITED Domain status - serverUpdateProhibited

Fields inherited from class com.neulevel.epp.core.EppObject

authInfo, clID, CONTACT, crDate, crID, DOMAIN, exDate, HOST, roid, status, trDate, upDate, upID

Constructor Summary

EppDomain()
Creates an EppDomain object

EppDomain(java.lang.String name)
Creates an EppDomain object with a domain name

Method Summary

void	addContact(EppContactType contact) Adds a contact for the domain
void	addContact(java.lang.String id, java.lang.String type) Adds a contact for the domain, given a contact id and its type
void	addHost(java.lang.String host) Adds a host name associated with the domain
void	addNameServer(java.lang.String nameServer) Add a name server associated with the domain
static EppCommandCheckDomain	check(java.lang.String xid) Creates an EppCommandCheckDomain object for checking the existance of EPP Domain objects in the registry.
static EppCommandDeleteDomain	delete(java.lang.String name, java.lang.String xid) Creates an EppCommandDeleteDomain object for deleting an EPP Domain object from the registry.
static EppEntity	fromXML(org.w3c.dom.Node root) Converts an XML element into an EppDomain object.
java.util.Vector	getContact() Gets a list of contacts associated with the domain
java.util.Vector	getHost() Gets a list of host names associated with the domain
java.lang.String	getName() Gets the domain name
java.util.Vector	getNameServer() Gets a list of name servers associated with the domain
EppPeriod	getPeriod() Gets registration period for the domain name
java.lang.String	getRegistrant() Gets the contact id of the registrant which owns the domain
static EppCommandInfoDomain	info(java.lang.String name, java.lang.String xid) Creates an EppCommandInfoDomain object for querying the details of an EPP Domain object
static EppCommandRenewDomain	renew(java.lang.String name, java.util.Calendar curExpDate, EppPeriod period, java.lang.String xid) Creates an EppCommandRenewDomain object for renewing the registration of an EPP Domain object in the registry.
void	setName(java.lang.String name) Sets the domain name
void	setPeriod(EppPeriod period) Sets registration period for the domain name
void	setRegistrant(java.lang.String registrant) Sets the contact id of the registrant which owns the domain
java.lang.String	toString()
org.w3c.dom.Element	toXML(org.w3c.dom.Document doc, java.lang.String tag) Converts the EppDomain object into an XML element
static EppCommandTransferDomain	transfer(java.lang.String name, EppPeriod period, java.lang.String xid) Creates an EppCommandTransferDomain object for transfering an EPP Domain object in the registry.
static EppCommandUpdateDomain	update(java.lang.String name, java.lang.String xid) Creates an EppCommandUpdateDomain object for updating an EPP Domain object in the registry.

Methods inherited from class com.neulevel.epp.core.EppObject

addStatus, create, fromXMLCommon, getAuthInfo, getClientId, getClientIdCreated, getClientIdUpdated, getDateCreated, getDateExpired, getDateTransferred, getDateUpdated, getRoid, getStatus, setAuthInfo, setClientId, setClientIdCreated, setClientIdUpdated, setDateCreated, setDateExpired, setDateTransferred, setDateUpdated, setRoid, toXMLCommon

Methods inherited from class com.neulevel.epp.core.EppEntity

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTACT_TYPE_ADMIN

public static final java.lang.String CONTACT_TYPE_ADMIN

Contact type for administration contact ("admin");

CONTACT_TYPE_BILLING

public static final java.lang.String CONTACT_TYPE_BILLING

Contact type for billing contact ("billing");

CONTACT_TYPE_TECH

public static final java.lang.String CONTACT_TYPE_TECH

Contact type for technical contact ("tech")

STATUS_CLIENT_DELETE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_DELETE_PROHIBITED

Domain status - clientDeleteProhibited

STATUS_CLIENT_HOLD

public static final java.lang.String STATUS_CLIENT_HOLD

Domain status - clientHold

STATUS_CLIENT_RENEW_PROHIBITED

public static final java.lang.String STATUS_CLIENT_RENEW_PROHIBITED

Domain status - clientRenewProhibited

STATUS_CLIENT_TRANSFER_PROHIBITED

public static final java.lang.String STATUS_CLIENT_TRANSFER_PROHIBITED

Domain status - clientTransferProhibited

STATUS_CLIENT_UPDATE_PROHIBITED

public static final java.lang.String STATUS_CLIENT_UPDATE_PROHIBITED

Domain status - clientUpdateProhibited

STATUS_INACTIVE

public static final java.lang.String STATUS_INACTIVE

Domain status - inactive

STATUS_OK

public static final java.lang.String STATUS_OK

Domain status - ok

STATUS_PENDING_DELETE

public static final java.lang.String STATUS_PENDING_DELETE

Domain status - pendingDelete

STATUS_PENDING_TRANSFER

public static final java.lang.String STATUS_PENDING_TRANSFER

Domain status - pendingTransfer

STATUS_PENDING_VERIFICATION

public static final java.lang.String STATUS_PENDING_VERIFICATION

Domain status - pendingVerification

STATUS_SERVER_DELETE_PROHIBITED

public static final java.lang.String STATUS_SERVER_DELETE_PROHIBITED

Domain status - serverDeleteProhibited

STATUS_SERVER_HOLD

public static final java.lang.String STATUS_SERVER_HOLD

Domain status - serverHold

STATUS_SERVER_RENEW_PROHIBITED

public static final java.lang.String STATUS_SERVER_RENEW_PROHIBITED

Domain status - serverRenewProhibited

STATUS_SERVER_TRANSFER_PROHIBITED

public static final java.lang.String STATUS_SERVER_TRANSFER_PROHIBITED

Domain status - serverTransferProhibited

STATUS_SERVER_UPDATE_PROHIBITED

public static final java.lang.String STATUS_SERVER_UPDATE_PROHIBITED

Domain status - serverUpdateProhibited

Constructor Detail

EppDomain

public EppDomain()

Creates an EppDomain object

EppDomain

public EppDomain(java.lang.String name)

Creates an EppDomain object with a domain name

Method Detail

getName

public java.lang.String getName()

Gets the domain name

setName

public void setName(java.lang.String name)

Sets the domain name

getHost

public java.util.Vector getHost()

Gets a list of host names associated with the domain

addHost

public void addHost(java.lang.String host)

Adds a host name associated with the domain

getNameServer

public java.util.Vector getNameServer()

Gets a list of name servers associated with the domain

addNameServer

public void addNameServer(java.lang.String nameServer)

Add a name server associated with the domain

getContact

public java.util.Vector getContact()

Gets a list of contacts associated with the domain

addContact

public void addContact(EppContactType contact)

Adds a contact for the domain

addContact

public void addContact(java.lang.String id,
                       java.lang.String type)

Adds a contact for the domain, given a contact id and its type

getPeriod

public EppPeriod getPeriod()

Gets registration period for the domain name

setPeriod

public void setPeriod(EppPeriod period)

Sets registration period for the domain name

getRegistrant

public java.lang.String getRegistrant()

Gets the contact id of the registrant which owns the domain

setRegistrant

public void setRegistrant(java.lang.String registrant)

Sets the contact id of the registrant which owns the domain

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc,
                                 java.lang.String tag)

Converts the EppDomain object into an XML element

Overrides:

toXML in class EppEntity

Parameters:

doc - the XML Document object

tag - the tag/element name for the EppDomain object

Returns:

an Element object

fromXML

public static EppEntity fromXML(org.w3c.dom.Node root)

Converts an XML element into an EppDomain object. The caller of this method must make sure that the root node is of the EPP Domain type.

Parameters:

root - root node for an EppDomain object in XML format

Returns:

an EppDomain object, or null if the node is invalid

toString

public java.lang.String toString()

Overrides:

toString in class EppEntity

delete

public static EppCommandDeleteDomain delete(java.lang.String name,
                                            java.lang.String xid)

Creates an EppCommandDeleteDomain object for deleting an EPP Domain object from the registry.

Parameters:

name - the name of the domain object to be deleted

xid - the client transaction id associated with the operation

info

public static EppCommandInfoDomain info(java.lang.String name,
                                        java.lang.String xid)

Creates an EppCommandInfoDomain object for querying the details of an EPP Domain object

Parameters:

name - the name of the domain object to be queried

xid - the client transaction id associated with the operation

check

public static EppCommandCheckDomain check(java.lang.String xid)

Creates an EppCommandCheckDomain object for checking the existance of EPP Domain objects in the registry. Names of EPP Domain objects can be added via the add or addName methods.

Parameters:

xid - the client transaction id associated with the operation

transfer

public static EppCommandTransferDomain transfer(java.lang.String name,
                                                EppPeriod period,
                                                java.lang.String xid)

Creates an EppCommandTransferDomain object for transfering an EPP Domain object in the registry. The operation type, registration period and authorization information associated with the operation should be specified via setPeriod, setOperation and setAuthInfo method.

Parameters:

name - the name of the domain object to be transferred

period - the extended registration period of the domain object, or null if there is no change in the expiration timestamp of the domain object after the transfer operation

xid - the client transaction id associated with the operation

update

public static EppCommandUpdateDomain update(java.lang.String name,
                                            java.lang.String xid)

Creates an EppCommandUpdateDomain object for updating an EPP Domain object in the registry. The actual update information should be specified via the various methods defined for the EppCommandUpdateDomain object.

Parameters:

name - the name of the domain object to be updated

xid - the client transaction id associated with the operation

renew

public static EppCommandRenewDomain renew(java.lang.String name,
                                          java.util.Calendar curExpDate,
                                          EppPeriod period,
                                          java.lang.String xid)

Creates an EppCommandRenewDomain object for renewing the registration of an EPP Domain object in the registry.

Parameters:

name - the name of the domain object to be renewed

curExpDate - the current expiration date of the domain object

period - the new registration period of the domain object, or null if using the value specified by the registry

xid - the client transaction id associated with the operation