org.apache.nifi.provenance

Interface ProvenanceEventRepository

public interface ProvenanceEventRepository

This Repository houses Provenance Events. The repository is responsible for managing the life-cycle of the events, providing access to the events that it has stored, and providing query capabilities against the events.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the repository, freeing any resources
ProvenanceEventBuilder	eventBuilder() Returns a ProvenanceEventBuilder that is capable of building ProvenanceEventRecords
ProvenanceEventRecord	getEvent(long id)
List<ProvenanceEventRecord>	getEvents(long firstRecordId, int maxRecords) Returns a List of all ProvenanceEventRecords in the repository starting with the given ID.
Long	getMaxEventId()
List<SearchableField>	getSearchableAttributes()
List<SearchableField>	getSearchableFields()
void	initialize(EventReporter eventReporter) Performs any initialization needed.
void	registerEvent(ProvenanceEventRecord event) Adds the given event to the repository and returns a new event for which the event id has been populated.
void	registerEvents(Iterable<ProvenanceEventRecord> events) Adds the given events to the repository.
ComputeLineageSubmission	retrieveLineageSubmission(String lineageIdentifier)
QuerySubmission	retrieveQuerySubmission(String queryIdentifier)
ComputeLineageSubmission	submitExpandChildren(long eventId) Submits a request to expand the children of the event with the given id
ComputeLineageSubmission	submitExpandParents(long eventId) Submits a request to expand the parents of the event with the given id
ComputeLineageSubmission	submitLineageComputation(String flowFileUuid) Submits a Lineage Computation to be completed and returns the AsynchronousLineageResult that indicates the status of the request and the results, if the computation is complete.
QuerySubmission	submitQuery(Query query) Submits an asynchronous request to process the given query, returning an identifier that can be used to fetch the results at a later time

Method Detail

initialize

void initialize(EventReporter eventReporter)
                throws IOException

Performs any initialization needed. This should be called only by the framework.

Parameters:

eventReporter - to report to

Throws:

IOException - if unable to initialize

eventBuilder

ProvenanceEventBuilder eventBuilder()

Returns a ProvenanceEventBuilder that is capable of building ProvenanceEventRecords

Returns:

builder

registerEvent

void registerEvent(ProvenanceEventRecord event)

Adds the given event to the repository and returns a new event for which the event id has been populated. Depending on the implementation, the returned event may or may not be the same event given

Parameters:

event - to register

registerEvents

void registerEvents(Iterable<ProvenanceEventRecord> events)

Adds the given events to the repository.

This interface makes no assumptions about whether or not the registration of the Collection are atomic. This detail is implementation-specific.

Parameters:

events - to register

getEvents

List<ProvenanceEventRecord> getEvents(long firstRecordId,
                                    int maxRecords)
                                      throws IOException

Returns a List of all ProvenanceEventRecords in the repository starting with the given ID. The first ID in the repository will always be 0 or higher.

Parameters:

firstRecordId - id of the first record to retrieve

maxRecords - maximum number of records to retrieve

Returns:

records

Throws:

IOException - if error reading from repository

getMaxEventId

Long getMaxEventId()

Returns:

the largest ID of any event that is queryable in the repository. If no queryable events exists, returns null

submitQuery

QuerySubmission submitQuery(Query query)

Submits an asynchronous request to process the given query, returning an identifier that can be used to fetch the results at a later time

Parameters:

query - to submit

Returns:

an identifier that can be used to fetch the results at a later time

retrieveQuerySubmission

QuerySubmission retrieveQuerySubmission(String queryIdentifier)

Parameters:

queryIdentifier - of the query

Returns:

the QueryResult associated with the given identifier, if the query has finished processing. If the query has not yet finished running, returns null

submitLineageComputation

ComputeLineageSubmission submitLineageComputation(String flowFileUuid)

Submits a Lineage Computation to be completed and returns the AsynchronousLineageResult that indicates the status of the request and the results, if the computation is complete.

Parameters:

flowFileUuid - the UUID of the FlowFile for which the Lineage should be calculated

Returns:

a ComputeLineageSubmission object that can be used to check if the computing is complete and if so get the results

retrieveLineageSubmission

ComputeLineageSubmission retrieveLineageSubmission(String lineageIdentifier)

Parameters:

lineageIdentifier - identifier of lineage to compute

Returns:

the ComputeLineageSubmission associated with the given identifier

getEvent

ProvenanceEventRecord getEvent(long id)
                               throws IOException

Parameters:

id - to lookup

Returns:

the Provenance Event Record with the given ID, if it exists, or null otherwise

Throws:

IOException - if failure while retrieving event

submitExpandParents

ComputeLineageSubmission submitExpandParents(long eventId)

Submits a request to expand the parents of the event with the given id

Parameters:

eventId - the one-up id of the Event to expand

Returns:

a submission which can be checked for status

Throws:

IllegalArgumentException - if the given identifier identifies a Provenance Event that has a Type that is not expandable or if the identifier cannot be found

submitExpandChildren

ComputeLineageSubmission submitExpandChildren(long eventId)

Submits a request to expand the children of the event with the given id

Parameters:

eventId - the one-up id of the Event

Returns:

a submission which can be checked for status

Throws:

IllegalArgumentException - if the given identifier identifies a Provenance Event that has a Type that is not expandable or if the identifier cannot be found

close

void close()
           throws IOException

Closes the repository, freeing any resources

Throws:

IOException - if failure closing repository

getSearchableFields

List<SearchableField> getSearchableFields()

Returns:

a list of all fields that can be searched via the #submitQuery(nifi.provenance.search.Query) method

getSearchableAttributes

List<SearchableField> getSearchableAttributes()

Returns:

a list of all FlowFile attributes that can be searched via the #submitQuery(nifi.provenance.search.Query) method