Package org.apache.nifi.processor.util.file.transfer

Class ListFileTransfer

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<FileInfo>

org.apache.nifi.processor.util.file.transfer.ListFileTransfer

All Implemented Interfaces:

ConfigurableComponent, Processor, VerifiableProcessor

public abstract class ListFileTransfer
extends AbstractListProcessor<FileInfo>

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 PropertyDescriptor	FILE_TRANSFER_LISTING_STRATEGY
static final PropertyDescriptor	HOSTNAME
static final PropertyDescriptor	REMOTE_PATH
static final PropertyDescriptor	UNDEFAULTED_PORT
static final PropertyDescriptor	USERNAME

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

BY_ENTITIES, BY_TIME_WINDOW, BY_TIMESTAMPS, DISTRIBUTED_CACHE_SERVICE, 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
ListFileTransfer()

Method Summary

Modifier and Type	Method	Description
protected Integer	countUnfilteredListing(ProcessContext context)
protected Map<String,String>	createAttributes(FileInfo fileInfo, ProcessContext context)
protected abstract FileTransfer	getFileTransfer(ProcessContext context)
protected String	getListingContainerName(ProcessContext context)
protected String	getPath(ProcessContext context)
protected abstract String	getProtocolName()
protected RecordSchema	getRecordSchema()
protected boolean	isListingResetNecessary(PropertyDescriptor property)
protected List<FileInfo>	performListing(ProcessContext context, Long minTimestamp, AbstractListProcessor.ListingMode listingMode)
protected List<FileInfo>	performListing(ProcessContext context, Long minTimestamp, AbstractListProcessor.ListingMode listingMode, boolean applyFilters)

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

createListedEntityTracker, customValidate, customValidate, getCurrentNanoTime, getCurrentTime, getDefaultTimePrecision, getKey, getPersistenceFile, getRelationships, getStateScope, initListedEntityTracker, listByNoTracking, listByTimeWindow, listByTrackingTimestamps, 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, getSupportedPropertyDescriptors, 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, migrateProperties, migrateRelationships

Field Details

HOSTNAME

public static final PropertyDescriptor HOSTNAME

UNDEFAULTED_PORT

public static final PropertyDescriptor UNDEFAULTED_PORT

USERNAME

public static final PropertyDescriptor USERNAME

REMOTE_PATH

public static final PropertyDescriptor REMOTE_PATH

FILE_TRANSFER_LISTING_STRATEGY

public static final PropertyDescriptor FILE_TRANSFER_LISTING_STRATEGY

Constructor Details

ListFileTransfer

public ListFileTransfer()

Method Details

createAttributes

protected Map<String,String> createAttributes(FileInfo fileInfo,
 ProcessContext context)

Specified by:

createAttributes in class AbstractListProcessor<FileInfo>

getPath

protected String getPath(ProcessContext context)

Specified by:

getPath in class AbstractListProcessor<FileInfo>

countUnfilteredListing

protected Integer countUnfilteredListing(ProcessContext context)
                                  throws IOException

Specified by:

countUnfilteredListing in class AbstractListProcessor<FileInfo>

Throws:

IOException

performListing

protected List<FileInfo> performListing(ProcessContext context,
 Long minTimestamp,
 AbstractListProcessor.ListingMode listingMode)
                                 throws IOException

Specified by:

performListing in class AbstractListProcessor<FileInfo>

Throws:

IOException

performListing

protected List<FileInfo> performListing(ProcessContext context,
 Long minTimestamp,
 AbstractListProcessor.ListingMode listingMode,
 boolean applyFilters)
                                 throws IOException

Throws:

IOException

getListingContainerName

protected String getListingContainerName(ProcessContext context)

Specified by:

getListingContainerName in class AbstractListProcessor<FileInfo>

getRecordSchema

protected RecordSchema getRecordSchema()

Specified by:

getRecordSchema in class AbstractListProcessor<FileInfo>

isListingResetNecessary

protected boolean isListingResetNecessary(PropertyDescriptor property)

Specified by:

isListingResetNecessary in class AbstractListProcessor<FileInfo>

getFileTransfer

protected abstract FileTransfer getFileTransfer(ProcessContext context)

getProtocolName

protected abstract String getProtocolName()