Package com.verisign.epp.codec.emailFwd

Class EPPEmailFwdTransferResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.emailFwd.EPPEmailFwdTransferResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPEmailFwdTransferResp extends EPPResponse
Represents an EPP EmailFwd <emailFwd:transfer-data> response to an EPPEmailFwdTransferCmd. When a <transfer> query command has been processed successfully, the EPP <resData> element MUST conemailFwdtain a child <emailFwd:trnData> element that identifies the emailFwd namespace and the location of the emailFwd schema. The <emailFwd:trnData> element SHALL contain the following child elements:

  • A <emailFwd:name> element that contains the fully qualified emailFwd name used in the query. Use getName and setName to get and set the element.
  • A <emailFwd:reID> element that contains the identifier of the client that initiated the transfer request. Use getRequestClient and setRequestClient to get and set the element.
  • A <emailFwd:acID> element that contains the identifier of the client that SHOULD respond to the transfer request. Use getActionClient and setActionClient to get and set the element.
  • A <emailFwd:trStatus> element that contains the state of the most recent transfer request. Valid values are "PENDING", "APPROVED", "REJECTED", "AUTO-APPROVED", "AUTO-REJECTED", and "CANCELLED". Use getStatus and setStatus with the EPPEmailFwdTransferResp.STATUS_ constants to get and set the element.
  • A <emailFwd:reDate> element that contains the date and time that the transfer was requested. Use getRequestDate and setRequestDate to get and set the element.
  • A <emailFwd:acDate> element that contains the date and time of a required or completed response. For a PENDING request, the value identifies the date and time by which a response is required before an automated response action MUST be taken by the server. For all other status types, the value identifies the date and time when the request was completed. Use getActionDate and setActionDate to get and set the element.
  • An OPTIONAL <emailFwd:exDate> element that contains the end of the emailFwd's validity period if the <transfer> command caused or causes a change in the validity period. Use getExpirationDate and setExpirationDate to get and set the element.


See Also:

  • Constructor Details

    • EPPEmailFwdTransferResp

      public EPPEmailFwdTransferResp()
      EPPEmailFwdTransferResp default constructor. Must call required setter methods before invoking encode, which include:

      • name - setName
      • request client - setRequestClient
      • action client - setActionClient
      • transfer status - setTransferStatus
      • request date - setReqeustDate
      • action date - setActionDate
      • transaction id - setTransId

    • EPPEmailFwdTransferResp

      public EPPEmailFwdTransferResp(EPPTransId aTransId, String aName)
      EPPEmailFwdTransferResp which takes the name of emailFwd. All other required attributes need to be set using the setter methods, which include:

      • request client - setRequestClient
      • action client - setActionClient
      • transfer status - setTransferStatus
      • request date - setReqeustDate
      • action date - setActionDate
      Parameters:
      aTransId - Transaction Id associated with response.
      aName - EmailFwd name

  • Method Details

    • getType

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

    • getNamespace

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

    • doEncode

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

    • doDecode

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

    • equals

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

    • clone

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

    • getName

      public String getName()
      Gets the emailFwd name
      Returns:
      EmailFwd Name if set; null otherwise.

    • setName

      public void setName(String aName)
      Sets the emailFwd name.
      Parameters:
      aName - EmailFwd Name

    • getRequestClient

      public String getRequestClient()
      Gets the identifier of the client that initiated the transfer request.
      Returns:
      The Request Client Id String if defined; null otherwise.

    • setRequestClient

      public void setRequestClient(String aRequestClient)
      Sets the identifier of the client that initiated the transfer request.
      Parameters:
      aRequestClient - The Request Client Id String

    • getActionClient

      public String getActionClient()
      Gets the identifier of the client that SHOULD respond to the transfer request.
      Returns:
      The Request Client Id String if defined; null otherwise.

    • setActionClient

      public void setActionClient(String aActionClient)
      Sets the identifier of the client that SHOULD respond to the transfer request.
      Parameters:
      aActionClient - The Action Client Id String

    • getTransferStatus

      public String getTransferStatus()
      Gets the state of the most recent transfer request. This should be one of the EPPResponse.TRANSFER constants.
      Returns:
      The transfer status String if defined; null otherwise.

    • setTransferStatus

      public void setTransferStatus(String aTransferStatus)
      Sets the state of the most recent transfer request. This should be one of the EPPResponse.TRANSFER constants.
      Parameters:
      aTransferStatus - The transfer status String (EPPResponse.TRANSFER)

    • getRequestDate

      public Date getRequestDate()
      Gets the date and time that the transfer was requested.
      Returns:
      The request date and time if defined; null otherwise.

    • setRequestDate

      public void setRequestDate(Date aRequestDate)
      Sets the date and time that the transfer was requested.
      Parameters:
      aRequestDate - The request date and time

    • getActionDate

      public Date getActionDate()
      Gets the date and time of a required or completed response.
      Returns:
      The required or complete response data and time if defined; null otherwise.

    • setActionDate

      public void setActionDate(Date aActionDate)
      Sets the date and time of a required or completed response.
      Parameters:
      aActionDate - The required or complete response data and time.

    • getExpirationDate

      public Date getExpirationDate()
      Gets the optional attribute that contains the end of the emailFwd's validity period if the transfer command caused or causes a change in the validity period.
      Returns:
      Transfer expiration data and time if defined; null otherwise.

    • setExpirationDate

      public void setExpirationDate(Date aExpirationDate)
      Sets the optional attribute that contains the end of the emailFwd's validity period if the transfer command caused or causes a change in the validity period.
      Parameters:
      aExpirationDate - Transfer expiration data and time.