org.apache.nifi.provenance

Interface ProvenanceRepository

All Superinterfaces:

ProvenanceEventRepository

public interface ProvenanceRepository
extends ProvenanceEventRepository

Method Summary

Modifier and Type	Method and Description
ProvenanceEventRecord	getEvent(long id, NiFiUser user)
List<ProvenanceEventRecord>	getEvents(long firstRecordId, int maxRecords, NiFiUser user) Returns a List of all ProvenanceEventRecords in the repository starting with the given ID.
ProvenanceEventRepository	getProvenanceEventRepository()
List<SearchableField>	getSearchableAttributes()
List<SearchableField>	getSearchableFields()
void	initialize(EventReporter eventReporter, Authorizer authorizer, ProvenanceAuthorizableFactory resourceFactory) Performs any initialization needed.
ComputeLineageSubmission	retrieveLineageSubmission(String lineageIdentifier, NiFiUser user)
QuerySubmission	retrieveQuerySubmission(String queryIdentifier, NiFiUser user)
ComputeLineageSubmission	submitExpandChildren(long eventId, NiFiUser user) Submits a request to expand the children of the event with the given id.
ComputeLineageSubmission	submitExpandParents(long eventId, NiFiUser user) Submits a request to expand the parents of the event with the given id.
ComputeLineageSubmission	submitLineageComputation(long eventId, NiFiUser user) 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.
ComputeLineageSubmission	submitLineageComputation(String flowFileUuid, NiFiUser user) 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, NiFiUser user) Submits an asynchronous request to process the given query, returning an identifier that can be used to fetch the results at a later time

Methods inherited from interface org.apache.nifi.provenance.ProvenanceEventRepository

close, eventBuilder, getEvent, getEvents, getMaxEventId, registerEvent, registerEvents

Method Detail

initialize

void initialize(EventReporter eventReporter,
                Authorizer authorizer,
                ProvenanceAuthorizableFactory resourceFactory)
         throws IOException

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

Parameters:

eventReporter - to report to

authorizer - the authorizer to use for authorizing individual events

resourceFactory - the resource factory to use for generating Provenance Resource objects for authorization purposes

Throws:

IOException - if unable to initialize

getEvent

ProvenanceEventRecord getEvent(long id,
                               NiFiUser user)
                        throws IOException

Throws:

IOException

getEvents

List<ProvenanceEventRecord> getEvents(long firstRecordId,
                                      int maxRecords,
                                      NiFiUser user)
                               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. Each event that is found will be authorized against the given NiFiUser. If the user does not have authorization for the event, the event will not be returned.

Parameters:

firstRecordId - id of the first record to retrieve

maxRecords - maximum number of records to retrieve

user - the NiFi user that the events should be authorized against

Returns:

records

Throws:

IOException - if error reading from repository

getProvenanceEventRepository

ProvenanceEventRepository getProvenanceEventRepository()

Returns:

the ProvenanceEventRepository backing this ProvenanceRepository

submitQuery

QuerySubmission submitQuery(Query query,
                            NiFiUser user)

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

user - the NiFi User to authorize the events against

Returns:

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

retrieveQuerySubmission

QuerySubmission retrieveQuerySubmission(String queryIdentifier,
                                        NiFiUser user)

Parameters:

queryIdentifier - of the query

user - the user who is retrieving 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,
                                                  NiFiUser user)

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. If the given user does not have authorization to view one of the events in the lineage, a placeholder event will be used instead that provides none of the event details except for the identifier of the component that emitted the Provenance Event. It is necessary to include this node in the lineage view so that the lineage makes sense, rather than showing disconnected graphs when the user is not authorized for all components' provenance events.

Parameters:

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

user - the NiFi User to authorize events against

Returns:

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

submitLineageComputation

ComputeLineageSubmission submitLineageComputation(long eventId,
                                                  NiFiUser user)

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. If the given user does not have authorization to view one of the events in the lineage, a placeholder event will be used instead that provides none of the event details except for the identifier of the component that emitted the Provenance Event. It is necessary to include this node in the lineage view so that the lineage makes sense, rather than showing disconnected graphs when the user is not authorized for all components' provenance events. This method is preferred to submitLineageComputation(String, NiFiUser) because it is much more efficient, but the former may be used if a particular Event ID is not available.

Parameters:

eventId - the numeric ID of the event that the lineage is for

user - the NiFi User to authorize events against

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,
                                                   NiFiUser user)

Parameters:

lineageIdentifier - identifier of lineage to compute

user - the user who is retrieving the lineage submission

Returns:

the ComputeLineageSubmission associated with the given identifier

submitExpandParents

ComputeLineageSubmission submitExpandParents(long eventId,
                                             NiFiUser user)

Submits a request to expand the parents of the event with the given id. If the given user is not authorized to access any event, a placeholder will be used instead that contains only the ID of the component that emitted the event.

Parameters:

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

user - the NiFi user to authorize events against

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,
                                              NiFiUser user)

Submits a request to expand the children of the event with the given id. If the given user is not authorized to access any event, a placeholder will be used instead that contains only the ID of the component that emitted the event.

Parameters:

eventId - the one-up id of the Event

user - the NiFi user to authorize events against

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

getSearchableFields

List<SearchableField> getSearchableFields()

Returns:

a list of all fields that can be searched via the submitQuery(Query, NiFiUser) method

getSearchableAttributes

List<SearchableField> getSearchableAttributes()

Returns:

a list of all FlowFile attributes that can be searched via the submitQuery(Query, NiFiUser) method