Class EPPNameVerificationInfoCmd

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.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:
    EPPNameVerificationInfoResp, Serialized Form
    • Field Detail

      • ELM_LOCALNAME

        public static final java.lang.String ELM_LOCALNAME
        XML local name for EPPNameVerificationInfoCmd.
        See Also:
        Constant Field Values
      • ELM_NAME

        public static final java.lang.String ELM_NAME
        XML root tag for EPPNameVerificationInfoCmd.
        See Also:
        Constant Field Values
    • Constructor Detail

      • EPPNameVerificationInfoCmd

        public EPPNameVerificationInfoCmd()
        EPPNameVerificationInfoCmd default constructor.
      • EPPNameVerificationInfoCmd

        public EPPNameVerificationInfoCmd​(java.lang.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​(java.lang.String aTransId,
                                          java.lang.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​(java.lang.String aTransId,
                                          java.lang.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​(java.lang.String aTransId,
                                          java.lang.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 Detail

      • getCode

        public java.lang.String getCode()
        Gets the verification code value.
        Returns:
        The verification code value.
      • setCode

        public void setCode​(java.lang.String aCode)
        Sets the verification code value.
        Parameters:
        aCode - Verification code value
      • 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 org.w3c.dom.Element doEncode​(org.w3c.dom.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​(org.w3c.dom.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​(java.lang.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 java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Clone EPPNameVerificationInfoCmd.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPCommand
        Returns:
        Deep copy clone of EPPNameVerificationInfoCmd
        Throws:
        java.lang.CloneNotSupportedException - standard Object.clone exception
      • toString

        public java.lang.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.