Package com.verisign.epp.codec.verificationcode

Class EPPVerificationCodeProfile

java.lang.Object
com.verisign.epp.codec.verificationcode.EPPVerificationCodeProfile
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPVerificationCodeProfile extends Object implements EPPCodecComponent
Information associated with compliance with a verification code profile. A Verification Profile defines the set of verification code types, the commands that the verification code types are required, supported, or not supported, and the grace period by which the verification code types MUST be set. A server MAY support many verification profiles, each with a unique name and a unique verification policy that is implemented by the server.
See Also:

  • Field Details

  • Constructor Details

    • EPPVerificationCodeProfile

      public EPPVerificationCodeProfile()
      Create an EPPVerificationCodeInfData instance.

    • EPPVerificationCodeProfile

      public EPPVerificationCodeProfile(String aProfileName, EPPVerificationCodeProfile.Status aStatus)
      Create a EPPVerificationCodeInfData instance with the required attributes status.
      Parameters:
      aProfileName - Name of the profile
      aStatus - Status of the verification

    • EPPVerificationCodeProfile

      public EPPVerificationCodeProfile(String aProfileName, EPPVerificationCodeProfile.Status aStatus, List<EPPVerificationCode> aMissingCodes, List<EPPVerificationCode> aSetCodes)
      Create a EPPVerificationCodeInfData instance with the all required and optional attributes.
      Parameters:
      aProfileName - Name of the profile
      aStatus - Status of the verification
      aMissingCodes - OPTIONAL missing codes. Set to null if there are no missing codes.
      aSetCodes - OPTIONAL set codes. Set to null if there are no set codes.

  • 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

    • getProfileName

      public String getProfileName()
      Gets the verification profile name.
      Returns:
      Verification profile if defined; null otherwise.

    • setProfileName

      public void setProfileName(String aProfileName)
      Sets the verification profile name.
      Parameters:
      aProfileName - Verification profile

    • getStatus

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

    • setStatus

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

    • hasMissingCodes

      public boolean hasMissingCodes()
      Are there any missing codes?
      Returns:
      true if there are missing codes; false otherwise.

    • getMissingCodes

      public List<EPPVerificationCode> getMissingCodes()
      Returns the list of missing codes. An empty list indicates that there are no missing codes.
      Returns:
      List of missing codes.

    • setMissingCodes

      public void setMissingCodes(List<EPPVerificationCode> aMissingCodes)
      Sets the missing codes.
      Parameters:
      aMissingCodes - The list of missing codes. Set to null or an empty list to indicate that there are no missing codes.

    • addMissingCode

      public void addMissingCode(EPPVerificationCode aMissingCode)
      Add a missing code to the list of missing codes.
      Parameters:
      aMissingCode - Missing code to add to the list of missing codes.

    • hasSetCodes

      public boolean hasSetCodes()
      Are there any set codes?
      Returns:
      true if there are set codes; false otherwise.

    • getSetCodes

      public List<EPPVerificationCode> getSetCodes()
      Returns the list of set codes. An empty list indicates that there are no set codes.
      Returns:
      List of set codes.

    • setSetCodes

      public void setSetCodes(List<EPPVerificationCode> aSetCodes)
      Sets the set codes.
      Parameters:
      aSetCodes - The list of set codes. Set to null or an empty list to indicate that there are no set codes.

    • addSetCode

      public void addSetCode(EPPVerificationCode aSetCode)
      Add a set code to the list of set codes.
      Parameters:
      aSetCode - Set code to add to the list of set codes.

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