Package com.verisign.epp.codec.nameWatch

Class EPPNameWatchRenewCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPRenewCmd
com.verisign.epp.codec.nameWatch.EPPNameWatchRenewCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPNameWatchRenewCmd extends EPPRenewCmd
Represents an EPP NameWatch <renew> command, which provides a transform operation that allows a client to extend the validity period of a nameWatch object. The EPP <renew> command provides a transform operation that allows a client to extend the validity period of a nameWatch object. In addition to the standard EPP command elements, the <renew> command MUST contain a <nameWatch:renew> element that identifies the nameWatch namespace and the location of the nameWatch schema. The <nameWatch:renew> element SHALL contain the following child elements:

  • A <nameWatch:roid> element that contains the fully qualified nameWatch roid of the object whose validity period is to be extended. Use getRoid and setRoid to get and set the element.
  • A <nameWatch:curExpDate> element that contains the date on which the current validity period ends. This value ensures that repeated <renew> commands do not result in multiple unanticipated successful renewals. Use getCurExpDate and setCurExpDate to get and set the element.
  • An OPTIONAL <nameWatch:period> element that contains the initial registration period of the nameWatch object. Use getPeriod and setPeriod to get and set the element. If return null, period has not been specified yet.


See Also:

  • Constructor Details

    • EPPNameWatchRenewCmd

      public EPPNameWatchRenewCmd()
      Allocates a new EPPNameWatchRenewCmd with default attribute values. the defaults include the following:

      • roid is set to null
      • period is set to 1 year
      • current expiration date to null

      The roid and current expiration year must be set before invoking encode.

    • EPPNameWatchRenewCmd

      public EPPNameWatchRenewCmd(String aTransId, String aRoid, Date aCurExpDate)
      EPPNameWatchRenewCmd constructor that takes the nameWatch roid and the current expiration year as arguments. The period will default to 1 year.
      Parameters:
      aTransId - Transaction Id associated with command.
      aRoid - NameWatch roid to renew.
      aCurExpDate - The current expiration date of the nameWatch

    • EPPNameWatchRenewCmd

      public EPPNameWatchRenewCmd(String aTransId, String aRoid, Date aCurExpDate, EPPNameWatchPeriod aPeriod)
      EPPNameWatchRenewCmd constructor that takes all of the attributes of the renew command as arguments.
      Parameters:
      aTransId - Transaction Id associated with command.
      aRoid - NameWatch roid to renew.
      aCurExpDate - The current expiration date of the nameWatch.
      aPeriod - Registration period in years.

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPNameWatchRenewCmd.
      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.

    • getRoid

      public String getRoid()
      Gets the nameWatch roid to renew.
      Returns:
      NameWatch Roid

    • setRoid

      public void setRoid(String aRoid)
      Sets the nameWatch roid to renew.
      Parameters:
      aRoid - NameWatch Roid

    • equals

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

    • clone

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

    • getCurExpDate

      public Date getCurExpDate()
      Get current expiration date.
      Returns:
      curExpDate

    • getPeriod

      public EPPNameWatchPeriod getPeriod()
      Gets the registration period of the renew command in years.
      Returns:
      Registration Period in years.

    • setCurExpDate

      public void setCurExpDate(Date newCurExpDate)
      Set current expiration date.
      Parameters:
      newCurExpDate - Current Expiration Date

    • setPeriod

      public void setPeriod(EPPNameWatchPeriod aPeriod)
      Sets the registration period of the renew command in years.
      Parameters:
      aPeriod - Registration Period in years.

    • doEncode

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

    • doDecode

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