org.apache.nifi.processors.standard

Class ListenFTP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.standard.ListenFTP

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"ingest","FTP","FTPS","listen"})
 @CapabilityDescription(value="Starts an FTP server that listens on the specified port and transforms incoming files into FlowFiles. The URI of the service will be ftp://{hostname}:{port}. The default port is 2221.")
 @WritesAttribute(attribute="filename",description="The name of the file received via the FTP/FTPS connection.") @WritesAttribute(attribute="path",description="The path pointing to the file\'s target directory. E.g.: file.txt is uploaded to /Folder1/SubFolder, then the value of the path attribute will be \"/Folder1/SubFolder/\" (note that it ends with a separator character).")
public class ListenFTP
extends AbstractSessionFactoryProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	BIND_ADDRESS
private FtpServer	ftpServer
static PropertyDescriptor	PASSWORD
static PropertyDescriptor	PORT
private static List<PropertyDescriptor>	PROPERTIES
static Relationship	RELATIONSHIP_SUCCESS
private static Set<Relationship>	RELATIONSHIPS
private AtomicReference<ProcessSessionFactory>	sessionFactory
private CountDownLatch	sessionFactorySetSignal
static PropertyDescriptor	SSL_CONTEXT_SERVICE
static PropertyDescriptor	USERNAME

Constructor Summary

Constructors

Constructor and Description
ListenFTP()

Method Summary

Modifier and Type	Method and Description
private ValidationResult	createValidationResult(String subject, String explanation)
protected Collection<ValidationResult>	customValidate(ValidationContext context)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory)
void	startFtpServer(ProcessContext context)
void	stopFtpServer()
private ValidationResult	usernameOrPasswordIsNull(PropertyDescriptor nullProperty)
private void	validateBindAddress(ValidationContext context, Collection<ValidationResult> validationResults)
private void	validateUsernameAndPassword(ValidationContext context, Collection<ValidationResult> validationResults)

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, onPropertyModified, validate

Methods inherited from class java.lang.Object

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

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

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

RELATIONSHIP_SUCCESS

public static final Relationship RELATIONSHIP_SUCCESS

BIND_ADDRESS

public static final PropertyDescriptor BIND_ADDRESS

PORT

public static final PropertyDescriptor PORT

USERNAME

public static final PropertyDescriptor USERNAME

PASSWORD

public static final PropertyDescriptor PASSWORD

PROPERTIES

private static final List<PropertyDescriptor> PROPERTIES

RELATIONSHIPS

private static final Set<Relationship> RELATIONSHIPS

ftpServer

private volatile FtpServer ftpServer

sessionFactorySetSignal

private volatile CountDownLatch sessionFactorySetSignal

sessionFactory

private final AtomicReference<ProcessSessionFactory> sessionFactory

Constructor Detail

ListenFTP

public ListenFTP()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

startFtpServer

@OnScheduled
public void startFtpServer(ProcessContext context)

stopFtpServer

@OnStopped
public void stopFtpServer()

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSessionFactory sessionFactory)
               throws ProcessException

Throws:

ProcessException

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

validateUsernameAndPassword

private void validateUsernameAndPassword(ValidationContext context,
                                         Collection<ValidationResult> validationResults)

validateBindAddress

private void validateBindAddress(ValidationContext context,
                                 Collection<ValidationResult> validationResults)

usernameOrPasswordIsNull

private ValidationResult usernameOrPasswordIsNull(PropertyDescriptor nullProperty)

createValidationResult

private ValidationResult createValidationResult(String subject,
                                                String explanation)