Package com.verisign.epp.codec.gen
Class EPPProtocolExtension
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPProtocolExtension
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public abstract class EPPProtocolExtension extends java.lang.Object implements EPPMessage
Represents an EPPProtocol extension that is sent by an EPP Client and received by an EPP Server. AnEPPProtocolExtension
can be encoded and decoded byEPPCodec
.
Every EPPProtocol extension must extendEPPProtocolExtension
and implement the Template Method Design PatterndoGenEncode
anddoGenDecode
methods. AnEPPProtocolExtension
client will callencode
ordecode
, which in turn will calldoGenEncode
ordoGenDecode
, respectively. There is one derivedEPPProtocolExtension
for each type of extension defined in the general EPP Specification.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EPPProtocolExtension()
Allocates a newEPPProtocolExtension
with default attribute values.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPProtocolExtension
.void
decode(org.w3c.dom.Element aElement)
decodeEPPProtocolExtension
from a DOM element tree.protected abstract void
doDecode(org.w3c.dom.Element aElement)
Decodes the atributes of a general extension ofEPPProtocolExtension
.protected abstract org.w3c.dom.Element
doEncode(org.w3c.dom.Document aDocument)
Encodes the atributes of a protocol extension ofEPPProtocolExtension
.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
encodeEPPProtocolExtension
into a DOM element tree.boolean
equals(java.lang.Object aObject)
implements a deepEPPProtocolExtension
compare.abstract java.lang.String
getNamespace()
Gets the EPP namespace associated with theEPPProtocolExtension
.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Method Detail
-
getNamespace
public abstract java.lang.String getNamespace()
Gets the EPP namespace associated with theEPPProtocolExtension
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Returns:
- Namespace URI associated with the
EPPProtocolExtension
.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encodeEPPProtocolExtension
into a DOM element tree. The <extensiongt; element is created and the attribute nodes are appending as children. This method is a Template Method in the Template Method Design Pattern.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document to create elements from- Returns:
- <extensiongt; root element tree.
- Throws:
EPPEncodeException
- Error encoding the DOM element tree.
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decodeEPPProtocolExtension
from a DOM element tree. The "extension" element needs to be the value of theaElement
argument. This method is a Template Method in the Template Method Design Pattern.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- <extensiongt; root element tree.- Throws:
EPPDecodeException
- Error decoding the DOM element tree.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPProtocolExtension
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPProtocolExtension
instance to compare with- Returns:
true
if equal;false
otherwise.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPProtocolExtension
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPProtocolExtension
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
doEncode
protected abstract org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encodes the atributes of a protocol extension ofEPPProtocolExtension
. An example of a protocol extension isEPPAlert
.encode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Parameters:
aDocument
- DOM document used as a factory of DOM objects.- Returns:
- instance root DOM element along with attribute child nodes.
- Throws:
EPPEncodeException
- Error encoding the DOM element tree.
-
doDecode
protected abstract void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decodes the atributes of a general extension ofEPPProtocolExtension
. An example of a protocol extension isEPPAlert
.decode
is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.- Parameters:
aElement
- root DOM element associated with instance- Throws:
EPPDecodeException
- Error decoding the DOM element tree.
-
-