com.symphony.bdk.core

Class SymphonyBdk

java.lang.Object

com.symphony.bdk.core.SymphonyBdk

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

BDK entry point.

Constructor Summary

Constructors

Modifier	Constructor and Description
	SymphonyBdk(BdkConfig config) Default public constructor.
protected	SymphonyBdk(BdkConfig config, ApiClientFactory apiClientFactory, AuthenticatorFactory authenticatorFactory)

Method Summary

Modifier and Type	Method and Description
ActivityRegistry	activities() Returns the ActivityRegistry in order to register Command or Form activities.
ExtensionAppAuthenticator	appAuthenticator() Returns the ExtensionAppAuthenticator.
ApplicationService	applications() Get the ApplicationService from a Bdk entry point.
UserV2	botInfo() Returns the bot information.
AuthSession	botSession() Returns the Bot session.
static SymphonyBdkBuilder	builder() Returns a new SymphonyBdkBuilder for fluent initialization.
BdkConfig	config() Returns the current configuration object.
ConnectionService	connections() Get the ConnectionService from a Bdk entry point.
DatafeedLoop	datafeed() Get the DatafeedLoop from a Bdk entry point.
DisclaimerService	disclaimers() Get the DisclaimerService from a Bdk entry point.
protected ExtensionAppAuthenticator	getExtensionAppAuthenticator()
protected OboAuthenticator	getOboAuthenticator()
HealthService	health() Get the HealthService from a Bdk entry point.
com.symphony.bdk.http.api.HttpClient.Builder	http() Get the HttpClient.Builder from a Bdk entry point.
MessageService	messages() Get the MessageService from a Bdk entry point.
OboServices	obo(AuthSession oboSession) Get an OboServices gathering all OBO enabled services
AuthSession	obo(java.lang.Long id) OBO Authenticate by using user Id.
AuthSession	obo(java.lang.String username) OBO Authenticate by using username.
PresenceService	presences() Get the PresenceService from a Bdk entry point.
SessionService	sessions() Get the SessionService from a Bdk entry point.
SignalService	signals() Get the SignalService from a Bdk entry point.
StreamService	streams() Get the StreamService from a Bdk entry point.
UserService	users() Get the UserService from a Bdk entry point.

Methods inherited from class java.lang.Object

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

Constructor Detail

SymphonyBdk

public SymphonyBdk(@Nonnull
                   BdkConfig config)
            throws AuthInitializationException,
                   AuthUnauthorizedException

Default public constructor.

For more advanced initialization, consider using builder() that provides advanced options through the SymphonyBdkBuilder.

Parameters:

config - Configuration properties, usually loaded from BdkConfigLoader.

Throws:

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

AuthUnauthorizedException - authentication issue (e.g. 401)

SymphonyBdk

protected SymphonyBdk(@Nonnull
                      BdkConfig config,
                      @Nullable
                      ApiClientFactory apiClientFactory,
                      @Nullable
                      AuthenticatorFactory authenticatorFactory)
               throws AuthInitializationException,
                      AuthUnauthorizedException

Throws:

AuthInitializationException

AuthUnauthorizedException

Method Detail

builder

@API(status=EXPERIMENTAL)
public static SymphonyBdkBuilder builder()

Returns a new SymphonyBdkBuilder for fluent initialization.

Returns:

new instance of SymphonyBdkBuilder.

http

public com.symphony.bdk.http.api.HttpClient.Builder http()

Get the HttpClient.Builder from a Bdk entry point. The returned HttpClient builder instance depends on which ApiClientBuilderProvider is implemented.

Returns:

HttpClient.Builder HttpClient builder instance.

messages

public MessageService messages()

Get the MessageService from a Bdk entry point. The returned message service instance.

Returns:

MessageService message service instance.

datafeed

public DatafeedLoop datafeed()

Get the DatafeedLoop from a Bdk entry point. The returned datafeed service instance depends on the configuration of datafeed version.

Returns:

DatafeedLoop datafeed service instance.

users

public UserService users()

Get the UserService from a Bdk entry point.

Returns:

UserService user service instance.

streams

public StreamService streams()

Get the StreamService from a Bdk entry point.

Returns:

StreamService user service instance.

disclaimers

public DisclaimerService disclaimers()

Get the DisclaimerService from a Bdk entry point.

Returns:

DisclaimerService disclaimer service instance.

presences

public PresenceService presences()

Get the PresenceService from a Bdk entry point.

Returns:

PresenceService presence service instance.

connections

public ConnectionService connections()

Get the ConnectionService from a Bdk entry point.

Returns:

ConnectionService connection service instance.

signals

public SignalService signals()

Get the SignalService from a Bdk entry point.

Returns:

SignalService signal service instance.

applications

public ApplicationService applications()

Get the ApplicationService from a Bdk entry point.

Returns:

ApplicationService application service instance.

health

public HealthService health()

Get the HealthService from a Bdk entry point.

Returns:

HealthService health service instance.

sessions

public SessionService sessions()

Get the SessionService from a Bdk entry point.

Returns:

SessionService session service instance.

activities

public ActivityRegistry activities()

Returns the ActivityRegistry in order to register Command or Form activities.

Returns:

the single ActivityRegistry

obo

public AuthSession obo(java.lang.Long id)
                throws AuthUnauthorizedException

OBO Authenticate by using user Id.

Parameters:

id - User id

Returns:

Obo authentication session

Throws:

AuthUnauthorizedException

obo

public AuthSession obo(java.lang.String username)
                throws AuthUnauthorizedException

OBO Authenticate by using username.

Parameters:

username - Username

Returns:

Obo authentication session

Throws:

AuthUnauthorizedException

obo

public OboServices obo(AuthSession oboSession)

Get an OboServices gathering all OBO enabled services

Parameters:

oboSession - the OBO session to use

Returns:

an OboServices instance using the provided OBO session

appAuthenticator

public ExtensionAppAuthenticator appAuthenticator()

Returns the ExtensionAppAuthenticator.

Returns:

the ExtensionAppAuthenticator

botSession

@API(status=EXPERIMENTAL)
public AuthSession botSession()

Returns the Bot session.

Returns:

the bot AuthSession

botInfo

@API(status=EXPERIMENTAL)
public UserV2 botInfo()

Returns the bot information.

Returns:

bot information.

config

public BdkConfig config()

Returns the current configuration object.

Returns:

current configuration.

getExtensionAppAuthenticator

protected ExtensionAppAuthenticator getExtensionAppAuthenticator()

getOboAuthenticator

protected OboAuthenticator getOboAuthenticator()