Open topic with navigation

com.hp.lft.sdk

## Class ModifiableSDKConfiguration

- java.lang.Object
- - com.hp.lft.sdk.ModifiableSDKConfiguration

- All Implemented Interfaces:
    SDKConfiguration

      public class ModifiableSDKConfiguration
      extends java.lang.Object
      implements SDKConfiguration

  Interface for defining the configuration information for the SDK.

- - ### Constructor Summary

    Constructor and Description
    `ModifiableSDKConfiguration()` Initializes a new instance of the ModifiableSDKConfiguration class, initialized to default values.

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `getAutoLaunch()` Indicates whether the LeanFT runtime engine is set to launch on LeanFT SDK initialization.
    `int` | `getConnectTimeoutSeconds()` Returns the maximum time (in seconds) to try to connect to the runtime engine.
    `int` | `getResponseTimeoutSeconds()` Returns the maximum time (in seconds) to wait for a response to any command sent to the runtime engine.
    `SDKMode` | `getSDKMode()` Returns the the SDK run mode.
    `java.net.URI` | `getServerAddress()` Returns the LeanFT runtime engine URL to use for the default session.
    `void` | `setAutoLaunch(boolean autoLaunch)` Sets whether the LeanFT runtime engine is set to launch on LeanFT SDK initialization.
    `void` | `setConnectTimeoutSeconds(int connectTimeoutSeconds)` Sets the maximum time (in seconds) to try to connect to the runtime engine.
    `void` | `setResponseTimeoutSeconds(int responseTimeoutSeconds)` Sets the maximum time (in seconds) to wait for a response to any command sent to the runtime engine.
    `void` | `setSDKMode(SDKMode sdkMode)` Sets the SDK run mode.
    `void` | `setServerAddress(java.net.URI serverAddress)` Sets the LeanFT runtime engine URL to use for the default session.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### ModifiableSDKConfiguration

          public ModifiableSDKConfiguration()
                                     throws java.net.URISyntaxException

      Initializes a new instance of the ModifiableSDKConfiguration class, initialized to default values.
      Throws:
        `java.net.URISyntaxException` - if the syntax of the URI is invalid.

  - ### Method Detail

    - #### getServerAddress

          public java.net.URI getServerAddress()

      Description copied from interface: `SDKConfiguration`
      Returns the LeanFT runtime engine URL to use for the default session.
      Specified by:
        `getServerAddress` in interface `SDKConfiguration`
      Returns:
        the LeanFT runtime engine URL to use for the default session.

    - #### getConnectTimeoutSeconds

          public int getConnectTimeoutSeconds()

      Description copied from interface: `SDKConfiguration`
      Returns the maximum time (in seconds) to try to connect to the runtime engine.
      Specified by:
        `getConnectTimeoutSeconds` in interface `SDKConfiguration`
      Returns:
        the maximum time (in seconds) to try to connect to the runtime engine.

    - #### getResponseTimeoutSeconds

          public int getResponseTimeoutSeconds()

      Description copied from interface: `SDKConfiguration`
      Returns the maximum time (in seconds) to wait for a response to any command sent to the runtime engine.
      Specified by:
        `getResponseTimeoutSeconds` in interface `SDKConfiguration`
      Returns:
        the maximum response wait time in seconds.

    - #### getAutoLaunch

          public boolean getAutoLaunch()

      Description copied from interface: `SDKConfiguration`
      Indicates whether the LeanFT runtime engine is set to launch on LeanFT SDK initialization. Note: Relevant only for local runs. When running remotely, the value should be false.
      Specified by:
        `getAutoLaunch` in interface `SDKConfiguration`
      Returns:
        true if the LeanFT runtime engine is set to launch on LeanFT SDK initialization, false otherwise.

    - #### getSDKMode

          public SDKMode getSDKMode()

      Description copied from interface: `SDKConfiguration`
      Returns the the SDK run mode.
      Specified by:
        `getSDKMode` in interface `SDKConfiguration`
      Returns:
        the current SDK mode.

    - #### setServerAddress

          public void setServerAddress(java.net.URI serverAddress)

      Sets the LeanFT runtime engine URL to use for the default session.
      Parameters:
        `serverAddress` - the LeanFT runtime engine URL to use.

    - #### setConnectTimeoutSeconds

          public void setConnectTimeoutSeconds(int connectTimeoutSeconds)

      Sets the maximum time (in seconds) to try to connect to the runtime engine.
      Parameters:
        `connectTimeoutSeconds` - the maximum time (in seconds) to try to connect to the runtime engine.

    - #### setResponseTimeoutSeconds

          public void setResponseTimeoutSeconds(int responseTimeoutSeconds)

      Sets the maximum time (in seconds) to wait for a response to any command sent to the runtime engine.
      Parameters:
        `responseTimeoutSeconds` - the response timeout in seconds.

    - #### setAutoLaunch

          public void setAutoLaunch(boolean autoLaunch)

      Sets whether the LeanFT runtime engine is set to launch on LeanFT SDK initialization. Note: Relevant only for local runs. When running remotely, the value should be false.
      Parameters:
        `autoLaunch` - true to launch LFTRuntime.exe automatically, false otherwise.

    - #### setSDKMode

          public void setSDKMode(SDKMode sdkMode)

      Sets the SDK run mode. Possible values: `SDKMode`. Default = Replay.
      Parameters:
        `sdkMode` - the mode the SDK will use during the run.