Package com.verisign.epp.codec.coaext

Class EPPCoaExtUpdate

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

Title: EPP 1.0 Client Object Attribute - Update

Description: The Update tag is used to represent the changes to an object's Client Object Attributes being performed as part of an epp <update> command. It consists of three collections, each of which are optional.

  • A collection of EPPCoaExtAttr objects representing new COAs being added to the object or having their values changed.
  • A collection of EPPCoaExtKey objects identifying existing COAs which are being removed from the object

As XML, it is represented by a <coa:update> element, which in turn contains one or more of the following elements:
  • A <coa:put> element containing in turn one or more <coa:attr> elements, each describing a new COA being added or updated.
  • A <coa:rem> element containing in turn one or more <coa:key> elements, each identifying an existing COA being removed.

Copyright: Copyright (c) 2011

Company: VeriSign

See Also:

  • Field Details

  • Constructor Details

    • EPPCoaExtUpdate

      public EPPCoaExtUpdate()

  • Method Details

    • getPutAttrs

      public List getPutAttrs()
      Gets the list of Attributes to be added or updated.
      Returns:
      List of attribute EPPCoaExtAttr instances if defined; null otherwise.

    • setPutAttrs

      public void setPutAttrs(List aPutAttrs)
      Sets the List of attributes EPPCoaExtAttr instances to create.
      Parameters:
      aPutAttrs - List of EPPCoaExtAttr instances

    • getRemAttrs

      public List getRemAttrs()
      Gets the list of Attribute keys to be removed.
      Returns:
      List of attribute EPPCoaExtKey instances if defined; null otherwise.

    • setRemAttrs

      public void setRemAttrs(List remAttrs)
      Sets the List of attribute key EPPCoaExtKey instances to remove.
      Parameters:
      remAttrs - List of EPPCoaExtAttr instances

    • 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 report fragment of XML
      Throws:
      EPPDecodeException - Thrown if any errors occur during decoding.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Append all data from this COA update 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.

    • clone

      public Object clone() throws CloneNotSupportedException
      A deep clone of the EPPCoaCreate.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPCodecComponent
      Throws:
      CloneNotSupportedException - standard Object.clone exception
      See Also:

    • equals

      public boolean equals(Object aObj)
      (non-Javadoc)
      Overrides:
      equals in class Object
      See Also:

    • appendPutAttr

      public void appendPutAttr(EPPCoaExtAttr aAttr)
      Appends to the List of attributes EPPCoaExtAttr instances to add or update.
      Parameters:
      aAttr - EPPCoaExtAttr instance

    • appendRemAttr

      public void appendRemAttr(EPPCoaExtKey aKey)
      Appends to the List of attribute keys EPPCoaExtKey instances to remove.
      Parameters:
      aKey - EPPCoaExtKey instance

    • getNamespace

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