Package com.verisign.epp.codec.keyrelay

Class EPPKeyRelayInfoResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.keyrelay.EPPKeyRelayInfoResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPKeyRelayInfoResp extends EPPResponse
Represents an EPP Key Relay <keyrelay:infData> response that is used in the key relay poll message. The <keyrelay:infData> element contains the following child elements:

  • A <keyrelay:name> element that contains the fully qualified name of the domain name of the key relay message.
  • A <keyrelay:authInfo> element that contains authorization information associated with the domain object. This should an empty element since the authorization information should be only validated by the server to authorize insertion of the key relay poll message.
  • One or more REQUIRED <keyRelayData> elements containing data to be relayed.
  • A <keyrelay:crDate> element that contains the date and time of the submitted <create> command that inserted the key relay message.
  • A <keyrelay:reID> element that contains the identifier of the client that requested the key relay.
  • A <keyrelay:acID> element that contains the identifier of the client that SHOULD act upon the key relay.
See Also:

  • Field Details

  • Constructor Details

    • EPPKeyRelayInfoResp

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

      • name - setName

    • EPPKeyRelayInfoResp

      public EPPKeyRelayInfoResp(EPPTransId aTransId, String aName)
      EPPKeyRelayInfoResp constructor that takes the required attribute values as parameters, except for the key data that can be appended with appendKeyData(). The setter methods of the optional attributes can be called before invoking encode.
      Parameters:
      aTransId - Transaction Id associated with response.
      aName - Domain name

    • EPPKeyRelayInfoResp

      public EPPKeyRelayInfoResp(EPPTransId aTransId, String aName, List<EPPKeyRelayData> aKeyData)
      EPPKeyRelayInfoResp constructor that takes the required attribute values as parameters. The setter methods of the optional attributes can be called before invoking encode.
      Parameters:
      aTransId - Transaction Id associated with response.
      aName - Domain name
      aKeyData - Key data sent *

  • Method Details

    • getType

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

    • getNamespace

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPKeyRelayInfoResp 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 EPPKeyRelayInfoResp.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPResponse
      Returns:
      clone of EPPKeyRelayInfoResp
      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 domain name associated with the key relay message
      Returns:
      Domain Name if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the domain name associated with the key relay message.
      Parameters:
      aName - Domain name associated with the key relay message

    • getRequestedId

      public String getRequestedId()
      Gets identifier of the client that requested the key relay.
      Returns:
      identifier of the client that requested the key relay if defined; null otherwise.

    • setRequestedId

      public void setRequestedId(String aRequestedId)
      Sets identifier of the client that requested the key relay.
      Parameters:
      aRequestedId - Identifier of the client that requested the key relay.

    • getActionId

      public String getActionId()
      Gets identifier of the client that SHOULD act upon the key relay.
      Returns:
      Identifier of the client that SHOULD act upon the key relay if defined; null otherwise.

    • setActionId

      public void setActionId(String aActionId)
      Sets identifier of the client that SHOULD act upon the key relay.
      Parameters:
      aActionId - Identifier of the client that SHOULD act upon the key relay.

    • getCreatedDate

      public Date getCreatedDate()
      Gets the date and time of the submitted <create> command.
      Returns:
      Date and time of the submitted <create> command if defined; null otherwise.

    • setCreatedDate

      public void setCreatedDate(Date aDate)
      Sets the date and time of the submitted <create> command.
      Parameters:
      aDate - Date and time of the submitted <create> command

    • hasAuthInfo

      public boolean hasAuthInfo()
      Has the authorization information been set?
      Returns:
      true if the authorization information has been set; false otherwise.

    • getAuthInfo

      public EPPAuthInfo getAuthInfo()
      Get authorization information
      Returns:
      Authorization information if defined; null otherwise;

    • setAuthInfo

      public void setAuthInfo(EPPAuthInfo aAuthInfo)
      Set authorization information
      Parameters:
      aAuthInfo - EPPAuthInfo

    • hasKeyData

      public boolean hasKeyData()
      Is there key data contained in EPPKeyRelayCreateCmd?
      Returns:
      true if list of EPPKeyRelayData is not null and not empty; false otherwise.

    • getKeyData

      public List<EPPKeyRelayData> getKeyData()
      Gets the key data.
      Returns:
      List of keyData EPPKeyRelayData instances if defined; null otherwise.

    • setKeyData

      public void setKeyData(List<EPPKeyRelayData> aKeyData)
      Sets the List of key data EPPKeyRelayData instances sent.
      Parameters:
      aKeyData - List of EPPKeyRelayData instances

    • appendKeyData

      public void appendKeyData(EPPKeyRelayData aKeyData)
      Appends to the List of key data EPPKeyRelayData instances sent.
      Parameters:
      aKeyData - EPPKeyRelayData instance

    • doEncode

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

    • doDecode

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