Package com.verisign.epp.codec.nv

Class EPPNameVerificationInfoCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPInfoCmd
com.verisign.epp.codec.nv.EPPNameVerificationInfoCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPNameVerificationInfoCmd extends EPPInfoCmd
Info command to get the information associated with the verification code, which includes either the signed code associated with the verification code or the input parameters passed for the domain verification.
See Also:

  • Field Details

  • Constructor Details

    • EPPNameVerificationInfoCmd

      public EPPNameVerificationInfoCmd()
      EPPNameVerificationInfoCmd default constructor.

    • EPPNameVerificationInfoCmd

      public EPPNameVerificationInfoCmd(String aTransId)
      EPPNameVerificationInfoCmd constructor that takes just the client transaction id.
      Parameters:
      aTransId - Client transaction id. Set to null of no client transaction id should be used.

    • EPPNameVerificationInfoCmd

      public EPPNameVerificationInfoCmd(String aTransId, String aCode)
      EPPNameVerificationInfoCmd constructor that takes the required verification code value. The default info type is set to Type.SIGNED_CODE.
      Parameters:
      aTransId - Client transaction id. Set to null of no client transaction id should be used.
      aCode - Verification code

    • EPPNameVerificationInfoCmd

      public EPPNameVerificationInfoCmd(String aTransId, String aCode, EPPNameVerificationInfoCmd.Type aType)
      EPPNameVerificationInfoCmd constructor that takes all of the required attributes.
      Parameters:
      aTransId - Client transaction id. Set to null of no client transaction id should be used.
      aCode - Verification code
      aType - Information type

    • EPPNameVerificationInfoCmd

      public EPPNameVerificationInfoCmd(String aTransId, String aCode, EPPNameVerificationInfoCmd.Type aType, EPPAuthInfo aAuthInfo)
      EPPNameVerificationInfoCmd constructor that takes all of the required attributes.}.
      Parameters:
      aTransId - Client transaction id. Set to null of no client transaction id should be used.
      aCode - Verification code
      aType - Information type
      aAuthInfo - Authorization information for Name Verification (NV) object.

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPNameVerificationInfoCmd.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Specified by:
      getNamespace in class EPPCommand
      Returns:
      EPPNameVerificationMapFactory.NS

    • getCode

      public String getCode()
      Gets the verification code value.
      Returns:
      The verification code value.

    • setCode

      public void setCode(String aCode)
      Sets the verification code value.
      Parameters:
      aCode - Verification code value

    • getInfoType

      public EPPNameVerificationInfoCmd.Type getInfoType()
      Gets the input type defined by the Type enumeration.
      Returns:
      input type

    • setInfoType

      public void setInfoType(EPPNameVerificationInfoCmd.Type aType)
      Sets the input type using one of the Type enumeration values.
      Parameters:
      aType - Input type

    • getAuthInfo

      public EPPAuthInfo getAuthInfo()
      Gets the OPTIONAL authorization information for the Name Verification (NV) object.
      Returns:
      Authorization information if defined; null otherwise.

    • setAuthInfo

      public void setAuthInfo(EPPAuthInfo aAuthInfo)
      Sets the authorization information for the Name Verification (NV) object.
      Parameters:
      aAuthInfo - Authorization information of NV object.

    • doEncode

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

    • doDecode

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPNameVerificationInfoCmd with this instance.
      Overrides:
      equals in class EPPInfoCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if this object is the same as the aObject argument; false otherwise.

    • clone

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