|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPProtocolExtension
public abstract class EPPProtocolExtension
Represents an EPPProtocol extension that is sent by an EPP Client and
received by an EPP Server. An EPPProtocolExtension
can be
encoded and decoded by EPPCodec
.
Every EPPProtocol extension must extend EPPProtocolExtension
and implement the Template Method Design Pattern doGenEncode
and doGenDecode
methods. An EPPProtocolExtension
client will call encode
or decode
, which in turn
will call doGenEncode
or doGenDecode
,
respectively. There is one derived EPPProtocolExtension
for each type of extension defined in the general EPP Specification.
Constructor Summary | |
---|---|
EPPProtocolExtension()
Allocates a new EPPProtocolExtension with default attribute
values. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPProtocolExtension . |
void |
decode(org.w3c.dom.Element aElement)
decode EPPProtocolExtension from a DOM element tree. |
protected abstract void |
doDecode(org.w3c.dom.Element aElement)
Decodes the atributes of a general extension of EPPProtocolExtension . |
protected abstract org.w3c.dom.Element |
doEncode(org.w3c.dom.Document aDocument)
Encodes the atributes of a protocol extension of EPPProtocolExtension . |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode EPPProtocolExtension into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPProtocolExtension compare. |
abstract java.lang.String |
getNamespace()
Gets the EPP namespace associated with the EPPProtocolExtension . |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPProtocolExtension()
EPPProtocolExtension
with default attribute
values.
Method Detail |
---|
public abstract java.lang.String getNamespace()
EPPProtocolExtension
.
getNamespace
in interface EPPMessage
EPPProtocolExtension
.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPProtocolExtension
into a DOM element tree. The
<extension> element is created and the attribute nodes are
appending as children. This method is a Template Method in
the Template Method Design Pattern.
encode
in interface EPPCodecComponent
aDocument
- DOCUMENT ME!
EPPEncodeException
- Error encoding the DOM element tree.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPProtocolExtension
from a DOM element tree. The
"extension" element needs to be the value of the
aElement
argument. This method is a Template
Method in the Template Method Design Pattern.
decode
in interface EPPCodecComponent
aElement
- <extension> root element tree.
EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
EPPProtocolExtension
compare.
equals
in class java.lang.Object
aObject
- EPPProtocolExtension
instance to compare
with
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPProtocolExtension
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPProtocolExtension
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.protected abstract org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPProtocolExtension
. An example of a protocol
extension is EPPAlert
. encode
is a
Template Method and this method is a Primitive
Operation within the Template Method Design Pattern.
aDocument
- DOM document used as a factory of DOM objects.
EPPEncodeException
- Error encoding the DOM element tree.protected abstract void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPProtocolExtension
. An example of a protocol
extension is EPPAlert
. decode
is a
Template Method and this method is a Primitive
Operation within the Template Method Design Pattern.
aElement
- root DOM element associated with instance
EPPDecodeException
- Error decoding the DOM element tree.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |