Package org.apache.nifi.processors.azure.storage

Class ListAzureBlobStorage_v12

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processor.util.list.AbstractListProcessor<BlobInfo>

org.apache.nifi.processors.azure.storage.AbstractListAzureProcessor<BlobInfo>

org.apache.nifi.processors.azure.storage.ListAzureBlobStorage_v12

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor, org.apache.nifi.processor.VerifiableProcessor

@PrimaryNodeOnly
@TriggerSerially
@Tags({"azure","microsoft","cloud","storage","blob"})
@SeeAlso({FetchAzureBlobStorage_v12.class,PutAzureBlobStorage_v12.class,DeleteAzureBlobStorage_v12.class,CopyAzureBlobStorage_v12.class})
@CapabilityDescription("Lists blobs in an Azure Blob Storage container. Listing details are attached to an empty FlowFile for use with FetchAzureBlobStorage. This Processor is designed to run on Primary Node only in a cluster. If the primary node changes, the new Primary Node will pick up where the previous node left off without duplicating all of the data. The processor uses Azure Blob Storage client library v12.")
@InputRequirement(INPUT_FORBIDDEN)
@WritesAttribute(attribute="azure.container",description="The name of the Azure Blob Storage container") @WritesAttribute(attribute="azure.blobname",description="The name of the blob on Azure Blob Storage") @WritesAttribute(attribute="azure.primaryUri",description="Primary location of the blob") @WritesAttribute(attribute="azure.etag",description="ETag of the blob") @WritesAttribute(attribute="azure.blobtype",description="Type of the blob (either BlockBlob, PageBlob or AppendBlob)") @WritesAttribute(attribute="mime.type",description="MIME Type of the content") @WritesAttribute(attribute="lang",description="Language code for the content") @WritesAttribute(attribute="azure.timestamp",description="Timestamp of the blob") @WritesAttribute(attribute="azure.length",description="Length of the blob")
@Stateful(scopes=CLUSTER,
          description="After performing a listing of blobs, the timestamp of the newest blob is stored if \'Tracking Timestamps\' Listing Strategy is in use (by default). This allows the Processor to list only blobs that have been added or modified after this date the next time that the Processor is run. State is stored across the cluster so that this Processor can be run on Primary Node only and if a new Primary Node is selected, the new node can pick up where the previous node left off, without duplicating the data.")
@DefaultSchedule(strategy=TIMER_DRIVEN,
                 period="1 min")
public class ListAzureBlobStorage_v12
extends AbstractListAzureProcessor<BlobInfo>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.processor.util.list.AbstractListProcessor

AbstractListProcessor.ListingMode

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.nifi.components.PropertyDescriptor	BLOB_NAME_PREFIX
private BlobServiceClientFactory	clientFactory
static final org.apache.nifi.components.PropertyDescriptor	CONTAINER
static final org.apache.nifi.components.PropertyDescriptor	INITIAL_LISTING_TARGET
private static final List<org.apache.nifi.components.PropertyDescriptor>	PROPERTIES
static final org.apache.nifi.components.PropertyDescriptor	TRACKING_STATE_CACHE
static final org.apache.nifi.components.PropertyDescriptor	TRACKING_TIME_WINDOW

Fields inherited from class org.apache.nifi.processors.azure.storage.AbstractListAzureProcessor

MAX_AGE, MAX_SIZE, MIN_AGE, MIN_SIZE

Fields inherited from class org.apache.nifi.processor.util.list.AbstractListProcessor

BY_ENTITIES, BY_TIME_WINDOW, BY_TIMESTAMPS, LISTING_LAG_MILLIS, LISTING_STRATEGY, NO_TRACKING, PRECISION_AUTO_DETECT, PRECISION_MILLIS, PRECISION_MINUTES, PRECISION_SECONDS, RECORD_WRITER, REL_SUCCESS, TARGET_SYSTEM_TIMESTAMP_PRECISION

Constructor Summary

Constructors

Constructor	Description
ListAzureBlobStorage_v12()

Method Summary

Modifier and Type	Method	Description
protected Integer	countUnfilteredListing(org.apache.nifi.processor.ProcessContext context)
protected Map<String,String>	createAttributes(BlobInfo entity, org.apache.nifi.processor.ProcessContext context)
protected String	getDefaultTimePrecision()
protected String	getListingContainerName(org.apache.nifi.processor.ProcessContext context)
protected String	getPath(org.apache.nifi.processor.ProcessContext context)
protected RecordSchema	getRecordSchema()
protected org.apache.nifi.components.state.Scope	getStateScope(org.apache.nifi.context.PropertyContext context)
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
protected boolean	isListingResetNecessary(org.apache.nifi.components.PropertyDescriptor property)
void	onScheduled(org.apache.nifi.processor.ProcessContext context)
void	onStopped()
protected List<BlobInfo>	performListing(org.apache.nifi.processor.ProcessContext context, Long minTimestamp, AbstractListProcessor.ListingMode listingMode)

Methods inherited from class org.apache.nifi.processors.azure.storage.AbstractListAzureProcessor

isFileInfoMatchesWithAgeAndSize

Methods inherited from class org.apache.nifi.processor.util.list.AbstractListProcessor

createListedEntityTracker, customValidate, customValidate, getCurrentNanoTime, getCurrentTime, getKey, getRelationships, initListedEntityTracker, listByNoTracking, listByTimeWindow, listByTrackingTimestamps, migrateProperties, onPrimaryNodeChange, onPropertyModified, onTrigger, updateState, verify

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, 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, validate

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful, migrateRelationships

Field Details

CONTAINER

public static final org.apache.nifi.components.PropertyDescriptor CONTAINER

BLOB_NAME_PREFIX

public static final org.apache.nifi.components.PropertyDescriptor BLOB_NAME_PREFIX

TRACKING_STATE_CACHE

public static final org.apache.nifi.components.PropertyDescriptor TRACKING_STATE_CACHE

TRACKING_TIME_WINDOW

public static final org.apache.nifi.components.PropertyDescriptor TRACKING_TIME_WINDOW

INITIAL_LISTING_TARGET

public static final org.apache.nifi.components.PropertyDescriptor INITIAL_LISTING_TARGET

PROPERTIES

private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTIES

clientFactory

private volatile BlobServiceClientFactory clientFactory

Constructor Details

ListAzureBlobStorage_v12

public ListAzureBlobStorage_v12()

Method Details

getSupportedPropertyDescriptors

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

Overrides:

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

onScheduled

@OnScheduled
public void onScheduled(org.apache.nifi.processor.ProcessContext context)

onStopped

@OnStopped
public void onStopped()

getPath

protected String getPath(org.apache.nifi.processor.ProcessContext context)

Specified by:

getPath in class AbstractListProcessor<BlobInfo>

getStateScope

protected org.apache.nifi.components.state.Scope getStateScope(org.apache.nifi.context.PropertyContext context)

Specified by:

getStateScope in class AbstractListProcessor<BlobInfo>

getRecordSchema

protected RecordSchema getRecordSchema()

Specified by:

getRecordSchema in class AbstractListProcessor<BlobInfo>

countUnfilteredListing

protected Integer countUnfilteredListing(org.apache.nifi.processor.ProcessContext context)
                                  throws IOException

Specified by:

countUnfilteredListing in class AbstractListProcessor<BlobInfo>

Throws:

IOException

getListingContainerName

protected String getListingContainerName(org.apache.nifi.processor.ProcessContext context)

Specified by:

getListingContainerName in class AbstractListProcessor<BlobInfo>

getDefaultTimePrecision

protected String getDefaultTimePrecision()

Overrides:

getDefaultTimePrecision in class AbstractListProcessor<BlobInfo>

isListingResetNecessary

protected boolean isListingResetNecessary(org.apache.nifi.components.PropertyDescriptor property)

Specified by:

isListingResetNecessary in class AbstractListProcessor<BlobInfo>

performListing

protected List<BlobInfo> performListing(org.apache.nifi.processor.ProcessContext context,
 Long minTimestamp,
 AbstractListProcessor.ListingMode listingMode)
                                 throws IOException

Specified by:

performListing in class AbstractListProcessor<BlobInfo>

Throws:

IOException

createAttributes

protected Map<String,String> createAttributes(BlobInfo entity,
 org.apache.nifi.processor.ProcessContext context)

Specified by:

createAttributes in class AbstractListProcessor<BlobInfo>