Package com.verisign.epp.codec.idntable
Class EPPIdnTableInfoResp
java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.idntable.EPPIdnTableInfoResp
- All Implemented Interfaces:
EPPCodecComponent,EPPMessage,Serializable,Cloneable
Represents an EPP Internationalized Domain Name (IDN) Table <info>
response, which support three different forms:
- Domain Info Form - Used to validate the domain name code points against the IDN Tables and IDN Policies, and to return the matching IDN Table meta-data.
- Table Info Form - Used to retrieve information associated with an IDN Table object.
- List Info Form - Used to retrieve the list of IDN Tables supported by the server.
EPPIdnTableInfoCmd is the concrete EPPCommand associated with
EPPIdnTableInfoCmd.- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumCheck form types, that include:
DOMAIN_FORMthat represents the "Domain Info Form".TABLE_FORMthat represents the "Table Info Form".LIST_FORMthat represents the "List Info Form". -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringXML local name forEPPIdnTableInfoResp.static final StringXML root tag forEPPIdnTableInfoResp.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
ConstructorsConstructorDescriptionEPPIdnTableInfoRespdefault constructor with the default form ofForm.LIST_FORM.EPPIdnTableInfoResp(EPPTransId aTransId) EPPIdnTableInfoRespconstructor that only takes the transaction identifier with the default form ofForm.LIST_FORM.EPPIdnTableInfoResp(EPPTransId aTransId, EPPIdnTableInfoDomain aDomain) EPPIdnTableInfoRespconstructor that only takes the transaction identifier and the domain information for the Domain Info Form.EPPIdnTableInfoResp(EPPTransId aTransId, EPPIdnTableInfoTable aTable) EPPIdnTableInfoRespconstructor that only takes the transaction identifier and the table information for the Table Info Form.EPPIdnTableInfoResp(EPPTransId aTransId, List<EPPIdnTableInfoListItem> aList) EPPIdnTableInfoRespconstructor that only takes the transaction identifier and the list information for the List Info Form. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddListItem(EPPIdnTableInfoListItem aListItem) Append a list item to the list in List Info Form.clone()CloneEPPIdnTableInfoResp.protected voidDecode theEPPIdnTableInfoRespattributes from the aElement DOM Element tree.protected ElementEncode a DOM Element tree from the attributes of theEPPIdnTableInfoRespinstance.booleanCompare an instance ofEPPIdnTableInfoRespwith this instance.Gets the domain information in Domain Info Form.getForm()What inform is being used?getList()Gets the list information in List Info Form.Gets the EPP command namespace associated withEPPIdnTableInfoResp.getTable()Gets the table information in Table Info Form.getType()Gets the EPP response type associated withEPPIdnTableInfoResp.voidsetDomain(EPPIdnTableInfoDomain aDomain) Sets the domain information in Domain Info Form.voidsetForm(EPPIdnTableInfoResp.Form aForm) Set the form of the info command using one of theFormenumerated values.voidsetList(List<EPPIdnTableInfoListItem> aList) Sets the list information in List Info Form.voidsetTable(EPPIdnTableInfoTable aTable) Sets the table information in Table Info Form.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 forEPPIdnTableInfoResp.- See Also:
-
ELM_NAME
XML root tag forEPPIdnTableInfoResp.- See Also:
-
-
Constructor Details
-
EPPIdnTableInfoResp
public EPPIdnTableInfoResp()EPPIdnTableInfoRespdefault constructor with the default form ofForm.LIST_FORM. -
EPPIdnTableInfoResp
EPPIdnTableInfoRespconstructor that only takes the transaction identifier with the default form ofForm.LIST_FORM.- Parameters:
aTransId- Transaction Id associated with response.
-
EPPIdnTableInfoResp
EPPIdnTableInfoRespconstructor that only takes the transaction identifier and the domain information for the Domain Info Form. The form is set toForm.DOMAIN_FORM.- Parameters:
aTransId- Transaction Id associated with response.aDomain- Domain information for Domain Info Form.
-
EPPIdnTableInfoResp
EPPIdnTableInfoRespconstructor that only takes the transaction identifier and the table information for the Table Info Form. The form is set toForm.TABLE_FORM.- Parameters:
aTransId- Transaction Id associated with response.aTable- Table information for Table Info Form.
-
EPPIdnTableInfoResp
EPPIdnTableInfoRespconstructor that only takes the transaction identifier and the list information for the List Info Form. The form is set toForm.LIST_FORM.- Parameters:
aTransId- Transaction Id associated with response.aList- List information for List Info Form.
-
-
Method Details
-
getForm
What inform is being used?- Returns:
- One of the
Formenumerated values, whereUNDEFINED_FORMis used when the form has not been set.
-
setForm
Set the form of the info command using one of theFormenumerated values.- Parameters:
aForm- One of theFormenumerated values.
-
getDomain
Gets the domain information in Domain Info Form.- Returns:
- Domain information if defined;
nullotherwise.
-
setDomain
Sets the domain information in Domain Info Form. The form will be automatically set toForm.DOMAIN_FORMfor a non-null domain value.- Parameters:
aDomain- the domain to set
-
getTable
Gets the table information in Table Info Form.- Returns:
- The table information if defined:
nullotherwise.
-
setTable
Sets the table information in Table Info Form. The form will be automatically set toForm.TABLE_FORMfor a non-null table value.- Parameters:
aTable- the table to set
-
addListItem
Append a list item to the list in List Info Form. The form will be automatically set toForm.LIST_FORM.- Parameters:
aListItem- List item to add to the list
-
getList
Gets the list information in List Info Form.- Returns:
- The list information if defined;
nullotherwise.
-
setList
Sets the list information in List Info Form. The form will be automatically set toForm.LIST_FORMfor a non-null table value.- Parameters:
aList- the list to set
-
doEncode
Encode a DOM Element tree from the attributes of theEPPIdnTableInfoRespinstance.- Overrides:
doEncodein classEPPResponse- Parameters:
aDocument- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the EPPIdnTableInfoResp instance.
- Throws:
EPPEncodeException- Unable to encode EPPIdnTableInfoResp instance.
-
doDecode
Decode theEPPIdnTableInfoRespattributes from the aElement DOM Element tree.- Overrides:
doDecodein classEPPResponse- Parameters:
aElement- Root DOM Element to decodeEPPIdnTableInfoRespfrom.- Throws:
EPPDecodeException- Unable to decode aElement
-
clone
CloneEPPIdnTableInfoResp.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classEPPResponse- Returns:
- clone of
EPPIdnTableInfoResp - Throws:
CloneNotSupportedException- standard Object.clone exception
-
getType
Gets the EPP response type associated withEPPIdnTableInfoResp.- Overrides:
getTypein classEPPResponse- Returns:
EPPIdnTableInfoResp.ELM_NAME
-
getNamespace
Gets the EPP command namespace associated withEPPIdnTableInfoResp.- Specified by:
getNamespacein interfaceEPPCodecComponent- Specified by:
getNamespacein interfaceEPPMessage- Overrides:
getNamespacein classEPPResponse- Returns:
EPPIdnTableMapFactory.NS
-
equals
Compare an instance ofEPPIdnTableInfoRespwith this instance.- Overrides:
equalsin classEPPResponse- Parameters:
aObject- Object to compare with.- Returns:
trueif this object is the same as the aObject argument;falseotherwise
-
toString
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.- Overrides:
toStringin classEPPResponse- Returns:
- Indented XML
Stringif successful;ERRORotherwise.
-