Package com.verisign.epp.codec.domain

Class EPPDomainCheckResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.domain.EPPDomainCheckResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPDomainCheckResp extends EPPResponse
Represents an EPP Domain <domain:chkData> response to a EPPDomainCheckCmd. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <domain:chkData> element that identifies the domain namespace and the location of the domain schema. The <domain:chkData> elements that contain the following child elements:
  • A <domain:name> element that contains the fully qualified name of the queried domain 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 <domain: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:

  • Field Details

  • Constructor Details

    • EPPDomainCheckResp

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

    • EPPDomainCheckResp

      public EPPDomainCheckResp(EPPTransId aTransId)
      EPPDomainCheckResp constructor that sets the transaction identifier.
      Parameters:
      aTransId - Transaction Id associated with response.

    • EPPDomainCheckResp

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

    • EPPDomainCheckResp

      public EPPDomainCheckResp(EPPTransId aTransId, Vector<EPPDomainCheckResult> someResults)
      EPPDomainCheckResp constructor that will set the result of multiple domains.
      Parameters:
      aTransId - Transaction Id associated with response.
      someResults - Vector of EPPDomainCheckResult instances.

  • Method Details

    • getType

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

    • getNamespace

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPDomainCheckResp with this instance.
      Overrides:
      equals in class EPPResponse
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.

    • clone

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

    • addResult

      public void addResult(EPPDomainCheckResult aResult)
      Adds a result to the list of check results.
      Parameters:
      aResult - Result to add.

    • setCheckResults

      public void setCheckResults(Vector<EPPDomainCheckResult> aResults)
      Set the results of a EPPDomainCheckResp Response. There is one EPPDomainCheckResult instance in someResults for each domain requested in the EPPDomainCheckCmd Command.
      Parameters:
      aResults - Vector of EPPDomainCheckResult instances.

    • getCheckResults

      public Vector<EPPDomainCheckResult> getCheckResults()
      Get the results of a EPPDomainCheckResp Response. There is one EPPDomainCheckResult instance in someResults for each domain requested in the EPPDomainCheckResult Command.
      Returns:
      Vector of EPPDomainCheckResult instances.

    • doEncode

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

    • doDecode

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