org.symphonyoss.symphony.clients.impl

Class DataFeedClientImpl

java.lang.Object

org.symphonyoss.symphony.clients.impl.DataFeedClientImpl

All Implemented Interfaces:

DataFeedClient

public class DataFeedClientImpl
extends java.lang.Object
implements DataFeedClient

Provides access to datafeed in order to stream all message events (messages) through blocking calls.

Constructor Summary

Constructors

Constructor and Description
DataFeedClientImpl(SymAuth symAuth, SymphonyClientConfig config) Init
DataFeedClientImpl(SymAuth symAuth, SymphonyClientConfig config, javax.ws.rs.client.Client httpClient) If you need to override HttpClient.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataFeedClientImpl

public DataFeedClientImpl(SymAuth symAuth,
                          SymphonyClientConfig config)

Init

Parameters:

symAuth - Authorization model containing session and key tokens

config - Config containing the Agent URL used to access API

DataFeedClientImpl

public DataFeedClientImpl(SymAuth symAuth,
                          SymphonyClientConfig config,
                          javax.ws.rs.client.Client httpClient)

If you need to override HttpClient. Important for handling individual client certs.

Parameters:

symAuth - Authorization model containing session and key tokens

config - Config containing the Agent URL used to access API

httpClient - Custom HTTP client

Method Detail

createDatafeed

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

Description copied from interface: DataFeedClient

Create a datafeed to consume messages/events from

Specified by:

createDatafeed in interface DataFeedClient

Parameters:

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

Returns:

Datafeed object to process messages from

Throws:

DataFeedException - Caused by Symphony API calls

getEventsFromDatafeed

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

Description copied from interface: DataFeedClient

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.

Specified by:

getEventsFromDatafeed in interface DataFeedClient

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

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

Description copied from interface: DataFeedClient

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.

Specified by:

getEventsFromDatafeed in interface DataFeedClient

Parameters:

datafeed - Datafeed object associated with BOT user

Returns:

List of base messages

Throws:

DataFeedException - Caused by Symphony API calls