Package com.verisign.epp.codec.authtoken.v01

Class EPPAuthTokenScope

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

  • Field Details

  • Constructor Details

    • EPPAuthTokenScope

      public EPPAuthTokenScope()
      Create a new instance of EPPAuthTokenScope

    • EPPAuthTokenScope

      public EPPAuthTokenScope(List<String> aSystem, List<String> aDomain)
      Create a new instance of EPPAuthTokenScope with the optional system and domain data.

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Sets this instance's data in the given XML document
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM document used as a factory of DOM objects.
      Returns:
      instance root DOM element along with attribute child nodes.
      Throws:
      EPPEncodeException - Error encoding the DOM element tree.

    • 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 EPPAuthTokenScope compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPAuthTokenScope instance to compare with
      Returns:
      true if equal false otherwise

    • clone

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

    • getDomains

      public List<String> getDomains()
      Gets the optional domain value.
      Returns:
      domains for which the auth token is scoped to; null otherwise.

    • setDomains

      public void setDomains(List<String> aDomains)
      Sets the domain value.
      Parameters:
      aDomains - List of domains for which the auth token is scoped to null to unset it.

    • getSystems

      public List<String> getSystems()
      Gets the optional system value.
      Returns:
      system for which the auth token is scoped to; null otherwise.

    • setSystems

      public void setSystems(List<String> aSystem)
      Sets the optional system value.
      Parameters:
      aSystem - sets the registry systems name to scope the token 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.