Package com.verisign.epp.codec.defReg

Class EPPDefRegInfoCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPInfoCmd
com.verisign.epp.codec.defReg.EPPDefRegInfoCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPDefRegInfoCmd extends EPPInfoCmd
Represents an EPPDefReg <info> command that is used to retrieve information associated with a defReg. The response to this command MAY vary depending on the identity of the querying client, use of authorization information, and server policy towards unauthorized clients. If the querying client is the sponsoring client, all available information MUST be returned. If the querying client is not the sponsoring client, but the client provides valid authorization information, all available information MUST be returned. If the querying client is not the sponsoring client, and the client does not provide valid authorization information, server policy determines which OPTIONAL elements are returned.

In addition to the standard EPP command elements, the <info> command MUST contain a <defReg:info> element that identifies the defReg namespace.The <defReg:info> element contains the following child elements:
  • A <defReg:roid> element that contains the roid of the object to be queried
  • A <defReg:authInfo> OPTIONAL element that contains authorization information associated with the defReg object or authorization information associated with the defReg object's registrant or associated contacts. An OPTIONAL "roid" attribute MUST be used to identify the registrant or contact object if and only if the given authInfo is associated with a registrant or contact object, and not the defReg itself. If this element is not provided or if the authorization information is invalid, server policy determines if the command is rejected or if response information will be returned to the client.
EPPDefRegInfoResp is the concrete EPPReponse associated with EPPDefRegInfoCmd.
See Also:

  • Constructor Details

    • EPPDefRegInfoCmd

      public EPPDefRegInfoCmd()
      EPPDefRegInfoCmd default constructor. The roid is initialized to null. The roid must be set before invoking encode.

    • EPPDefRegInfoCmd

      public EPPDefRegInfoCmd(String aTransId, String aRoid)
      EPPDefRegInfoCmd constructor that takes the defReg roid as an argument.
      Parameters:
      aTransId - Transaction Id associated with command.
      aRoid - DefReg roid to get information on.

    • EPPDefRegInfoCmd

      public EPPDefRegInfoCmd(String aTransId, String aRoid, EPPAuthInfo aAuthInfo)

  • Method Details

    • getNamespace

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

    • getKey

      public String getKey()
      Gets the key for the defensive registration object, which is the defensive registration ROID.
      Overrides:
      getKey in class EPPCommand
      Returns:
      The defensive registration ROID if set; null otherwise.

    • getRoid

      public String getRoid()
      Gets the defReg roid to get information on.
      Returns:
      DefReg roid String instance if defined; null otherwise.

    • setRoid

      public void setRoid(String aRoid)
      Sets the defReg roid to get information on.
      Parameters:
      aRoid - DefReg Name

    • doEncode

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

    • doDecode

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

    • getAuthInfo

      public EPPAuthInfo getAuthInfo()
      Get authorization information
      Returns:
      Authorization information if defined; null otherwise;

    • setAuthInfo

      public void setAuthInfo(EPPAuthInfo aAuthInfo)
      Set authorization information
      Parameters:
      aAuthInfo - EPPAuthInfo

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPDefRegInfoCmd with this instance.
      Overrides:
      equals in class EPPInfoCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      DOCUMENT ME!

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPDefRegInfoCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      clone of EPPDefRegInfoCmd
      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.