com.symphony.bdk.core.service.datafeed.impl

Class DatafeedLoopV1

java.lang.Object

com.symphony.bdk.core.service.datafeed.impl.DatafeedLoopV1

All Implemented Interfaces:

DatafeedLoop

@API(status=INTERNAL)
public class DatafeedLoopV1
extends java.lang.Object

A class for implementing the datafeed v1 loop service.

This service will be started by calling start()

At the beginning, a datafeed will be created and the BDK bot will listen to this datafeed to receive the real-time events. With datafeed service v1, we don't have the api endpoint to retrieve the datafeed id that a service account is listening, so, the id of the created datafeed must be persisted in the bot side.

The BDK bot will listen to this datafeed to get all the received real-time events.

From the second time, the bot will firstly retrieve the datafeed that was persisted and try to read the real-time events from this datafeed. If this datafeed is expired or faulty, the datafeed service will create the new one for listening.

This service will be stopped by calling stop()

If the datafeed service is stopped during a read datafeed call, it has to wait until the last read finish to be really stopped

Field Summary

Fields

Modifier and Type	Field and Description
protected com.symphony.bdk.http.api.ApiClient	apiClient
protected AuthSession	authSession
protected BdkConfig	bdkConfig
protected UserV2	botInfo
protected DatafeedApi	datafeedApi
protected RetryWithRecoveryBuilder	retryWithRecoveryBuilder

Constructor Summary

Constructors

Constructor and Description
DatafeedLoopV1(DatafeedApi datafeedApi, AuthSession authSession, BdkConfig config, UserV2 botInfo)
DatafeedLoopV1(DatafeedApi datafeedApi, AuthSession authSession, BdkConfig config, UserV2 botInfo, DatafeedIdRepository repository)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	createDatafeed()
protected void	handleV4EventList(java.util.List<V4Event> events) Handle a received listener by using the subscribed RealTimeEventListener.
protected void	refresh()
protected java.util.Optional<java.lang.String>	retrieveDatafeed()
void	start() Start the datafeed events service
void	stop() Stop the datafeed events service.
void	subscribe(RealTimeEventListener listener) The bot subscribes to a RealTimeEventListener
void	unsubscribe(RealTimeEventListener listener) The bot unsubscribes to a RealTimeEventListener

Methods inherited from class java.lang.Object

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

Field Detail

authSession

protected final AuthSession authSession

bdkConfig

protected final BdkConfig bdkConfig

botInfo

protected final UserV2 botInfo

retryWithRecoveryBuilder

protected final RetryWithRecoveryBuilder retryWithRecoveryBuilder

datafeedApi

protected DatafeedApi datafeedApi

apiClient

protected com.symphony.bdk.http.api.ApiClient apiClient

Constructor Detail

DatafeedLoopV1

public DatafeedLoopV1(DatafeedApi datafeedApi,
                      AuthSession authSession,
                      BdkConfig config,
                      UserV2 botInfo)

DatafeedLoopV1

public DatafeedLoopV1(DatafeedApi datafeedApi,
                      AuthSession authSession,
                      BdkConfig config,
                      UserV2 botInfo,
                      DatafeedIdRepository repository)

Method Detail

start

public void start()
           throws AuthUnauthorizedException,
                  com.symphony.bdk.http.api.ApiException

Start the datafeed events service

Throws:

AuthUnauthorizedException

com.symphony.bdk.http.api.ApiException

stop

public void stop()

Stop the datafeed events service. The datafeed service will be stopped after a small delay to finish the last read datafeed call.

createDatafeed

protected java.lang.String createDatafeed()
                                   throws java.lang.Throwable

Throws:

java.lang.Throwable

retrieveDatafeed

protected java.util.Optional<java.lang.String> retrieveDatafeed()

subscribe

public void subscribe(RealTimeEventListener listener)

The bot subscribes to a RealTimeEventListener

Specified by:

subscribe in interface DatafeedLoop

Parameters:

listener - a Datafeed event listener to be subscribed

unsubscribe

public void unsubscribe(RealTimeEventListener listener)

The bot unsubscribes to a RealTimeEventListener

Specified by:

unsubscribe in interface DatafeedLoop

Parameters:

listener - a Datafeed event listener to be unsubscribed

handleV4EventList

protected void handleV4EventList(java.util.List<V4Event> events)
                          throws RequeueEventException

Handle a received listener by using the subscribed RealTimeEventListener.

Parameters:

events - List of Datafeed events to be handled

Throws:

RequeueEventException - Raised if a listener fails and the developer wants to explicitly not update the ack id.

refresh

protected void refresh()
                throws AuthUnauthorizedException

Throws:

AuthUnauthorizedException