EPPRegistryKey (verisign 1.12.0.12 API)

java.lang.Object
- com.verisign.epp.codec.registry.v01.EPPRegistryKey

All Implemented Interfaces:

EPPCodecComponent, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

EPPRegistryDS
```
public class EPPRegistryKey
extends java.lang.Object
implements EPPCodecComponent
```
Defines the Key Data Interface, as defined in RFC 5910, policies. The <registry:keyDataInterface> element contains the following child elements:
- <registry:min> - the minimum number of keys associated with the domain object. Use getMin() and setMin(Integer) to get and set the element.
- <registry:max> - the maximum number of keys associated with the domain object. Use getMax() and 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 2.1.3 of RFC 4034. Use getAlgorithms() and setAlgorithms(List) to get and set the element. Use addAlgorithm(String) to add an algorithm String to an existing List.
See Also:

EPPRegistryDNSSEC, Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ELM_ALGORITHM` XML Element Name of `algorithms` attribute.
`static java.lang.String`	`ELM_LOCALNAME` XML local name for `EPPRegistryKey`.
`static java.lang.String`	`ELM_MAX` XML Element Name of `max` attribute.
`static java.lang.String`	`ELM_MIN` XML Element Name of `min` attribute.
`static java.lang.String`	`ELM_NAME` XML root tag for `EPPRegistryKey`.

Constructor Summary

Constructors
Constructor and Description
`EPPRegistryKey()` Default constructor.
`EPPRegistryKey(java.lang.Integer aMin, java.lang.Integer aMax, java.util.List<java.lang.String> aAlgorithms)` Constructs an instance with `min`, `max` and `List` of `algorithms`.
`EPPRegistryKey(int aMin, int aMax, java.util.List<java.lang.String> aAlgorithms)` Constructs an instance with `min`, `max` and `List` of `algorithms`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAlgorithm(java.lang.String aAltorithm)` Adds one algorithm to existing supported algorithms.
`java.lang.Object`	`clone()` Clone `EPPRegistryKey`.
`void`	`decode(org.w3c.dom.Element aElement)` Decode the `EPPRegistryKey` attributes from the aElement DOM Element tree.
`org.w3c.dom.Element`	`encode(org.w3c.dom.Document aDocument)` Encode a DOM Element tree from the attributes of the `EPPRegistryKey` instance.
`boolean`	`equals(java.lang.Object aObject)` implements a deep `EPPRegistryKey` compare.
`java.util.List<java.lang.String>`	`getAlgorithms()` Gets the supported algorithms.
`java.lang.Integer`	`getMax()` Gets the maximum number of keys.
`java.lang.Integer`	`getMin()` Gets the minimum number of keys.
`java.lang.String`	`getNamespace()` Returns the XML namespace associated with the `EPPCodecComponent`.
`protected java.lang.String`	`getRootName()` Gets the root element local name.
`boolean`	`hasAlgorithms()` Is the algorithms defined?
`void`	`setAlgorithms(java.util.List<java.lang.String> aAlgorithms)` Sets the supported algorithms.
`void`	`setMax(java.lang.Integer aMax)` Sets the maximum number of keys.
`void`	`setMin(java.lang.Integer aMin)` Sets the minimum number of keys.
`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

- Field Detail
  - ELM_LOCALNAME
```
public static final java.lang.String ELM_LOCALNAME
```
    XML local name for EPPRegistryKey.
    
    See Also:
    
    Constant Field Values
  - ELM_NAME
```
public static final java.lang.String ELM_NAME
```
    XML root tag for EPPRegistryKey.
    
    See Also:
    
    Constant Field Values
  - ELM_MIN
```
public static final java.lang.String ELM_MIN
```
    XML Element Name of min attribute.
    
    See Also:
    
    Constant Field Values
  - ELM_MAX
```
public static final java.lang.String ELM_MAX
```
    XML Element Name of max attribute.
    
    See Also:
    
    Constant Field Values
  - ELM_ALGORITHM
```
public static final java.lang.String ELM_ALGORITHM
```
    XML Element Name of algorithms attribute.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - EPPRegistryKey
```
public EPPRegistryKey()
```
    Default constructor. Must call setMin(Integer) and setMax(Integer) before calling encode(Document) method.
  - EPPRegistryKey
```
public EPPRegistryKey(java.lang.Integer aMin,
                      java.lang.Integer aMax,
                      java.util.List<java.lang.String> aAlgorithms)
```
    Constructs an instance with min, max and List of algorithms.
    
    Parameters:
    
    aMin - minimum number of keys associated with the domain object
    
    aMax - maximum number of keys associated with the domain object
    
    aAlgorithms - supported algorithms as described in section 2.1.3 of RFC 4034
  - EPPRegistryKey
```
public EPPRegistryKey(int aMin,
                      int aMax,
                      java.util.List<java.lang.String> aAlgorithms)
```
    Constructs an instance with min, max and List of algorithms.
    
    Parameters:
    
    aMin - minimum number of keys associated with the domain object
    
    aMax - maximum number of keys associated with the domain object
    
    aAlgorithms - supported algorithms as described in section 2.1.3 of RFC 4034
- Method Detail
  - encode
```
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument)
                           throws EPPEncodeException
```
    Encode a DOM Element tree from the attributes of the EPPRegistryKey instance.
    
    Specified by:
    
    encode in interface EPPCodecComponent
    
    Parameters:
    
    aDocument - DOM Document that is being built. Used as an Element factory.
    
    Returns:
    
    Element Root DOM Element representing the EPPRegistryKey instance.
    
    Throws:
    
    EPPEncodeException - - Unable to encode EPPRegistryKey instance.
  - decode
```
public void decode(org.w3c.dom.Element aElement)
            throws EPPDecodeException
```
    Decode the EPPRegistryKey attributes from the aElement DOM Element tree.
    
    Specified by:
    
    decode in interface EPPCodecComponent
    
    Parameters:
    
    aElement - Root DOM Element to decode EPPRegistryKey from.
    
    Throws:
    
    EPPDecodeException - Unable to decode aElement
  - clone
```
public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
```
    Clone EPPRegistryKey.
    
    Specified by:
    
    clone in interface EPPCodecComponent
    
    Overrides:
    
    clone in class java.lang.Object
    
    Returns:
    
    clone of EPPRegistryKey
    
    Throws:
    
    java.lang.CloneNotSupportedException - standard Object.clone exception
  - equals
```
public boolean equals(java.lang.Object aObject)
```
    implements a deep EPPRegistryKey compare.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    aObject - EPPRegistryKey instance to compare with
    
    Returns:
    
    true if this object is the same as the aObject argument; false otherwise
  - toString
```
public java.lang.String toString()
```
    Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Indented XML String if successful; ERROR otherwise.
  - getMin
```
public java.lang.Integer getMin()
```
    Gets the minimum number of keys.
    
    Returns:
    
    minimum number of keys associated with the domain object.
  - setMin
```
public void setMin(java.lang.Integer aMin)
```
    Sets the minimum number of keys.
    
    Parameters:
    
    aMin - minimum number of keys associated with the domain object.
  - getMax
```
public java.lang.Integer getMax()
```
    Gets the maximum number of keys.
    
    Returns:
    
    maximum number of keys associated with the domain object.
  - setMax
```
public void setMax(java.lang.Integer aMax)
```
    Sets the maximum number of keys.
    
    Parameters:
    
    aMax - maximum number of keys associated with the domain object.
  - hasAlgorithms
```
public boolean hasAlgorithms()
```
    Is the algorithms defined?
    
    Returns:
    
    true if the algorithms is defined; false otherwise.
  - getAlgorithms
```
public java.util.List<java.lang.String> getAlgorithms()
```
    Gets the supported algorithms.
    
    Returns:
    
    List of supported algorithms as described in section 2.1.3 of RFC 4034
  - setAlgorithms
```
public void setAlgorithms(java.util.List<java.lang.String> aAlgorithms)
```
    Sets the supported algorithms.
    
    Parameters:
    
    aAlgorithms - List of supported algorithms as described in section 2.1.3 of RFC 4034
  - addAlgorithm
```
public void addAlgorithm(java.lang.String aAltorithm)
```
    Adds one algorithm to existing supported algorithms.
    
    Parameters:
    
    aAltorithm - supported algorithms as described in section 2.1.3 of RFC 4034
  - getNamespace
```
public java.lang.String getNamespace()
```
    Returns the XML namespace associated with the EPPCodecComponent.
    
    Specified by:
    
    getNamespace in interface EPPCodecComponent
    
    Returns:
    
    XML namespace for the EPPCodecComponent.
  - getRootName
```
protected java.lang.String getRootName()
```
    Gets the root element local name.
    
    Returns:
    
    Root element local name.

Class EPPRegistryKey

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ELM_LOCALNAME

ELM_NAME

ELM_MIN

ELM_MAX

ELM_ALGORITHM

Constructor Detail

EPPRegistryKey

EPPRegistryKey

EPPRegistryKey

Method Detail

encode

decode

clone

equals

toString

getMin

setMin

getMax

setMax

hasAlgorithms

getAlgorithms

setAlgorithms

addAlgorithm

getNamespace

getRootName