class EppCommand

This EppCommand class implements EPP Command entity.

Inheritance:

Public Methods

[more] EppCommand()
Creates EppCommand object
[more]virtual ~EppCommand()
Destructor
[more]virtual int getEntityType()
Returns the run-time type of an EppEntity object
[more]EppCreds* getCreds()
Gets command credentials
[more]void setCreds( EppCreds& creds )
Sets command credentials
[more]EppUnspec* getUnspec()
Gets optional unspecified object
[more]void setUnspec( EppUnspec& unspec )
Sets optional unspecified object
[more]DOMString getClientTransactionId()
Gets transaction id from the registrar client
[more]void setClientTransactionId( DOMString xid )
Sets transaction id from the registrar client
[more]static EppCommand* fromXML( const DOM_Node& root )
Converts an XML element into an EppCommand object.
[more]static EppCommandCreate create( EppObject* object, DOMString xid )
Creates an EppCommandCreate object.
[more]static EppCommandCheck* check( int objectType, DOMString xid )
Creates an EppCommandCheck object based on the object type.
[more]static EppCommandDelete* remove( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandDelete object based on the object type.
[more]static EppCommandInfo* info( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandInfo object based on the object type.
[more]static EppCommandUpdate* update( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandUpdate object based on the object type.
[more]static EppCommandTransfer* transfer( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandTransfer object based on the object type.
[more]static EppCommandRenew* renew( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandRenew object based on the object type.

Protected Fields

[more]EppCreds* creds
The EPP Credentials associated with the EPP Command (optional)
[more]EppUnspec* unspec
Any extension data associated with the EPP Command (optional)
[more]DOMString clTRID
The client transaction id associated with the EPP Command

Protected Methods

[more]DOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element )
Converts the shared EppCommand components into an XML element.
[more]DOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element, ValueVectorOf<DOM_Attr>* attrList )
Converts the shared EppCommand components into an XML element.
[more]DOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, EppEntity* object )
Converts the shared EppCommand components into an XML element.
[more]DOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element, EppEntity* object, const DOMString tag, ValueVectorOf<DOM_Attr>* attrList )
Converts the shared EppCommand components into an XML element

Inherited from EppEntity:

Public Methods

obool instanceOf( const int type )
ovirtual DOM_Element toXML( DOM_Document &doc, const DOMString &tag )
ovirtual DOMString toString()

Protected Methods

oDOMString toString( const DOMString &tag )

Documentation

This EppCommand class implements EPP Command entity.

oEppCreds* creds
The EPP Credentials associated with the EPP Command (optional)

oEppUnspec* unspec
Any extension data associated with the EPP Command (optional)

oDOMString clTRID
The client transaction id associated with the EPP Command

oDOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element )
Converts the shared EppCommand components into an XML element. The command must be object specific commands such as create/delete/query, etc.

Parameters:
doc - the XML DOM_Element object
command - the tag/element name for the EppCommand object
element - the DOM_Element associated with the command
Returns:
an DOM_Element object

oDOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element, ValueVectorOf<DOM_Attr>* attrList )
Converts the shared EppCommand components into an XML element. The command must be object specific commands such as create/delete/query, etc.

Parameters:
doc - the XML DOM_Element object
command - the tag/element name for the EppCommand object
element - the DOM_Element associated with the command
attrList - the Attr list associated with the command
Returns:
an DOM_Element object

oDOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, EppEntity* object )
Converts the shared EppCommand components into an XML element. The command must be object specific commands such as create/delete/query, etc.

Parameters:
doc - the XML DOM_Element object
command - the tag/element name for the EppCommand object
object - the EppObject associated with the command. the type of the object should be either EppEntity or DOM_Element
Returns:
an DOM_Element object

oDOM_Element toXMLCommon( DOM_Document& doc, const DOMString command, DOM_Element& element, EppEntity* object, const DOMString tag, ValueVectorOf<DOM_Attr>* attrList )
Converts the shared EppCommand components into an XML element

Parameters:
doc - the XML DOM_Element object
command - the tag/element name for the EppCommand object
element - the DOM_Element associated with the command.
object - the EppEntity associated with the command.
tag - the tag indicating if the command is generic, such as login/logout
attrList - the Attr list associated with the command
Returns:
an DOM_Element object
Note: the element and object parameters should be mutually exclusive, i.e. if object is not null, element will not be used, or if object is null, the element should be used

o EppCommand()
Creates EppCommand object

ovirtual ~EppCommand()
Destructor

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

oEppCreds* getCreds()
Gets command credentials

ovoid setCreds( EppCreds& creds )
Sets command credentials

oEppUnspec* getUnspec()
Gets optional unspecified object

ovoid setUnspec( EppUnspec& unspec )
Sets optional unspecified object

oDOMString getClientTransactionId()
Gets transaction id from the registrar client

ovoid setClientTransactionId( DOMString xid )
Sets transaction id from the registrar client

ostatic EppCommand* fromXML( const DOM_Node& root )
Converts an XML element into an EppCommand object. The caller of this method must make sure that the root node is of an EPP Command entity.

Parameters:
root - root node for an EppCommand object in XML format
Returns:
an EppEntity object, or null if the node is invalid

ostatic EppCommandCreate create( EppObject* object, DOMString xid )
Creates an EppCommandCreate object. This is a convience method for creating an EPP Object in the registry.

Parameters:
object - object to be created in the registry
xid - client transaction id associated with the operation
Returns:
an EppCommandCreate object, which could be one of the subclass of EppCommandCreate

ostatic EppCommandCheck* check( int objectType, DOMString xid )
Creates an EppCommandCheck object based on the object type.

Parameters:
objectType - the type of objects to be checked. The value must be defined in EppObject, as one of the followings:
xid - client transaction id associated with the operation
Returns:
an EppCommandCheck object, which could be one of the subclass of EppCommandCheck; or null if the object type is invalid.
Note: the memory associated with the command should be freed by the caller

ostatic EppCommandDelete* remove( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandDelete object based on the object type.

Parameters:
objectType - the type of object to be deleted. The value must be defined in EppObject, as one of the followings:
objectId - the id associated with object to be deleted. The value is id for an EPP Contact object, domain name for an EPP Domain object, or host name for an EPP Host object.
xid - client transaction id associated with the operation
Returns:
an EppCommandDelete object, which could be one of the subclass of EppCommandDelete; or null if the object type is invalid.
Note: the memory associated with the command should be freed by the caller
Note: this method is named as delete in its Java API, but we could not use delete as it is a C++ keyword.

ostatic EppCommandInfo* info( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandInfo object based on the object type.

Parameters:
objectType - the type of object to be queried. The value must be defined in EppObject, as one of the followings:
objectId - the id associated with object to be queried. The value is id for an EPP Contact object, domain name for an EPP Domain object, or host name for an EPP Host object.
xid - client transaction id associated with the operation
Returns:
an EppCommandInfo object, which could be one of the subclass of EppCommandInfo; or null if the object type is invalid.
Note: the memory associated with the command should be freed by the caller

ostatic EppCommandUpdate* update( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandUpdate object based on the object type.

Parameters:
objectType - the type of object to be updated. The value must be defined in EppObject, as one of the followings:
objectId - the id associated with object to be updated. The value is id for an EPP Contact object, domain name for an EPP Domain object, or host name for an EPP Host object.
xid - client transaction id associated with the operation
Returns:
an EppCommandUpdate object, which could be one of the subclass of EppCommandUpdate; or null if the object type is invalid.
Note: the memory associated with the command should be freed by the caller

ostatic EppCommandTransfer* transfer( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandTransfer object based on the object type.

Parameters:
objectType - the type of object to be transferred. The value must be defined in EppObject, as one of the followings:
objectId - the id associated with object to be transferred. The value is id for an EPP Contact object, domain name for an EPP Domain object.
xid - client transaction id associated with the operation
Returns:
an EppCommandTransfer object, which could be one of the subclass of EppCommandTransfer; or null if the object type is invalid.
Note: the memory associated with the command should be freed by the caller

ostatic EppCommandRenew* renew( int objectType, DOMString objectId, DOMString xid )
Creates an EppCommandRenew object based on the object type.

Parameters:
objectType - the type of object to be renewed. The value must be defined in EppObject, as one of the followings:
objectId - the id associated with object to be renewed. The value is the domain name for an EPP Domain object.
xid - client transaction id associated with the operation
Returns:
an EppCommandRenew object, which could be one of the subclass of EppCommandRenew; or null if the object type is invalid.
Note: As the current expiration date of the object is default to the current date, and the default value of the new registration period is specified by the registry, the the caller to this method may have to use setCurrentExpiratin and setPeriod to change these default values.

Direct child classes:
EppCommandUpdate
EppCommandTransfer
EppCommandRenew
EppCommandPoll
EppCommandLogout
EppCommandLogin
EppCommandInfo
EppCommandDelete
EppCommandCreate
EppCommandCheck
Author:
Ning Zhang ning.zhang@neustar.com
Version:
$Revision: 1.1 $ $Date: 2001/11/05 20:20:36 $

Alphabetic index HTML hierarchy of classes or Java

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