org.ikasan.connector.ftp.outbound

Class FTPConnectionImpl

java.lang.Object

org.ikasan.connector.basefiletransfer.outbound.BaseFileTransferConnectionImpl

org.ikasan.connector.ftp.outbound.FTPConnectionImpl

All Implemented Interfaces:

javax.resource.cci.Connection, BaseFileTransferConnection, TransactionCommitFailureObserverable

public class FTPConnectionImpl
extends BaseFileTransferConnectionImpl

This class implements the virtual connection to the FTP server.
An instance of this class is returned to the clients via the getConnection() method called on
FTPConnectionFactory by the Application Server. All functionality for the FTP virtual connection is defined in the interface and implemented within this class. In reality much of the work is passed onto the FTPManagedConnection as that does the 'physical work' of talking to the FTP Server

Author:

Ikasan Development Team

Field Summary

Fields

Modifier and Type	Field and Description
protected FTPManagedConnection	managedConnection The managed connection, overrides the definition in the EISConnectionImpl so that we don't have to cast back all of the time

Fields inherited from class org.ikasan.connector.basefiletransfer.outbound.BaseFileTransferConnectionImpl

listeners, REFERENCE_PAYLOAD_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
FTPConnectionImpl(FTPManagedConnection mc, FileChunkDao fileChunkDao, BaseFileTransferDao baseFileTransferDao) Constructor which takes ManagedConnection as a parameter

Method Summary

Modifier and Type	Method and Description
void	close() Clients call this to indicate that they have finished with a connection.
void	deliverPayload(Payload payload, String outputDir, Map<String,String> outputTargets, boolean overwrite, String renameExtension, boolean checksumDelivered, boolean unzip, boolean cleanup) Deprecated.
protected ExecutionOutput	executeCommand(TransactionalResourceCommand command, ExecutionContext executionContext) Executes a command with a given ExecutionContext
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 filterOnLastModifiedDate, boolean chronological, boolean isRecursive)
TransactionalCommandConnection	getManagedConnection() getManagedConnection is called by the FTPManagedConnection when the application server wants to re-associate a virtual connection with a new manager.
void	housekeep(int maxRows, int ageOfFiles) TODO Non trivial change but this too can go up one level to BaseFileTransferConnectionImpl
void	setManagedConnection(TransactionalCommandConnection managedConnection) setManagedConnection is called by the FTPManagedConnection when the application server wants to re-associate a virtual connection with a new manager.

Methods inherited from class org.ikasan.connector.basefiletransfer.outbound.BaseFileTransferConnectionImpl

addListener, addListenersToCommand, createInteraction, deliverInputStream, fileChunkHeaderToPayload, getLocalTransaction, getMetaData, getResultSetInfo, isChunkReference

Methods inherited from class java.lang.Object

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

Field Detail

managedConnection

protected FTPManagedConnection managedConnection

The managed connection, overrides the definition in the EISConnectionImpl so that we don't have to cast back all of the time

Constructor Detail

FTPConnectionImpl

public FTPConnectionImpl(FTPManagedConnection mc,
                         FileChunkDao fileChunkDao,
                         BaseFileTransferDao baseFileTransferDao)

Constructor which takes ManagedConnection as a parameter

Parameters:

mc - The ManagedConnection

Method Detail

getManagedConnection

public TransactionalCommandConnection getManagedConnection()

getManagedConnection is called by the FTPManagedConnection when the application server wants to re-associate a virtual connection with a new manager.

setManagedConnection

public void setManagedConnection(TransactionalCommandConnection managedConnection)

setManagedConnection is called by the FTPManagedConnection when the application server wants to re-associate a virtual connection with a new manager.

Parameters:

managedConnection - - The managed connection

close

public void close()

Clients call this to indicate that they have finished with a connection. Of course, we aren't really going to close anything, we will simply indicate to the manager of this virtual connection that it is now defunct.

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 filterOnLastModifiedDate,
                                 boolean chronological,
                                 boolean isRecursive)
                          throws javax.resource.ResourceException

Throws:

javax.resource.ResourceException

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.

Deliver the Payload

Parameters:

payload - - The payload to deliver

outputDir - - The output directory to deliver it to

outputTargets - - The list of output targets to deliver it to

overwrite - - Overwrite flag

renameExtension - - extension for the file rename

checksumDelivered - - Flag to indicate whether we're checksuming the delivery

unzip - - Flag to indicate whether we're unzipping the file

cleanup - - Flag to indicate whether we cleanup the transaction journal

Throws:

javax.resource.ResourceException - - Exception thrown by the FTP connector

executeCommand

protected ExecutionOutput executeCommand(TransactionalResourceCommand command,
                                         ExecutionContext executionContext)
                                  throws javax.resource.ResourceException

Executes a command with a given ExecutionContext

Specified by:

executeCommand in class BaseFileTransferConnectionImpl

Parameters:

command - - The command to execute

executionContext - - The context of execution

Returns:

ExecutionOutput - The output from executing the command

Throws:

javax.resource.ResourceException - - Exception from the FTP connector

housekeep

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

TODO Non trivial change but this too can go up one level to BaseFileTransferConnectionImpl

Parameters:

maxRows - The maximum amount of rows to housekeep

ageOfFiles - The age of the files to housekeep

Throws:

javax.resource.ResourceException - Exception thrown by the FTP Connector