org.symphonyoss.symphony.clients

Interface DataFeedClient

All Known Implementing Classes:

DataFeedClientImpl

public interface DataFeedClient

Provides access to datafeed in order to stream all message events (messages) through blocking calls. Created by Frank Tarsillo on 5/15/2016.

Method Summary

Modifier and Type	Method and Description
org.symphonyoss.symphony.agent.model.Datafeed	createDatafeed(ApiVersion apiVersion) Create a datafeed to consume messages/events from
java.util.List<SymEvent>	getEventsFromDatafeed(org.symphonyoss.symphony.agent.model.Datafeed datafeed) This will return events from datafeed object through underlying blocking calls.
java.util.List<SymEvent>	getEventsFromDatafeed(org.symphonyoss.symphony.agent.model.Datafeed datafeed, int maxMessages) This will return events from datafeed object through underlying blocking calls.

Method Detail

createDatafeed

org.symphonyoss.symphony.agent.model.Datafeed createDatafeed(ApiVersion apiVersion)
                                                      throws DataFeedException

Create a datafeed to consume messages/events from

Parameters:

apiVersion - ApiVersion to use (V2, V4..)

Returns:

Datafeed object to process messages from

Throws:

DataFeedException - Caused by Symphony API calls

getEventsFromDatafeed

java.util.List<SymEvent> getEventsFromDatafeed(org.symphonyoss.symphony.agent.model.Datafeed datafeed,
                                               int maxMessages)
                                        throws DataFeedException

This will return events from datafeed object through underlying blocking calls. This method should be called repeatedly to pull event based data. This is only used for V4+ enabled clients.

Parameters:

datafeed - Datafeed object associated with BOT user

maxMessages - maximum number of messages returned.

Returns:

List of base messages

Throws:

DataFeedException - Caused by Symphony API calls

getEventsFromDatafeed

java.util.List<SymEvent> getEventsFromDatafeed(org.symphonyoss.symphony.agent.model.Datafeed datafeed)
                                        throws DataFeedException

This will return events from datafeed object through underlying blocking calls. This method should be called repeatedly to pull event based data. This is only used for V4+ enabled clients.

Parameters:

datafeed - Datafeed object associated with BOT user

Returns:

List of base messages

Throws:

DataFeedException - Caused by Symphony API calls