class EppDomain

This EppDomain class implements EPP Domain objects.

Inheritance:


Public Fields

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

Public Methods

[more] EppDomain()
Creates an EppDomain object
[more] EppDomain( DOMString name )
Creates an EppDomain object with a domain name
[more] ~EppDomain()
Destructor
[more]virtual int getEntityType()
Returns the run-time type of an EppEntity object
[more]DOMString getName()
Gets the domain name
[more]void setName( DOMString name )
Sets the domain name
[more]ValueVectorOf<DOMString> * getHost()
Gets a list of host names associated with the domain
[more]void addHost( DOMString host )
Adds a host name associated with the domain
[more]ValueVectorOf<DOMString> * getNameServer()
Gets a list of name servers associated with the domain
[more]void addNameServer( DOMString nameServer )
Add a name server associated with the domain
[more]ValueVectorOf<EppContactType> * getContact()
Gets a list of contacts associated with the domain
[more]void addContact( EppContactType contact )
Adds a contact for the domain
[more]void addContact( DOMString id, DOMString type )
Adds a contact for the domain, given a contact id and its type
[more]EppPeriod* getPeriod()
Gets registration period for the domain name
[more]void setPeriod( EppPeriod period )
Sets registration period for the domain name
[more]DOMString getRegistrant()
Gets the contact id of the registrant which owns the domain
[more]void setRegistrant( DOMString registrant )
Sets the contact id of the registrant which owns the domain
[more]DOM_Element toXML( DOM_Document& doc, const DOMString& tag )
Converts the EppDomain object into an XML element
[more]static EppDomain* fromXML( const DOM_Node& root )
Converts an XML element into an EppDomain object.
[more]static EppCommandDeleteDomain remove( DOMString name, DOMString xid )
Creates an EppCommandDeleteDomain object for deleting an EPP Domain object from the registry.
[more]static EppCommandInfoDomain info( DOMString name, DOMString xid )
Creates an EppCommandInfoDomain object for querying the details of an EPP Domain object
[more]static EppCommandCheckDomain check( DOMString xid )
Creates an EppCommandCheckDomain object for checking the existance of EPP Domain objects in the registry.
[more]static EppCommandTransferDomain transfer( DOMString name, EppPeriod& period, DOMString xid )
Creates an EppCommandTransferDomain object for transfering an EPP Domain object in the registry.
[more]static EppCommandUpdateDomain update( DOMString name, DOMString xid )
Creates an EppCommandUpdateDomain object for updating an EPP Domain object in the registry.
[more]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

ostatic const int CONTACT
ostatic const int DOMAIN
ostatic const int HOST
ostatic const int SVCSUB

Public Methods

oDOMString getRoid()
ovoid setRoid( DOMString roid )
oDOMString getClientId()
ovoid setClientId( DOMString clientId )
oDOMString getClientIdCreated()
ovoid setClientIdCreated( DOMString clientId )
otime_t getDateCreated()
ovoid setDateCreated( time_t cal )
oDOMString getClientIdUpdated()
ovoid setClientIdUpdated( DOMString clientId )
otime_t getDateUpdated()
ovoid setDateUpdated( time_t cal )
otime_t getDateExpired()
ovoid setDateExpired( time_t cal )
otime_t getDateTransferred()
ovoid setDateTransferred( time_t cal )
oEppAuthInfo* getAuthInfo()
ovoid setAuthInfo( EppAuthInfo authInfo )
oValueVectorOf<EppStatus> * getStatus()
ovoid addStatus( EppStatus status )
ostatic EppCommandCreate create( EppObject* object, DOMString xid )

Protected Fields

oDOMString roid
oValueVectorOf<EppStatus> * status
oDOMString clID
oDOMString crID
otime_t crDate
oDOMString upID
otime_t upDate
otime_t exDate
otime_t trDate
oEppAuthInfo* authInfo

Protected Methods

ovoid fromXMLCommon( const DOM_Node& node, const DOMString name )
ovoid toXMLCommon( DOM_Document& doc, DOM_Element& body )
ovoid freeCommon()


Inherited from EppEntity:

Public Methods

obool instanceOf( const int type )
ovirtual DOMString toString()

Protected Methods

oDOMString toString( const DOMString &tag )


Documentation

This EppDomain class implements EPP Domain objects.

ostatic const char* CONTACT_TYPE_ADMIN
Contact type for administration contact ("admin");

ostatic const char* CONTACT_TYPE_BILLING
Contact type for billing contact ("billing");

ostatic const char* CONTACT_TYPE_TECH
Contact type for technical contact ("tech")

ostatic const char* STATUS_CLIENT_DELETE_PROHIBITED
Domain status - clientDeleteProhibited

ostatic const char* STATUS_CLIENT_HOLD
Domain status - clientHold

ostatic const char* STATUS_CLIENT_RENEW_PROHIBITED
Domain status - clientRenewProhibited

ostatic const char* STATUS_CLIENT_TRANSFER_PROHIBITED
Domain status - clientTransferProhibited

ostatic const char* STATUS_CLIENT_UPDATE_PROHIBITED
Domain status - clientUpdateProhibited

ostatic const char* STATUS_INACTIVE
Domain status - inactive

ostatic const char* STATUS_OK
Domain status - ok

ostatic const char* STATUS_PENDING_DELETE
Domain status - pendingDelete

ostatic const char* STATUS_PENDING_TRANSFER
Domain status - pendingTransfer

ostatic const char* STATUS_PENDING_VERIFICATION
Domain status - pendingVerification

ostatic const char* STATUS_SERVER_DELETE_PROHIBITED
Domain status - serverDeleteProhibited

ostatic const char* STATUS_SERVER_HOLD
Domain status - serverHold

ostatic const char* STATUS_SERVER_RENEW_PROHIBITED
Domain status - serverRenewProhibited

ostatic const char* STATUS_SERVER_TRANSFER_PROHIBITED
Domain status - serverTransferProhibited

ostatic const char* STATUS_SERVER_UPDATE_PROHIBITED
Domain status - serverUpdateProhibited

o EppDomain()
Creates an EppDomain object

o EppDomain( DOMString name )
Creates an EppDomain object with a domain name

o ~EppDomain()
Destructor

ovirtual int getEntityType()
Returns the run-time type of an EppEntity object

oDOMString getName()
Gets the domain name

ovoid setName( DOMString name )
Sets the domain name

oValueVectorOf<DOMString> * getHost()
Gets a list of host names associated with the domain

ovoid 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.

oValueVectorOf<DOMString> * getNameServer()
Gets a list of name servers associated with the domain

ovoid addNameServer( DOMString nameServer )
Add a name server associated with the domain

oValueVectorOf<EppContactType> * getContact()
Gets a list of contacts associated with the domain

ovoid addContact( EppContactType contact )
Adds a contact for the domain

ovoid addContact( DOMString id, DOMString type )
Adds a contact for the domain, given a contact id and its type

oEppPeriod* getPeriod()
Gets registration period for the domain name

ovoid setPeriod( EppPeriod period )
Sets registration period for the domain name

oDOMString getRegistrant()
Gets the contact id of the registrant which owns the domain

ovoid setRegistrant( DOMString registrant )
Sets the contact id of the registrant which owns the domain

oDOM_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

ostatic 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

ostatic 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

ostatic 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

ostatic 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

ostatic 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

ostatic 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

ostatic 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


Copyright © 2001-2002 NeuLevel, Inc. All Rights Reserved.