Package com.verisign.epp.codec.registry

Class EPPRegistryFields

java.lang.Object
com.verisign.epp.codec.registry.EPPRegistryFields
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryFields extends Object implements EPPCodecComponent
Class that defines the management of related fields.
See Also:

  • Field Details

    • TYPE_SHARED

      public static final String TYPE_SHARED
      Constant for the related zone fields being shared, where there is one set of related fields. Updating a field in one related zone results in updating the field value across all of the related zones.
      See Also:

    • TYPE_SYNC

      public static final String TYPE_SYNC
      Constant for the related zone fields required to be synchronized by registry policy. Updating a field in one related zone does not result in updating the field across all of the related zones.
      See Also:

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      Constant for the phase local name
      See Also:

    • ELM_NAME

      public static final String ELM_NAME
      Constant for the qualified name (prefix and local name)
      See Also:

    • ATTR_TYPE

      public static final String ATTR_TYPE
      Required attribute type name that should have a value of either TYPE_SHARED or TYPE_SYNC.
      See Also:

  • Constructor Details

    • EPPRegistryFields

      public EPPRegistryFields()
      Default constructor. The type value MUST be set using the setType(String) method and the fields MUST be set using setFields(List) or addField(String).

    • EPPRegistryFields

      public EPPRegistryFields(String aType, List<String> aFields)
      Create EPPRegistryFields instance with required attributes.
      Parameters:
      aType - Type of related fields with either TYPE_SHARED or TYPE_SYNC.
      aFields - List of related fields.

  • Method Details

    • getType

      public String getType()
      Gets the related fields type, which should be either TYPE_SHARED or TYPE_SYNC.
      Returns:
      TYPE_SHARED or TYPE_SYNC if defined; null otherwise.

    • setType

      public void setType(String aType)
      Sets the related fields type, which should be either TYPE_SHARED or TYPE_SYNC.
      Parameters:
      aType - the type, which should be either TYPE_SHARED or TYPE_SYNC

    • getFields

      public List<String> getFields()
      Gets the related field names.
      Returns:
      List of related field names.

    • setFields

      public void setFields(List<String> aFields)
      Sets the related field names.
      Parameters:
      aFields - The list of related field names.

    • addField

      public void addField(String aField)
      Adds a field to the list of fields.
      Parameters:
      aField - Field to add to the list of fields.

    • clone

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

    • decode

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

    • encode

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

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRegistryFields compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryFields instance to compare with
      Returns:
      true if equal; 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 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.