org.ikasan.connector.basefiletransfer.outbound

Class BaseFileTransferConnectionImpl

java.lang.Object

org.ikasan.connector.base.outbound.EISConnectionImpl

org.ikasan.connector.basefiletransfer.outbound.BaseFileTransferConnectionImpl

All Implemented Interfaces:

javax.resource.cci.Connection, EISConnection, TransactionCommitFailureObserverable

public abstract class BaseFileTransferConnectionImpl
extends EISConnectionImpl
implements TransactionCommitFailureObserverable

A Base implementation for File transfer connections

Author:

Ikasan Development Team

Field Summary

Fields

Modifier and Type	Field and Description
protected List<TransactionCommitFailureListener>	listeners
protected static String	REFERENCE_PAYLOAD_ATTRIBUTE

Fields inherited from class org.ikasan.connector.base.outbound.EISConnectionImpl

managedConnection

Constructor Summary

Constructors

Constructor and Description
BaseFileTransferConnectionImpl(javax.resource.spi.ManagedConnection mc) Constructor which takes ManagedConnection as a parameter

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(TransactionCommitFailureListener listener)
protected void	addListenersToCommand(TransactionalResourceCommand command)
void	deliverInputStream(InputStream inputStream, String fileName, String outputDir, boolean overwrite, String renameExtension, boolean checksumDelivered, boolean unzip, boolean createParentDirectory, String tempFileName) Deliver the InputStream TODO Add in the checksumDelivered feature
protected abstract ExecutionOutput	executeCommand(TransactionalResourceCommand deliveryCommand, ExecutionContext executionContext) Execute the command
protected Payload	fileChunkHeaderToPayload(FileChunkHeader header) Method used to map an FTPMappedRecord object to a Payload object.
protected boolean	isChunkReference(Payload payload) Determines if we need to handle this as a chunk reference

Methods inherited from class org.ikasan.connector.base.outbound.EISConnectionImpl

close, createInteraction, getAutoCommit, getConnectionState, getLocalTransaction, getMetaData, getResultSetInfo, invalidate, setAutoCommit, setManager, validate

Methods inherited from class java.lang.Object

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

Field Detail

REFERENCE_PAYLOAD_ATTRIBUTE

protected static final String REFERENCE_PAYLOAD_ATTRIBUTE

See Also:

Constant Field Values

listeners

protected List<TransactionCommitFailureListener> listeners

Constructor Detail

BaseFileTransferConnectionImpl

public BaseFileTransferConnectionImpl(javax.resource.spi.ManagedConnection mc)

Constructor which takes ManagedConnection as a parameter

Parameters:

mc - The ManagedConnection

Method Detail

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

Deliver the InputStream TODO Add in the checksumDelivered feature

Parameters:

inputStream - to deliver

fileName - The name of the file

outputDir - The output directory to deliver to

overwrite - Whether to overwrite or not

renameExtension - The extension for renaming the file

checksumDelivered - A flag to see if we check the checksum on delivery

unzip - flag

Throws:

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

executeCommand

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

Execute the command

Parameters:

deliveryCommand - The command to execute

executionContext - The execution context

Returns:

The output of that Execution

Throws:

javax.resource.ResourceException - The Exception from the JCA connector

fileChunkHeaderToPayload

protected Payload fileChunkHeaderToPayload(FileChunkHeader header)

Method used to map an FTPMappedRecord object to a Payload object. TODO Is there any other Payload stuff to set here?

Parameters:

header - The record as returned from the FileTransferProtocolClient

Returns:

A payload constructed from the record.

isChunkReference

protected boolean isChunkReference(Payload payload)

Determines if we need to handle this as a chunk reference

Parameters:

payload - - The payload to check

Returns:

true if the payload is simply a reference to a set of chunks

addListenersToCommand

protected void addListenersToCommand(TransactionalResourceCommand command)

Parameters:

command -

addListener

public void addListener(TransactionCommitFailureListener listener)

Specified by:

addListener in interface TransactionCommitFailureObserverable