com.toolsverse.io

Interface IoProcessor

All Known Implementing Classes:

DirectProcessor, FileProcessor, FtpProcessor, FtpsProcessor, HttpProcessor, MailProcessor, NullProcessor, SftpProcessor

public interface IoProcessor

The collection of basic IO methods, such as connect, copy, delete, mkdir, etc. The particular implementations of this interface are: FileProcessor, FtpProcessor and SftpProcessor.

Since:

2.0

Version:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALPHA_ALG
static String	BACK_ALPHA_ALG
static String	LARGETS_ALG
static String	NEWEST_ALG
static String	OLDEST_ALG
static String	SMALLEST_ALG

Method Summary

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 params, 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 client, 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 proxyUrl, 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 client, 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.

Field Detail

OLDEST_ALG

static final String OLDEST_ALG

See Also:

Constant Field Values

NEWEST_ALG

static final String NEWEST_ALG

See Also:

Constant Field Values

ALPHA_ALG

static final String ALPHA_ALG

See Also:

Constant Field Values

BACK_ALPHA_ALG

static final String BACK_ALPHA_ALG

See Also:

Constant Field Values

LARGETS_ALG

static final String LARGETS_ALG

See Also:

Constant Field Values

SMALLEST_ALG

static final String SMALLEST_ALG

See Also:

Constant Field Values

Method Detail

connect

void connect(String url,
             String user,
             String password,
             boolean passiveMode,
             String params,
             Object request)
      throws Exception

Connects to the remote resource.

Parameters:

url - the url

user - the user

password - the password

passiveMode - the passive mode flag

params - the parameters

request - the request

Throws:

Exception - in case of any error

copy

IoStatus copy(IoProcessor processor,
              String fromFolder,
              String toFolder,
              String filename,
              String toFilename)
       throws Exception

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).

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

boolean delete(String folder,
               String filename)
        throws Exception

Deletes a file folder + filename.

Parameters:

folder - the folder

filename - the filename

Returns:

true, if successful

Throws:

Exception - in case of any error

disconnect

void disconnect()

Disconnects from the remore resource.

done

boolean done()
      throws Exception

Executed when IO command is finished.

Returns:

true, if successful

Throws:

Exception - in case of any error

dumpOutput

void dumpOutput(OutputStream outputStream,
                String name)
         throws Exception

Dumps output stream to the designated destination. For example http connector can send object represented by outputStream to the server using put method

Parameters:

outputStream - the output stream

name - the dataset name

Throws:

Exception - the exception

get

IoStatus get(IoProcessor client,
             String fromFolder,
             String toFolder,
             String filename)
      throws Exception

Copies a file fromFolder + filename to the toFolder + filename using client as a source IoProcessor.

Parameters:

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

InputStream get(String fromFolder,
                String filename)
         throws Exception

Copies file fromFolder + filename to the InputStream.

Parameters:

fromFolder - the from folder

filename - the filename

Returns:

the InputStream

Throws:

Exception - in case of any error

get

boolean get(String fromFolder,
            String toFolder,
            String filename)
     throws Exception

Copies file fromFolder + filename to the toFolder + filename using itself as a source 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

List<FileResource> getList(String folder,
                           String filename,
                           boolean includeFolders,
                           int maxFiles)
                    throws Exception

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.

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

String getName()

Get processor name.

Returns:

the processor name

getOutputStream

OutputStream getOutputStream(String fileName)
                      throws Exception

Gets the output stream through which data can be written to store a file.

Parameters:

fileName - the file name

Returns:

the output stream

Throws:

Exception - the exception

getPropsWizardResource

String getPropsWizardResource()

Gets the name of the xml file used to create a wizard for editing properties.

Returns:

the name of the xml file

getProxyIoProcessor

IoProcessor getProxyIoProcessor(String proxyUrl,
                                int proxyPort)

Gets the proxy version of the give io processor.

Parameters:

proxyUrl - the proxy url

proxyPort - the proxy port

Returns:

the proxy io processor

isFileSystem

boolean isFileSystem()

Checks if IoProcessor operates on a local file system.

Returns:

true, if IoProcessor operates on a local file system

isTruncateUrl

boolean isTruncateUrl()

Checks if url needs to be truncated (separated from the file name).

Returns:

true, if url needs to be truncated

mkDir

boolean mkDir(String folder)
       throws Exception

Creates a folder.

Parameters:

folder - the folder to create

Returns:

true, if successful

Throws:

Exception - in case of any error

move

boolean move(IoProcessor processor,
             String fromFolder,
             String toFolder,
             String filename,
             String toFilename)
      throws Exception

Moves a file fromFolder + filename to the toFolder + filename using processor as a destination 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

boolean put(IoProcessor client,
            String fromFolder,
            String toFolder,
            String filename)
     throws Exception

Copies file fromFolder + filename to the toFolder + filename using client as a designation IoProcessor.

Parameters:

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

IoStatus put(String toFolder,
             String filename,
             InputStream in)
      throws Exception

Creates a file toFolder + filename from the InputStream in.

Parameters:

toFolder - the to folder

filename - the filename

in - the InputStream

Returns:

true, if successful

Throws:

Exception - in case of any error

put

boolean put(String fromFolder,
            String toFolder,
            String filename)
     throws Exception

Copies a file fromFolder + filename to the toFolder + toFolder using itself as a destination 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

int rank()

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.

Returns:

the sorting rank

rename

boolean rename(String fromFolder,
               String toFolder,
               String filename,
               String toFilename)
        throws Exception

Renames a file fromFolder + filename to toFolder + toFilename.

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

boolean supportsCdata()

Checks if IoProcessor supports cdata. Can be used for SOAP requests to attach XML to the request body

Returns:

true, IoProcessor supports cdata

supportsFiles

boolean supportsFiles()

Checks if IoProcessor supports files.

Returns:

true, if IoProcessor supports files

getWildcardAlgorithm

String getWildcardAlgorithm()

Gets the wildcard algorithm.

Returns:

the wildcard algorithm

isDirect

boolean isDirect()

Checks if processor gets and saves data directly to the alias.

Returns:

true, if processor gets and saves data directly to the alias

get

InputStream get(Object cData)
         throws Exception

Gets the InputStream from the cData.

Parameters:

cData - the cdata

Returns:

the InputStream

Throws:

Exception

forceFileExtension

boolean forceFileExtension()

If true force adding file extension to the name.

Returns:

true, if processor will be forcing adding file extension to the name.

getActualName

String getActualName(String name)

Gets the actual file name from the passed name. Most processors returns null, except mail.

Parameters:

name - String

Returns:

the actual file name

isApi

boolean isApi()

Checks if processor is associated with api.

Returns:

true, if is api

maxObjectsInBatch

int maxObjectsInBatch()

Maximum number of objects that can be processed in a single call.

Returns:

the int

batchDelete

boolean batchDelete(String folder,
                    String filename,
                    boolean forceDelete)
             throws Exception

Batch delete.

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

boolean isStreamingProcessor()

Checks if this is a streaming processor.

Returns:

true, if this is streaming processor

appendPrefix

String appendPrefix()

Append this prefix at the beginning of the URL if not present.

Returns:

the string

preserveUrl

boolean preserveUrl()

If true - do not modify the URL when connecting to the resource.

Returns:

true, if system should not be modifying the URL when connecting to the resource