Open topic with navigation

com.hp.lft.sdk

## Class SDKConfigurationFactory

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

-     public class SDKConfigurationFactory
      extends java.lang.Object

  Factory for creating an SDK configuration.

- - ### Constructor Summary

    Constructor and Description
    `SDKConfigurationFactory()`

  - ### Method Summary

    Modifier and Type | Method and Description
    --- | ---
    `static ModifiableSDKConfiguration` | `createDefaultSDKConfiguration()` Creates an SDKConfiguration with default values.
    `static ModifiableSDKConfiguration` | `loadConfigurationFromExternalPropertiesFile(java.lang.String propertiesFilePath)` Reads the SDK configuration from a properties file.
    `static ModifiableSDKConfiguration` | `loadConfigurationFromResources(java.lang.String propertiesFileName)` Reads the SDK configuration from a properties file located in the resources folder.

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

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

- - ### Constructor Detail

    - #### SDKConfigurationFactory

          public SDKConfigurationFactory()

  - ### Method Detail

    - #### createDefaultSDKConfiguration

          public static ModifiableSDKConfiguration createDefaultSDKConfiguration()
                                                                          throws java.net.URISyntaxException

      Creates an SDKConfiguration with default values.
      Returns:
        an SDKConfiguration with default values.
      Throws:
        `java.net.URISyntaxException` - if the syntax of the URI is invalid.

    - #### loadConfigurationFromResources

          public static ModifiableSDKConfiguration loadConfigurationFromResources(java.lang.String propertiesFileName)
                                                                           throws java.net.URISyntaxException,
                                                                                  java.io.IOException

      Reads the SDK configuration from a properties file located in the resources folder. For any property not found in the supplied property file, the default value is assigned.
      Parameters:
        `propertiesFileName` - the name of the properties file to load. (The file path is always the resources folder).
      Returns:
        the configuration with the values from the supplied properties file.
      Throws:
        `java.net.URISyntaxException` - if the server address is not in correct URI format.
        `java.io.IOException` - in case the file is not found.

    - #### loadConfigurationFromExternalPropertiesFile

          public static ModifiableSDKConfiguration loadConfigurationFromExternalPropertiesFile(java.lang.String propertiesFilePath)
                                                                                        throws java.net.URISyntaxException,
                                                                                               java.io.IOException

      Reads the SDK configuration from a properties file. For any property not found in the supplied property file, the default value is assigned.
      Parameters:
        `propertiesFilePath` - the full path of the properties file to load.
      Returns:
        the configuration with the values from the supplied properties file.
      Throws:
        `java.net.URISyntaxException` - if the server address is not in correct URI format.
        `java.io.IOException` - in case the file is not found.