org.ikasan.endpoint.ftp

Class FileTransferConnectionTemplate

java.lang.Object

org.ikasan.endpoint.ftp.FileTransferConnectionTemplate

All Implemented Interfaces:

TransactionCommitFailureObserverable

public class FileTransferConnectionTemplate
extends Object
implements TransactionCommitFailureObserverable

Test the FileTRansferConnectionTempalte class

Author:

Ikasan Development Team

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TransactionCommitFailureListener>	listeners

Constructor Summary

Constructors

Constructor and Description
FileTransferConnectionTemplate(javax.resource.cci.ConnectionSpec connectionSpec, TransactionalResourceCommandDAO transactionalResourceCommandDAO, FileChunkDao fileChunkDao, BaseFileTransferDao baseFileTransferDao, org.springframework.transaction.jta.JtaTransactionManager transactionManager) Constructor

Method Summary

Modifier and Type	Method and Description
void	addListener(TransactionCommitFailureListener listener)
protected void	addListenersToConnection(BaseFileTransferConnection connection) Helper method to add the listeners to the connection.
static void	closeConnection(javax.resource.cci.Connection connection) Closes the connection, suppressing any exceptions
void	deliverInputStream(InputStream inputStream, String fileName, String outputDir, boolean overwrite, String renameExtension, boolean checksumDelivered, boolean unzip, boolean createParentDirectory, String tempFileName) Delivering an InputStream
void	deliverPayload(Payload payload, String outputDir, Map<String,String> outputTargets, boolean overwrite, String renameExtension, boolean checksumDelivered, boolean unzip, boolean cleanup) Deprecated. - use deliverInputStream
Object	execute(ConnectionCallback action) Execute the action specified by the given action object with a Connection.
Payload	getDiscoveredFile(String sourceDir, String filenamePattern, boolean renameOnSuccess, String renameOnSuccessExtension, boolean moveOnSuccess, String moveOnSuccessNewPath, boolean chunking, int chunkSize, boolean checksum, long minAge, boolean destructive, boolean filterDuplicates, boolean filterOnFilename, boolean filterOnLastModifedDate, boolean chronological, boolean isRecursive) Test the getDiscoveredFile
protected TransactionJournal	getTransactionJournal(TransactionalResourceCommandDAO transactionalResourceCommandDAO, FileChunkDao fileChunkDao) Lazily instantiates the TransactionJournal
void	housekeep(int maxRows, int ageOfFiles) Housekeep the FileFilter table

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

listeners

protected List<TransactionCommitFailureListener> listeners

Constructor Detail

FileTransferConnectionTemplate

public FileTransferConnectionTemplate(javax.resource.cci.ConnectionSpec connectionSpec,
                                      TransactionalResourceCommandDAO transactionalResourceCommandDAO,
                                      FileChunkDao fileChunkDao,
                                      BaseFileTransferDao baseFileTransferDao,
                                      org.springframework.transaction.jta.JtaTransactionManager transactionManager)
                               throws javax.resource.ResourceException

Constructor

Parameters:

connectionSpec - - THe connection spec

Throws:

javax.resource.ResourceException

Method Detail

deliverPayload

public void deliverPayload(Payload payload,
                           String outputDir,
                           Map<String,String> outputTargets,
                           boolean overwrite,
                           String renameExtension,
                           boolean checksumDelivered,
                           boolean unzip,
                           boolean cleanup)
                    throws javax.resource.ResourceException

Deprecated. - use deliverInputStream

Test Delivering a payload

Parameters:

payload - - The payload to deliver

outputDir - - The directory to place the file in

outputTargets - - The Map of targets to deliver the file to

overwrite - - Overwrite existing files flag

renameExtension - - The extension for the temp file rename

checksumDelivered - - Flag for whether we perform checksumming

unzip - - Flag for whether we unzip the delivered file

cleanup - - Cleanup txn journal flag

Throws:

javax.resource.ResourceException - - Exception if JCA connector fails

deliverInputStream

public void deliverInputStream(InputStream inputStream,
                               String fileName,
                               String outputDir,
                               boolean overwrite,
                               String renameExtension,
                               boolean checksumDelivered,
                               boolean unzip,
                               boolean createParentDirectory,
                               String tempFileName)
                        throws javax.resource.ResourceException

Delivering an InputStream

Parameters:

inputStream - - The 'file'

fileName - - The name of the file

outputDir - - The directory to place the file in

overwrite - - Overwrite existing files flag

renameExtension - - The extension for the temp file rename

checksumDelivered - - Flag for whether we perform checksumming

unzip - - Flag for whether we unzip the delivered file

createParentDirectory - -

tempFileName - -

Throws:

javax.resource.ResourceException - - Exception if JCA connector fails

getDiscoveredFile

public Payload getDiscoveredFile(String sourceDir,
                                 String filenamePattern,
                                 boolean renameOnSuccess,
                                 String renameOnSuccessExtension,
                                 boolean moveOnSuccess,
                                 String moveOnSuccessNewPath,
                                 boolean chunking,
                                 int chunkSize,
                                 boolean checksum,
                                 long minAge,
                                 boolean destructive,
                                 boolean filterDuplicates,
                                 boolean filterOnFilename,
                                 boolean filterOnLastModifedDate,
                                 boolean chronological,
                                 boolean isRecursive)
                          throws javax.resource.ResourceException

Test the getDiscoveredFile

Parameters:

sourceDir - - The directory to get the file from

filenamePattern - - The pattern to search on

renameOnSuccess - - Whether we rename a file on successful delivery

renameOnSuccessExtension - - The extension to rename to

moveOnSuccess - - Whether we move the file on successful delivery

moveOnSuccessNewPath - - Where we move the file to

chunking - - Whether we are chunking enabled

chunkSize - - The size of the chunks

checksum - - Whether we checksum the pickup

minAge - - The minimum age the file has to be in order to be picked up

destructive - - Whether we pick up destructively

filterDuplicates - - Whether we filter duplicates

filterOnFilename - - Whether we filter duplicates based on file name

filterOnLastModifedDate - - Whether we filter duplicates based on file name

chronological - - Whether we pickup files in age order

isRecursive - - Whether we pickup files and all subdirectories

Returns:

The discovered file as a Payload

Throws:

javax.resource.ResourceException - - Exception if the JCA connector fails

housekeep

public void housekeep(int maxRows,
                      int ageOfFiles)
               throws javax.resource.ResourceException

Housekeep the FileFilter table

Parameters:

maxRows - Max rows the housekeeper will deal with

ageOfFiles - How old the files have to be in days to be considered for housekeeping

Throws:

javax.resource.ResourceException - - Exception if JCA connector fails

addListenersToConnection

protected void addListenersToConnection(BaseFileTransferConnection connection)

Helper method to add the listeners to the connection.

Parameters:

connection -

addListener

public void addListener(TransactionCommitFailureListener listener)

Specified by:

addListener in interface TransactionCommitFailureObserverable

execute

public Object execute(ConnectionCallback action)
               throws javax.resource.ResourceException

Execute the action specified by the given action object with a Connection.

Parameters:

action - callback object that exposes the Connection

Returns:

the result object from working with the Connection

Throws:

javax.resource.ResourceException - if there is any problem

closeConnection

public static void closeConnection(javax.resource.cci.Connection connection)

Closes the connection, suppressing any exceptions

Parameters:

connection - - possibly null, not necessarily open

getTransactionJournal

protected TransactionJournal getTransactionJournal(TransactionalResourceCommandDAO transactionalResourceCommandDAO,
                                                   FileChunkDao fileChunkDao)

Lazily instantiates the TransactionJournal

Returns:

TransactionJournal