Package com.verisign.epp.codec.emailFwd

Class EPPEmailFwdCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.emailFwd.EPPEmailFwdCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPEmailFwdCheckCmd extends EPPCheckCmd
Represents an EPP EmailFwd <check> command, which is used to determine if a emailFwd name is known to the server. The <emailFwd:check> element MUST contain the following child elements:

  • One or more (up to a maximum of sixteen) <emailFwd:name> elements that contain the fully qualified name of the queried emailFwds. Use getNames and setNames to get and set the elements. Use setName to set an individual name.

EPPEmailFwdCheckResp is the concrete EPPReponse associated with EPPEmailFwdCheckCmd.
See Also:

  • Field Details

    • MAX_EMAILFWDS

      public static final int MAX_EMAILFWDS
      Maximum number of emailFwds to check at once.
      See Also:

  • Constructor Details

    • EPPEmailFwdCheckCmd

      public EPPEmailFwdCheckCmd()
      EPPEmailFwdCheckCmd default constructor. It will set the names attribute to an empty Vector.

    • EPPEmailFwdCheckCmd

      public EPPEmailFwdCheckCmd(String aTransId, String aName)
      EPPEmailFwdCheckCmd constructor that will check an individual emailFwd name.
      Parameters:
      aTransId - Transaction Id associated with command.
      aName - EmailFwd name to check

    • EPPEmailFwdCheckCmd

      public EPPEmailFwdCheckCmd(String aTransId, Vector someNames)
      EPPEmailFwdCheckCmd constructor that will check a list of emailFwd names.
      Parameters:
      aTransId - Transaction Id associated with command.
      someNames - Vector of emailFwd name String instances.

  • Method Details

    • getNamespace

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

    • getKey

      public String getKey()
      Gets the key for the emailFwd object, which is the emailFwd name.
      Overrides:
      getKey in class EPPCommand
      Returns:
      The emailFwd name if set to a single value; null otherwise.

    • equals

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

    • clone

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

    • setName

      public void setName(String aName)
      Sets emailFwd name to check.
      Parameters:
      aName - Name to check.

    • getNames

      public Vector getNames()
      Gets emailFwd names to check.
      Returns:
      Vector of emailFwd name String's.

    • setNames

      public void setNames(Vector someNames)
      Sets emailFwd names to check.
      Parameters:
      someNames - Names to check.

    • doEncode

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

    • doDecode

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