Package com.verisign.epp.codec.idntable

Class EPPIdnTableCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.idntable.EPPIdnTableCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPIdnTableCheckCmd extends EPPCheckCmd
Represents an EPP Internationalized Domain Name (IDN) Table <check> command, which is used to determine if an (IDN) Table Identifier is known to the server. The <idnTable:check> element MUST either a list of <idnTable:domain> elements to check on the IDN table information for the domain names or a list of < elements to check on the IDN table information for the IDN table identifiers:

EPPIdnTableCheckResp is the concrete EPPReponse associated with EPPIdnTableCheckCmd.
See Also:

  • Field Details

  • Constructor Details

    • EPPIdnTableCheckCmd

      public EPPIdnTableCheckCmd()
      EPPIdnTableCheckCmd default constructor.

    • EPPIdnTableCheckCmd

      public EPPIdnTableCheckCmd(String aTransId)
      EPPIdnTableCheckCmd constructor that only takes the client transaction identifier
      Parameters:
      aTransId - Transaction Id associated with command.

    • EPPIdnTableCheckCmd

      public EPPIdnTableCheckCmd(String aTransId, String aTable)
      EPPIdnTableCheckCmd constructor for setting an individual table identifier to check in Table Check Form.
      Parameters:
      aTransId - Transaction Id associated with command.
      aTable - table identifier to check

    • EPPIdnTableCheckCmd

      public EPPIdnTableCheckCmd(String aTransId, EPPIdnTableDomainLabel aDomain)
      EPPIdnTableCheckCmd constructor for setting an individual domain name to check in Domain Check Form.
      Parameters:
      aTransId - Transaction Id associated with command.
      aDomain - Domain name to check

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPIdnTableCheckCmd.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Specified by:
      getNamespace in class EPPCommand
      Returns:
      EPPIdnTableMapFactory.NS

    • getForm

      public EPPIdnTableCheckCmd.Form getForm()
      What check form is being used, which are defined by the Form enumeration.
      Returns:
      One of the Form values.

    • hasTables

      public boolean hasTables()
      Are any table identifiers defined in the list of table identifiers?
      Returns:
      true if there is at least one table identifier defined; false otherwise.

    • getTables

      public List<String> getTables()
      Get the list of table identifiers to check.
      Returns:
      List of table identifier String's

    • setTables

      public void setTables(List<String> aTables)
      Set the list of table identifiers to check.
      Parameters:
      aTables - List of table identifier String's

    • setTable

      public void setTable(String aTable)
      Set an individual table identifier to check. This method clears the existing list of table identifiers.
      Parameters:
      aTable - Table identifier to check

    • addTable

      public void addTable(String aTable)
      Append a table identifier to the list of table identifiers to check. This method does NOT clear the existing list of table identifiers.
      Parameters:
      aTable - Table identifier to check

    • hasDomains

      public boolean hasDomains()
      Are any domain names defined in the list of domain names?
      Returns:
      true if there is at least one domain name defined; false otherwise.

    • getDomains

      public List<EPPIdnTableDomainLabel> getDomains()
      Get the list of domain names to check
      Returns:
      List of domain names

    • setDomains

      public void setDomains(List<EPPIdnTableDomainLabel> aDomains)
      Set the list of domain names to check
      Parameters:
      aDomains - List of domain names

    • setDomain

      public void setDomain(EPPIdnTableDomainLabel aDomain)
      Set an individual domain name to check. This method clears the existing list of domain names.
      Parameters:
      aDomain - Domain name to check

    • addDomain

      public void addDomain(EPPIdnTableDomainLabel aDomain)
      Append a domain name to the list of domain names to check. This method does NOT clear the existing list of domain names.
      Parameters:
      aDomain - Domain name to check

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPIdnTableCheckCmd instance.
      Specified by:
      doEncode in class EPPCheckCmd
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element Root DOM Element representing the EPPIdnTableCheckCmd instance.
      Throws:
      EPPEncodeException - Unable to encode EPPIdnTableCheckCmd instance.

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPIdnTableCheckCmd attributes from the aElement DOM Element tree.
      Specified by:
      doDecode in class EPPCheckCmd
      Parameters:
      aElement - Root DOM Element to decode EPPIdnTableCheckCmd from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPIdnTableCheckCmd with this instance.
      Overrides:
      equals in class EPPCheckCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if this object is the same as the aObject argument; false otherwise.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPIdnTableCheckCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      Deep copy clone of EPPIdnTableCheckCmd
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • toString

      public String toString()
      Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
      Overrides:
      toString in class EPPCommand
      Returns:
      Indented XML String if successful; ERROR otherwise.