com.salesforce.androidsdk.analytics.store

Class EventStoreManager

java.lang.Object

com.salesforce.androidsdk.analytics.store.EventStoreManager

public class EventStoreManager
extends java.lang.Object

Provides APIs to store events in an encrypted store on the filesystem. Each event is stored in a separate file on the filesystem.

Author:

bhariharan

Constructor Summary

Constructors

Constructor and Description
EventStoreManager(java.lang.String filenameSuffix, Context context, java.lang.String encryptionKey) Parameterized constructor.

Method Summary

Modifier and Type	Method and Description
void	deleteAllEvents() Deletes all the events stored on the filesystem for that unique identifier.
boolean	deleteEvent(java.lang.String eventId) Deletes a specific event stored on the filesystem.
void	deleteEvents(java.util.Collection<java.lang.String> eventIds) Deletes the events stored on the filesystem for that unique identifier.
void	enableLogging(boolean enabled) Disables or enables logging of events.
java.util.List<InstrumentationEvent>	fetchAllEvents() Returns all the events stored on the filesystem.
InstrumentationEvent	fetchEvent(java.lang.String eventId) Returns a specific event stored on the filesystem for that unique identifier.
int	getMaxEvents() Returns the maximum number of events that can be stored.
int	getNumStoredEvents() Returns number of stored events.
boolean	isLoggingEnabled() Returns whether logging is enabled or disabled.
java.lang.Iterable<InstrumentationEvent>	iterateAllEvents() Streams all the events stored on the filesystem.
void	setMaxEvents(int maxEvents) Sets the maximum number of events that can be stored.
void	storeEvent(InstrumentationEvent event) Stores an event to the filesystem.
void	storeEvents(java.util.List<InstrumentationEvent> events) Stores a list of events to the filesystem.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventStoreManager

public EventStoreManager(java.lang.String filenameSuffix,
                         Context context,
                         java.lang.String encryptionKey)

Parameterized constructor.

Parameters:

filenameSuffix - Filename suffix to uniquely identify this batch of events. Typically this would be used to batch events for a user or an org.

context - Context.

encryptionKey - Encryption key (must be Base 64 encoded).

Method Detail

storeEvent

public void storeEvent(InstrumentationEvent event)

Stores an event to the filesystem. A combination of event's unique ID and filename suffix is used to generate a unique filename per event.

Parameters:

event - Event to be persisted.

storeEvents

public void storeEvents(java.util.List<InstrumentationEvent> events)

Stores a list of events to the filesystem.

Parameters:

events - List of events.

fetchEvent

public InstrumentationEvent fetchEvent(java.lang.String eventId)

Returns a specific event stored on the filesystem for that unique identifier.

Parameters:

eventId - Unique identifier for the event.

Returns:

Event.

fetchAllEvents

public java.util.List<InstrumentationEvent> fetchAllEvents()

Returns all the events stored on the filesystem.

Returns:

List of events.

iterateAllEvents

public java.lang.Iterable<InstrumentationEvent> iterateAllEvents()

Streams all the events stored on the filesystem. Will load each event into memory one at a time to decrease memory impact.

Returns:

Iterable of events.

deleteEvent

public boolean deleteEvent(java.lang.String eventId)

Deletes a specific event stored on the filesystem.

Parameters:

eventId - Unique identifier for the event.

Returns:

True - if successful, False - otherwise.

deleteEvents

public void deleteEvents(java.util.Collection<java.lang.String> eventIds)

Deletes the events stored on the filesystem for that unique identifier.

deleteAllEvents

public void deleteAllEvents()

Deletes all the events stored on the filesystem for that unique identifier.

enableLogging

public void enableLogging(boolean enabled)

Disables or enables logging of events. If logging is disabled, no events will be stored. However, publishing of events is still possible.

Parameters:

enabled - True - if logging should be enabled, False - otherwise.

isLoggingEnabled

public boolean isLoggingEnabled()

Returns whether logging is enabled or disabled.

Returns:

True - if logging is enabled, False - otherwise.

setMaxEvents

public void setMaxEvents(int maxEvents)

Sets the maximum number of events that can be stored.

Parameters:

maxEvents - Maximum number of events.

getMaxEvents

public int getMaxEvents()

Returns the maximum number of events that can be stored.

Returns:

Maximum number of events.

getNumStoredEvents

public int getNumStoredEvents()

Returns number of stored events. Counts the keys in the book (and store the count in countEvents) if countEvents if null. Returns countEvents directly if known (i.e. not null)

Returns:

Number of stored events.