com.symphony.bdk.core.config

Class BdkConfigLoader

java.lang.Object

com.symphony.bdk.core.config.BdkConfigLoader

@API(status=STABLE)
public class BdkConfigLoader
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
BdkConfigLoader()

Method Summary

Modifier and Type	Method and Description
static BdkConfig	loadFromClasspath(java.lang.String configPath) Load BdkConfig from a classpath
static BdkConfig	loadFromFile(java.lang.String configPath) Load BdkConfig from a file path
static BdkConfig	loadFromInputStream(java.io.InputStream inputStream) Load BdkConfig from an InputStream
static BdkConfig	loadFromSymphonyDir(java.lang.String relPath) Load BdkConfig from a relative path located in the .symphony directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

BdkConfigLoader

public BdkConfigLoader()

Method Detail

loadFromFile

public static BdkConfig loadFromFile(java.lang.String configPath)
                              throws BdkConfigException

Load BdkConfig from a file path

Parameters:

configPath - Path of the config file

Returns:

Symphony Bot Configuration

Throws:

BdkConfigException

loadFromInputStream

public static BdkConfig loadFromInputStream(java.io.InputStream inputStream)
                                     throws BdkConfigException

Load BdkConfig from an InputStream

Parameters:

inputStream - InputStream

Returns:

Symphony Bot Configuration

Throws:

BdkConfigException

loadFromSymphonyDir

public static BdkConfig loadFromSymphonyDir(java.lang.String relPath)
                                     throws BdkConfigException

Load BdkConfig from a relative path located in the .symphony directory.

Note: The .symphony directory is located under your home directory (System.getProperty("user.home")). Convention adopted in order to avoid storing sensitive information (such as usernames, private keys...) within the code base.

Parameters:

relPath - Configuration file relative path from the ${user.home}/.symphony directory

Returns:

Symphony Bot Configuration

Throws:

BdkConfigException

loadFromClasspath

public static BdkConfig loadFromClasspath(java.lang.String configPath)
                                   throws BdkConfigException

Load BdkConfig from a classpath

Parameters:

configPath - Classpath to config file

Returns:

Symphony Bot Configuration

Throws:

BdkConfigException