org.apache.nifi.provenance.store

Class PartitionedEventStore

java.lang.Object

org.apache.nifi.provenance.store.PartitionedEventStore

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, EventStore

Direct Known Subclasses:

PartitionedWriteAheadEventStore

public abstract class PartitionedEventStore
extends java.lang.Object
implements EventStore

Constructor Summary

Constructors

Constructor and Description
PartitionedEventStore(RepositoryConfiguration config, EventReporter eventReporter)

Method Summary

Modifier and Type	Method and Description
StorageResult	addEvents(java.lang.Iterable<ProvenanceEventRecord> events) Adds the given events to the store.
void	close()
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 transformer) 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 transformer) Retrieves up to maxRecords events from the store, starting with the event whose ID is equal to firstRecordId.
long	getMaxEventId()
protected abstract java.util.List<? extends EventStorePartition>	getPartitions()
long	getSize()
void	initialize() Performs any initialization routines that need to happen before the store is used

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.provenance.store.EventStore

reindexLatestEvents

Constructor Detail

PartitionedEventStore

public PartitionedEventStore(RepositoryConfiguration config,
                             EventReporter eventReporter)

Method Detail

initialize

public void initialize()
                throws java.io.IOException

Description copied from interface: EventStore

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

Specified by:

initialize in interface EventStore

Throws:

java.io.IOException - if unable to perform initialization

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

addEvents

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

Description copied from interface: EventStore

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.

Specified by:

addEvents in interface EventStore

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

public long getSize()

Specified by:

getSize in interface EventStore

Returns:

the number of bytes occupied by the events in the store

getMaxEventId

public long getMaxEventId()

Specified by:

getMaxEventId in interface EventStore

Returns:

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

getEvent

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

Description copied from interface: EventStore

Retrieves the event with the given ID

Specified by:

getEvent in interface EventStore

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

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

Description copied from interface: EventStore

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.

Specified by:

getEvents in interface EventStore

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

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

Description copied from interface: EventStore

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.

Specified by:

getEvents in interface EventStore

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

transformer - 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

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

Description copied from interface: EventStore

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.

Specified by:

getEvents in interface EventStore

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

transformer - 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

getPartitions

protected abstract java.util.List<? extends EventStorePartition> getPartitions()