class EppDomain

This EppDomain class implements EPP Domain objects.

Inheritance:

Public Fields

static const char* CONTACT_TYPE_ADMIN

Contact type for administration contact ("admin");

static const char* CONTACT_TYPE_BILLING

Contact type for billing contact ("billing");

static const char* CONTACT_TYPE_TECH

Contact type for technical contact ("tech")

static const char* STATUS_CLIENT_DELETE_PROHIBITED

Domain status - clientDeleteProhibited

static const char* STATUS_CLIENT_HOLD

Domain status - clientHold

static const char* STATUS_CLIENT_RENEW_PROHIBITED

Domain status - clientRenewProhibited

static const char* STATUS_CLIENT_TRANSFER_PROHIBITED

Domain status - clientTransferProhibited

static const char* STATUS_CLIENT_UPDATE_PROHIBITED

Domain status - clientUpdateProhibited

static const char* STATUS_INACTIVE

Domain status - inactive

static const char* STATUS_OK

Domain status - ok

static const char* STATUS_PENDING_DELETE

Domain status - pendingDelete

static const char* STATUS_PENDING_TRANSFER

Domain status - pendingTransfer

static const char* STATUS_PENDING_VERIFICATION

Domain status - pendingVerification

static const char* STATUS_SERVER_DELETE_PROHIBITED

Domain status - serverDeleteProhibited

static const char* STATUS_SERVER_HOLD

Domain status - serverHold

static const char* STATUS_SERVER_RENEW_PROHIBITED

Domain status - serverRenewProhibited

static const char* STATUS_SERVER_TRANSFER_PROHIBITED

Domain status - serverTransferProhibited

static const char* STATUS_SERVER_UPDATE_PROHIBITED

Domain status - serverUpdateProhibited

Public Methods

EppDomain()

Creates an EppDomain object

EppDomain( DOMString name )

Creates an EppDomain object with a domain name

~EppDomain()

Destructor

virtual int getEntityType()

Returns the run-time type of an EppEntity object

DOMString getName()

Gets the domain name

void setName( DOMString name )

Sets the domain name

ValueVectorOf<DOMString> * getHost()

Gets a list of host names associated with the domain

void addHost( DOMString host )

Adds a host name associated with the domain

ValueVectorOf<DOMString> * getNameServer()

Gets a list of name servers associated with the domain

void addNameServer( DOMString nameServer )

Add a name server associated with the domain

ValueVectorOf<EppContactType> * getContact()

Gets a list of contacts associated with the domain

void addContact( EppContactType contact )

Adds a contact for the domain

void addContact( DOMString id, DOMString type )

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

EppPeriod* getPeriod()

Gets registration period for the domain name

void setPeriod( EppPeriod period )

Sets registration period for the domain name

DOMString getRegistrant()

Gets the contact id of the registrant which owns the domain

void setRegistrant( DOMString registrant )

Sets the contact id of the registrant which owns the domain

DOM_Element toXML( DOM_Document& doc, const DOMString& tag )

Converts the EppDomain object into an XML element

static EppDomain* fromXML( const DOM_Node& root )

Converts an XML element into an EppDomain object.

static EppCommandDeleteDomain remove( DOMString name, DOMString xid )

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

static EppCommandInfoDomain info( DOMString name, DOMString xid )

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

static EppCommandCheckDomain check( DOMString xid )

Creates an EppCommandCheckDomain object for checking the existance of EPP Domain objects in the registry.

static EppCommandTransferDomain transfer( DOMString name, EppPeriod& period, DOMString xid )

Creates an EppCommandTransferDomain object for transfering an EPP Domain object in the registry.

static EppCommandUpdateDomain update( DOMString name, DOMString xid )

Creates an EppCommandUpdateDomain object for updating an EPP Domain object in the registry.

static EppCommandRenewDomain renew( DOMString name, time_t curExpDate, EppPeriod& period, DOMString xid )

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

Inherited from EppObject:

Public Fields

static const int CONTACT

static const int DOMAIN

static const int HOST

static const int SVCSUB

Public Methods

DOMString getRoid()

void setRoid( DOMString roid )

DOMString getClientId()

void setClientId( DOMString clientId )

DOMString getClientIdCreated()

void setClientIdCreated( DOMString clientId )

time_t getDateCreated()

void setDateCreated( time_t cal )

DOMString getClientIdUpdated()

void setClientIdUpdated( DOMString clientId )

time_t getDateUpdated()

void setDateUpdated( time_t cal )

time_t getDateExpired()

void setDateExpired( time_t cal )

time_t getDateTransferred()

void setDateTransferred( time_t cal )

EppAuthInfo* getAuthInfo()

void setAuthInfo( EppAuthInfo authInfo )

ValueVectorOf<EppStatus> * getStatus()

void addStatus( EppStatus status )

static EppCommandCreate create( EppObject* object, DOMString xid )

Protected Fields

DOMString roid

ValueVectorOf<EppStatus> * status

DOMString clID

DOMString crID

time_t crDate

DOMString upID

time_t upDate

time_t exDate

time_t trDate

EppAuthInfo* authInfo

Protected Methods

void fromXMLCommon( const DOM_Node& node, const DOMString name )

void toXMLCommon( DOM_Document& doc, DOM_Element& body )

void freeCommon()

Inherited from EppEntity:

Public Methods

bool instanceOf( const int type )

virtual DOMString toString()

Protected Methods

DOMString toString( const DOMString &tag )

Documentation

This EppDomain class implements EPP Domain objects.

static const char* CONTACT_TYPE_ADMIN

Contact type for administration contact ("admin");

static const char* CONTACT_TYPE_BILLING

Contact type for billing contact ("billing");

static const char* CONTACT_TYPE_TECH

Contact type for technical contact ("tech")

static const char* STATUS_CLIENT_DELETE_PROHIBITED

Domain status - clientDeleteProhibited

static const char* STATUS_CLIENT_HOLD

Domain status - clientHold

static const char* STATUS_CLIENT_RENEW_PROHIBITED

Domain status - clientRenewProhibited

static const char* STATUS_CLIENT_TRANSFER_PROHIBITED

Domain status - clientTransferProhibited

static const char* STATUS_CLIENT_UPDATE_PROHIBITED

Domain status - clientUpdateProhibited

static const char* STATUS_INACTIVE

Domain status - inactive

static const char* STATUS_OK

Domain status - ok

static const char* STATUS_PENDING_DELETE

Domain status - pendingDelete

static const char* STATUS_PENDING_TRANSFER

Domain status - pendingTransfer

static const char* STATUS_PENDING_VERIFICATION

Domain status - pendingVerification

static const char* STATUS_SERVER_DELETE_PROHIBITED

Domain status - serverDeleteProhibited

static const char* STATUS_SERVER_HOLD

Domain status - serverHold

static const char* STATUS_SERVER_RENEW_PROHIBITED

Domain status - serverRenewProhibited

static const char* STATUS_SERVER_TRANSFER_PROHIBITED

Domain status - serverTransferProhibited

static const char* STATUS_SERVER_UPDATE_PROHIBITED

Domain status - serverUpdateProhibited

EppDomain()

Creates an EppDomain object

EppDomain( DOMString name )

Creates an EppDomain object with a domain name

~EppDomain()

Destructor

virtual int getEntityType()

Returns the run-time type of an EppEntity object

DOMString getName()

Gets the domain name

void setName( DOMString name )

Sets the domain name

ValueVectorOf<DOMString> * getHost()

Gets a list of host names associated with the domain

void addHost( DOMString host )

Adds a host name associated with the domain

Note: this method should be only called by the EPP server, and an EPP client should not perform this operation.

ValueVectorOf<DOMString> * getNameServer()

Gets a list of name servers associated with the domain

void addNameServer( DOMString nameServer )

Add a name server associated with the domain

ValueVectorOf<EppContactType> * getContact()

Gets a list of contacts associated with the domain

void addContact( EppContactType contact )

Adds a contact for the domain

void addContact( DOMString id, DOMString type )

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

EppPeriod* getPeriod()

Gets registration period for the domain name

void setPeriod( EppPeriod period )

Sets registration period for the domain name

DOMString getRegistrant()

Gets the contact id of the registrant which owns the domain

void setRegistrant( DOMString registrant )

Sets the contact id of the registrant which owns the domain

DOM_Element toXML( DOM_Document& doc, const DOMString& tag )

Converts the EppDomain object into an XML element

Parameters:

doc - the XML DOM_Element object
tag - the tag/element name for the EppDomain object

Returns:

an DOM_Element object

static EppDomain* fromXML( const 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

static EppCommandDeleteDomain remove( DOMString name, DOMString 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

static EppCommandInfoDomain info( DOMString name, DOMString 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

static EppCommandCheckDomain check( DOMString 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

static EppCommandTransferDomain transfer( DOMString name, EppPeriod& period, DOMString 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

static EppCommandUpdateDomain update( DOMString name, DOMString 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

static EppCommandRenewDomain renew( DOMString name, time_t curExpDate, EppPeriod& period, DOMString 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

This class has no child classes.

Author:

Ning Zhang ning.zhang@neustar.com

Version:

$Revision: 1.1.1.1 $ $Date: 2005/12/06 20:11:35 $

Alphabetic index HTML hierarchy of classes or Java