org.ikasan.endpoint.ftp.consumer

Class FtpMessageProvider

java.lang.Object

org.ikasan.endpoint.ftp.consumer.FtpMessageProvider

All Implemented Interfaces:

MessageProvider<Payload>, TransactionCommitFailureListener, ManagedResource

public class FtpMessageProvider
extends Object
implements ManagedResource, MessageProvider<Payload>, TransactionCommitFailureListener

Default implementation on MessageProvider using JobExecutionContext as a message type.

Author:

Ikasan Development Team

Field Summary

Fields

Modifier and Type	Field and Description
protected FileTransferConnectionTemplate	activeFileTransferConnectionTemplate Currently active connection template
protected FileTransferConnectionTemplate	alternateFileTransferConnectionTemplate Alternate template to be used in cases of failure
protected FtpConsumerConfiguration	configuration Configuration
protected FileTransferConnectionTemplate	fileTransferConnectionTemplate A connection template

Constructor Summary

Constructors

Constructor and Description
FtpMessageProvider(org.springframework.transaction.jta.JtaTransactionManager transactionManager, BaseFileTransferDao baseFileTransferDao, FileChunkDao fileChunkDao, TransactionalResourceCommandDAO transactionalResourceCommandDAO, FileBasedPasswordHelper fileBasedPasswordHelper)

Method Summary

Modifier and Type	Method and Description
void	commitFailureOccurred(TransactionCommitEvent event)
protected FTPConnectionSpec	getConnectionSpec() Utility method to aid testing of this class
protected List<String>	getSourceDirectories() Return a list of src directories to be polled.
protected void	housekeep() Apply any configured housekeeping on this connection template.
Payload	invoke(org.quartz.JobExecutionContext context)
boolean	isCriticalOnStartup()
void	setAlternateFileTransferConnectionTemplate(FileTransferConnectionTemplate alternate)
void	setConfiguration(FtpConsumerConfiguration configuration)
void	setCriticalOnStartup(boolean criticalOnStartup)
void	setDirectoryURLFactory(DirectoryURLFactory directoryURLFactory)
void	setManagedResourceRecoveryManager(ManagedResourceRecoveryManager managedResourceRecoveryManager)
void	startManagedResource()
void	stopManagedResource()
protected void	switchActiveConnection() Switch the active connection to the other connection template.

Methods inherited from class java.lang.Object

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

Field Detail

activeFileTransferConnectionTemplate

protected FileTransferConnectionTemplate activeFileTransferConnectionTemplate

Currently active connection template

fileTransferConnectionTemplate

protected FileTransferConnectionTemplate fileTransferConnectionTemplate

A connection template

alternateFileTransferConnectionTemplate

protected FileTransferConnectionTemplate alternateFileTransferConnectionTemplate

Alternate template to be used in cases of failure

configuration

protected FtpConsumerConfiguration configuration

Configuration

Constructor Detail

FtpMessageProvider

public FtpMessageProvider(org.springframework.transaction.jta.JtaTransactionManager transactionManager,
                          BaseFileTransferDao baseFileTransferDao,
                          FileChunkDao fileChunkDao,
                          TransactionalResourceCommandDAO transactionalResourceCommandDAO,
                          FileBasedPasswordHelper fileBasedPasswordHelper)

Method Detail

invoke

public Payload invoke(org.quartz.JobExecutionContext context)

Specified by:

invoke in interface MessageProvider<Payload>

housekeep

protected void housekeep()
                  throws javax.resource.ResourceException

Apply any configured housekeeping on this connection template.

Throws:

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

getSourceDirectories

protected List<String> getSourceDirectories()

Return a list of src directories to be polled.

Returns:

List of src directories

setAlternateFileTransferConnectionTemplate

public void setAlternateFileTransferConnectionTemplate(FileTransferConnectionTemplate alternate)

Parameters:

alternate - the FileTransferConnectionTemplate alternate to use

switchActiveConnection

protected void switchActiveConnection()

Switch the active connection to the other connection template.

startManagedResource

public void startManagedResource()

Specified by:

startManagedResource in interface ManagedResource

stopManagedResource

public void stopManagedResource()

Specified by:

stopManagedResource in interface ManagedResource

setManagedResourceRecoveryManager

public void setManagedResourceRecoveryManager(ManagedResourceRecoveryManager managedResourceRecoveryManager)

Specified by:

setManagedResourceRecoveryManager in interface ManagedResource

isCriticalOnStartup

public boolean isCriticalOnStartup()

Specified by:

isCriticalOnStartup in interface ManagedResource

setCriticalOnStartup

public void setCriticalOnStartup(boolean criticalOnStartup)

Specified by:

setCriticalOnStartup in interface ManagedResource

getConnectionSpec

protected FTPConnectionSpec getConnectionSpec()

Utility method to aid testing of this class

Returns:

setDirectoryURLFactory

public void setDirectoryURLFactory(DirectoryURLFactory directoryURLFactory)

Parameters:

directoryURLFactory - the directoryURLFactory to set

setConfiguration

public void setConfiguration(FtpConsumerConfiguration configuration)

commitFailureOccurred

public void commitFailureOccurred(TransactionCommitEvent event)

Specified by:

commitFailureOccurred in interface TransactionCommitFailureListener