Package com.symphony.bdk.core

Class SymphonyBdkBuilder

java.lang.Object

com.symphony.bdk.core.SymphonyBdkBuilder

@API(status=EXPERIMENTAL)
public class SymphonyBdkBuilder
extends Object

Fluent builder for advanced configuration of the SymphonyBdk entry point.

Please note that some of the parameters (such as ApiClientBuilderProvider, ApiClientFactory or AuthenticatorFactory) have to be used with caution.

Constructor Summary

Constructors

Constructor	Description
SymphonyBdkBuilder()

Method Summary

Modifier and Type	Method	Description
SymphonyBdkBuilder	apiClientBuilderProvider(com.symphony.bdk.http.api.ApiClientBuilderProvider apiClientBuilderProvider)	With custom ApiClientBuilderProvider instance.
SymphonyBdkBuilder	apiClientFactory(ApiClientFactory apiClientFactory)	With custom ApiClientFactory instance.
SymphonyBdkBuilder	authenticatorFactory(AuthenticatorFactory authenticatorFactory)	With custom AuthenticatorFactory instance.
SymphonyBdk	build()	Build new SymphonyBdk.
SymphonyBdkBuilder	config(com.symphony.bdk.core.config.model.BdkConfig config)	With BdkConfig.
SymphonyBdkBuilder	extension(Class<? extends com.symphony.bdk.extension.BdkExtension> extension)	Registers a BdkExtension.

Methods inherited from class java.lang.Object

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

Constructor Details

SymphonyBdkBuilder

public SymphonyBdkBuilder()

Method Details

config

public SymphonyBdkBuilder config(@Nonnull
 com.symphony.bdk.core.config.model.BdkConfig config)

With BdkConfig.

The config object can be loaded in different ways (file system, classpath or InputStream) using the BdkConfigLoader.

Parameters:

config - config POJO.

Returns:

updated builder.

See Also:

• BdkConfigLoader

apiClientBuilderProvider

public SymphonyBdkBuilder apiClientBuilderProvider(@Nullable
 com.symphony.bdk.http.api.ApiClientBuilderProvider apiClientBuilderProvider)

With custom ApiClientBuilderProvider instance.

Parameters:

apiClientBuilderProvider - a custom ApiClientBuilderProvider instance.

Returns:

updated builder.

apiClientFactory

public SymphonyBdkBuilder apiClientFactory(@Nullable
 ApiClientFactory apiClientFactory)

With custom ApiClientFactory instance.

Parameters:

apiClientFactory - a custom ApiClientFactory instance.

Returns:

updated builder.

authenticatorFactory

public SymphonyBdkBuilder authenticatorFactory(@Nullable
 AuthenticatorFactory authenticatorFactory)

With custom AuthenticatorFactory instance.

Parameters:

authenticatorFactory - a custom AuthenticatorFactory instance.

Returns:

updated builder.

extension

public SymphonyBdkBuilder extension(@Nonnull
 Class<? extends com.symphony.bdk.extension.BdkExtension> extension)

Registers a BdkExtension.

Parameters:

extension - BdkExtension class to be registered.

Returns:

updated builder.

build

public SymphonyBdk build()
                  throws AuthUnauthorizedException,
AuthInitializationException

Build new SymphonyBdk.

Returns:

a new SymphonyBdk instance.

Throws:

AuthInitializationException - when unable to read/parse a RSA Private Key or a certificate

AuthUnauthorizedException - authentication issue (e.g. 401)