Package com.symphony.bdk.core
Class SymphonyBdk
java.lang.Object
com.symphony.bdk.core.SymphonyBdk
BDK entry point.
-
Constructor Summary
ModifierConstructorDescriptionSymphonyBdk
(com.symphony.bdk.core.config.model.BdkConfig config) Default public constructor.protected
SymphonyBdk
(com.symphony.bdk.core.config.model.BdkConfig config, ApiClientFactory apiClientFactory, AuthenticatorFactory authenticatorFactory) -
Method Summary
Modifier and TypeMethodDescriptionReturns theActivityRegistry
in order to register Command or Form activities.Returns theExtensionAppAuthenticator
.Get theApplicationService
from a Bdk entry point.botInfo()
Returns the bot information.Returns the Bot session.static SymphonyBdkBuilder
builder()
Returns a newSymphonyBdkBuilder
for fluent initialization.com.symphony.bdk.core.config.model.BdkConfig
config()
Returns the current configuration object.Get theConnectionService
from a Bdk entry point.datafeed()
Get theDatafeedLoop
from a Bdk entry point.datahose()
Get theDisclaimerService
from a Bdk entry point.protected ExtensionAppAuthenticator
protected OboAuthenticator
health()
Get theHealthService
from a Bdk entry point.com.symphony.bdk.http.api.HttpClient.Builder
http()
Get theHttpClient.Builder
from a Bdk entry point.messages()
Get theMessageService
from a Bdk entry point.obo
(AuthSession oboSession) Get anOboServices
gathering all OBO enabled servicesOBO Authenticate by using user Id.OBO Authenticate by using username.Get thePresenceService
from a Bdk entry point.sessions()
Get theSessionService
from a Bdk entry point.signals()
Get theSignalService
from a Bdk entry point.streams()
Get theStreamService
from a Bdk entry point.users()
Get theUserService
from a Bdk entry point.
-
Constructor Details
-
SymphonyBdk
public SymphonyBdk(@Nonnull com.symphony.bdk.core.config.model.BdkConfig config) throws AuthInitializationException, AuthUnauthorizedException Default public constructor.For more advanced initialization, consider using
builder()
that provides advanced options through theSymphonyBdkBuilder
.- Parameters:
config
- Configuration properties, usually loaded fromBdkConfigLoader
.- Throws:
AuthInitializationException
- when unable to read/parse a RSA Private Key or a certificateAuthUnauthorizedException
- authentication issue (e.g. 401)
-
SymphonyBdk
protected SymphonyBdk(@Nonnull com.symphony.bdk.core.config.model.BdkConfig config, @Nullable ApiClientFactory apiClientFactory, @Nullable AuthenticatorFactory authenticatorFactory) throws AuthInitializationException, AuthUnauthorizedException
-
-
Method Details
-
builder
Returns a newSymphonyBdkBuilder
for fluent initialization.- Returns:
- new instance of
SymphonyBdkBuilder
.
-
http
public com.symphony.bdk.http.api.HttpClient.Builder http()Get theHttpClient.Builder
from a Bdk entry point. The returned HttpClient builder instance depends on whichApiClientBuilderProvider
is implemented.- Returns:
HttpClient.Builder
HttpClient builder instance.
-
messages
Get theMessageService
from a Bdk entry point. The returned message service instance.- Returns:
MessageService
message service instance.
-
datafeed
Get theDatafeedLoop
from a Bdk entry point. The returned datafeed service instance depends on the configuration of datafeed version.- Returns:
DatafeedLoop
datafeed service instance.
-
datahose
-
users
Get theUserService
from a Bdk entry point.- Returns:
UserService
user service instance.
-
streams
Get theStreamService
from a Bdk entry point.- Returns:
StreamService
user service instance.
-
disclaimers
Get theDisclaimerService
from a Bdk entry point.- Returns:
DisclaimerService
disclaimer service instance.
-
presences
Get thePresenceService
from a Bdk entry point.- Returns:
PresenceService
presence service instance.
-
connections
Get theConnectionService
from a Bdk entry point.- Returns:
ConnectionService
connection service instance.
-
signals
Get theSignalService
from a Bdk entry point.- Returns:
SignalService
signal service instance.
-
applications
Get theApplicationService
from a Bdk entry point.- Returns:
ApplicationService
application service instance.
-
health
Get theHealthService
from a Bdk entry point.- Returns:
HealthService
health service instance.
-
sessions
Get theSessionService
from a Bdk entry point.- Returns:
SessionService
session service instance.
-
activities
Returns theActivityRegistry
in order to register Command or Form activities.- Returns:
- the single
ActivityRegistry
-
obo
OBO Authenticate by using user Id.- Parameters:
id
- User id- Returns:
- Obo authentication session
- Throws:
AuthUnauthorizedException
-
obo
OBO Authenticate by using username.- Parameters:
username
- Username- Returns:
- Obo authentication session
- Throws:
AuthUnauthorizedException
-
obo
Get anOboServices
gathering all OBO enabled services- Parameters:
oboSession
- the OBO session to use- Returns:
- an
OboServices
instance using the provided OBO session
-
appAuthenticator
Returns theExtensionAppAuthenticator
.- Returns:
- the
ExtensionAppAuthenticator
-
botSession
Returns the Bot session.- Returns:
- the bot
AuthSession
-
botInfo
Returns the bot information.- Returns:
- bot information.
-
config
public com.symphony.bdk.core.config.model.BdkConfig config()Returns the current configuration object.- Returns:
- current configuration.
-
extensions
-
getExtensionAppAuthenticator
-
getOboAuthenticator
-