Package com.verisign.epp.codec.coaext

Class EPPCoaExtKey

java.lang.Object
com.verisign.epp.codec.coaext.EPPCoaExtKey
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPCoaExtKey extends Object implements EPPCodecComponent
EPPCodecComponent that encodes and decodes a COA Key Tag.

Title: EPP 1.0 Client Object Attribute - Key

Description: The Key tag represents the name of a Client Object Attribute. It contains simply the Client Object Attribute name as text.

Copyright: Copyright (c) 2011

Company: VeriSign

See Also:

  • Field Details

  • Constructor Details

    • EPPCoaExtKey

      public EPPCoaExtKey()
      Create an EPPCoaExtKey instance

    • EPPCoaExtKey

      public EPPCoaExtKey(String aKey)
      Create a EPPCoaExtKey intance with the given key
      Parameters:
      aKey - the key

  • Method Details

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPCoaExtKey.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPCoaExtKey
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Sets all this instance's data in the given XML document
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - a DOM Document to attach data to.
      Returns:
      The root element of this component.
      Throws:
      EPPEncodeException - Thrown if any errors prevent encoding.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPCoaExtKey component
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - DOM Element to decode
      Throws:
      EPPDecodeException - On decoding error

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPCoaExtKey compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPCoaExtKey instance to compare with
      Returns:
      true if equal false otherwise

    • getKey

      public String getKey()
      Returns the key to a key/value pair.
      Returns:
      the COA key

    • setKey

      public void setKey(String aKey)
      Sets the Key
      Parameters:
      aKey - Key of COA

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.