Package com.verisign.epp.codec.idntable
Class EPPIdnTableCheckResp
java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.idntable.EPPIdnTableCheckResp
- All Implemented Interfaces:
EPPCodecComponent,EPPMessage,Serializable,Cloneable
Represents an Internationalized Domain Name (IDN) Table response to a
<check> command, with two different forms including the Domain Check
Form and the Table Check Form. The response in Domain Check Form returns the
validity of the domain name and the matching IDN table identifiers. The
response in Table Check Form returns whether or not the table identifier
exists.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumCheck form types, that include:
UNDEFINED_FORMthat represents an undefined state, where neither or both tables and domains are defined.DOMAIN_FORMthat represents the "Domain Check Form", where domain names are only defined.TABLE_FORMthat represents the "Table Check Form", where table identifiers are only defined. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringXML local name forEPPIdnTableCheckResp.static final StringXML root tag forEPPIdnTableCheckCmd.Fields inherited from class com.verisign.epp.codec.gen.EPPResponse
ELM_EXTENSION, ELM_MESSAGE_QUEUE, ELM_MESSAGE_QUEUE_QDATE, ELM_RESPONSE_DATA, extensions, TRANSFER_CLIENT_APPROVED, TRANSFER_CLIENT_CANCELLED, TRANSFER_CLIENT_REJECTED, TRANSFER_PENDING, TRANSFER_SERVER_APPROVED, TRANSFER_SERVER_CANCELLED -
Constructor Summary
ConstructorsConstructorDescriptionEPPIdnTableCheckRespdefault constructor.EPPIdnTableCheckResp(EPPTransId aTransId) EPPIdnTableCheckRespconstructor that only takes the transaction identifier.EPPIdnTableCheckResp(EPPTransId aTransId, EPPIdnTableCheckDomain aDomain) EPPIdnTableCheckRespconstructor that takes an individual domain.EPPIdnTableCheckResp(EPPTransId aTransId, EPPIdnTableCheckTable aTable) EPPIdnTableCheckRespconstructor that takes an individual table. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddDomain(EPPIdnTableCheckDomain aDomain) Append a domain to the list of domains.voidaddTable(EPPIdnTableCheckTable aTable) Append a table to the list of tables.clone()CloneEPPIdnTableCheckResp.protected voidDecode theEPPIdnTableCheckRespattributes from the aElement DOM Element tree.protected ElementEncode a DOM Element tree from the attributes of theEPPIdnTableCheckRespinstance.booleanCompare an instance ofEPPIdnTableCheckRespwith this instance.Get the list of domainsgetForm()What check form is being used, which are defined by theFormenumeration.Get the EPP command Namespace associated withEPPIdnTableCheckResp.Get the list of tables.getType()Get the EPP response type associated withEPPIdnTableCheckResp.booleanAre any domains defined in the list of domains?booleanAre any table defined in the list of tables?voidsetDomain(EPPIdnTableCheckDomain aDomain) Set an individual domain.voidsetDomains(List<EPPIdnTableCheckDomain> aDomains) Set the list of domainsvoidsetTable(EPPIdnTableCheckTable aTable) Set an individual table.voidsetTables(List<EPPIdnTableCheckTable> aTables) Set the list of tables.toString()Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.Methods inherited from class com.verisign.epp.codec.gen.EPPResponse
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getMessageQueue, getMsgQueue, getMsgQueueCount, getMsgQueueDate, getMsgQueueMsg, getQDate, getResult, getResults, getTransId, hasExtension, hasExtensions, hasMessageQueue, hasMsgQueue, hasResultCode, isSuccess, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId
-
Field Details
-
ELM_LOCALNAME
XML local name forEPPIdnTableCheckResp.- See Also:
-
ELM_NAME
XML root tag forEPPIdnTableCheckCmd.- See Also:
-
-
Constructor Details
-
EPPIdnTableCheckResp
public EPPIdnTableCheckResp()EPPIdnTableCheckRespdefault constructor. It will set results attribute to an emptyList. -
EPPIdnTableCheckResp
EPPIdnTableCheckRespconstructor that only takes the transaction identifier.- Parameters:
aTransId- transaction Id associated with response
-
EPPIdnTableCheckResp
EPPIdnTableCheckRespconstructor that takes an individual table. Add more tables usingaddTable(EPPIdnTableCheckTable).- Parameters:
aTransId- transaction Id associated with responseaTable- An individual table
-
EPPIdnTableCheckResp
EPPIdnTableCheckRespconstructor that takes an individual domain. Add more domains usingaddDomain(EPPIdnTableCheckDomain).- Parameters:
aTransId- transaction Id associated with responseaDomain- An individual domain
-
-
Method Details
-
getForm
What check form is being used, which are defined by theFormenumeration.- Returns:
- One of the
Formvalues.
-
hasTables
public boolean hasTables()Are any table defined in the list of tables?- Returns:
trueif there is at least one table defined;falseotherwise.
-
getTables
Get the list of tables.- Returns:
Listof tables
-
setTables
Set the list of tables.- Parameters:
aTables-Listof tables
-
setTable
Set an individual table. This method clears the existing list of tables.- Parameters:
aTable- Table check result
-
addTable
Append a table to the list of tables. This method does NOT clear the existing list of tables.- Parameters:
aTable- Table check result
-
hasDomains
public boolean hasDomains()Are any domains defined in the list of domains?- Returns:
trueif there is at least one domain defined;falseotherwise.
-
getDomains
Get the list of domains- Returns:
Listof domains
-
setDomains
Set the list of domains- Parameters:
aDomains-Listof domains
-
setDomain
Set an individual domain. This method clears the existing list of domains.- Parameters:
aDomain- Domain check result
-
addDomain
Append a domain to the list of domains. This method does NOT clear the existing list of domains.- Parameters:
aDomain- Domain check result
-
doEncode
Encode a DOM Element tree from the attributes of theEPPIdnTableCheckRespinstance.- Overrides:
doEncodein classEPPResponse- Parameters:
aDocument- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPIdnTableCheckRespinstance. - Throws:
EPPEncodeException- Unable to encodeEPPIdnTableCheckRespinstance.
-
doDecode
Decode theEPPIdnTableCheckRespattributes from the aElement DOM Element tree.- Overrides:
doDecodein classEPPResponse- Parameters:
aElement- Root DOM Element to decodeEPPIdnTableCheckRespfrom.- Throws:
EPPDecodeException- Unable to decode aElement
-
getType
Get the EPP response type associated withEPPIdnTableCheckResp.- Overrides:
getTypein classEPPResponse- Returns:
EPPIdnTableCheckResp.ELM_NAME
-
getNamespace
Get the EPP command Namespace associated withEPPIdnTableCheckResp.- Specified by:
getNamespacein interfaceEPPCodecComponent- Specified by:
getNamespacein interfaceEPPMessage- Overrides:
getNamespacein classEPPResponse- Returns:
EPPRegistryMapFactory.NS
-
equals
Compare an instance ofEPPIdnTableCheckRespwith this instance.- Overrides:
equalsin classEPPResponse- Parameters:
aObject- Object to compare with.- Returns:
trueif this object is the same as the aObject argument;falseotherwise
-
clone
CloneEPPIdnTableCheckResp.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classEPPResponse- Returns:
- clone of
EPPIdnTableCheckResp - Throws:
CloneNotSupportedException- standard Object.clone exception
-
toString
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.- Overrides:
toStringin classEPPResponse- Returns:
- Indented XML
Stringif successful;ERRORotherwise.
-