org.apache.nifi.reporting

Class SiteToSiteProvenanceReportingTask

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

org.apache.nifi.reporting.AbstractSiteToSiteReportingTask

org.apache.nifi.reporting.SiteToSiteProvenanceReportingTask

All Implemented Interfaces:

ConfigurableComponent, ReportingTask, VerifiableReportingTask

@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 the task knows where it left off.")
 @Restricted(restrictions=@Restriction(requiredPermission=EXPORT_NIFI_DETAILS,explanation="Provides operator the ability to send sensitive details contained in Provenance events to any external system."))
public class SiteToSiteProvenanceReportingTask
extends AbstractSiteToSiteReportingTask

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static AllowableValue	BEGINNING_OF_STREAM
private ProvenanceEventConsumer	consumer
(package private) static AllowableValue	END_OF_STREAM
(package private) static PropertyDescriptor	FILTER_COMPONENT_ID
(package private) static PropertyDescriptor	FILTER_COMPONENT_ID_EXCLUDE
(package private) static PropertyDescriptor	FILTER_COMPONENT_NAME
(package private) static PropertyDescriptor	FILTER_COMPONENT_NAME_EXCLUDE
(package private) static PropertyDescriptor	FILTER_COMPONENT_TYPE
(package private) static PropertyDescriptor	FILTER_COMPONENT_TYPE_EXCLUDE
(package private) static PropertyDescriptor	FILTER_EVENT_TYPE
(package private) static PropertyDescriptor	FILTER_EVENT_TYPE_EXCLUDE
(package private) static PropertyDescriptor	START_POSITION

Fields inherited from class org.apache.nifi.reporting.AbstractSiteToSiteReportingTask

ALLOW_NULL_VALUES, DESTINATION_URL_PATH, LAST_EVENT_ID_KEY, RECORD_WRITER, recordSchema, siteToSiteClient, TIMESTAMP_FORMAT

Constructor Summary

Constructors

Constructor and Description
SiteToSiteProvenanceReportingTask()

Method Summary

Modifier and Type	Method and Description
private void	addField(javax.json.JsonObjectBuilder builder, javax.json.JsonBuilderFactory factory, String key, Collection<String> values, Boolean allowNullValues)
private static void	addField(javax.json.JsonObjectBuilder builder, javax.json.JsonBuilderFactory factory, String key, Map<String,String> values, Boolean allowNullValues)
private static javax.json.JsonArrayBuilder	createJsonArray(javax.json.JsonBuilderFactory factory, Collection<String> values)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onScheduled(ConfigurationContext context)
void	onTrigger(ReportingContext context)
void	onUnscheduled()
private javax.json.JsonObject	serialize(javax.json.JsonBuilderFactory factory, javax.json.JsonObjectBuilder builder, ProvenanceEventRecord event, DateFormat df, String componentName, String processGroupId, String processGroupName, String hostname, URL nifiUrl, String applicationName, String platform, String nodeIdentifier, Boolean allowNullValues)

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

addField, addField, addField, addField, getClient, getData, sendData, setup, shutdown, verify

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

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

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.reporting.ReportingTask

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

BEGINNING_OF_STREAM

static final AllowableValue BEGINNING_OF_STREAM

END_OF_STREAM

static final AllowableValue END_OF_STREAM

FILTER_EVENT_TYPE

static final PropertyDescriptor FILTER_EVENT_TYPE

FILTER_EVENT_TYPE_EXCLUDE

static final PropertyDescriptor FILTER_EVENT_TYPE_EXCLUDE

FILTER_COMPONENT_TYPE

static final PropertyDescriptor FILTER_COMPONENT_TYPE

FILTER_COMPONENT_TYPE_EXCLUDE

static final PropertyDescriptor FILTER_COMPONENT_TYPE_EXCLUDE

FILTER_COMPONENT_ID

static final PropertyDescriptor FILTER_COMPONENT_ID

FILTER_COMPONENT_ID_EXCLUDE

static final PropertyDescriptor FILTER_COMPONENT_ID_EXCLUDE

FILTER_COMPONENT_NAME

static final PropertyDescriptor FILTER_COMPONENT_NAME

FILTER_COMPONENT_NAME_EXCLUDE

static final PropertyDescriptor FILTER_COMPONENT_NAME_EXCLUDE

START_POSITION

static final PropertyDescriptor START_POSITION

consumer

private volatile ProvenanceEventConsumer consumer

Constructor Detail

SiteToSiteProvenanceReportingTask

public SiteToSiteProvenanceReportingTask()
                                  throws IOException

Throws:

IOException

Method Detail

onScheduled

@OnScheduled
public void onScheduled(ConfigurationContext context)
                              throws IOException

Throws:

IOException

onUnscheduled

@OnUnscheduled
public void onUnscheduled()

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractSiteToSiteReportingTask

onTrigger

public void onTrigger(ReportingContext context)

serialize

private javax.json.JsonObject serialize(javax.json.JsonBuilderFactory factory,
                                        javax.json.JsonObjectBuilder builder,
                                        ProvenanceEventRecord event,
                                        DateFormat df,
                                        String componentName,
                                        String processGroupId,
                                        String processGroupName,
                                        String hostname,
                                        URL nifiUrl,
                                        String applicationName,
                                        String platform,
                                        String nodeIdentifier,
                                        Boolean allowNullValues)

addField

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

addField

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

createJsonArray

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