Package com.verisign.epp.codec.verificationcode

Class EPPVerificationCodeInfData

java.lang.Object
com.verisign.epp.codec.verificationcode.EPPVerificationCodeInfData
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPVerificationCodeInfData extends Object implements EPPCodecComponent
Extension to the info response to return the verification information. The EPPVerificationCodeInfo info command extension defines interest in returning the verification information in the extension to the info response.
See Also:

  • Field Details

  • Constructor Details

    • EPPVerificationCodeInfData

      public EPPVerificationCodeInfData()
      Create an EPPVerificationCodeInfData instance.

    • EPPVerificationCodeInfData

      public EPPVerificationCodeInfData(EPPVerificationCodeInfData.Status aStatus)
      Create a EPPVerificationCodeInfData instance with the required status.
      Parameters:
      aStatus - Status of the verification

    • EPPVerificationCodeInfData

      public EPPVerificationCodeInfData(EPPVerificationCodeInfData.Status aStatus, EPPVerificationCodeProfile aProfile)
      Create a EPPVerificationCodeInfData instance with the required status and the a single profile.
      Parameters:
      aStatus - Status of the verification
      aProfile - Single verification profile

    • EPPVerificationCodeInfData

      public EPPVerificationCodeInfData(EPPVerificationCodeInfData.Status aStatus, List<EPPVerificationCodeProfile> aProfiles)
      Create a EPPVerificationCodeInfData instance with the required status and the optional profiles.
      Parameters:
      aStatus - Status of the verification
      aProfiles - OPTIONAL verification profiles

  • Method Details

    • clone

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

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Sets all this instance's data in the given XML document
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - a DOM Document to attach data to.
      Returns:
      The root element of this component.
      Throws:
      EPPEncodeException - Thrown if any errors prevent encoding.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPVerificationCodeInfData component
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode from
      Throws:
      EPPDecodeException - On decoding error

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPVerificationCodeInfData compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPVerificationCodeInfData instance to compare with
      Returns:
      true if equal false otherwise

    • getStatus

      public EPPVerificationCodeInfData.Status getStatus()
      Gets the verification status.
      Returns:
      Verification status

    • setStatus

      public void setStatus(EPPVerificationCodeInfData.Status aStatus)
      Sets the verification status.
      Parameters:
      aStatus - Verification status

    • hasProfiles

      public boolean hasProfiles()
      Are there any profiles?
      Returns:
      true if there are profiles; false otherwise.

    • getProfiles

      public List<EPPVerificationCodeProfile> getProfiles()
      Returns the list of profiles. An empty list indicates that there are no profiles.
      Returns:
      List of profiles.

    • setProfiles

      public void setProfiles(List<EPPVerificationCodeProfile> aProfiles)
      Sets the profiles.
      Parameters:
      aProfiles - The list of profiles. Set to null or an empty list to indicate that there are no profiles.

    • addProfile

      public void addProfile(EPPVerificationCodeProfile aProfile)
      Add a profile to the list of profiles.
      Parameters:
      aProfile - Profile to add to the list of profiles.

    • hasProfile

      public boolean hasProfile()
      Is there a single profile?
      Returns:
      true if there is one profiles; false otherwise.

    • getProfile

      public EPPVerificationCodeProfile getProfile()
      Gets the single profile.
      Returns:
      Single profile that is set if defined; null otherwise.

    • setProfile

      public void setProfile(EPPVerificationCodeProfile aProfile)
      Sets the single profile. If there is a list of profiles currently set, this method will clear the list and set the profiles to a single profile consisting of aProfile.
      Parameters:
      aProfile - Single profile to set.

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