Class EPPInfoCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPInfoCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
Direct Known Subclasses:
EPPBalanceInfoCmd, EPPBalanceInfoCmd, EPPChangeInfoCmd, EPPContactInfoCmd, EPPDefRegInfoCmd, EPPDomainInfoCmd, EPPEmailFwdInfoCmd, EPPHostInfoCmd, EPPIdnTableInfoCmd, EPPMaintenanceInfoCmd, EPPNameVerificationInfoCmd, EPPNameWatchInfoCmd, EPPOrgInfoCmd, EPPRegistryInfoCmd, EPPRegistryInfoCmd

public abstract class EPPInfoCmd extends EPPCommand
The EPP <info> command is used to retrieve information associated with an existing object. The elements needed to identify an object and the type of information associated with an object are both object- specific, so the child elements of the <info> command are specified using the EPP extension framework. In addition to the standard EPP command elements, the <info> command SHALL contain the following child elements: An object-specific <obj:info> element that identifies the object to be queried.

EPPInfoCmd is an abstract EPP command class that represents a info operation. A command mapping info command extends EPPInfoCmd. For example, EPPDomainInfoCmd is a EPPInfoCmd that implements the Domain Info Command Mapping.
See Also:
  • Constructor Details

    • EPPInfoCmd

      public EPPInfoCmd()
      Default constructor for EPPInfoCmd.
    • EPPInfoCmd

      public EPPInfoCmd(String aTransId)
      EPPInfoCmd that takes all required attributes as arguments. This will call the super EPPCommand(String) method to set the transaction id for the command.
      Parameters:
      aTransId - Transaction Id associated with command.
  • Method Details

    • getType

      public String getType()
      Gets the EPP command type associated with EPPInfoCmd.
      Specified by:
      getType in class EPPCommand
      Returns:
      EPPCommand.TYPE_INFO
    • equals

      public boolean equals(Object aObject)
      Compares an instance of EPPInfoCmd with this instance.
      Overrides:
      equals in class EPPCommand
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.
    • doGenEncode

      protected Element doGenEncode(Document aDocument) throws EPPEncodeException
      Encodes a DOM Element tree from the attributes of the EPPInfoCmd instance. This method is a member of the Template Design Pattern. EPPCommand.encode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
      Specified by:
      doGenEncode in class EPPCommand
      Parameters:
      aDocument - - DOM Document that is being built. Used as an Element factory.
      Returns:
      Root DOM Element representing the EPPInfoCmd instance.
      Throws:
      EPPEncodeException - Unable to encode EPPInfoCmd instance.
    • doGenDecode

      protected void doGenDecode(Element aElement) throws EPPDecodeException
      Decodes the EPPInfoCmd attributes from the aElement DOM Element tree. This method is a member of the Template Design Pattern. EPPCommand.decode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
      Specified by:
      doGenDecode in class EPPCommand
      Parameters:
      aElement - - Root DOM Element to decode EPPInfoCmd from.
      Throws:
      EPPDecodeException - Unable to decode aElement
    • doEncode

      protected abstract Element doEncode(Document aDocument) throws EPPEncodeException
      Must be defined by EPPInfoCmd extensions (Command Mappings) to encode the attributes to a DOM Element tree. doGenEncode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
      Parameters:
      aDocument - - DOM Document that is being built. Used as an Element factory.
      Returns:
      Root DOM Element representing the EPPInfoCmd extension instance.
      Throws:
      EPPEncodeException - Unable to encode EPPInfoCmd extension instance.
    • doDecode

      protected abstract void doDecode(Element aElement) throws EPPDecodeException
      Must be defined by EPPInfoCmd extensions (Command Mappings) to decode the attributes to a DOM Element tree. doGenDecode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
      Parameters:
      aElement - Root DOM Element representing the EPPInfoCmd extension instance.
      Throws:
      EPPDecodeException - Unable to decode aElement.