Package org.apache.nifi.controller.repository

Class StandardProvenanceReporter

java.lang.Object

org.apache.nifi.controller.repository.StandardProvenanceReporter

All Implemented Interfaces:

InternalProvenanceReporter, ProvenanceReporter

public class StandardProvenanceReporter
extends Object
implements InternalProvenanceReporter

Field Summary

Fields

Modifier and Type	Field	Description
private long	bytesFetched
private long	bytesReceived
private long	bytesSent
private final ProvenanceEventEnricher	eventEnricher
private final Set<ProvenanceEventRecord>	events
private final Predicate<FlowFile>	flowfileKnownCheck
private int	flowFilesFetched
private int	flowFilesReceived
private int	flowFilesSent
private final org.slf4j.Logger	logger
private final String	processorId
private final String	processorType
private final ProvenanceEventRepository	repository

Constructor Summary

Constructors

Constructor	Description
StandardProvenanceReporter(Predicate<FlowFile> flowfileKnownCheck, String processorId, String processorType, ProvenanceEventRepository repository, ProvenanceEventEnricher enricher)

Method Summary

Modifier and Type	Method	Description
void	associate(FlowFile flowFile, String alternateIdentifierNamespace, String alternateIdentifier)
ProvenanceEventBuilder	build(FlowFile flowFile, ProvenanceEventType eventType)
void	clear()
void	clone(FlowFile parent, FlowFile child)
void	clone(FlowFile parent, FlowFile child, boolean verifyFlowFile)
void	create(FlowFile flowFile)
void	create(FlowFile flowFile, String details)
ProvenanceEventRecord	drop(FlowFile flowFile, String reason)
void	expire(FlowFile flowFile, String details)
void	fetch(FlowFile flowFile, String transitUri)
void	fetch(FlowFile flowFile, String transitUri, long transmissionMillis)
void	fetch(FlowFile flowFile, String transitUri, String details, long transmissionMillis)
void	fork(FlowFile parent, Collection<FlowFile> children)
void	fork(FlowFile parent, Collection<FlowFile> children, long forkDuration)
void	fork(FlowFile parent, Collection<FlowFile> children, String details)
void	fork(FlowFile parent, Collection<FlowFile> children, String details, long forkDuration)
ProvenanceEventRecord	generateDropEvent(FlowFile flowFile, String details)
ProvenanceEventRecord	generateJoinEvent(Collection<FlowFile> parents, FlowFile child)	Generates a Fork event for the given child and parents but does not register the event.
long	getBytesFetched()
long	getBytesReceived()
long	getBytesSent()
Set<ProvenanceEventRecord>	getEvents()
int	getFlowFilesFetched()
int	getFlowFilesReceived()
int	getFlowFilesSent()
void	invokeRemoteProcess(FlowFile flowFile, String transitUri)
void	invokeRemoteProcess(FlowFile flowFile, String transitUri, String details)
void	join(Collection<FlowFile> parents, FlowFile child)
void	join(Collection<FlowFile> parents, FlowFile child, long joinDuration)
void	join(Collection<FlowFile> parents, FlowFile child, String details)
void	join(Collection<FlowFile> parents, FlowFile child, String details, long joinDuration)
void	migrate(InternalProvenanceReporter newOwner, Collection<String> flowFileIds)
void	modifyAttributes(FlowFile flowFile)
void	modifyAttributes(FlowFile flowFile, String details)
void	modifyContent(FlowFile flowFile)
void	modifyContent(FlowFile flowFile, long processingMillis)
void	modifyContent(FlowFile flowFile, String details)
void	modifyContent(FlowFile flowFile, String details, long processingMillis)
void	receive(FlowFile flowFile, String transitUri)
void	receive(FlowFile flowFile, String transitUri, long transmissionMillis)
void	receive(FlowFile flowFile, String transitUri, String details)
void	receive(FlowFile flowFile, String transitUri, String details, long transmissionMillis)
void	receive(FlowFile flowFile, String transitUri, String sourceSystemFlowFileIdentifier, String details, long transmissionMillis)
void	receiveMigration(Set<ProvenanceEventRecord> events)
void	remove(ProvenanceEventRecord event)	Removes the given event from the reporter
void	removeEventsForFlowFile(String uuid)
void	route(FlowFile flowFile, org.apache.nifi.processor.Relationship relationship)
void	route(FlowFile flowFile, org.apache.nifi.processor.Relationship relationship, long processingDuration)
void	route(FlowFile flowFile, org.apache.nifi.processor.Relationship relationship, String details)
void	route(FlowFile flowFile, org.apache.nifi.processor.Relationship relationship, String details, long processingDuration)
void	send(FlowFile flowFile, String transitUri)
void	send(FlowFile flowFile, String transitUri, boolean force)
void	send(FlowFile flowFile, String transitUri, long transmissionMillis)
void	send(FlowFile flowFile, String transitUri, long transmissionMillis, boolean force)
void	send(FlowFile flowFile, String transitUri, String details)
void	send(FlowFile flowFile, String transitUri, String details, boolean force)
void	send(FlowFile flowFile, String transitUri, String details, long transmissionMillis)
void	send(FlowFile flowFile, String transitUri, String details, long transmissionMillis, boolean force)
void	upload(FlowFile flowFile, long size, String transitUri)
void	upload(FlowFile flowFile, long size, String transitUri, String details, long transmissionMillis, boolean force)
private void	verifyFlowFileKnown(FlowFile flowFile)

Methods inherited from class java.lang.Object

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

Field Details

logger

private final org.slf4j.Logger logger

processorId

private final String processorId

processorType

private final String processorType

events

private final Set<ProvenanceEventRecord> events

repository

private final ProvenanceEventRepository repository

eventEnricher

private final ProvenanceEventEnricher eventEnricher

flowfileKnownCheck

private final Predicate<FlowFile> flowfileKnownCheck

bytesSent

private long bytesSent

bytesReceived

private long bytesReceived

flowFilesSent

private int flowFilesSent

flowFilesReceived

private int flowFilesReceived

flowFilesFetched

private int flowFilesFetched

bytesFetched

private long bytesFetched

Constructor Details

StandardProvenanceReporter

public StandardProvenanceReporter(Predicate<FlowFile> flowfileKnownCheck,
 String processorId,
 String processorType,
 ProvenanceEventRepository repository,
 ProvenanceEventEnricher enricher)

Method Details

getEvents

public Set<ProvenanceEventRecord> getEvents()

Specified by:

getEvents in interface InternalProvenanceReporter

remove

public void remove(ProvenanceEventRecord event)

Removes the given event from the reporter

Specified by:

remove in interface InternalProvenanceReporter

Parameters:

event - event

removeEventsForFlowFile

public void removeEventsForFlowFile(String uuid)

Specified by:

removeEventsForFlowFile in interface InternalProvenanceReporter

clear

public void clear()

Specified by:

clear in interface InternalProvenanceReporter

migrate

public void migrate(InternalProvenanceReporter newOwner,
 Collection<String> flowFileIds)

Specified by:

migrate in interface InternalProvenanceReporter

receiveMigration

public void receiveMigration(Set<ProvenanceEventRecord> events)

Specified by:

receiveMigration in interface InternalProvenanceReporter

generateJoinEvent

public ProvenanceEventRecord generateJoinEvent(Collection<FlowFile> parents,
 FlowFile child)

Generates a Fork event for the given child and parents but does not register the event. This is useful so that a ProcessSession has the ability to de-dupe events, since one or more events may be created by the session itself, as well as by the Processor

Specified by:

generateJoinEvent in interface InternalProvenanceReporter

Parameters:

parents - parents

child - child

Returns:

record

generateDropEvent

public ProvenanceEventRecord generateDropEvent(FlowFile flowFile,
 String details)

Specified by:

generateDropEvent in interface InternalProvenanceReporter

verifyFlowFileKnown

private void verifyFlowFileKnown(FlowFile flowFile)

receive

public void receive(FlowFile flowFile,
 String transitUri)

Specified by:

receive in interface ProvenanceReporter

receive

public void receive(FlowFile flowFile,
 String transitUri,
 String details)

Specified by:

receive in interface ProvenanceReporter

receive

public void receive(FlowFile flowFile,
 String transitUri,
 long transmissionMillis)

Specified by:

receive in interface ProvenanceReporter

receive

public void receive(FlowFile flowFile,
 String transitUri,
 String details,
 long transmissionMillis)

Specified by:

receive in interface ProvenanceReporter

receive

public void receive(FlowFile flowFile,
 String transitUri,
 String sourceSystemFlowFileIdentifier,
 String details,
 long transmissionMillis)

Specified by:

receive in interface ProvenanceReporter

fetch

public void fetch(FlowFile flowFile,
 String transitUri)

Specified by:

fetch in interface ProvenanceReporter

fetch

public void fetch(FlowFile flowFile,
 String transitUri,
 long transmissionMillis)

Specified by:

fetch in interface ProvenanceReporter

fetch

public void fetch(FlowFile flowFile,
 String transitUri,
 String details,
 long transmissionMillis)

Specified by:

fetch in interface ProvenanceReporter

send

public void send(FlowFile flowFile,
 String transitUri,
 long transmissionMillis)

Specified by:

send in interface ProvenanceReporter

send

public void send(FlowFile flowFile,
 String transitUri,
 boolean force)

Specified by:

send in interface ProvenanceReporter

send

public void send(FlowFile flowFile,
 String transitUri)

Specified by:

send in interface ProvenanceReporter

send

public void send(FlowFile flowFile,
 String transitUri,
 String details)

Specified by:

send in interface ProvenanceReporter

send

public void send(FlowFile flowFile,
 String transitUri,
 long transmissionMillis,
 boolean force)

Specified by:

send in interface ProvenanceReporter

send

public void send(FlowFile flowFile,
 String transitUri,
 String details,
 boolean force)

Specified by:

send in interface ProvenanceReporter

send

public void send(FlowFile flowFile,
 String transitUri,
 String details,
 long transmissionMillis)

Specified by:

send in interface ProvenanceReporter

send

public void send(FlowFile flowFile,
 String transitUri,
 String details,
 long transmissionMillis,
 boolean force)

Specified by:

send in interface ProvenanceReporter

upload

public void upload(FlowFile flowFile,
 long size,
 String transitUri)

Specified by:

upload in interface ProvenanceReporter

upload

public void upload(FlowFile flowFile,
 long size,
 String transitUri,
 String details,
 long transmissionMillis,
 boolean force)

Specified by:

upload in interface ProvenanceReporter

invokeRemoteProcess

public void invokeRemoteProcess(FlowFile flowFile,
 String transitUri)

Specified by:

invokeRemoteProcess in interface ProvenanceReporter

invokeRemoteProcess

public void invokeRemoteProcess(FlowFile flowFile,
 String transitUri,
 String details)

Specified by:

invokeRemoteProcess in interface ProvenanceReporter

associate

public void associate(FlowFile flowFile,
 String alternateIdentifierNamespace,
 String alternateIdentifier)

Specified by:

associate in interface ProvenanceReporter

drop

public ProvenanceEventRecord drop(FlowFile flowFile,
 String reason)

Specified by:

drop in interface InternalProvenanceReporter

expire

public void expire(FlowFile flowFile,
 String details)

Specified by:

expire in interface InternalProvenanceReporter

fork

public void fork(FlowFile parent,
 Collection<FlowFile> children)

Specified by:

fork in interface ProvenanceReporter

fork

public void fork(FlowFile parent,
 Collection<FlowFile> children,
 long forkDuration)

Specified by:

fork in interface ProvenanceReporter

fork

public void fork(FlowFile parent,
 Collection<FlowFile> children,
 String details)

Specified by:

fork in interface ProvenanceReporter

fork

public void fork(FlowFile parent,
 Collection<FlowFile> children,
 String details,
 long forkDuration)

Specified by:

fork in interface ProvenanceReporter

join

public void join(Collection<FlowFile> parents,
 FlowFile child)

Specified by:

join in interface ProvenanceReporter

join

public void join(Collection<FlowFile> parents,
 FlowFile child,
 long joinDuration)

Specified by:

join in interface ProvenanceReporter

join

public void join(Collection<FlowFile> parents,
 FlowFile child,
 String details)

Specified by:

join in interface ProvenanceReporter

join

public void join(Collection<FlowFile> parents,
 FlowFile child,
 String details,
 long joinDuration)

Specified by:

join in interface ProvenanceReporter

clone

public void clone(FlowFile parent,
 FlowFile child)

Specified by:

clone in interface ProvenanceReporter

clone

public void clone(FlowFile parent,
 FlowFile child,
 boolean verifyFlowFile)

Specified by:

clone in interface InternalProvenanceReporter

modifyContent

public void modifyContent(FlowFile flowFile)

Specified by:

modifyContent in interface ProvenanceReporter

modifyContent

public void modifyContent(FlowFile flowFile,
 String details)

Specified by:

modifyContent in interface ProvenanceReporter

modifyContent

public void modifyContent(FlowFile flowFile,
 long processingMillis)

Specified by:

modifyContent in interface ProvenanceReporter

modifyContent

public void modifyContent(FlowFile flowFile,
 String details,
 long processingMillis)

Specified by:

modifyContent in interface ProvenanceReporter

modifyAttributes

public void modifyAttributes(FlowFile flowFile)

Specified by:

modifyAttributes in interface ProvenanceReporter

modifyAttributes

public void modifyAttributes(FlowFile flowFile,
 String details)

Specified by:

modifyAttributes in interface ProvenanceReporter

route

public void route(FlowFile flowFile,
 org.apache.nifi.processor.Relationship relationship)

Specified by:

route in interface ProvenanceReporter

route

public void route(FlowFile flowFile,
 org.apache.nifi.processor.Relationship relationship,
 long processingDuration)

Specified by:

route in interface ProvenanceReporter

route

public void route(FlowFile flowFile,
 org.apache.nifi.processor.Relationship relationship,
 String details)

Specified by:

route in interface ProvenanceReporter

route

public void route(FlowFile flowFile,
 org.apache.nifi.processor.Relationship relationship,
 String details,
 long processingDuration)

Specified by:

route in interface ProvenanceReporter

create

public void create(FlowFile flowFile)

Specified by:

create in interface ProvenanceReporter

create

public void create(FlowFile flowFile,
 String details)

Specified by:

create in interface ProvenanceReporter

build

public ProvenanceEventBuilder build(FlowFile flowFile,
 ProvenanceEventType eventType)

Specified by:

build in interface InternalProvenanceReporter

getFlowFilesSent

public int getFlowFilesSent()

Specified by:

getFlowFilesSent in interface ProvenanceReporter

getBytesSent

public long getBytesSent()

Specified by:

getBytesSent in interface ProvenanceReporter

getFlowFilesReceived

public int getFlowFilesReceived()

Specified by:

getFlowFilesReceived in interface ProvenanceReporter

getBytesReceived

public long getBytesReceived()

Specified by:

getBytesReceived in interface ProvenanceReporter

getFlowFilesFetched

public int getFlowFilesFetched()

Specified by:

getFlowFilesFetched in interface ProvenanceReporter

getBytesFetched

public long getBytesFetched()

Specified by:

getBytesFetched in interface ProvenanceReporter