Package com.verisign.epp.codec.nameWatch

Class EPPNameWatchInfoCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPInfoCmd
com.verisign.epp.codec.nameWatch.EPPNameWatchInfoCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPNameWatchInfoCmd extends EPPInfoCmd
Represents an EPP NameWatch <info> command that is used to retrieve information associated with a nameWatch. The <nameWatch:info> element MUST contain the following child elements:

  • A <nameWatch:roid> element that contains the fully qualified nameWatch name for which information is requested. Use getRoid and setRoid to get and set the element.

EPPNameWatchInfoResp is the concrete EPPReponse associated with EPPNameWatchInfoCmd.

See Also:

  • Constructor Details

    • EPPNameWatchInfoCmd

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

    • EPPNameWatchInfoCmd

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

    • EPPNameWatchInfoCmd

      public EPPNameWatchInfoCmd(String aTransId, String aRoid, EPPAuthInfo aAuthInfo)
      EPPNameWatchInfoCmd constructor that takes the roid and authinfo of the NameWatch object.
      Parameters:
      aTransId - Transaction Id associated with command.
      aRoid - NameWatch roid to get information on.
      aAuthInfo - Authorization info for the NameWatch object

  • Method Details

    • getNamespace

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

    • getKey

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

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPNameWatchInfoCmd 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 EPPNameWatchInfoCmd instance.
      Throws:
      EPPEncodeException - Unable to encode EPPNameWatchInfoCmd instance.

    • doDecode

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

    • getRoid

      public String getRoid()
      Gets the nameWatch roid
      Returns:
      NameWatch roid

    • setRoid

      public void setRoid(String aRoid)
      Sets the nameWatch roid
      Parameters:
      aRoid - NameWatch roid

    • 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 EPPNameWatchInfoCmd with this instance.
      Overrides:
      equals in class EPPInfoCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      DOCUMENT ME!

    • clone

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