Package com.verisign.epp.codec.contact

Class EPPContactCheckResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.contact.EPPContactCheckResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPContactCheckResp extends EPPResponse
Represents an EPP Contact <contact:chkData> response to a EPPContactCheckCmd. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <contact:chkData> element that identifies the contact namespace and the location of the contact schema. The <contact:chkData> element contains one or more <contact:cd> elements that contain the following child elements:
  • A <contact:id> element that identifies the queried object. This element MUST contain an "avail" attribute whose value indicates object availablity at the moment the <check> command was completed. A value of "1" or "true" means that the object is available. A value of "0" or "false" means that the object is not available.
  • An OPTIONAL <contact: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

    • EPPContactCheckResp

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

    • EPPContactCheckResp

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

    • EPPContactCheckResp

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

  • Method Details

    • getType

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

    • getNamespace

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

    • doEncode

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

    • doDecode

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

    • equals

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

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPContactCheckResp.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPResponse
      Returns:
      clone of EPPContactCheckResp
      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 EPPContactCheckResp Response. There is one EPPContactResult instance in someResults for each contact requested in the EPPContactCheckCmd Command.
      Parameters:
      someResults - Vector of EPPContactResult instances.

    • getCheckResults

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