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
,java.io.Serializable
,java.lang.Cloneable
public class EPPIdnTableCheckResp extends EPPResponse
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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
EPPIdnTableCheckResp.Form
Check form types, that include:
UNDEFINED_FORM
that represents an undefined state, where neither or both tables and domains are defined.DOMAIN_FORM
that represents the "Domain Check Form", where domain names are only defined.TABLE_FORM
that represents the "Table Check Form", where table identifiers are only defined.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPIdnTableCheckResp
.static java.lang.String
ELM_NAME
XML 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
Constructors Constructor Description EPPIdnTableCheckResp()
EPPIdnTableCheckResp
default constructor.EPPIdnTableCheckResp(EPPTransId aTransId)
EPPIdnTableCheckResp
constructor that only takes the transaction identifier.EPPIdnTableCheckResp(EPPTransId aTransId, EPPIdnTableCheckDomain aDomain)
EPPIdnTableCheckResp
constructor that takes an individual domain.EPPIdnTableCheckResp(EPPTransId aTransId, EPPIdnTableCheckTable aTable)
EPPIdnTableCheckResp
constructor that takes an individual table.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDomain(EPPIdnTableCheckDomain aDomain)
Append a domain to the list of domains.void
addTable(EPPIdnTableCheckTable aTable)
Append a table to the list of tables.java.lang.Object
clone()
CloneEPPIdnTableCheckResp
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPIdnTableCheckResp
attributes from the aElement DOM Element tree.protected org.w3c.dom.Element
doEncode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPIdnTableCheckResp
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPIdnTableCheckResp
with this instance.java.util.List<EPPIdnTableCheckDomain>
getDomains()
Get the list of domainsEPPIdnTableCheckResp.Form
getForm()
What check form is being used, which are defined by theForm
enumeration.java.lang.String
getNamespace()
Get the EPP command Namespace associated withEPPIdnTableCheckResp
.java.util.List<EPPIdnTableCheckTable>
getTables()
Get the list of tables.java.lang.String
getType()
Get the EPP response type associated withEPPIdnTableCheckResp
.boolean
hasDomains()
Are any domains defined in the list of domains?boolean
hasTables()
Are any table defined in the list of tables?void
setDomain(EPPIdnTableCheckDomain aDomain)
Set an individual domain.void
setDomains(java.util.List<EPPIdnTableCheckDomain> aDomains)
Set the list of domainsvoid
setTable(EPPIdnTableCheckTable aTable)
Set an individual table.void
setTables(java.util.List<EPPIdnTableCheckTable> aTables)
Set the list of tables.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation 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 Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPIdnTableCheckResp
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPIdnTableCheckCmd
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPIdnTableCheckResp
public EPPIdnTableCheckResp()
EPPIdnTableCheckResp
default constructor. It will set results attribute to an emptyList
.
-
EPPIdnTableCheckResp
public EPPIdnTableCheckResp(EPPTransId aTransId)
EPPIdnTableCheckResp
constructor that only takes the transaction identifier.- Parameters:
aTransId
- transaction Id associated with response
-
EPPIdnTableCheckResp
public EPPIdnTableCheckResp(EPPTransId aTransId, EPPIdnTableCheckTable aTable)
EPPIdnTableCheckResp
constructor that takes an individual table. Add more tables usingaddTable(EPPIdnTableCheckTable)
.- Parameters:
aTransId
- transaction Id associated with responseaTable
- An individual table
-
EPPIdnTableCheckResp
public EPPIdnTableCheckResp(EPPTransId aTransId, EPPIdnTableCheckDomain aDomain)
EPPIdnTableCheckResp
constructor that takes an individual domain. Add more domains usingaddDomain(EPPIdnTableCheckDomain)
.- Parameters:
aTransId
- transaction Id associated with responseaDomain
- An individual domain
-
-
Method Detail
-
getForm
public EPPIdnTableCheckResp.Form getForm()
What check form is being used, which are defined by theForm
enumeration.- Returns:
- One of the
Form
values.
-
hasTables
public boolean hasTables()
Are any table defined in the list of tables?- Returns:
true
if there is at least one table defined;false
otherwise.
-
getTables
public java.util.List<EPPIdnTableCheckTable> getTables()
Get the list of tables.- Returns:
List
of tables
-
setTables
public void setTables(java.util.List<EPPIdnTableCheckTable> aTables)
Set the list of tables.- Parameters:
aTables
-List
of tables
-
setTable
public void setTable(EPPIdnTableCheckTable aTable)
Set an individual table. This method clears the existing list of tables.- Parameters:
aTable
- Table check result
-
addTable
public void addTable(EPPIdnTableCheckTable aTable)
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:
true
if there is at least one domain defined;false
otherwise.
-
getDomains
public java.util.List<EPPIdnTableCheckDomain> getDomains()
Get the list of domains- Returns:
List
of domains
-
setDomains
public void setDomains(java.util.List<EPPIdnTableCheckDomain> aDomains)
Set the list of domains- Parameters:
aDomains
-List
of domains
-
setDomain
public void setDomain(EPPIdnTableCheckDomain aDomain)
Set an individual domain. This method clears the existing list of domains.- Parameters:
aDomain
- Domain check result
-
addDomain
public void addDomain(EPPIdnTableCheckDomain aDomain)
Append a domain to the list of domains. This method does NOT clear the existing list of domains.- Parameters:
aDomain
- Domain check result
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPIdnTableCheckResp
instance.- Overrides:
doEncode
in classEPPResponse
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPIdnTableCheckResp
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPIdnTableCheckResp
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPIdnTableCheckResp
attributes from the aElement DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPIdnTableCheckResp
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
getType
public java.lang.String getType()
Get the EPP response type associated withEPPIdnTableCheckResp
.- Overrides:
getType
in classEPPResponse
- Returns:
EPPIdnTableCheckResp.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Get the EPP command Namespace associated withEPPIdnTableCheckResp
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPRegistryMapFactory.NS
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPIdnTableCheckResp
with this instance.- Overrides:
equals
in classEPPResponse
- Parameters:
aObject
- Object to compare with.- Returns:
true
if this object is the same as the aObject argument;false
otherwise
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPIdnTableCheckResp
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPIdnTableCheckResp
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classEPPResponse
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
-