org.ikasan.connector.ftp.outbound

Class FTPManagedConnection

java.lang.Object

org.ikasan.connector.base.command.TransactionalCommandConnection

org.ikasan.connector.ftp.outbound.FTPManagedConnection

All Implemented Interfaces:

com.arjuna.ats.jta.resources.LastResourceCommitOptimisation, Serializable, XAResource, TransactionCommitFailureObserverable

public class FTPManagedConnection
extends TransactionalCommandConnection
implements Serializable

This EJB implements the ManagedConnection for the FTP resource adapter. This is a representation of a real, physical connection to the server, so it has an object instance variable which remains allocated to a server for the life of this object. This class is responsible for creating virtual connections, of class EISConnection, when the application server calls getConnection() It extends a (1 Phase Commit and 2 Phase commit) managed connection TODO Max retry attempts is really a client parameter, which brings us the question of whether we even want to open a connection at this stage

Author:

Ikasan Development Team

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static org.slf4j.Logger	logger The logger instance.

Fields inherited from class org.ikasan.connector.base.command.TransactionalCommandConnection

instanceCount, instanceOrdinal, listeners, transactionJournal, xid

Fields inherited from interface javax.transaction.xa.XAResource

TMENDRSCAN, TMFAIL, TMJOIN, TMNOFLAGS, TMONEPHASE, TMRESUME, TMSTARTRSCAN, TMSUCCESS, TMSUSPEND, XA_OK, XA_RDONLY

Constructor Summary

Constructors

Constructor and Description
FTPManagedConnection(FTPConnectionRequestInfo fcri) Constructor, sets the managed connection factory and the hibernate filter table client ID sits on EISManagedConnection

Method Summary

Modifier and Type	Method and Description
protected boolean	cleanupJournalOnComplete()
protected void	closeSession() Close the FileTransferProtocolClient session
void	forget(Xid arg0) Deal with forgetting this unit of work as a txn, in this case do nothing
String	getClientID()
Object	getConnection(FileChunkDao fileChunkDao, BaseFileTransferDao baseFileTransferDao) Create a virtual connection (a BaseFileTransferConnection object) and add it to the list of managed instances before returning it to the client.
protected TransactionalResource	getTransactionalResource()
int	getTransactionTimeout() Return the Transaction timeout, always set to 0
XAResource	getXAResource() Get the XA resource for this managed connection, in this case, itself.
boolean	isSameRM(XAResource arg0) Return whether or not this resource manager is the same, always return false
void	openSession() openSession initiates the physical connection to the server and logs us in.
protected void	postCommit(Xid arg0) Hook method to allow any connector specific post commit functionality
protected void	postRollback(Xid arg0) Hook method to allow any connector specific post rollback functionality
boolean	setTransactionTimeout(int arg0) Set the txn timeout, always return false

Methods inherited from class org.ikasan.connector.base.command.TransactionalCommandConnection

addListener, addListenersToCommand, commit, commitCommands, end, executeCommand, preCommit, prepare, preRollback, recover, rollback, rollbackCommands, sendErrorEvent, setTransactionJournal, start, transactionInProgress

Methods inherited from class java.lang.Object

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

Field Detail

logger

public static org.slf4j.Logger logger

The logger instance.

Constructor Detail

FTPManagedConnection

public FTPManagedConnection(FTPConnectionRequestInfo fcri)

Constructor, sets the managed connection factory and the hibernate filter table client ID sits on EISManagedConnection

Parameters:

fcri - connection request info

Method Detail

getConnection

public Object getConnection(FileChunkDao fileChunkDao,
                            BaseFileTransferDao baseFileTransferDao)

Create a virtual connection (a BaseFileTransferConnection object) and add it to the list of managed instances before returning it to the client.

getClientID

public String getClientID()

openSession

public void openSession()
                 throws javax.resource.ResourceException

openSession initiates the physical connection to the server and logs us in. This method is called by FTPManagedConnectionFactory immediately after creating the instance of this class. In this implementation of an FTP connector there is no real concept of a session (a connection is made per method call), openSession is left here as it initialises the ftpClient and also provides a starting point for true session functionality to be added if required

Throws:

javax.resource.ResourceException - Exception thrown by Connector

closeSession

protected void closeSession()

Close the FileTransferProtocolClient session

forget

public void forget(Xid arg0)

Deal with forgetting this unit of work as a txn, in this case do nothing

Specified by:

forget in interface XAResource

See Also:

EISXAManagedConnection

getTransactionTimeout

public int getTransactionTimeout()

Return the Transaction timeout, always set to 0

Specified by:

getTransactionTimeout in interface XAResource

Returns:

0

See Also:

EISXAManagedConnection

getXAResource

public XAResource getXAResource()

Get the XA resource for this managed connection, in this case, itself.

Specified by:

getXAResource in class TransactionalCommandConnection

See Also:

EISXAManagedConnection

isSameRM

public boolean isSameRM(XAResource arg0)

Return whether or not this resource manager is the same, always return false

Specified by:

isSameRM in interface XAResource

Returns:

false

See Also:

EISXAManagedConnection

setTransactionTimeout

public boolean setTransactionTimeout(int arg0)

Set the txn timeout, always return false

Specified by:

setTransactionTimeout in interface XAResource

Returns:

false

See Also:

EISXAManagedConnection

getTransactionalResource

protected TransactionalResource getTransactionalResource()

Specified by:

getTransactionalResource in class TransactionalCommandConnection

postRollback

protected void postRollback(Xid arg0)

Hook method to allow any connector specific post rollback functionality

Overrides:

postRollback in class TransactionalCommandConnection

Parameters:

arg0 - Transaction Id

postCommit

protected void postCommit(Xid arg0)

Hook method to allow any connector specific post commit functionality

Overrides:

postCommit in class TransactionalCommandConnection

Parameters:

arg0 - Transaction Id

cleanupJournalOnComplete

protected boolean cleanupJournalOnComplete()

Overrides:

cleanupJournalOnComplete in class TransactionalCommandConnection