FileProcessor (Toolsverse API Reference 5.9)

Object
- com.toolsverse.io.FileProcessor

All Implemented Interfaces:

IoProcessor, SplitReceiver
```
public class FileProcessor
extends Object
implements IoProcessor, SplitReceiver
```
The local file system implementation of the IoProcessor.

Since:

1.5

Version:

2.0

Field Summary

Fields
Modifier and Type Field and Description

static String FILE
FILE.

static String NAME
NAME.

static String WILDCARD_PROP
The WILDCARD property.
- Fields inherited from interface com.toolsverse.io.IoProcessor
  ALPHA_ALG, BACK_ALPHA_ALG, LARGETS_ALG, NEWEST_ALG, OLDEST_ALG, SMALLEST_ALG

Fields
Modifier and Type	Field and Description
`static String`	`FILE` FILE.
`static String`	`NAME` NAME.
`static String`	`WILDCARD_PROP` The WILDCARD property.

Constructor Summary

Constructors
Constructor and Description

FileProcessor()

Constructors
Constructor and Description
`FileProcessor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`appendPrefix()` Append this prefix at the beginning of the URL if not present.
`boolean`	`batchDelete(String folder, String filename, boolean forceDelete)` Batch delete.
`void`	`connect(String url, String user, String password, boolean passiveMode, String parameters, Object request)` Connects to the remote resource.
`IoStatus`	`copy(IoProcessor processor, String fromFolder, String toFolder, String filename, String toFilename)` Copies fromFolder + filename file to the toFolder + toFilename using provided destination processor.
`boolean`	`delete(String folder, String filename)` Deletes a file folder + filename.
`void`	`disconnect()` Disconnects from the remore resource.
`boolean`	`done()` Executed when IO command is finished.
`void`	`dumpOutput(OutputStream outputStream, String name)` Dumps output stream to the designated destination.
`boolean`	`forceFileExtension()` If true force adding file extension to the name.
`IoStatus`	`get(IoProcessor processor, String fromFolder, String toFolder, String filename)` Copies a file fromFolder + filename to the toFolder + filename using client as a source IoProcessor.
`InputStream`	`get(Object cData)` Gets the InputStream from the cData.
`InputStream`	`get(String fromFolder, String filename)` Copies file fromFolder + filename to the InputStream.
`boolean`	`get(String fromFolder, String toFolder, String filename)` Copies file fromFolder + filename to the toFolder + filename using itself as a source IoProcessor.
`String`	`getActualName(String name)` Gets the actual file name from the passed name.
`List<FileResource>`	`getList(String folder, String filename, boolean includeFolders, int maxFiles)` Gets the list of FileResource objects from the folder + filename.
`String`	`getName()` Get processor name.
`OutputStream`	`getOutputStream(String fileName)` Gets the output stream through which data can be written to store a file.
`String`	`getPropsWizardResource()` Gets the name of the xml file used to create a wizard for editing properties.
`IoProcessor`	`getProxyIoProcessor(String proxyHost, int proxyPort)` Gets the proxy version of the give io processor.
`String`	`getWildcardAlgorithm()` Gets the wildcard algorithm.
`boolean`	`isApi()` Checks if processor is associated with api.
`boolean`	`isDirect()` Checks if processor gets and saves data directly to the alias.
`boolean`	`isFileSystem()` Checks if IoProcessor operates on a local file system.
`boolean`	`isStreamingProcessor()` Checks if this is a streaming processor.
`boolean`	`isTruncateUrl()` Checks if url needs to be truncated (separated from the file name).
`int`	`maxObjectsInBatch()` Maximum number of objects that can be processed in a single call.
`boolean`	`mkDir(String folder)` Creates a folder.
`boolean`	`move(IoProcessor processor, String fromFolder, String toFolder, String filename, String toFilename)` Moves a file fromFolder + filename to the toFolder + filename using processor as a destination IoProcessor.
`boolean`	`preserveUrl()` If true - do not modify the URL when connecting to the resource.
`boolean`	`put(IoProcessor processor, String fromFolder, String toFolder, String filename)` Copies file fromFolder + filename to the toFolder + filename using client as a designation IoProcessor.
`IoStatus`	`put(String toFolder, String filename, InputStream in)` Creates a file toFolder + filename from the InputStream in.
`boolean`	`put(String fromFolder, String toFolder, String filename)` Copies a file fromFolder + filename to the toFolder + toFolder using itself as a destination IoProcessor.
`int`	`rank()` Gets the sorting rank.
`boolean`	`rename(String fromFolder, String toFolder, String filename, String toFilename)` Renames a file fromFolder + filename to toFolder + toFilename.
`boolean`	`supportsCdata()` Checks if IoProcessor supports cdata.
`boolean`	`supportsFiles()` Checks if IoProcessor supports files.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FILE
```
public static final String FILE
```
    FILE.
    
    See Also:
    
    Constant Field Values
  - NAME
```
public static final String NAME
```
    NAME.
    
    See Also:
    
    Constant Field Values
  - WILDCARD_PROP
```
public static final String WILDCARD_PROP
```
    The WILDCARD property.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FileProcessor
```
public FileProcessor()
```
- Method Detail
  - connect
```
public void connect(String url,
                    String user,
                    String password,
                    boolean passiveMode,
                    String parameters,
                    Object request)
             throws Exception
```
    Description copied from interface: IoProcessor
    
    Connects to the remote resource.
    
    Specified by:
    
    connect in interface IoProcessor
    
    Parameters:
    
    url - the url
    
    user - the user
    
    password - the password
    
    passiveMode - the passive mode flag
    
    parameters - the parameters
    
    request - the request
    
    Throws:
    
    Exception - in case of any error
  - getWildcardAlgorithm
```
public String getWildcardAlgorithm()
```
    Description copied from interface: IoProcessor
    
    Gets the wildcard algorithm.
    
    Specified by:
    
    getWildcardAlgorithm in interface IoProcessor
    
    Returns:
    
    the wildcard algorithm
  - copy
```
public IoStatus copy(IoProcessor processor,
                     String fromFolder,
                     String toFolder,
                     String filename,
                     String toFilename)
              throws Exception
```
    Description copied from interface: IoProcessor
    
    Copies fromFolder + filename file to the toFolder + toFilename using provided destination processor. For example it is possible to copy a file from the local files system (FileProcessor) to the FTP (FtpProcessor).
    
    Specified by:
    
    copy in interface IoProcessor
    
    Parameters:
    
    processor - the destination IoProcessor
    
    fromFolder - the from folder
    
    toFolder - the to folder
    
    filename - the filename
    
    toFilename - the to filename
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - delete
```
public boolean delete(String folder,
                      String filename)
               throws Exception
```
    Description copied from interface: IoProcessor
    
    Deletes a file folder + filename.
    
    Specified by:
    
    delete in interface IoProcessor
    
    Parameters:
    
    folder - the folder
    
    filename - the filename
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - disconnect
```
public void disconnect()
```
    Description copied from interface: IoProcessor
    
    Disconnects from the remore resource.
    
    Specified by:
    
    disconnect in interface IoProcessor
  - done
```
public boolean done()
             throws Exception
```
    Description copied from interface: IoProcessor
    
    Executed when IO command is finished.
    
    Specified by:
    
    done in interface IoProcessor
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - dumpOutput
```
public void dumpOutput(OutputStream outputStream,
                       String name)
                throws Exception
```
    Description copied from interface: IoProcessor
    
    Dumps output stream to the designated destination. For example http connector can send object represented by outputStream to the server using put method
    
    Specified by:
    
    dumpOutput in interface IoProcessor
    
    Parameters:
    
    outputStream - the output stream
    
    name - the dataset name
    
    Throws:
    
    Exception - the exception
  - get
```
public IoStatus get(IoProcessor processor,
                    String fromFolder,
                    String toFolder,
                    String filename)
             throws Exception
```
    Description copied from interface: IoProcessor
    
    Copies a file fromFolder + filename to the toFolder + filename using client as a source IoProcessor.
    
    Specified by:
    
    get in interface IoProcessor
    
    Parameters:
    
    processor - the source IoProcessor
    
    fromFolder - the from folder
    
    toFolder - the to folder
    
    filename - the filename
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - get
```
public InputStream get(String fromFolder,
                       String filename)
                throws Exception
```
    Description copied from interface: IoProcessor
    
    Copies file fromFolder + filename to the InputStream.
    
    Specified by:
    
    get in interface IoProcessor
    
    Parameters:
    
    fromFolder - the from folder
    
    filename - the filename
    
    Returns:
    
    the InputStream
    
    Throws:
    
    Exception - in case of any error
  - get
```
public boolean get(String fromFolder,
                   String toFolder,
                   String filename)
            throws Exception
```
    Description copied from interface: IoProcessor
    
    Copies file fromFolder + filename to the toFolder + filename using itself as a source IoProcessor.
    
    Specified by:
    
    get in interface IoProcessor
    
    Parameters:
    
    fromFolder - the from folder
    
    toFolder - the to folder
    
    filename - the filename
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - getList
```
public List<FileResource> getList(String folder,
                                  String filename,
                                  boolean includeFolders,
                                  int maxFiles)
                           throws Exception
```
    Description copied from interface: IoProcessor
    
    Gets the list of FileResource objects from the folder + filename. filename can be a mask, for example: /usr/test/*.txt. If includeFolders == true recursively includes sub-folders.
    
    Specified by:
    
    getList in interface IoProcessor
    
    Parameters:
    
    folder - the folder
    
    filename - the filename
    
    includeFolders - the include folders flag. If equals to true recursively includes sub-folders
    
    maxFiles - the maximum number of files
    
    Returns:
    
    the list of FileResource objects
    
    Throws:
    
    Exception - in case of any error
    
    See Also:
    
    FileResource
  - getName
```
public String getName()
```
    Description copied from interface: IoProcessor
    
    Get processor name.
    
    Specified by:
    
    getName in interface IoProcessor
    
    Returns:
    
    the processor name
  - getOutputStream
```
public OutputStream getOutputStream(String fileName)
                             throws Exception
```
    Description copied from interface: IoProcessor
    
    Gets the output stream through which data can be written to store a file.
    
    Specified by:
    
    getOutputStream in interface IoProcessor
    
    Parameters:
    
    fileName - the file name
    
    Returns:
    
    the output stream
    
    Throws:
    
    Exception - the exception
  - getPropsWizardResource
```
public String getPropsWizardResource()
```
    Description copied from interface: IoProcessor
    
    Gets the name of the xml file used to create a wizard for editing properties.
    
    Specified by:
    
    getPropsWizardResource in interface IoProcessor
    
    Returns:
    
    the name of the xml file
  - getProxyIoProcessor
```
public IoProcessor getProxyIoProcessor(String proxyHost,
                                       int proxyPort)
```
    Description copied from interface: IoProcessor
    
    Gets the proxy version of the give io processor.
    
    Specified by:
    
    getProxyIoProcessor in interface IoProcessor
    
    Parameters:
    
    proxyHost - the proxy url
    
    proxyPort - the proxy port
    
    Returns:
    
    the proxy io processor
  - isFileSystem
```
public boolean isFileSystem()
```
    Description copied from interface: IoProcessor
    
    Checks if IoProcessor operates on a local file system.
    
    Specified by:
    
    isFileSystem in interface IoProcessor
    
    Returns:
    
    true, if IoProcessor operates on a local file system
  - isTruncateUrl
```
public boolean isTruncateUrl()
```
    Description copied from interface: IoProcessor
    
    Checks if url needs to be truncated (separated from the file name).
    
    Specified by:
    
    isTruncateUrl in interface IoProcessor
    
    Returns:
    
    true, if url needs to be truncated
  - mkDir
```
public boolean mkDir(String folder)
              throws Exception
```
    Description copied from interface: IoProcessor
    
    Creates a folder.
    
    Specified by:
    
    mkDir in interface IoProcessor
    
    Parameters:
    
    folder - the folder to create
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - move
```
public boolean move(IoProcessor processor,
                    String fromFolder,
                    String toFolder,
                    String filename,
                    String toFilename)
             throws Exception
```
    Description copied from interface: IoProcessor
    
    Moves a file fromFolder + filename to the toFolder + filename using processor as a destination IoProcessor.
    
    Specified by:
    
    move in interface IoProcessor
    
    Parameters:
    
    processor - the destination IoProcessor
    
    fromFolder - the from folder
    
    toFolder - the to folder
    
    filename - the filename
    
    toFilename - the to filename
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - put
```
public boolean put(IoProcessor processor,
                   String fromFolder,
                   String toFolder,
                   String filename)
            throws Exception
```
    Description copied from interface: IoProcessor
    
    Copies file fromFolder + filename to the toFolder + filename using client as a designation IoProcessor.
    
    Specified by:
    
    put in interface IoProcessor
    
    Parameters:
    
    processor - the designation IoProcessor
    
    fromFolder - the from folder
    
    toFolder - the to folder
    
    filename - the filename
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - put
```
public IoStatus put(String toFolder,
                    String filename,
                    InputStream in)
             throws Exception
```
    Description copied from interface: IoProcessor
    
    Creates a file toFolder + filename from the InputStream in.
    
    Specified by:
    
    put in interface IoProcessor
    
    Parameters:
    
    toFolder - the to folder
    
    filename - the filename
    
    in - the InputStream
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - put
```
public boolean put(String fromFolder,
                   String toFolder,
                   String filename)
            throws Exception
```
    Description copied from interface: IoProcessor
    
    Copies a file fromFolder + filename to the toFolder + toFolder using itself as a destination IoProcessor.
    
    Specified by:
    
    put in interface IoProcessor
    
    Parameters:
    
    fromFolder - the from folder
    
    toFolder - the to folder
    
    filename - the filename
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - rank
```
public int rank()
```
    Description copied from interface: IoProcessor
    
    Gets the sorting rank. Lower ranks appear on top of the list. Default ranks: 0 - file, 1 - ftp, 2 - sftp. Use ranks > 2 for plugin io processors.
    
    Specified by:
    
    rank in interface IoProcessor
    
    Returns:
    
    the sorting rank
  - rename
```
public boolean rename(String fromFolder,
                      String toFolder,
                      String filename,
                      String toFilename)
               throws Exception
```
    Description copied from interface: IoProcessor
    
    Renames a file fromFolder + filename to toFolder + toFilename.
    
    Specified by:
    
    rename in interface IoProcessor
    
    Parameters:
    
    fromFolder - the from folder
    
    toFolder - the to folder
    
    filename - the filename
    
    toFilename - the to filename
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - supportsCdata
```
public boolean supportsCdata()
```
    Description copied from interface: IoProcessor
    
    Checks if IoProcessor supports cdata. Can be used for SOAP requests to attach XML to the request body
    
    Specified by:
    
    supportsCdata in interface IoProcessor
    
    Returns:
    
    true, IoProcessor supports cdata
  - supportsFiles
```
public boolean supportsFiles()
```
    Description copied from interface: IoProcessor
    
    Checks if IoProcessor supports files.
    
    Specified by:
    
    supportsFiles in interface IoProcessor
    
    Returns:
    
    true, if IoProcessor supports files
  - isDirect
```
public boolean isDirect()
```
    Description copied from interface: IoProcessor
    
    Checks if processor gets and saves data directly to the alias.
    
    Specified by:
    
    isDirect in interface IoProcessor
    
    Returns:
    
    true, if processor gets and saves data directly to the alias
  - get
```
public InputStream get(Object cData)
```
    Description copied from interface: IoProcessor
    
    Gets the InputStream from the cData.
    
    Specified by:
    
    get in interface IoProcessor
    
    Parameters:
    
    cData - the cdata
    
    Returns:
    
    the InputStream
  - forceFileExtension
```
public boolean forceFileExtension()
```
    Description copied from interface: IoProcessor
    
    If true force adding file extension to the name.
    
    Specified by:
    
    forceFileExtension in interface IoProcessor
    
    Returns:
    
    true, if processor will be forcing adding file extension to the name.
  - getActualName
```
public String getActualName(String name)
```
    Description copied from interface: IoProcessor
    
    Gets the actual file name from the passed name. Most processors returns null, except mail.
    
    Specified by:
    
    getActualName in interface IoProcessor
    
    Parameters:
    
    name - String
    
    Returns:
    
    the actual file name
  - isApi
```
public boolean isApi()
```
    Description copied from interface: IoProcessor
    
    Checks if processor is associated with api.
    
    Specified by:
    
    isApi in interface IoProcessor
    
    Returns:
    
    true, if is api
  - maxObjectsInBatch
```
public int maxObjectsInBatch()
```
    Description copied from interface: IoProcessor
    
    Maximum number of objects that can be processed in a single call.
    
    Specified by:
    
    maxObjectsInBatch in interface IoProcessor
    
    Returns:
    
    the int
  - batchDelete
```
public boolean batchDelete(String folder,
                           String filename,
                           boolean forceDelete)
                    throws Exception
```
    Description copied from interface: IoProcessor
    
    Batch delete.
    
    Specified by:
    
    batchDelete in interface IoProcessor
    
    Parameters:
    
    folder - the folder
    
    filename - the filename
    
    forceDelete - if true force the delete
    
    Returns:
    
    true, if successful
    
    Throws:
    
    Exception - in case of any error
  - isStreamingProcessor
```
public boolean isStreamingProcessor()
```
    Description copied from interface: IoProcessor
    
    Checks if this is a streaming processor.
    
    Specified by:
    
    isStreamingProcessor in interface IoProcessor
    
    Returns:
    
    true, if this is streaming processor
  - appendPrefix
```
public String appendPrefix()
```
    Description copied from interface: IoProcessor
    
    Append this prefix at the beginning of the URL if not present.
    
    Specified by:
    
    appendPrefix in interface IoProcessor
    
    Returns:
    
    the string
  - preserveUrl
```
public boolean preserveUrl()
```
    Description copied from interface: IoProcessor
    
    If true - do not modify the URL when connecting to the resource.
    
    Specified by:
    
    preserveUrl in interface IoProcessor
    
    Returns:
    
    true, if system should not be modifying the URL when connecting to the resource

Class FileProcessor

Field Summary

Fields inherited from interface com.toolsverse.io.IoProcessor

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

FILE

NAME

WILDCARD_PROP

Constructor Detail

FileProcessor

Method Detail

connect

getWildcardAlgorithm

copy

delete

disconnect

done

dumpOutput

get

get

get

getList

getName

getOutputStream

getPropsWizardResource

getProxyIoProcessor

isFileSystem

isTruncateUrl

mkDir

move

put

put

put

rank

rename

supportsCdata

supportsFiles

isDirect

get

forceFileExtension

getActualName

isApi

maxObjectsInBatch

batchDelete

isStreamingProcessor

appendPrefix

preserveUrl