Package com.verisign.epp.codec.verificationcode

Class EPPVerificationCodeInfo

java.lang.Object
com.verisign.epp.codec.verificationcode.EPPVerificationCodeInfo
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPVerificationCodeInfo extends Object implements EPPCodecComponent
Extension to the info command to retrieve the verification information for the verification profile assigned to the client or using the verification profile explicitly specified.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    Constant for the verification code info extension local name
    static final String
    ELM_NAME
    Constant for the verification code info extension tag

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPVerificationCodeInfo()
    Create an EPPVerificationCodeInfo instance.
    EPPVerificationCodeInfo(String aProfile)
    Create a EPPVerificationCodeInfo instance with the optional client specified profile.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    Clone EPPVerificationCodeInfo.
    void
    decode(Element aElement)
    Decode the DOM element to the EPPVerificationCodeInfo.
    Element
    encode(Document aDocument)
    Encode the EPPVerificationCodeInfo to a DOM Element
    boolean
    equals(Object aObject)
    implements a deep EPPVerificationCodeInfo compare.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getProfile()
    Gets the client specified profile to base the verification information on.
    boolean
    hasProfile()
    Is the verification profile defined?
    void
    setProfile(String aProfile)
    Sets the client specified profile to base the verification information on.

    Methods inherited from class java.lang.Object

    finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • ELM_LOCALNAME

      public static final String ELM_LOCALNAME
      Constant for the verification code info extension local name
      See Also:

    • ELM_NAME

      public static final String ELM_NAME
      Constant for the verification code info extension tag
      See Also:

  • Constructor Details

    • EPPVerificationCodeInfo

      public EPPVerificationCodeInfo()
      Create an EPPVerificationCodeInfo instance.

    • EPPVerificationCodeInfo

      public EPPVerificationCodeInfo(String aProfile)
      Create a EPPVerificationCodeInfo instance with the optional client specified profile.
      Parameters:
      aProfile - Profile to base the verification information on.

  • Method Details

    • hasProfile

      public boolean hasProfile()
      Is the verification profile defined?
      Returns:
      true if the verification profile is defined; false otherwise.

    • getProfile

      public String getProfile()
      Gets the client specified profile to base the verification information on.
      Returns:
      Verification profile if defined; null otherwise.

    • setProfile

      public void setProfile(String aProfile)
      Sets the client specified profile to base the verification information on.
      Parameters:
      aProfile - Profile to base the verification information on.

    • clone

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

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode the EPPVerificationCodeInfo to a DOM Element
      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 DOM element to the EPPVerificationCodeInfo.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - DOM Element to decode the attribute values
      Throws:
      EPPDecodeException - Error decoding the DOM Element

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPVerificationCodeInfo compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPVerificationCodeInfo instance to compare with
      Returns:
      true if equal false 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.