com.symphony.bdk.core

Class SymphonyBdkBuilder

java.lang.Object

com.symphony.bdk.core.SymphonyBdkBuilder

@API(status=EXPERIMENTAL)
public class SymphonyBdkBuilder
extends java.lang.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 and Description
SymphonyBdkBuilder()

Method Summary

Modifier and Type	Method and 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(BdkConfig config) With BdkConfig.

Methods inherited from class java.lang.Object

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

Constructor Detail

SymphonyBdkBuilder

public SymphonyBdkBuilder()

Method Detail

config

public SymphonyBdkBuilder config(@Nonnull
                                 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.

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)