Class EPPVerificationCodeInfData
- java.lang.Object
-
- com.verisign.epp.codec.verificationcode.EPPVerificationCodeInfData
-
- All Implemented Interfaces:
EPPCodecComponent,java.io.Serializable,java.lang.Cloneable
public class EPPVerificationCodeInfData extends java.lang.Object implements EPPCodecComponent
Extension to the info response to return the verification information. TheEPPVerificationCodeInfoinfo command extension defines interest in returning the verification information in the extension to the info response.- See Also:
EPPVerificationCodeInfo, Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classEPPVerificationCodeInfData.StatusVerification statuses that include:
NOT_APPLICABLE- The status is not applicable to the client since there is no assigned verification profile.NON_COMPLIANT- The object is non-compliant according to the verification profile.PENDING_COMPLIANCE- The object is not in compliance with the verification profile, but has a grace period to set the required set of verification codes, as reflected by the due date of the verification code type.COMPLIANTThe object is compliant with the verification profile.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringELM_LOCALNAMEConstant for the info response extension local namestatic java.lang.StringELM_NAMEConstant for the info response extension tag
-
Constructor Summary
Constructors Constructor Description EPPVerificationCodeInfData()Create anEPPVerificationCodeInfDatainstance.EPPVerificationCodeInfData(EPPVerificationCodeInfData.Status aStatus)Create a EPPVerificationCodeInfData instance with the required status.EPPVerificationCodeInfData(EPPVerificationCodeInfData.Status aStatus, EPPVerificationCodeProfile aProfile)Create a EPPVerificationCodeInfData instance with the required status and the a single profile.EPPVerificationCodeInfData(EPPVerificationCodeInfData.Status aStatus, java.util.List<EPPVerificationCodeProfile> aProfiles)Create a EPPVerificationCodeInfData instance with the required status and the optional profiles.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddProfile(EPPVerificationCodeProfile aProfile)Add a profile to the list of profiles.java.lang.Objectclone()CloneEPPVerificationCodeInfData.voiddecode(org.w3c.dom.Element aElement)Decode the EPPVerificationCodeInfData componentorg.w3c.dom.Elementencode(org.w3c.dom.Document aDocument)Sets all this instance's data in the given XML documentbooleanequals(java.lang.Object aObject)implements a deepEPPVerificationCodeInfDatacompare.java.lang.StringgetNamespace()Returns the XML namespace associated with theEPPCodecComponent.EPPVerificationCodeProfilegetProfile()Gets the single profile.java.util.List<EPPVerificationCodeProfile>getProfiles()Returns the list of profiles.EPPVerificationCodeInfData.StatusgetStatus()Gets the verification status.booleanhasProfile()Is there a single profile?booleanhasProfiles()Are there any profiles?voidsetProfile(EPPVerificationCodeProfile aProfile)Sets the single profile.voidsetProfiles(java.util.List<EPPVerificationCodeProfile> aProfiles)Sets the profiles.voidsetStatus(EPPVerificationCodeInfData.Status aStatus)Sets the verification status.java.lang.StringtoString()Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
Constant for the info response extension local name- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
Constant for the info response extension tag- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPVerificationCodeInfData
public EPPVerificationCodeInfData()
Create anEPPVerificationCodeInfDatainstance.
-
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 verificationaProfile- Single verification profile
-
EPPVerificationCodeInfData
public EPPVerificationCodeInfData(EPPVerificationCodeInfData.Status aStatus, java.util.List<EPPVerificationCodeProfile> aProfiles)
Create a EPPVerificationCodeInfData instance with the required status and the optional profiles.- Parameters:
aStatus- Status of the verificationaProfiles- OPTIONAL verification profiles
-
-
Method Detail
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedExceptionCloneEPPVerificationCodeInfData.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classjava.lang.Object- Returns:
- clone of
EPPVerificationCodeInfData - Throws:
java.lang.CloneNotSupportedException- standard Object.clone exception
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeExceptionSets all this instance's data in the given XML document- Specified by:
encodein interfaceEPPCodecComponent- 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(org.w3c.dom.Element aElement) throws EPPDecodeExceptionDecode the EPPVerificationCodeInfData component- Specified by:
decodein interfaceEPPCodecComponent- Parameters:
aElement- Element to decode from- Throws:
EPPDecodeException- On decoding error
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPVerificationCodeInfDatacompare.- Overrides:
equalsin classjava.lang.Object- Parameters:
aObject-EPPVerificationCodeInfDatainstance 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:
trueif there are profiles;falseotherwise.
-
getProfiles
public java.util.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(java.util.List<EPPVerificationCodeProfile> aProfiles)
Sets the profiles.- Parameters:
aProfiles- The list of profiles. Set tonullor 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:
trueif there is one profiles;falseotherwise.
-
getProfile
public EPPVerificationCodeProfile getProfile()
Gets the single profile.- Returns:
- Single profile that is set if defined;
nullotherwise.
-
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 ofaProfile.- Parameters:
aProfile- Single profile to set.
-
toString
public java.lang.String toString()
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.- Overrides:
toStringin classjava.lang.Object- Returns:
- Indented XML
Stringif successful;ERRORotherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent.- Specified by:
getNamespacein interfaceEPPCodecComponent- Returns:
- XML namespace for the
EPPCodecComponent.
-
-