com.box.sdk

Class EventLog

Object

EventLog

All Implemented Interfaces:

Iterable<BoxEvent>

public class EventLog
extends Object
implements Iterable<BoxEvent>

A log of events that were retrieved from the events endpoint.

An EventLog cannot be instantiated directly. Instead, use one of the static methods to retrieve a log of events. Unlike the EventStream class, EventLog doesn't support retrieving events in real-time.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	ENTERPRISE_EVENT_URL_TEMPLATE Enterprise Event URL Template.

Method Summary

Modifier and Type	Method and Description
int	getChunkSize() Gets the number of events in this log, including duplicate events.
Date	getEndDate() Gets the date of the latest event in this log.
static EventLog	getEnterpriseEvents(BoxAPIConnection api, Date after, Date before, BoxEvent.Type... types) Deprecated. Use getEnterpriseEvents(BoxAPIConnection, EnterpriseEventsRequest)
static EventLog	getEnterpriseEvents(BoxAPIConnection api, EnterpriseEventsRequest enterpriseEventsRequest) Method reads from the `admin-logs` stream and returns BoxEvent Iterator.
static EventLog	getEnterpriseEvents(BoxAPIConnection api, String position, Date after, Date before, BoxEvent.Type... types) Deprecated. Use getEnterpriseEvents(BoxAPIConnection, EnterpriseEventsRequest)
static EventLog	getEnterpriseEvents(BoxAPIConnection api, String position, Date after, Date before, int limit, BoxEvent.Type... types) Deprecated. Use getEnterpriseEvents(BoxAPIConnection, EnterpriseEventsRequest)
static EventLog	getEnterpriseEventsStream(BoxAPIConnection api, EnterpriseEventsStreamRequest enterpriseEventsStreamRequest) Method reads from the `admin-logs-streaming` stream and returns BoxEvent Iterator The emphasis for this feed is on low latency rather than chronological accuracy, which means that Box may return events more than once and out of chronological order.
int	getLimit() Gets the maximum number of events that this event log could contain given its start date, end date, and stream position.
String	getNextStreamPosition() Gets the next position within the event stream for retrieving subsequent events.
int	getSize() Gets the number of events in this list, excluding duplicate events.
Date	getStartDate() Gets the date of the earliest event in this log.
String	getStreamPosition() Gets the starting position of the events in this log within the event stream.
Iterator<BoxEvent>	iterator() Returns an iterator over the events in this log.

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Field Detail

ENTERPRISE_EVENT_URL_TEMPLATE

public static final URLTemplate ENTERPRISE_EVENT_URL_TEMPLATE

Enterprise Event URL Template.

Method Detail

getEnterpriseEvents

@Deprecated
public static EventLog getEnterpriseEvents(BoxAPIConnection api,
                                                       String position,
                                                       Date after,
                                                       Date before,
                                                       BoxEvent.Type... types)

Deprecated. Use getEnterpriseEvents(BoxAPIConnection, EnterpriseEventsRequest)

Gets all the enterprise events that occurred within a specified date range, starting from a given position within the event stream.

Parameters:

api - the API connection to use.

position - the starting position of the event stream.

after - the lower bound on the timestamp of the events returned.

before - the upper bound on the timestamp of the events returned.

types - an optional list of event types to filter by.

Returns:

a log of all the events that met the given criteria.

getEnterpriseEvents

@Deprecated
public static EventLog getEnterpriseEvents(BoxAPIConnection api,
                                                       Date after,
                                                       Date before,
                                                       BoxEvent.Type... types)

Deprecated. Use getEnterpriseEvents(BoxAPIConnection, EnterpriseEventsRequest)

Gets all the enterprise events that occurred within a specified date range.

Parameters:

api - the API connection to use.

after - the lower bound on the timestamp of the events returned.

before - the upper bound on the timestamp of the events returned.

types - an optional list of event types to filter by.

Returns:

a log of all the events that met the given criteria.

getEnterpriseEvents

@Deprecated
public static EventLog getEnterpriseEvents(BoxAPIConnection api,
                                                       String position,
                                                       Date after,
                                                       Date before,
                                                       int limit,
                                                       BoxEvent.Type... types)

Deprecated. Use getEnterpriseEvents(BoxAPIConnection, EnterpriseEventsRequest)

Gets all the enterprise events that occurred within a specified date range, starting from a given position within the event stream.

Parameters:

api - the API connection to use.

position - the starting position of the event stream.

after - the lower bound on the timestamp of the events returned.

before - the upper bound on the timestamp of the events returned.

limit - the number of entries to be returned in the response.

types - an optional list of event types to filter by.

Returns:

a log of all the events that met the given criteria.

getEnterpriseEvents

public static EventLog getEnterpriseEvents(BoxAPIConnection api,
                                           EnterpriseEventsRequest enterpriseEventsRequest)

Method reads from the `admin-logs` stream and returns BoxEvent Iterator. The emphasis for this stream is on completeness over latency, which means that Box will deliver admin events in chronological order and without duplicates, but with higher latency. You can specify start and end time/dates. This method will only work with an API connection for an enterprise admin account or service account with manage enterprise properties. You can specify a date range to limit when events occured, starting from a given position within the event stream, set limit or specify event types that should be filtered. Example:

 
 EnterpriseEventsRequest request = new EnterpriseEventsRequest()
     .after(after)        // The lower bound on the timestamp of the events returned.
     .before(before)      // The upper bound on the timestamp of the events returned.
     .limit(20)           // The number of entries to be returned in the response.
     .position(position)  // The starting position of the event stream.
     .types(EventType.LOGIN, EventType.FAILED_LOGIN); // List of event types to filter by.
 EventLog.getEnterpriseEvents(api, request);
 
 

Parameters:

api - the API connection to use.

enterpriseEventsRequest - request to get events.

Returns:

a log of all the events that met the given criteria.

getEnterpriseEventsStream

public static EventLog getEnterpriseEventsStream(BoxAPIConnection api,
                                                 EnterpriseEventsStreamRequest enterpriseEventsStreamRequest)

Method reads from the `admin-logs-streaming` stream and returns BoxEvent Iterator The emphasis for this feed is on low latency rather than chronological accuracy, which means that Box may return events more than once and out of chronological order. Events are returned via the API around 12 seconds after they are processed by Box (the 12 seconds buffer ensures that new events are not written after your cursor position). Only two weeks of events are available via this feed, and you cannot set start and end time/dates. This method will only work with an API connection for an enterprise admin account or service account with manage enterprise properties. You can specify a starting from a given position within the event stream, set limit or specify event types that should be filtered. Example:

 
 EnterpriseEventsStreamRequest request = new EnterpriseEventsStreamRequest()
     .limit(200)          // The number of entries to be returned in the response.
     .position(position)  // The starting position of the event stream.
     .types(EventType.LOGIN, EventType.FAILED_LOGIN); // List of event types to filter by.
 EventLog.getEnterpriseEventsStream(api, request);
 
 

Parameters:

api - the API connection to use.

enterpriseEventsStreamRequest - request to get events.

Returns:

a log of all the events that met the given criteria.

iterator

public Iterator<BoxEvent> iterator()

Returns an iterator over the events in this log.

Specified by:

iterator in interface Iterable<BoxEvent>

Returns:

an iterator over the events in this log.

getStartDate

public Date getStartDate()

Gets the date of the earliest event in this log.

The value returned by this method corresponds to the created_after URL parameter that was used when retrieving the events in this EventLog.

Returns:

the date of the earliest event in this log.

getEndDate

public Date getEndDate()

Gets the date of the latest event in this log.

The value returned by this method corresponds to the created_before URL parameter that was used when retrieving the events in this EventLog.

Returns:

the date of the latest event in this log.

getLimit

public int getLimit()

Gets the maximum number of events that this event log could contain given its start date, end date, and stream position.

The value returned by this method corresponds to the limit URL parameter that was used when retrieving the events in this EventLog.

Returns:

the maximum number of events.

getStreamPosition

public String getStreamPosition()

Gets the starting position of the events in this log within the event stream.

The value returned by this method corresponds to the stream_position URL parameter that was used when retrieving the events in this EventLog.

Returns:

the starting position within the event stream.

getNextStreamPosition

public String getNextStreamPosition()

Gets the next position within the event stream for retrieving subsequent events.

The value returned by this method corresponds to the next_stream_position field returned by the API's events endpoint.

Returns:

the next position within the event stream.

getChunkSize

public int getChunkSize()

Gets the number of events in this log, including duplicate events.

The chunk size may not be representative of the number of events returned by this EventLog's iterator because the iterator will automatically ignore duplicate events.

The value returned by this method corresponds to the chunk_size field returned by the API's events endpoint.

Returns:

the number of events, including duplicates.

getSize

public int getSize()

Gets the number of events in this list, excluding duplicate events.

The size is guaranteed to be representative of the number of events returned by this EventLog's iterator.

Returns:

the number of events, excluding duplicates.