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

Class EPPAuthTokenCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.authtoken.v01.EPPAuthTokenCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPAuthTokenCheckCmd extends EPPCheckCmd
Represents an EPP AuthToken <check> command, which is used to determine if an authToken is valid. The <authToken:check> element MUST contain the following child elements:
  • One or more <authToken:authToken> elements that contain the authToken string. Use getAuthTokens and setAuthTokens to get and set the elements. Use setAuthToken to set an individual authToken.

EPPAuthTokenCheckResp is the concrete EPPReponse associated with EPPAuthTokenCheckCmd.

See Also:

  • Field Details

  • Constructor Details

    • EPPAuthTokenCheckCmd

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

    • EPPAuthTokenCheckCmd

      public EPPAuthTokenCheckCmd(String aTransId, EPPAuthTokenData aAuthToken)
      EPPAuthTokenCheckCmd constructor that will check an individual authentication token.
      Parameters:
      aTransId - Transaction Id associated with command.
      aAuthToken - Authentication token EPPAuthTokenData to check

    • EPPAuthTokenCheckCmd

      public EPPAuthTokenCheckCmd(String aTransId, List<EPPAuthTokenData> aAuthTokens)
      EPPAuthTokenCheckCmd constructor that will check an individual authentication token.
      Parameters:
      aTransId - Transaction Id associated with command.
      aAuthTokens - List of authentication token EPPAuthTokenData instances.

  • Method Details

    • getNamespace

      public String getNamespace()
      Get the EPP command Namespace associated with EPPAuthTokenCheckCmd.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Specified by:
      getNamespace in class EPPCommand
      Returns:
      EPPAuthTokenMapFactory.NS

    • getAuthTokens

      public List<EPPAuthTokenData> getAuthTokens()
      Get the authentication token.
      Returns:
      Domain Name

    • setAuthToken

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

    • setAuthTokens

      public void setAuthTokens(List<EPPAuthTokenData> aAuthTokens)
      Set the authentication names to check.
      Parameters:
      aAuthTokens - authentication tokens to check

    • appendAuthToken

      public void appendAuthToken(EPPAuthTokenData aAuthToken)
      Appends to the List of authentication token EPPAuthTokenData instances to check.
      Parameters:
      aAuthToken - EPPAuthTokenData instance

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPAuthTokenCheckCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      clone of EPPAuthTokenCheckCmd
      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 EPPCommand
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • doEncode

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

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPAuthTokenCheckCmd attributes from the aElement DOM Element tree.
      Specified by:
      doDecode in class EPPCheckCmd
      Parameters:
      aElement - Root DOM Element to decode EPPAuthTokenCheckCmd from.
      Throws:
      EPPDecodeException - Unable to decode aElement