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

Class EPPAuthTokenCredential

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

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPAuthTokenCredential.
    static final String
    ELM_NAME
    XML Element Name of EPPAuthTokenCredential root element.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPAuthTokenCredential()
    Create a new instance of EPPAuthTokenCredential
    EPPAuthTokenCredential(String aClId, String aPassword, EPPAuthTokenMfa aMfa)
    Create a new instance of EPPAuthTokenCredential with all the required attributes

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPAuthTokenCredential.
    void
    decode(Element aElement)
    Populate the data of this instance with the data stored in the given Element of the DOM tree
    Element
    encode(Document aDocument)
    Sets this instance's data in the given XML document
    boolean
    equals(Object aObject)
    implements a deep EPPAuthTokenCredential compare.
    String
    getClId()
    Gets the registrar user identifier for the authenticating user.
    EPPAuthTokenMfa
    getMfa()
    Gets the MFA associated with this request.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getPassword()
    Gets the registrar user password for the authenticating user.
    void
    setClId(String aClId)
    Sets the registrar user identifier for the authenticating user.
    void
    setMfa(EPPAuthTokenMfa aMfa)
    Sets the Mfa.
    void
    setPassword(String aPassword)
    Sets the registrar user password for the authenticating user.
    String
    toString()
    Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

  • Constructor Details

    • EPPAuthTokenCredential

      public EPPAuthTokenCredential()
      Create a new instance of EPPAuthTokenCredential

    • EPPAuthTokenCredential

      public EPPAuthTokenCredential(String aClId, String aPassword, EPPAuthTokenMfa aMfa)
      Create a new instance of EPPAuthTokenCredential with all the required attributes

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

    • clone

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

    • getMfa

      public EPPAuthTokenMfa getMfa()
      Gets the MFA associated with this request.
      Returns:
      EPPAuthTokenMfa instance

    • setMfa

      public void setMfa(EPPAuthTokenMfa aMfa)
      Sets the Mfa.
      Parameters:
      aMfa - EPPAuthTokenMfa instance

    • getClId

      public String getClId()
      Gets the registrar user identifier for the authenticating user.
      Returns:
      user identifier

    • setClId

      public void setClId(String aClId)
      Sets the registrar user identifier for the authenticating user.
      Parameters:
      aClId - registrar user identifier for the authenticating user.

    • getPassword

      public String getPassword()
      Gets the registrar user password for the authenticating user.
      Returns:
      Gets the registrar user password for the authenticating user

    • setPassword

      public void setPassword(String aPassword)
      Sets the registrar user password for the authenticating user.
      Parameters:
      aPassword - the registrar user password for the authenticating user

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