Package com.verisign.epp.codec.authtoken.v01

Class EPPAuthTokenCheckResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.authtoken.v01.EPPAuthTokenCheckResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPAuthTokenCheckResp extends EPPResponse
Represents an EPP Authentication Token <authToken:chkData> response to a EPPAuthTokenCheckCmd. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <authToken:chkData> element that identifies the authToken namespace and the location of the authToken schema. The <authToken:chkData> elements that contain the following child elements:
  • A <authToken:authToken> element that contains the authentication token of the queried object. This element MUST contain an "valid" attribute whose value indicates if the authToken is valid at the moment the <check> command was completed. A value of "1" or "true" means that the token is valid. A value of "0" or "false" means that the token is not valid.
  • An OPTIONAL <authToken:reason> element that MAY be provided when the token is not valid. If present, this element contains server-specific text to help explain why the object is not valid. 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

    • EPPAuthTokenCheckResp

      public EPPAuthTokenCheckResp()
      Allocates a new EPPAuthTokenCheckResp with default attribute values, which are all set to null.

    • EPPAuthTokenCheckResp

      public EPPAuthTokenCheckResp(EPPTransId aTransId, EPPAuthTokenCheckData aCheckData)
      EPPAuthTokenCheckResp constructor that will set the result of an individual authentication token.
      Parameters:
      aTransId -
      aCheckData -

    • EPPAuthTokenCheckResp

      public EPPAuthTokenCheckResp(EPPTransId aTransId, List<EPPAuthTokenCheckData> aCheckData)
      EPPAuthTokenCheckResp constructor that will set the result of an multiple authentication tokens.
      Parameters:
      aTransId -
      aCheckData -

  • Method Details

    • setCheckData

      public void setCheckData(List<EPPAuthTokenCheckData> aCheckData)
      Set the results of a EPPAuthTokenCheckResp Response. There is one EPPAuthTokenCheckData instance in someResults for each authToken requested in the EPPAuthTokenCheckCmd Command.
      Parameters:
      aCheckData - List of EPPAuthTokenCheckData instances.

    • getCheckData

      public List<EPPAuthTokenCheckData> getCheckData()
      Get the results of a EPPAuthTokenCheckResp Response. There is one EPPAuthTokenCheckData instance in someResults for each authToken requested in the EPPAuthTokenCheckData Command.
      Returns:
      List of EPPAuthTokenCheckData instances.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPAuthTokenCheckResp 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 EPPAuthTokenCheckResp.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPResponse
      Returns:
      clone of EPPAuthTokenCheckResp
      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.

    • doEncode

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

    • doDecode

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

    • getNamespace

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