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

Class EPPAuthTokenCheckData

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

  • Field Details

  • Constructor Details

    • EPPAuthTokenCheckData

      public EPPAuthTokenCheckData()
      Allocates a new EPPAuthTokenCheckData with default attribute values, which are all set to null.

    • EPPAuthTokenCheckData

      public EPPAuthTokenCheckData(EPPAuthTokenData aAuthToken)
      Creates new instance of a valid EPPAuthTokenCheckData
      Parameters:
      aAuthToken - EPPAuthTokenData instance

    • EPPAuthTokenCheckData

      public EPPAuthTokenCheckData(EPPAuthTokenData aAuthToken, String aReason)
      Creates a new instance an invalid EPPAuthTokenCheckData
      Parameters:
      aAuthToken - EPPAuthTokenData instance
      aReason - represents why authToken is invalid

  • Method Details

    • getAuthenticationToken

      public EPPAuthTokenData getAuthenticationToken()
      Get the authentication token data.
      Returns:
      EPPAuthTokenData instance

    • setAuthToken

      public void setAuthToken(EPPAuthTokenData aAuthToken)
      Set the authentication token data.
      Parameters:
      aAuthToken - Authentication Token

    • getReason

      public String getReason()
      Returns:

    • setReason

      public void setReason(String aReason)
      Parameters:
      aReason -

    • isValid

      public boolean isValid()
      get value that represents if this token is valid
      Returns:

    • setValid

      public void setValid(Boolean valid)
      set value that represents if this token is valid
      Parameters:
      valid -

    • equals

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

    • clone

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

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPAuthTokenCheckData instance.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Root DOM Element representing the EPPAuthTokenCheckData instance.
      Throws:
      EPPEncodeException - Unable to encode EPPAuthTokenCheckData instance.

    • decode

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

    • getNamespace

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