org.apache.nifi.minifi.provenance.reporting

Class ProvenanceReportingTask

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

org.apache.nifi.minifi.provenance.reporting.ProvenanceReportingTask

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.reporting.ReportingTask

@Tags(value={"provenance","lineage","tracking","site","site to site"})
 @CapabilityDescription(value="Publishes Provenance events using the Site To Site protocol.")
 @Stateful(scopes=LOCAL,
          description="Stores the Reporting Task\'s last event Id so that on restart of MiNiFi the task knows where it left off.")
public class ProvenanceReportingTask
extends org.apache.nifi.reporting.AbstractReportingTask

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ProvenanceReportingTask.NiFiUrlValidator

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static org.apache.nifi.components.PropertyDescriptor	BATCH_SIZE
(package private) static org.apache.nifi.components.PropertyDescriptor	COMPRESS
(package private) static org.apache.nifi.components.PropertyDescriptor	DESTINATION_URL
private long	firstEventId
private static String	LAST_EVENT_ID_KEY
(package private) static org.apache.nifi.components.PropertyDescriptor	MINIFI_URL
(package private) static org.apache.nifi.components.PropertyDescriptor	PORT_NAME
private org.apache.nifi.remote.client.SiteToSiteClient	siteToSiteClient
(package private) static org.apache.nifi.components.PropertyDescriptor	SSL_CONTEXT
(package private) static org.apache.nifi.components.PropertyDescriptor	TIMEOUT
private static String	TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
ProvenanceReportingTask()

Method Summary

Modifier and Type	Method and Description
private static void	addField(javax.json.JsonObjectBuilder builder, javax.json.JsonBuilderFactory factory, String key, Collection<String> values)
private static void	addField(javax.json.JsonObjectBuilder builder, javax.json.JsonBuilderFactory factory, String key, Map<String,String> values)
private static void	addField(javax.json.JsonObjectBuilder builder, String key, Long value)
private static void	addField(javax.json.JsonObjectBuilder builder, String key, String value)
private static javax.json.JsonArrayBuilder	createJsonArray(javax.json.JsonBuilderFactory factory, Collection<String> values)
protected org.apache.nifi.remote.client.SiteToSiteClient	getClient()
private String	getComponentName(org.apache.nifi.controller.status.ProcessGroupStatus status, org.apache.nifi.provenance.ProvenanceEventRecord event)
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(org.apache.nifi.reporting.ReportingContext context)
(package private) static javax.json.JsonObject	serialize(javax.json.JsonBuilderFactory factory, javax.json.JsonObjectBuilder builder, org.apache.nifi.provenance.ProvenanceEventRecord event, String componentName, String hostname, URL nifiUrl, String applicationName)
void	setup(org.apache.nifi.controller.ConfigurationContext context)
void	shutdown()

Methods inherited from class org.apache.nifi.reporting.AbstractReportingTask

getControllerServiceLookup, getIdentifier, getLogger, getName, getSchedulingPeriod, init, initialize

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

TIMESTAMP_FORMAT

private static final String TIMESTAMP_FORMAT

See Also:

Constant Field Values

LAST_EVENT_ID_KEY

private static final String LAST_EVENT_ID_KEY

See Also:

Constant Field Values

DESTINATION_URL

static final org.apache.nifi.components.PropertyDescriptor DESTINATION_URL

PORT_NAME

static final org.apache.nifi.components.PropertyDescriptor PORT_NAME

SSL_CONTEXT

static final org.apache.nifi.components.PropertyDescriptor SSL_CONTEXT

MINIFI_URL

static final org.apache.nifi.components.PropertyDescriptor MINIFI_URL

COMPRESS

static final org.apache.nifi.components.PropertyDescriptor COMPRESS

TIMEOUT

static final org.apache.nifi.components.PropertyDescriptor TIMEOUT

BATCH_SIZE

static final org.apache.nifi.components.PropertyDescriptor BATCH_SIZE

firstEventId

private volatile long firstEventId

siteToSiteClient

private volatile org.apache.nifi.remote.client.SiteToSiteClient siteToSiteClient

Constructor Detail

ProvenanceReportingTask

public ProvenanceReportingTask()

Method Detail

getSupportedPropertyDescriptors

protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

setup

@OnScheduled
public void setup(org.apache.nifi.controller.ConfigurationContext context)
                        throws IOException

Throws:

IOException

shutdown

@OnStopped
public void shutdown()
                         throws IOException

Throws:

IOException

getClient

protected org.apache.nifi.remote.client.SiteToSiteClient getClient()

getComponentName

private String getComponentName(org.apache.nifi.controller.status.ProcessGroupStatus status,
                                org.apache.nifi.provenance.ProvenanceEventRecord event)

onTrigger

public void onTrigger(org.apache.nifi.reporting.ReportingContext context)

serialize

static javax.json.JsonObject serialize(javax.json.JsonBuilderFactory factory,
                                       javax.json.JsonObjectBuilder builder,
                                       org.apache.nifi.provenance.ProvenanceEventRecord event,
                                       String componentName,
                                       String hostname,
                                       URL nifiUrl,
                                       String applicationName)

addField

private static void addField(javax.json.JsonObjectBuilder builder,
                             javax.json.JsonBuilderFactory factory,
                             String key,
                             Map<String,String> values)

addField

private static void addField(javax.json.JsonObjectBuilder builder,
                             String key,
                             Long value)

addField

private static void addField(javax.json.JsonObjectBuilder builder,
                             javax.json.JsonBuilderFactory factory,
                             String key,
                             Collection<String> values)

addField

private static void addField(javax.json.JsonObjectBuilder builder,
                             String key,
                             String value)

createJsonArray

private static javax.json.JsonArrayBuilder createJsonArray(javax.json.JsonBuilderFactory factory,
                                                           Collection<String> values)