org.apache.nifi.processors.standard

Class PutFTP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.PutFileTransfer<FTPTransfer>

org.apache.nifi.processors.standard.PutFTP

All Implemented Interfaces:

ConfigurableComponent, Processor

@SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"remote","copy","egress","put","ftp","archive","files"})
 @CapabilityDescription(value="Sends FlowFiles to an FTP Server")
 @SeeAlso(value=GetFTP.class)
 @DynamicProperty(name="pre.cmd._____",value="Not used",description="The command specified in the key will be executed before doing a put.  You may add these optional properties  to send any commands to the FTP server before the file is actually transferred (before the put command). This option is only available for the PutFTP processor, as only FTP has this functionality. This is essentially the same as sending quote commands to an FTP server from the command line.  While this is the same as sending a quote command, it is very important that you leave off the .") @DynamicProperty(name="post.cmd._____",value="Not used",description="The command specified in the key will be executed after doing a put.  You may add these optional properties  to send any commands to the FTP server before the file is actually transferred (before the put command). This option is only available for the PutFTP processor, as only FTP has this functionality. This is essentially the same as sending quote commands to an FTP server from the command line.  While this is the same as sending a quote command, it is very important that you leave off the .")
public class PutFTP
extends PutFileTransfer<FTPTransfer>

Field Summary

Fields

Modifier and Type	Field and Description
private static Pattern	POST_SEND_CMD_PATTERN
private AtomicReference<List<PropertyDescriptor>>	postSendDescriptorRef
private static Pattern	PRE_SEND_CMD_PATTERN
private AtomicReference<List<PropertyDescriptor>>	preSendDescriptorRef
private List<PropertyDescriptor>	properties
static PropertyDescriptor	REMOTE_PATH

Fields inherited from class org.apache.nifi.processors.standard.PutFileTransfer

REL_FAILURE, REL_REJECT, REL_SUCCESS

Constructor Summary

Constructors

Constructor and Description
PutFTP()

Method Summary

Modifier and Type	Method and Description
protected void	afterPut(FlowFile flowFile, ProcessContext context, FTPTransfer transfer)
protected void	beforePut(FlowFile flowFile, ProcessContext context, FTPTransfer transfer)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
void	determinePrePostSendProperties(ProcessContext context)
private List<String>	getCommands(List<PropertyDescriptor> descriptors, ProcessContext context, FlowFile flowFile)
protected FTPTransfer	getFileTransfer(ProcessContext context)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)

Methods inherited from class org.apache.nifi.processors.standard.PutFileTransfer

getRelationships, onTrigger

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

onTrigger

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

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

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

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

PRE_SEND_CMD_PATTERN

private static final Pattern PRE_SEND_CMD_PATTERN

POST_SEND_CMD_PATTERN

private static final Pattern POST_SEND_CMD_PATTERN

preSendDescriptorRef

private final AtomicReference<List<PropertyDescriptor>> preSendDescriptorRef

postSendDescriptorRef

private final AtomicReference<List<PropertyDescriptor>> postSendDescriptorRef

properties

private List<PropertyDescriptor> properties

REMOTE_PATH

public static final PropertyDescriptor REMOTE_PATH

Constructor Detail

PutFTP

public PutFTP()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

beforePut

protected void beforePut(FlowFile flowFile,
                         ProcessContext context,
                         FTPTransfer transfer)
                  throws IOException

Overrides:

beforePut in class PutFileTransfer<FTPTransfer>

Throws:

IOException

afterPut

protected void afterPut(FlowFile flowFile,
                        ProcessContext context,
                        FTPTransfer transfer)
                 throws IOException

Overrides:

afterPut in class PutFileTransfer<FTPTransfer>

Throws:

IOException

getFileTransfer

protected FTPTransfer getFileTransfer(ProcessContext context)

Specified by:

getFileTransfer in class PutFileTransfer<FTPTransfer>

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

determinePrePostSendProperties

@OnScheduled
public void determinePrePostSendProperties(ProcessContext context)

getCommands

private List<String> getCommands(List<PropertyDescriptor> descriptors,
                                 ProcessContext context,
                                 FlowFile flowFile)

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent