com.verisign.epp.interfaces
Class EPPIdnTable

java.lang.Object
  extended by com.verisign.epp.interfaces.EPPIdnTable

public class EPPIdnTable
extends java.lang.Object

EPPIdnTable is the primary client interface class used for the IDN Table EPP mapping. An instance of EPPIdnTable is created with an initialized EPPSession, and can be used for more than one request within a single thread. A set of setter methods are provided to set the attributes before a call to one of the send action methods. The responses returned from the send action methods are either instances of EPPResponse or instances of response classes in the com.verisign.epp.codec.idntable package.

See Also:
EPPIdnTableCheckResp, EPPIdnTableInfoResp

Constructor Summary
EPPIdnTable(EPPSession aSession)
          Constructs an EPPIdnTable given an initialized EPP session.
 
Method Summary
 void addDomain(java.lang.String aDomain, EPPIdnTableDomainLabel.Form aForm)
          Adds a domain for use with a send method.
 void addExtension(EPPCodecComponent aExtension)
          Adds a command extension object.
 void addTable(java.lang.String aTable)
          Adds a table identifier for use with a send method.
 java.util.Vector getExtensions()
          Gets the command extensions.
 EPPResponse getResponse()
          Gets the response associated with the last command.
protected  void resetIdnTable()
          Resets the IDN Table instance to its initial state.
 EPPIdnTableCheckResp sendDomainCheck()
          Sends an IDN Table Check Command in Domain Check Form to the server.
 EPPIdnTableInfoResp sendDomainInfo()
          Sends an IDN Table Info Command in Domain Info Form to the server.
 EPPIdnTableInfoResp sendListInfo()
          Sends an IDN Table Info Command in List Info Form to the server.
 EPPIdnTableCheckResp sendTableCheck()
          Sends an IDN Table Check Command in Table Check Form to the server.
 EPPIdnTableInfoResp sendTableInfo()
          Sends an IDN Table Info Command in Table Info Form to the server.
 void setExtensions(java.util.Vector aExtensions)
          Sets the command extension objects.
 void setTransId(java.lang.String aTransId)
          Sets the client transaction identifier.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EPPIdnTable

public EPPIdnTable(EPPSession aSession)
Constructs an EPPIdnTable given an initialized EPP session.

Parameters:
aSession - Server session to use.
Method Detail

addExtension

public void addExtension(EPPCodecComponent aExtension)
Adds a command extension object.

Parameters:
aExtension - command extension object associated with the command

setExtensions

public void setExtensions(java.util.Vector aExtensions)
Sets the command extension objects.

Parameters:
aExtensions - command extension objects associated with the command

getExtensions

public java.util.Vector getExtensions()
Gets the command extensions.

Returns:
Vector of concrete EPPCodecComponent associated with the command if exists; null otherwise.

setTransId

public void setTransId(java.lang.String aTransId)
Sets the client transaction identifier.

Parameters:
aTransId - Client transaction identifier

addDomain

public void addDomain(java.lang.String aDomain,
                      EPPIdnTableDomainLabel.Form aForm)
Adds a domain for use with a send method. Adding more than one domain is only supported by sendCheck.

Parameters:
aDomain - Domain name to add
aForm - The form of the domain name, which is EPPIdnTableDomainLabel.A_LABEL for an A-label and // * EPPIdnTableDomainLabel.U_LABEL for a U-label.

addTable

public void addTable(java.lang.String aTable)
Adds a table identifier for use with a send method. Adding more than one table is only supported by sendCheck.

Parameters:
aTable - Table identifier to add.

sendDomainCheck

public EPPIdnTableCheckResp sendDomainCheck()
                                     throws EPPCommandException
Sends an IDN Table Check Command in Domain Check Form to the server.

There required attributes that must be set prior to executing sendDomainCheck() include:



The optional attributes can be set with the following:

Returns:
EPPIdnTableCheckResp with form set to EPPIdnTableCheckResp.Form.DOMAIN_FORM.
Throws:
EPPCommandException - On error

sendTableCheck

public EPPIdnTableCheckResp sendTableCheck()
                                    throws EPPCommandException
Sends an IDN Table Check Command in Table Check Form to the server.

There required attributes that must be set prior to executing sendTableCheck() include:



The optional attributes can be set with the following:

Returns:
EPPIdnTableCheckResp with form set to EPPIdnTableCheckResp.Form.TABLE_FORM.
Throws:
EPPCommandException - On error

sendDomainInfo

public EPPIdnTableInfoResp sendDomainInfo()
                                   throws EPPCommandException
Sends an IDN Table Info Command in Domain Info Form to the server.

There required attributes that must be set prior to executing sendDomainInfo() include:



The optional attributes can be set with the following:

Returns:
EPPIdnTableInfoResp with form set to EPPIdnTableInfoResp.Form.DOMAIN_FORM.
Throws:
EPPCommandException - On error

sendTableInfo

public EPPIdnTableInfoResp sendTableInfo()
                                  throws EPPCommandException
Sends an IDN Table Info Command in Table Info Form to the server.

There required attributes that must be set prior to executing sendTableInfo() include:



The optional attributes can be set with the following:

Returns:
EPPIdnTableInfoResp with form set to EPPIdnTableInfoResp.Form.TABLE_FORM.
Throws:
EPPCommandException - On error

sendListInfo

public EPPIdnTableInfoResp sendListInfo()
                                 throws EPPCommandException
Sends an IDN Table Info Command in List Info Form to the server.

There are no required attributes that must be set prior to executing sendListInfo().


The optional attributes can be set with the following:

Returns:
EPPIdnTableInfoResp with form set to EPPIdnTableInfoResp.Form.LIST_FORM.
Throws:
EPPCommandException - On error

resetIdnTable

protected void resetIdnTable()
Resets the IDN Table instance to its initial state.


getResponse

public EPPResponse getResponse()
Gets the response associated with the last command. This method can be used to retrieve the server error response in the catch block of EPPCommandException.

Returns:
Response associated with the last command


Copyright © VeriSign Inc. All Rights Reserved.