Package com.verisign.epp.codec.registry

Class EPPRegistryDS

java.lang.Object

com.verisign.epp.codec.registry.EPPRegistryKey

com.verisign.epp.codec.registry.EPPRegistryDS

All Implemented Interfaces:

EPPCodecComponent, Serializable, Cloneable

public class EPPRegistryDS
extends EPPRegistryKey

Defines the DS Data Interface, as defined in RFC 5910, policies. The <registry:dsDataInterface> element contains the following child elements:

• <registry:min> - the minimum number of DS associated with the domain object. Use EPPRegistryKey.getMin() and EPPRegistryKey.setMin(Integer) to get and set the element.
• <registry:max> - the maximum number of DS associated with the domain object. Use EPPRegistryKey.getMax() and EPPRegistryKey.setMax(Integer) to get and set the element.
• <registry:alg> - zero or more <registry:alg> elements that define the supported algorithms as described in section 5.1.2 of RFC 4034. Use EPPRegistryKey.getAlgorithms() and EPPRegistryKey.setAlgorithms(List) to get and set the element.
• <registry:digestType> - zero or more <registry:digestType> elements that define the supported digest types as described in section 5.1.3 of RFC 4034. Use getDigestTypes() and setDigestTypes(List) to get and set the element.

See Also:

• EPPRegistryDNSSEC
• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_DIGEST	XML tag name for the digestTypeF attribute.
static final String	ELM_NAME	XML Element Name of EPPRegistryDS root element.

Fields inherited from class com.verisign.epp.codec.registry.EPPRegistryKey

ALGORITHM, ELM_MAX, ELM_MIN

Constructor Summary

Constructors

Constructor	Description
EPPRegistryDS()	Constructs a new EPPRegistryDS object.
EPPRegistryDS(int min, int max, List algorithms, List digestTypes)	Constructs a new EPPRegistryDS with given values.
EPPRegistryDS(Integer min, Integer max, List algorithms, List digestTypes)	Constructs a new EPPRegistryDS with given values.

Method Summary

Modifier and Type	Method	Description
void	addDigestType(String digestType)	Add one digest type to an existing list.
Object	clone()	Clone EPPRegistryDS.
void	decode(Element aElement)	Decode the EPPRegistryDS attributes from the aElement DOM Element tree.
Element	encode(Document aDocument)	Encode a DOM Element tree from the attributes of the EPPRegistryDS instance.
boolean	equals(Object aObject)	implements a deep EPPRegistryDS compare.
List	getDigestTypes()	Get digest types.
String	getRootName()	DOCUMENT ME!
void	setDigestTypes(List digestTypes)	Set digest types.
String	toString()	Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Methods inherited from class com.verisign.epp.codec.registry.EPPRegistryKey

addAlgorithm, getAlgorithms, getMax, getMin, getNamespace, setAlgorithms, setMax, setMin

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ELM_NAME

public static final String ELM_NAME

XML Element Name of EPPRegistryDS root element.

See Also:

• Constant Field Values

ELM_DIGEST

public static final String ELM_DIGEST

XML tag name for the digestTypeF attribute.

See Also:

• Constant Field Values

Constructor Details

EPPRegistryDS

public EPPRegistryDS()

Constructs a new EPPRegistryDS object. All attributes are set to default. Must call EPPRegistryKey.setMin(Integer) and EPPRegistryKey.setMax(Integer) before calling encode(Document) method.

EPPRegistryDS

public EPPRegistryDS(Integer min,
 Integer max,
 List algorithms,
 List digestTypes)

Constructs a new EPPRegistryDS with given values.

Parameters:

min - minimum number of DS associated with the domain object

max - maximum number of DS associated with the domain object

algorithms - List of algorithm String

digestTypes - List of digest type String

EPPRegistryDS

public EPPRegistryDS(int min,
 int max,
 List algorithms,
 List digestTypes)

Constructs a new EPPRegistryDS with given values.

Parameters:

min - minimum number of DS associated with the domain object

max - maximum number of DS associated with the domain object

algorithms - List of algorithm String

digestTypes - List of digest type String

Method Details

encode

public Element encode(Document aDocument)
               throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPRegistryDS instance.

Specified by:

encode in interface EPPCodecComponent

Overrides:

encode in class EPPRegistryKey

Parameters:

aDocument - DOM Document that is being built. Used as an Element factory.

Returns:

Element Root DOM Element representing the EPPRegistryDS instance.

Throws:

EPPEncodeException - - Unable to encode EPPRegistryDS instance.

decode

public void decode(Element aElement)
            throws EPPDecodeException

Decode the EPPRegistryDS attributes from the aElement DOM Element tree.

Specified by:

decode in interface EPPCodecComponent

Overrides:

decode in class EPPRegistryKey

Parameters:

aElement - Root DOM Element to decode EPPRegistryDS from.

Throws:

EPPDecodeException - Unable to decode aElement

clone

public Object clone()
             throws CloneNotSupportedException

Clone EPPRegistryDS.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPRegistryKey

Returns:

clone of EPPRegistryDS

Throws:

CloneNotSupportedException - standard Object.clone exception

equals

public boolean equals(Object aObject)

implements a deep EPPRegistryDS compare.

Overrides:

equals in class EPPRegistryKey

Parameters:

aObject - EPPRegistryDS instance to compare with

Returns:

true if this object is the same as the aObject argument; false otherwise

toString

public String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class EPPRegistryKey

Returns:

Indented XML String if successful; ERROR otherwise.

getDigestTypes

public List getDigestTypes()

Get digest types.

Returns:

List of digest type in String

setDigestTypes

public void setDigestTypes(List digestTypes)

Set digest types.

Parameters:

digestTypes - List of digest type in String

addDigestType

public void addDigestType(String digestType)

Add one digest type to an existing list.

Parameters:

digestType - digest type in String

getRootName

public String getRootName()

DOCUMENT ME!

Overrides:

getRootName in class EPPRegistryKey

Returns:

DOCUMENT ME!