Package com.verisign.epp.interfaces

Class EPPKeyRelay

java.lang.Object
com.verisign.epp.interfaces.EPPKeyRelay
public class EPPKeyRelay extends Object
EPPKeyRelay is the primary client interface class used for keyrelay management. An instance of EPPKeyRelay is created with an initialized EPPSession, and can be used for more than one request within a single thread. A set of setter methods are provided to set the attributes before a call to one of the send action methods. The responses returned from the send action methods are either instances of EPPResponse or instances of response classes in the com.verisign.epp.codec.keyrelay package.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPKeyRelay(EPPSession aSession)
    Constructs an EPPKeyRelay given an initialized EPP session.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addExtension(EPPCodecComponent aExtension)
    Adds a command extension object.
    void
    appendKeyData(EPPKeyRelayData aKeyData)
    Appends to the List of key data EPPKeyRelayData instances to send.
    EPPAuthInfo
    getAuthInfo()
    Gets the set authorization information if defined.
    String
    getAuthRoid()
    Sets the authorization roid that is used to identify the registrant or contact object if and only if the value of authInfo, set by setAuthString(String), is associated with the registrant or contact object.
    String
    getAuthString()
    Sets the authorization string associated with an sendCreate and sendTransfer.
    Vector<EPPCodecComponent>
    getExtensions()
    Gets the command extensions.
    List<EPPKeyRelayData>
    getKeyData()
    Gets the key data.
    EPPResponse
    getResponse()
    Gets the response associated with the last command.
    boolean
    hasKeyData()
    Is there key data contained in EPPKeyRelayCreateCmd?
    protected void
    resetKeyRelay()
    Resets the key relay instance to its initial state.
    EPPResponse
    sendCreate()
    Sends a Key Relay Create Command to the server.

    The required attributes have been set with the following methods:

    setName - Sets the domain name asssociated with the key relay message. setAuthString - Sets the authorization information to authorize insertion of the key relay message. TODO - Add the key relay data

    The optional attributes have been set with the following:

    setTransId - Sets the client transaction identifier
    void
    setAuthInfo(EPPAuthInfo aAuthInfo)
    Sets the authorization information using the EPPAuthInfo object.
    void
    setAuthRoid(String aAuthRoid)
    Gets the authorization roid that is used to identify the registrant or contact object if and only if the value of authInfo, set by setAuthString(String), is associated with the registrant or contact object.
    void
    setAuthString(String aAuthString)
    Sets the authorization string associated with an sendCreate and sendTransfer and optionally sendInfo.
    void
    setExtensions(Vector<EPPCodecComponent> aExtensions)
    Sets the command extension objects.
    void
    setKeyData(List<EPPKeyRelayData> aKeyData)
    Sets the List of key data EPPKeyRelayData instances to send
    void
    setName(String aName)
    Sets the domain name associated with the key relay message.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • EPPKeyRelay

      public EPPKeyRelay(EPPSession aSession)
      Constructs an EPPKeyRelay given an initialized EPP session.
      Parameters:
      aSession - Server session to use.

  • Method Details

    • addExtension

      public void addExtension(EPPCodecComponent aExtension)
      Adds a command extension object.
      Parameters:
      aExtension - command extension object associated with the command

    • setExtensions

      public void setExtensions(Vector<EPPCodecComponent> aExtensions)
      Sets the command extension objects.
      Parameters:
      aExtensions - command extension objects associated with the command

    • getExtensions

      public Vector<EPPCodecComponent> getExtensions()
      Gets the command extensions.
      Returns:
      Vector of concrete EPPCodecComponent associated with the command if exists; 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

    • setAuthString

      public void setAuthString(String aAuthString)
      Sets the authorization string associated with an sendCreate and sendTransfer and optionally sendInfo.
      Parameters:
      aAuthString - Authorization string

    • getAuthRoid

      public String getAuthRoid()
      Sets the authorization roid that is used to identify the registrant or contact object if and only if the value of authInfo, set by setAuthString(String), is associated with the registrant or contact object. This can be used with sendCreate and sendInfo along with setting the authInfo with the setAuthString(String) method.
      Returns:
      Roid of registrant or contact object if defined; null otherwise.

    • setAuthRoid

      public void setAuthRoid(String aAuthRoid)
      Gets the authorization roid that is used to identify the registrant or contact object if and only if the value of authInfo, set by setAuthString(String), is associated with the registrant or contact object. This can be used with sendCreate along with setting the authInfo with the setAuthString(String) method.
      Parameters:
      aAuthRoid - Roid of registrant or contact object

    • getAuthString

      public String getAuthString()
      Sets the authorization string associated with an sendCreate and sendTransfer.
      Returns:
      Authorization string if defined; null otherwise.

    • getAuthInfo

      public EPPAuthInfo getAuthInfo()
      Gets the set authorization information if defined.
      Returns:
      The authorization information if defined; null otherwise.

    • setAuthInfo

      public void setAuthInfo(EPPAuthInfo aAuthInfo)
      Sets the authorization information using the EPPAuthInfo object.
      Parameters:
      aAuthInfo - The authorization information to set.

    • 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 to send
      Parameters:
      aKeyData - List of EPPKeyRelayData instances

    • appendKeyData

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

    • sendCreate

      public EPPResponse sendCreate() throws EPPCommandException
      Sends a Key Relay Create Command to the server.

      The required attributes have been set with the following methods:

      • setName - Sets the domain name asssociated with the key relay message.
      • setAuthString - Sets the authorization information to authorize insertion of the key relay message.
        • TODO - Add the key relay data


      The optional attributes have been set with the following:

      • setTransId - Sets the client transaction identifier
      Returns:
      EPPResponse containing the result of inserting the key relay message
      Throws:
      EPPCommandException - Error executing the create command. Use getResponse to get the associated server error response.

    • resetKeyRelay

      protected void resetKeyRelay()
      Resets the key relay instance to its initial state.

    • getResponse

      public EPPResponse getResponse()
      Gets the response associated with the last command. This method can be used to retrieve the server error response in the catch block of EPPCommandException.
      Returns:
      Response associated with the last command