|
EPP 0.2.5 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.neulevel.epp.core.EppEntity | +--com.neulevel.epp.core.command.EppCommand
This EppCommand
class implements EPP Command entity.
Field Summary | |
protected java.lang.String |
clTRID
The client transaction id associated with the EPP Command |
protected EppCreds |
creds
The EPP Credentials associated with the EPP Command (optional) |
protected EppUnspec |
unspec
Any extension data associated with the EPP Command (optional) |
Constructor Summary | |
EppCommand()
|
Method Summary | |
static EppCommandCheck |
check(int objectType,
java.lang.String xid)
Creates an EppCommandCheck object based on the
object type. |
static EppCommandCreate |
create(EppObject object,
java.lang.String xid)
Creates an EppCommandCreate object. |
static EppCommandDelete |
delete(int objectType,
java.lang.String objectId,
java.lang.String xid)
Creates an EppCommandDelete object based on the
object type. |
static EppEntity |
fromXML(org.w3c.dom.Node root)
Converts an XML element into an EppCommand object. |
java.lang.String |
getClientTransactionId()
Gets transaction id from the registrar client |
EppCreds |
getCreds()
Gets command credentials |
EppUnspec |
getUnspec()
Gets optional unspecified object |
static EppCommandInfo |
info(int objectType,
java.lang.String objectId,
java.lang.String xid)
Creates an EppCommandInfo object based on the
object type. |
static EppCommandRenew |
renew(int objectType,
java.lang.String objectId,
java.lang.String xid)
Creates an EppCommandRenew object based on the
object type. |
void |
setClientTransactionId(java.lang.String xid)
Sets transaction id from the registrar client |
void |
setCreds(EppCreds creds)
Sets command credentials |
void |
setUnspec(EppUnspec unspec)
Sets optional unspecified object |
protected org.w3c.dom.Element |
toXMLCommon(org.w3c.dom.Document doc,
java.lang.String command,
org.w3c.dom.Element element)
Converts the shared EppCommand components into an XML
element. |
protected org.w3c.dom.Element |
toXMLCommon(org.w3c.dom.Document doc,
java.lang.String command,
org.w3c.dom.Element element,
java.util.Vector attrList)
Converts the shared EppCommand components into an XML
element. |
protected org.w3c.dom.Element |
toXMLCommon(org.w3c.dom.Document doc,
java.lang.String command,
EppEntity object)
Converts the shared EppCommand components into an XML
element. |
protected org.w3c.dom.Element |
toXMLCommon(org.w3c.dom.Document doc,
java.lang.String command,
java.lang.Object object,
java.lang.String tag,
java.util.Vector attrList)
Converts the shared EppCommand components into an XML
element |
static EppCommandTransfer |
transfer(int objectType,
java.lang.String objectId,
java.lang.String xid)
Creates an EppCommandTransfer object based on the
object type. |
static EppCommandUpdate |
update(int objectType,
java.lang.String objectId,
java.lang.String xid)
Creates an EppCommandUpdate object based on the
object type. |
Methods inherited from class com.neulevel.epp.core.EppEntity |
toString,
toString,
toXML |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
protected EppCreds creds
protected EppUnspec unspec
protected java.lang.String clTRID
Constructor Detail |
public EppCommand()
Method Detail |
public EppCreds getCreds()
public void setCreds(EppCreds creds)
public EppUnspec getUnspec()
public void setUnspec(EppUnspec unspec)
public java.lang.String getClientTransactionId()
public void setClientTransactionId(java.lang.String xid)
protected org.w3c.dom.Element toXMLCommon(org.w3c.dom.Document doc, java.lang.String command, org.w3c.dom.Element element)
EppCommand
components into an XML
element. The command must be object specific commands such as
create/delete/query, etc.doc
- the XML Document
objectcommand
- the tag/element name for the EppCommand
objectelement
- the Element
associated with the commandElement
objectprotected org.w3c.dom.Element toXMLCommon(org.w3c.dom.Document doc, java.lang.String command, org.w3c.dom.Element element, java.util.Vector attrList)
EppCommand
components into an XML
element. The command must be object specific commands such as
create/delete/query, etc.doc
- the XML Document
objectcommand
- the tag/element name for the EppCommand
objectelement
- the Element
associated with the commandattrList
- the Attr
list associated with the
commandElement
objectprotected org.w3c.dom.Element toXMLCommon(org.w3c.dom.Document doc, java.lang.String command, EppEntity object)
EppCommand
components into an XML
element. The command must be object specific commands such as
create/delete/query, etc.doc
- the XML Document
objectcommand
- the tag/element name for the EppCommand
objectobject
- the EppObject
associated with the command.
the type of the object should be either
EppEntity
or Element
Element
objectprotected org.w3c.dom.Element toXMLCommon(org.w3c.dom.Document doc, java.lang.String command, java.lang.Object object, java.lang.String tag, java.util.Vector attrList)
EppCommand
components into an XML
elementdoc
- the XML Document
objectcommand
- the tag/element name for the EppCommand
objectobject
- the Object
associated with the command.
the type of the object should be either
EppEntity
or Element
tag
- the tag indicating if the command is generic, such
as login/logoutattrList
- the Attr
list associated with the
commandElement
objectpublic static EppEntity fromXML(org.w3c.dom.Node root)
EppCommand
object.
The caller of this method must make sure that the root node is of
an EPP Command entity.root
- root node for an EppCommand
object in XML
formatEppEntity
object, or null if the node
is invalidpublic static EppCommandCreate create(EppObject object, java.lang.String xid)
EppCommandCreate
object. This is a
convience method for creating an EPP Object in the registry.object
- object to be created in the registryxid
- client transaction id associated with the operationEppCommandCreate
object, which could
be one of the subclass of EppCommandCreate
public static EppCommandCheck check(int objectType, java.lang.String xid)
EppCommandCheck
object based on the
object type.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 operationEppCommandCheck
object, which could
be one of the subclass of EppCommandCheck
;
or null if the object type is invalid.public static EppCommandDelete delete(int objectType, java.lang.String objectId, java.lang.String xid)
EppCommandDelete
object based on the
object type.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, or service
subscription id for an EPP Svcsub objectxid
- client transaction id associated with the operationEppCommandDelete
object, which could
be one of the subclass of EppCommandDelete
;
or null if the object type is invalid.public static EppCommandInfo info(int objectType, java.lang.String objectId, java.lang.String xid)
EppCommandInfo
object based on the
object type.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, or service
subscription id for an EPP Svcsub objectxid
- client transaction id associated with the operationEppCommandInfo
object, which could
be one of the subclass of EppCommandInfo
;
or null if the object type is invalid.public static EppCommandUpdate update(int objectType, java.lang.String objectId, java.lang.String xid)
EppCommandUpdate
object based on the
object type.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, or service subscription
id for an EPP Svcsub objectxid
- client transaction id associated with the operationEppCommandUpdate
object, which could
be one of the subclass of EppCommandUpdate
;
or null if the object type is invalid.public static EppCommandTransfer transfer(int objectType, java.lang.String objectId, java.lang.String xid)
EppCommandTransfer
object based on the
object type.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, or service
subscription id for an EPP Svcsub objectxid
- client transaction id associated with the operationEppCommandTransfer
object, which could
be one of the subclass of EppCommandTransfer
;
or null if the object type is invalid.public static EppCommandRenew renew(int objectType, java.lang.String objectId, java.lang.String xid)
EppCommandRenew
object based on the
object type.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, or service subscription id for an EPP
Svcsub objectxid
- client transaction id associated with the operationEppCommandRenew
object, which could
be one of the subclass of EppCommandRenew
;
or null if the object type is invalid.
|
EPP 0.2.5 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |