Package com.verisign.epp.codec.statusset.v01

Class EPPStatusSetAuthTokenList

java.lang.Object
com.verisign.epp.codec.statusset.v01.EPPStatusSetAuthTokenList
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
Direct Known Subclasses:
EPPStatusSetCreate, EPPStatusSetDelete, EPPStatusSetInfo, EPPStatusSetRenew, EPPStatusSetTransfer, EPPStatusSetUpdate
public abstract class EPPStatusSetAuthTokenList extends Object implements EPPCodecComponent
Abstract base class for the Status Set extensions, which accept a list of EPPAuthTokenData objects.
See Also:

  • Constructor Details

    • EPPStatusSetAuthTokenList

      public EPPStatusSetAuthTokenList()
      Default constructor for EPPStatusSetExtension.

    • EPPStatusSetAuthTokenList

      public EPPStatusSetAuthTokenList(EPPAuthTokenData aAuthToken)
      Constructor for EPPStatusSetExtension that takes a single authentication token.
      Parameters:
      aAuthToken - A single authentication token

    • EPPStatusSetAuthTokenList

      public EPPStatusSetAuthTokenList(List<EPPAuthTokenData> aAuthTokens)
      Constructor for EPPStatusSetExtension with a list of authentication tokens.
      Parameters:
      aAuthTokens - A list of authentication tokens

  • Method Details

    • getLocalName

      protected abstract String getLocalName()
      Abstract method that the sub-class must define to return the local name for the root element.
      Returns:
      Local name of the root element of the extensions.

    • hasAuthTokens

      public boolean hasAuthTokens()
      Are the authentication tokens defined?
      Returns:
      true if the authentication tokens are defined; false otherwise.

    • getAuthTokens

      public List<EPPAuthTokenData> getAuthTokens() throws EPPDecodeException
      Gets the list of authentication tokens if defined.
      Returns:
      List of authentication tokens if defined; empty list otherwise.
      Throws:
      EPPDecodeException

    • addAuthToken

      public void addAuthToken(EPPAuthTokenData aAuthToken)
      Adds an authentication token to the list of authentication tokens.
      Parameters:
      aAuthToken - The authentication token to add.

    • setAuthTokens

      public void setAuthTokens(List<EPPAuthTokenData> aAuthTokens)
      Sets the list of authentication tokens.
      Parameters:
      aAuthTokens - The authentication tokens to set.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPStatusSetExtension

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • clone

      public Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPStatusSetExtension
      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.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPStatusSetExtension with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.