com.box.sdk

Class EventStream

Object

EventStream

public class EventStream
extends Object

Receives real-time events from the API and forwards them to EventListeners.

This class handles long polling the Box events endpoint in order to receive real-time user events. When an EventStream is started, it begins long polling on a separate thread until the stop() method is called. Since the API may return duplicate events, EventStream also maintains a small cache of the most recently received event IDs in order to automatically deduplicate events.

Note: Enterprise Events can be accessed by admin users with the EventLog.getEnterpriseEvents method

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	EVENT_URL Events URL.

Constructor Summary

Constructors

Constructor and Description
EventStream(BoxAPIConnection api) Constructs an EventStream using an API connection.
EventStream(BoxAPIConnection api, long startingPosition) Constructs an EventStream using an API connection and a starting initial position.
EventStream(BoxAPIConnection api, long startingPosition, int pollingDelay) Constructs an EventStream using an API connection and a starting initial position with custom polling delay.

Method Summary

Modifier and Type	Method and Description
void	addListener(EventListener listener) Adds a listener that will be notified when an event is received.
protected boolean	isDuplicate(String eventID) Indicates whether or not an event ID is a duplicate.
boolean	isStarted() Indicates whether or not this EventStream has been started.
void	start() Starts this EventStream and begins long polling the API.
void	stop() Stops this EventStream and disconnects from the API.

Methods inherited from class Object

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

Field Detail

EVENT_URL

public static final URLTemplate EVENT_URL

Events URL.

Constructor Detail

EventStream

public EventStream(BoxAPIConnection api)

Constructs an EventStream using an API connection.

Parameters:

api - the API connection to use.

EventStream

public EventStream(BoxAPIConnection api,
                   long startingPosition)

Constructs an EventStream using an API connection and a starting initial position.

Parameters:

api - the API connection to use.

startingPosition - the starting position of the event stream.

EventStream

public EventStream(BoxAPIConnection api,
                   long startingPosition,
                   int pollingDelay)

Constructs an EventStream using an API connection and a starting initial position with custom polling delay.

Parameters:

api - the API connection to use.

startingPosition - the starting position of the event stream.

pollingDelay - the delay in milliseconds between successive calls to get more events.

Method Detail

addListener

public void addListener(EventListener listener)

Adds a listener that will be notified when an event is received.

Parameters:

listener - the listener to add.

isStarted

public boolean isStarted()

Indicates whether or not this EventStream has been started.

Returns:

true if this EventStream has been started; otherwise false.

stop

public void stop()

Stops this EventStream and disconnects from the API.

Throws:

IllegalStateException - if the EventStream is already stopped.

start

public void start()

Starts this EventStream and begins long polling the API.

Throws:

IllegalStateException - if the EventStream is already started.

isDuplicate

protected boolean isDuplicate(String eventID)

Indicates whether or not an event ID is a duplicate.

This method can be overridden by a subclass in order to provide custom de-duping logic.

Parameters:

eventID - the event ID.

Returns:

true if the event is a duplicate; otherwise false.