Package com.verisign.epp.codec.registry.v02

Class EPPRegistryZoneList

java.lang.Object
com.verisign.epp.codec.registry.v02.EPPRegistryZoneList
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryZoneList extends Object implements EPPCodecComponent
Represents a list of zone summary info. Upon receiving an <info> command, with a <registry:all> element in it, the server puts a <registry:zoneList> element in the response. The list contains the zone summary attributes of supported zones. Use setZoneList and getZoneList to set and get zone list; use addZone to add zone to existing list; and use setZone to add one zone in the zone list ( setZone will empty the existing zone list).

Each element in the list contains the following info:
  • <registry:name> - fully qualified name of the zone
  • <registry:crDate> - date of zone object creation
  • <registry:upDate> - optional date of last update
See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryZoneList

      public EPPRegistryZoneList()
      Default constructor. zoneList is initialized as an empty List.

    • EPPRegistryZoneList

      public EPPRegistryZoneList(List<EPPRegistryZoneSummary> aZoneList)
      Constructor that takes a zone list.
      Parameters:
      aZoneList - List of zone summary

    • EPPRegistryZoneList

      public EPPRegistryZoneList(EPPRegistryZoneSummary zoneSummary)
      Constructor that takes one EPPRegistryZoneSummary instance. zoneList is initialized to have one element.
      Parameters:
      zoneSummary - summary attributes of one zone

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPRegistryZoneList 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 EPPRegistryZoneList instance.
      Throws:
      EPPEncodeException - - Unable to encode EPPRegistryZoneList instance.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPRegistryZoneList attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - - Root DOM Element to decode EPPRegistryZoneList from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRegistryZoneList compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryZoneList instance to compare with
      Returns:
      true if this object is the same as the aObject argument; false otherwise

    • clone

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

    • 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.

    • getZoneList

      public List<EPPRegistryZoneSummary> getZoneList()
      Get the zone summary list.
      Returns:
      List of EPPRegistryZone

    • setZoneList

      public void setZoneList(List<EPPRegistryZoneSummary> aZoneList)
      Set the zone summary list.
      Parameters:
      aZoneList - List of EPPRegistryZone

    • addZone

      public void addZone(EPPRegistryZoneSummary zone)
      Append one zone to the existing zone list.
      Parameters:
      zone - zone to add

    • setZone

      public void setZone(EPPRegistryZoneSummary zone)
      Clear the existing zone list and add add one zone to the list
      Parameters:
      zone - zone to add

    • getNamespace

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