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

Interface FileTransfer

All Superinterfaces:
AutoCloseable, Closeable
public interface FileTransfer extends Closeable

  • Field Details

    • HOSTNAME

      static final org.apache.nifi.components.PropertyDescriptor HOSTNAME

    • USERNAME

      static final org.apache.nifi.components.PropertyDescriptor USERNAME

    • PASSWORD

      static final org.apache.nifi.components.PropertyDescriptor PASSWORD

    • DATA_TIMEOUT

      static final org.apache.nifi.components.PropertyDescriptor DATA_TIMEOUT

    • CONNECTION_TIMEOUT

      static final org.apache.nifi.components.PropertyDescriptor CONNECTION_TIMEOUT

    • REMOTE_PATH

      static final org.apache.nifi.components.PropertyDescriptor REMOTE_PATH

    • CREATE_DIRECTORY

      static final org.apache.nifi.components.PropertyDescriptor CREATE_DIRECTORY

    • USE_COMPRESSION

      static final org.apache.nifi.components.PropertyDescriptor USE_COMPRESSION

    • FILE_FILTER_REGEX

      static final org.apache.nifi.components.PropertyDescriptor FILE_FILTER_REGEX

    • PATH_FILTER_REGEX

      static final org.apache.nifi.components.PropertyDescriptor PATH_FILTER_REGEX

    • MAX_SELECTS

      static final org.apache.nifi.components.PropertyDescriptor MAX_SELECTS

    • REMOTE_POLL_BATCH_SIZE

      static final org.apache.nifi.components.PropertyDescriptor REMOTE_POLL_BATCH_SIZE

    • DELETE_ORIGINAL

      static final org.apache.nifi.components.PropertyDescriptor DELETE_ORIGINAL

    • POLLING_INTERVAL

      static final org.apache.nifi.components.PropertyDescriptor POLLING_INTERVAL

    • IGNORE_DOTTED_FILES

      static final org.apache.nifi.components.PropertyDescriptor IGNORE_DOTTED_FILES

    • USE_NATURAL_ORDERING

      static final org.apache.nifi.components.PropertyDescriptor USE_NATURAL_ORDERING

    • FILE_MODIFY_DATE_ATTR_FORMAT

      static final String FILE_MODIFY_DATE_ATTR_FORMAT
      See Also:

    • CONFLICT_RESOLUTION_REPLACE

      static final String CONFLICT_RESOLUTION_REPLACE
      See Also:

    • CONFLICT_RESOLUTION_REPLACE_ALLOWABLE

      static final org.apache.nifi.components.AllowableValue CONFLICT_RESOLUTION_REPLACE_ALLOWABLE

    • CONFLICT_RESOLUTION_RENAME

      static final String CONFLICT_RESOLUTION_RENAME
      See Also:

    • CONFLICT_RESOLUTION_RENAME_ALLOWABLE

      static final org.apache.nifi.components.AllowableValue CONFLICT_RESOLUTION_RENAME_ALLOWABLE

    • CONFLICT_RESOLUTION_IGNORE

      static final String CONFLICT_RESOLUTION_IGNORE
      See Also:

    • CONFLICT_RESOLUTION_IGNORE_ALLOWABLE

      static final org.apache.nifi.components.AllowableValue CONFLICT_RESOLUTION_IGNORE_ALLOWABLE

    • CONFLICT_RESOLUTION_REJECT

      static final String CONFLICT_RESOLUTION_REJECT
      See Also:

    • CONFLICT_RESOLUTION_REJECT_ALLOWABLE

      static final org.apache.nifi.components.AllowableValue CONFLICT_RESOLUTION_REJECT_ALLOWABLE

    • CONFLICT_RESOLUTION_FAIL

      static final String CONFLICT_RESOLUTION_FAIL
      See Also:

    • CONFLICT_RESOLUTION_FAIL_ALLOWABLE

      static final org.apache.nifi.components.AllowableValue CONFLICT_RESOLUTION_FAIL_ALLOWABLE

    • CONFLICT_RESOLUTION_NONE

      static final String CONFLICT_RESOLUTION_NONE
      See Also:

    • CONFLICT_RESOLUTION_NONE_ALLOWABLE

      static final org.apache.nifi.components.AllowableValue CONFLICT_RESOLUTION_NONE_ALLOWABLE

    • CONFLICT_RESOLUTION_ALLOWABLE_VALUES

      static final org.apache.nifi.components.AllowableValue[] CONFLICT_RESOLUTION_ALLOWABLE_VALUES

    • CONFLICT_RESOLUTION

      static final org.apache.nifi.components.PropertyDescriptor CONFLICT_RESOLUTION

    • REJECT_ZERO_BYTE

      static final org.apache.nifi.components.PropertyDescriptor REJECT_ZERO_BYTE

    • DOT_RENAME

      static final org.apache.nifi.components.PropertyDescriptor DOT_RENAME

    • TEMP_FILENAME

      static final org.apache.nifi.components.PropertyDescriptor TEMP_FILENAME

    • LAST_MODIFIED_TIME

      static final org.apache.nifi.components.PropertyDescriptor LAST_MODIFIED_TIME

    • PERMISSIONS

      static final org.apache.nifi.components.PropertyDescriptor PERMISSIONS

    • REMOTE_OWNER

      static final org.apache.nifi.components.PropertyDescriptor REMOTE_OWNER

    • REMOTE_GROUP

      static final org.apache.nifi.components.PropertyDescriptor REMOTE_GROUP

    • BATCH_SIZE

      static final org.apache.nifi.components.PropertyDescriptor BATCH_SIZE

  • Method Details

    • getHomeDirectory

      String getHomeDirectory(org.apache.nifi.flowfile.FlowFile flowFile) throws IOException
      Throws:
      IOException

    • getListing

      List<FileInfo> getListing(boolean applyFilters) throws IOException
      Throws:
      IOException

    • getRemoteFile

      org.apache.nifi.flowfile.FlowFile getRemoteFile(String remoteFileName, org.apache.nifi.flowfile.FlowFile flowFile, org.apache.nifi.processor.ProcessSession session) throws org.apache.nifi.processor.exception.ProcessException, IOException
      Throws:
      org.apache.nifi.processor.exception.ProcessException
      IOException

    • getRemoteFileInfo

      FileInfo getRemoteFileInfo(org.apache.nifi.flowfile.FlowFile flowFile, String path, String remoteFileName) throws IOException
      Throws:
      IOException

    • put

      String put(org.apache.nifi.flowfile.FlowFile flowFile, String path, String filename, InputStream content) throws IOException
      Throws:
      IOException

    • rename

      void rename(org.apache.nifi.flowfile.FlowFile flowFile, String source, String target) throws IOException
      Throws:
      IOException

    • deleteFile

      void deleteFile(org.apache.nifi.flowfile.FlowFile flowFile, String path, String remoteFileName) throws IOException
      Throws:
      IOException

    • deleteDirectory

      void deleteDirectory(org.apache.nifi.flowfile.FlowFile flowFile, String remoteDirectoryName) throws IOException
      Throws:
      IOException

    • isClosed

      boolean isClosed()

    • getProtocolName

      String getProtocolName()

    • ensureDirectoryExists

      void ensureDirectoryExists(org.apache.nifi.flowfile.FlowFile flowFile, File remoteDirectory) throws IOException
      Throws:
      IOException

    • getAbsolutePath

      default String getAbsolutePath(org.apache.nifi.flowfile.FlowFile flowFile, String remotePath) throws IOException
      Compute an absolute file path for the given remote path.
      Parameters:
      flowFile - is used to setup file transfer client with its attribute values, to get user home directory
      remotePath - the target remote path
      Returns:
      The absolute path for the given remote path
      Throws:
      IOException