Package org.ikasan.endpoint.ftp.producer

Class FtpProducer

java.lang.Object

org.ikasan.endpoint.ftp.producer.FtpProducer

All Implemented Interfaces:

org.ikasan.connector.listener.TransactionCommitFailureListener, org.ikasan.spec.component.endpoint.Producer<org.ikasan.filetransfer.Payload>, org.ikasan.spec.configuration.Configured<FtpProducerConfiguration>, org.ikasan.spec.configuration.ConfiguredResource<FtpProducerConfiguration>, org.ikasan.spec.management.ManagedResource

public class FtpProducer
extends java.lang.Object
implements org.ikasan.spec.component.endpoint.Producer<org.ikasan.filetransfer.Payload>, org.ikasan.spec.management.ManagedResource, org.ikasan.spec.configuration.ConfiguredResource<FtpProducerConfiguration>, org.ikasan.connector.listener.TransactionCommitFailureListener

FTP Implementation of a producer based on the JCA specification.

Author:

Middleware Team

Field Summary

Fields

Modifier and Type	Field	Description
protected FileTransferConnectionTemplate	activeFileTransferConnectionTemplate	Currently active connection template
protected FileTransferConnectionTemplate	alternateFileTransferConnectionTemplate	Alternate template to be used in cases of failure
protected FtpProducerConfiguration	configuration	Configuration - default to vanilla instance
protected java.lang.String	configuredResourceId	configured resource id
protected FileTransferConnectionTemplate	fileTransferConnectionTemplate	A connection template
protected boolean	isCriticalOnStartup	determines whether this managed resource failure will fail the startup of the flow

Constructor Summary

Constructors

Constructor

Description

FtpProducer(org.springframework.transaction.jta.JtaTransactionManager transactionManager, org.ikasan.connector.basefiletransfer.outbound.persistence.BaseFileTransferDao baseFileTransferDao, org.ikasan.connector.util.chunking.model.dao.FileChunkDao fileChunkDao, org.ikasan.connector.base.command.TransactionalResourceCommandDAO transactionalResourceCommandDAO, FileBasedPasswordHelper fileBasedPasswordHelper)

Method Summary

Modifier and Type	Method	Description
void	commitFailureOccurred(org.ikasan.connector.listener.TransactionCommitEvent event)
FtpProducerConfiguration	getConfiguration()
java.lang.String	getConfiguredResourceId()
protected FTPConnectionSpec	getConnectionSpec()	Utility method to aid testing of this class
void	invoke(org.ikasan.filetransfer.Payload payload)
boolean	isCriticalOnStartup()
void	setConfiguration(FtpProducerConfiguration configuration)
void	setConfiguredResourceId(java.lang.String configuredResourceId)
void	setCriticalOnStartup(boolean isCriticalOnStartup)
void	setManagedResourceRecoveryManager(org.ikasan.spec.management.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

configuredResourceId

protected java.lang.String configuredResourceId

configured resource id

configuration

protected FtpProducerConfiguration configuration

Configuration - default to vanilla instance

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

isCriticalOnStartup

protected boolean isCriticalOnStartup

determines whether this managed resource failure will fail the startup of the flow

Constructor Detail

FtpProducer

public FtpProducer(org.springframework.transaction.jta.JtaTransactionManager transactionManager,
                   org.ikasan.connector.basefiletransfer.outbound.persistence.BaseFileTransferDao baseFileTransferDao,
                   org.ikasan.connector.util.chunking.model.dao.FileChunkDao fileChunkDao,
                   org.ikasan.connector.base.command.TransactionalResourceCommandDAO transactionalResourceCommandDAO,
                   FileBasedPasswordHelper fileBasedPasswordHelper)

Method Detail

getConfiguration

public FtpProducerConfiguration getConfiguration()

Specified by:

getConfiguration in interface org.ikasan.spec.configuration.Configured<FtpProducerConfiguration>

getConfiguredResourceId

public java.lang.String getConfiguredResourceId()

Specified by:

getConfiguredResourceId in interface org.ikasan.spec.configuration.ConfiguredResource<FtpProducerConfiguration>

setConfiguration

public void setConfiguration(FtpProducerConfiguration configuration)

Specified by:

setConfiguration in interface org.ikasan.spec.configuration.Configured<FtpProducerConfiguration>

setConfiguredResourceId

public void setConfiguredResourceId(java.lang.String configuredResourceId)

Specified by:

setConfiguredResourceId in interface org.ikasan.spec.configuration.ConfiguredResource<FtpProducerConfiguration>

invoke

public void invoke(org.ikasan.filetransfer.Payload payload)
            throws org.ikasan.spec.component.endpoint.EndpointException

Specified by:

invoke in interface org.ikasan.spec.component.endpoint.Producer<org.ikasan.filetransfer.Payload>

Throws:

org.ikasan.spec.component.endpoint.EndpointException

switchActiveConnection

protected void switchActiveConnection()

Switch the active connection to the other connection template.

startManagedResource

public void startManagedResource()

Specified by:

startManagedResource in interface org.ikasan.spec.management.ManagedResource

stopManagedResource

public void stopManagedResource()

Specified by:

stopManagedResource in interface org.ikasan.spec.management.ManagedResource

isCriticalOnStartup

public boolean isCriticalOnStartup()

Specified by:

isCriticalOnStartup in interface org.ikasan.spec.management.ManagedResource

setCriticalOnStartup

public void setCriticalOnStartup(boolean isCriticalOnStartup)

Specified by:

setCriticalOnStartup in interface org.ikasan.spec.management.ManagedResource

setManagedResourceRecoveryManager

public void setManagedResourceRecoveryManager(org.ikasan.spec.management.ManagedResourceRecoveryManager managedResourceRecoveryManager)

Specified by:

setManagedResourceRecoveryManager in interface org.ikasan.spec.management.ManagedResource

getConnectionSpec

protected FTPConnectionSpec getConnectionSpec()

Utility method to aid testing of this class

Returns:

commitFailureOccurred

public void commitFailureOccurred(org.ikasan.connector.listener.TransactionCommitEvent event)

Specified by:

commitFailureOccurred in interface org.ikasan.connector.listener.TransactionCommitFailureListener