Package com.verisign.epp.codec.keyrelay

Class EPPKeyRelayData

java.lang.Object
com.verisign.epp.codec.keyrelay.EPPKeyRelayData
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPKeyRelayData extends Object implements EPPCodecComponent
The EPPKeyRelayData is the EPPCodecComponent that knows how to encode and decode keyData elements from/to XML and object instance.
See Also:

  • Constructor Details

    • EPPKeyRelayData

      public EPPKeyRelayData()
      Create a new instance of EPPKeyRelayData

    • EPPKeyRelayData

      public EPPKeyRelayData(EPPKeyRelayKeyData aKeyData)
      Create a new instance of EPPKeyRelayData with the required key data.

    • EPPKeyRelayData

      public EPPKeyRelayData(EPPKeyRelayKeyData aKeyData, EPPKeyRelayExpiry aExpiry)
      Create a new instance of EPPKeyRelayData with the required key data and the optional expiry.

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Append all data from this secDNS:keyData to the given DOM Document
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - The DOM Document to append data to
      Returns:
      Encoded DOM Element
      Throws:
      EPPEncodeException - Thrown when errors occur during the encode attempt or if the instance is invalid.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Populate the data of this instance with the data stored in the given Element of the DOM tree
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - The root element of the fragment of XML
      Throws:
      EPPDecodeException - Thrown if any errors occur during decoding.

    • equals

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

    • clone

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

    • getKeyData

      public EPPKeyRelayKeyData getKeyData()
      Gets the DNSSEC key material.
      Returns:
      DNSSEC key material

    • setKeyData

      public void setKeyData(EPPKeyRelayKeyData aKeyData)
      Sets the DNSSEC key material.
      Parameters:
      aKeyData - DNSSEC key material

    • getExpiry

      public EPPKeyRelayExpiry getExpiry()
      Gets the optional expected lifetime of the relayed key(s) in the zone.
      Returns:
      Expected lifetime of the relayed key(s) in the zone if defined; null otherwise.

    • setExpiry

      public void setExpiry(EPPKeyRelayExpiry aExpiry)
      Sets the optional expected lifetime of the relayed key(s) in the zone.
      Parameters:
      aExpiry - Expected lifetime of the relayed key(s) in the zone. Set to null to unset it.

    • 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 Object
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • getNamespace

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