org.ikasan.connector.ftp.outbound

Class FTPConnectionSpec

java.lang.Object

org.ikasan.connector.base.outbound.EISConnectionSpec

org.ikasan.connector.ftp.outbound.FTPConnectionSpec

All Implemented Interfaces:

javax.resource.cci.ConnectionSpec, EISConnectionProperties

public class FTPConnectionSpec
extends EISConnectionSpec

This is an class representing the connection specific application properties passed to the getConnection method.

Author:

Ikasan Development Team

Field Summary

Fields inherited from interface org.ikasan.connector.base.outbound.EISConnectionProperties

CLIENTID

Constructor Summary

Constructors

Constructor and Description
FTPConnectionSpec() Default Constructor.

Method Summary

Modifier and Type	Method and Description
Boolean	getActive() Getter for active
Boolean	getCleanupJournalOnComplete() Getter for cleanupJournalOnComplete
Integer	getConnectionTimeout() Get connection timeout
Integer	getDataTimeout() Get data connection timeout
Boolean	getFtpsIsImplicit()
String	getFtpsKeyStoreFilePassword()
String	getFtpsKeyStoreFilePath()
Integer	getFtpsPort()
String	getFtpsProtocol()
Boolean	getIsFTPS()
Integer	getMaxRetryAttempts() Get the max retry attempts
String	getPassword() Get the password
Integer	getPollTime() Getter for pollTime
String	getRemoteHostname() Get the host
Integer	getRemotePort() Gets remote port number.
Integer	getSocketTimeout() Get socket connection timeout
String	getSystemKey() Getter for systemKey
String	getUsername() Get the username
void	setActive(Boolean active) Set active
void	setCleanupJournalOnComplete(Boolean cleanupJournalOnComplete) Setter for cleanupJournalOnComplete
void	setConnectionTimeout(Integer connectionTimeout) Set connection timeout
void	setDataTimeout(Integer dataTimeout) Set data timeout
void	setFtpsIsImplicit(Boolean ftpsIsImplicit)
void	setFtpsKeyStoreFilePassword(String ftpsKeyStoreFilePassword)
void	setFtpsKeyStoreFilePath(String ftpsKeyStoreFilePath)
void	setFtpsPort(Integer ftpsPort)
void	setFtpsProtocol(String ftpsProtocol)
void	setIsFTPS(Boolean isFTPS)
void	setMaxRetryAttempts(Integer maxRetryAttempts) Set the max retry attempts
void	setPassword(String password) Set the password
void	setPollTime(Integer pollTime) Setter for pollTime
void	setRemoteHostname(String remoteHostname) Set the host
void	setRemotePort(Integer remotePort) Sets the value of remotePort.
void	setSocketTimeout(Integer socketTimeout) Set socket timeout
void	setSystemKey(String systemKey) Setter for systemKey
void	setUsername(String username) Set the username
String	toString() String representation of the ConnectionSpec

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

getClientID, setClientID

Methods inherited from class java.lang.Object

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

Constructor Detail

FTPConnectionSpec

public FTPConnectionSpec()

Default Constructor.

Method Detail

getActive

public Boolean getActive()

Getter for active

Returns:

active

setActive

public void setActive(Boolean active)

Set active

Parameters:

active - active/passive mode.

getCleanupJournalOnComplete

public Boolean getCleanupJournalOnComplete()

Getter for cleanupJournalOnComplete

Returns:

cleanupJournalOnComplete

setCleanupJournalOnComplete

public void setCleanupJournalOnComplete(Boolean cleanupJournalOnComplete)

Setter for cleanupJournalOnComplete

Parameters:

cleanupJournalOnComplete - Flag to clean transaction journal after complete.

getRemoteHostname

public String getRemoteHostname()

Get the host

Returns:

the host

setRemoteHostname

public void setRemoteHostname(String remoteHostname)

Set the host

Parameters:

remoteHostname - - the host

getMaxRetryAttempts

public Integer getMaxRetryAttempts()

Get the max retry attempts

Returns:

the max retry attempts

setMaxRetryAttempts

public void setMaxRetryAttempts(Integer maxRetryAttempts)

Set the max retry attempts

Parameters:

maxRetryAttempts - Maximum connection attempts before failure.

getPassword

public String getPassword()

Get the password

Returns:

the password

setPassword

public void setPassword(String password)

Set the password

Parameters:

password - User password for FTP host.

getRemotePort

public Integer getRemotePort()

Gets remote port number.

Returns:

remotePort

setRemotePort

public void setRemotePort(Integer remotePort)

Sets the value of remotePort.

Parameters:

remotePort - The remote port number.

getUsername

public String getUsername()

Get the username

Returns:

the username

setUsername

public void setUsername(String username)

Set the username

Parameters:

username - User with privilege to connect to FTP host.

getPollTime

public Integer getPollTime()

Getter for pollTime

Returns:

Integer

setPollTime

public void setPollTime(Integer pollTime)

Setter for pollTime

Parameters:

pollTime - Initial polling time

getSystemKey

public String getSystemKey()

Getter for systemKey

Returns:

systemKey

setSystemKey

public void setSystemKey(String systemKey)

Setter for systemKey

Parameters:

systemKey - The system key to set

getConnectionTimeout

public Integer getConnectionTimeout()

Get connection timeout

Returns:

Integer - connectionTimeout

setConnectionTimeout

public void setConnectionTimeout(Integer connectionTimeout)

Set connection timeout

Parameters:

connectionTimeout - -

getDataTimeout

public Integer getDataTimeout()

Get data connection timeout

Returns:

Integer - dataTimeout

setDataTimeout

public void setDataTimeout(Integer dataTimeout)

Set data timeout

Parameters:

dataTimeout - The data timeout in ms

getSocketTimeout

public Integer getSocketTimeout()

Get socket connection timeout

Returns:

Integer - socketTimeout

setSocketTimeout

public void setSocketTimeout(Integer socketTimeout)

Set socket timeout

Parameters:

socketTimeout - The socket timeout in ms

getIsFTPS

public Boolean getIsFTPS()

setIsFTPS

public void setIsFTPS(Boolean isFTPS)

getFtpsPort

public Integer getFtpsPort()

setFtpsPort

public void setFtpsPort(Integer ftpsPort)

getFtpsProtocol

public String getFtpsProtocol()

setFtpsProtocol

public void setFtpsProtocol(String ftpsProtocol)

getFtpsIsImplicit

public Boolean getFtpsIsImplicit()

setFtpsIsImplicit

public void setFtpsIsImplicit(Boolean ftpsIsImplicit)

getFtpsKeyStoreFilePath

public String getFtpsKeyStoreFilePath()

setFtpsKeyStoreFilePath

public void setFtpsKeyStoreFilePath(String ftpsKeyStoreFilePath)

getFtpsKeyStoreFilePassword

public String getFtpsKeyStoreFilePassword()

setFtpsKeyStoreFilePassword

public void setFtpsKeyStoreFilePassword(String ftpsKeyStoreFilePassword)

toString

public String toString()

String representation of the ConnectionSpec

Overrides:

toString in class Object