Package com.verisign.epp.codec.emailFwd

Class EPPEmailFwdCheckResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.emailFwd.EPPEmailFwdCheckResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPEmailFwdCheckResp extends EPPResponse
Represents an EPP EmailFwd <emailFwd:chkData> response to a EPPEmailFwdCheckCmd. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <emailFwd:chkData> element that identifies the emailFwd namespace and the location of the emailFwd schema. The <emailFwd:chkData> elements that contain the following child elements:
  • A <emailFwd:name> element that contains the fully qualified name of the queried emailFwd object. This element MUST contain an "avail" attribute whose value indicates object availability at the moment the <check> command was completed. A value of "1" or "true" menas that the object is availabe. A value of "0" or "false" means that the object is not available.
  • An OPTIONAL <emailFwd:reason> element that MAY be provided when an object is not available for provisioning. If present, this element contains server-specific text to help explain why the object is unavailable. This text MUST be represented in the response language previously negotiated with the client; an OPTIONAL "lang" attribute MAY be present to identify the language if the negotiated value is something other that a default value of "en" (English).
See Also:

  • Constructor Details

    • EPPEmailFwdCheckResp

      public EPPEmailFwdCheckResp()
      EPPEmailFwdCheckResp default constructor. It will set results attribute to an empty Vector.

    • EPPEmailFwdCheckResp

      public EPPEmailFwdCheckResp(EPPTransId aTransId, EPPEmailFwdCheckResult aResult)
      EPPEmailFwdCheckResp constructor that will set the result of an individual emailFwd.
      Parameters:
      aTransId - Transaction Id associated with response.
      aResult - Result of a single emailFwd name.

    • EPPEmailFwdCheckResp

      public EPPEmailFwdCheckResp(EPPTransId aTransId, Vector someResults)
      EPPEmailFwdCheckResp constructor that will set the result of multiple emailFwds.
      Parameters:
      aTransId - Transaction Id associated with response.
      someResults - Vector of EPPEmailFwdCheckResult instances.

  • Method Details

    • getType

      public String getType()
      Get the EPP response type associated with EPPEmailFwdCheckResp.
      Overrides:
      getType in class EPPResponse
      Returns:
      EPPEmailFwdCheckResp.ELM_NAME

    • getNamespace

      public String getNamespace()
      Get the EPP command Namespace associated with EPPEmailFwdCheckResp.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Overrides:
      getNamespace in class EPPResponse
      Returns:
      EPPEmailFwdMapFactory.NS

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPEmailFwdCheckResp.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPResponse
      Returns:
      clone of EPPEmailFwdCheckResp
      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 EPPResponse
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • setCheckResults

      public void setCheckResults(Vector someResults)
      Set the results of a EPPEmailFwdCheckResp Response. There is one EPPEmailFwdCheckResult instance in someResults for each emailFwd requested in the EPPEmailFwdCheckCmd Command.
      Parameters:
      someResults - Vector of EPPEmailFwdCheckResult instances.

    • getCheckResults

      public Vector getCheckResults()
      Get the results of a EPPEmailFwdCheckResp Response. There is one EPPEmailFwdCheckResult instance in someResults for each emailFwd requested in the EPPEmailFwdCheckResult Command.
      Returns:
      Vector of EPPEmailFwdCheckResult instances.

    • doEncode

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

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPEmailFwdCheckResp attributes from the aElement DOM Element tree.
      Overrides:
      doDecode in class EPPResponse
      Parameters:
      aElement - Root DOM Element to decode EPPEmailFwdCheckResp from.
      Throws:
      EPPDecodeException - Unable to decode aElement