org.apache.nifi.provenance.store

Interface EventStore

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

ArrayListEventStore, PartitionedEventStore, PartitionedWriteAheadEventStore

public interface EventStore
extends java.io.Closeable

An Event Store is responsible for storing Provenance Events and retrieving them at a later time.

Method Summary

Modifier and Type	Method and Description
StorageResult	addEvents(java.lang.Iterable<ProvenanceEventRecord> events) Adds the given events to the store.
java.util.Optional<ProvenanceEventRecord>	getEvent(long id) Retrieves the event with the given ID
java.util.List<ProvenanceEventRecord>	getEvents(java.util.List<java.lang.Long> eventIds, EventAuthorizer authorizer, EventTransformer unauthorizedTransformer) Given a List of Event ID's, returns a List of Provenance Events that contain the events that have those corresponding Event ID's.
java.util.List<ProvenanceEventRecord>	getEvents(long firstRecordId, int maxRecords) Retrieves up to maxRecords events from the store, starting with the event whose ID is equal to firstRecordId.
java.util.List<ProvenanceEventRecord>	getEvents(long firstRecordId, int maxRecords, EventAuthorizer authorizer, EventTransformer unauthorizedTransformer) Retrieves up to maxRecords events from the store, starting with the event whose ID is equal to firstRecordId.
long	getMaxEventId()
long	getSize()
void	initialize() Performs any initialization routines that need to happen before the store is used
void	reindexLatestEvents(EventIndex eventIndex) Causes the latest events in this store to be re-indexed by the given Event Index

Methods inherited from interface java.io.Closeable

close

Method Detail

initialize

void initialize()
         throws java.io.IOException

Performs any initialization routines that need to happen before the store is used

Throws:

java.io.IOException - if unable to perform initialization

addEvents

StorageResult addEvents(java.lang.Iterable<ProvenanceEventRecord> events)
                 throws java.io.IOException

Adds the given events to the store. All events will be written to the same Storage Location. I.e., all of the StorageSummary objects that are provided when calling the StorageResult.getStorageLocations() method will return the same value for the StorageSummary.getStorageLocation(). Each one, however, will have a different Event ID and potentially a different Block Index.

Parameters:

events - the events to add

Returns:

a mapping of event to the location where it was stored

Throws:

java.io.IOException - if unable to add the events

getSize

long getSize()
      throws java.io.IOException

Returns:

the number of bytes occupied by the events in the store

Throws:

java.io.IOException - if unable to determine the size of the store

getMaxEventId

long getMaxEventId()

Returns:

the largest Event ID that has been written to this store, or -1 if no events have yet been stored.

getEvent

java.util.Optional<ProvenanceEventRecord> getEvent(long id)
                                            throws java.io.IOException

Retrieves the event with the given ID

Parameters:

id - the ID of the event to retrieve

Returns:

an Optional containing the Event with the given ID, or an empty optional if the event cannot be found

Throws:

java.io.IOException - if unable to read the event from storage

getEvents

java.util.List<ProvenanceEventRecord> getEvents(long firstRecordId,
                                                int maxRecords)
                                         throws java.io.IOException

Retrieves up to maxRecords events from the store, starting with the event whose ID is equal to firstRecordId. If that event cannot be found, then the first event will be the oldest event in the store whose ID is greater than firstRecordId. All events will be returned in the order that they were written to the store. I.e., all events will have monotonically increasing Event ID's. No events will be filtered out, since there is no EventAuthorizer provided.

Parameters:

firstRecordId - the ID of the first event to retrieve

maxRecords - the maximum number of records to retrieve. The actual number of results returned may be less than this.

Returns:

a List of ProvenanceEventRecord's

Throws:

java.io.IOException - if unable to retrieve records from the store

getEvents

java.util.List<ProvenanceEventRecord> getEvents(long firstRecordId,
                                                int maxRecords,
                                                EventAuthorizer authorizer,
                                                EventTransformer unauthorizedTransformer)
                                         throws java.io.IOException

Retrieves up to maxRecords events from the store, starting with the event whose ID is equal to firstRecordId. If that event cannot be found, then the first event will be the oldest event in the store whose ID is greater than firstRecordId. All events will be returned in the order that they were written to the store. I.e., all events will have monotonically increasing Event ID's.

Parameters:

firstRecordId - the ID of the first event to retrieve

maxRecords - the maximum number of records to retrieve. The actual number of results returned may be less than this.

authorizer - the authorizer that should be used to filter out any events that the user doesn't have access to

unauthorizedTransformer - the transformer to apply to unauthorized events

Returns:

a List of ProvenanceEventRecord's

Throws:

java.io.IOException - if unable to retrieve records from the store

getEvents

java.util.List<ProvenanceEventRecord> getEvents(java.util.List<java.lang.Long> eventIds,
                                                EventAuthorizer authorizer,
                                                EventTransformer unauthorizedTransformer)
                                         throws java.io.IOException

Given a List of Event ID's, returns a List of Provenance Events that contain the events that have those corresponding Event ID's. If any events cannot be found, a warning will be logged but no Exception will be thrown.

Parameters:

eventIds - a Stream of Event ID's

authorizer - the authorizer that should be used to filter out any events that the user doesn't have access to

unauthorizedTransformer - the transformer to apply to unauthorized events

Returns:

a List of events that correspond to the given ID's

Throws:

java.io.IOException - if unable to retrieve records from the store

reindexLatestEvents

void reindexLatestEvents(EventIndex eventIndex)

Causes the latest events in this store to be re-indexed by the given Event Index

Parameters:

eventIndex - the EventIndex to use for indexing events