FTPConnectionRequestInfo (ikasan-ftp-endpoint 2.0.0-beta API)

java.lang.Object
- org.ikasan.connector.base.outbound.EISConnectionRequestInfo
- - org.ikasan.connector.ftp.outbound.FTPConnectionRequestInfo

All Implemented Interfaces:

javax.resource.spi.ConnectionRequestInfo
```
public class FTPConnectionRequestInfo
extends EISConnectionRequestInfo
```
FTPConnectionRequestInfo provides FTP EIS specific connection properties. It gets passed into the FTPManagedConnectionFactory This class itself gets populated by the client calling the connector Typically this is used to override the defaults provided by the ra.xml file.

Author:

Ikasan Development Team

Constructor Summary

Constructors
Constructor and Description

FTPConnectionRequestInfo()

Constructors
Constructor and Description
`FTPConnectionRequestInfo()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`cleanupJournalOnComplete()` Getter for cleanupJournalOnComplete
`boolean`	`equals(Object o)`
`Boolean`	`getActive()` Get active
`Integer`	`getConnectionTimeout()` Get the connection timeout
`Integer`	`getDataTimeout()` Get the data 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()` Get the poll rate
`String`	`getRemoteHostname()` Get the host name
`Integer`	`getRemotePort()` Get the port
`Integer`	`getSocketTimeout()` Get the connection timeout
`String`	`getSystemKey()` Get the systemKey
`String`	`getUsername()` Get the username
`int`	`hashCode()`
`void`	`setActive(Boolean active)` Set active
`void`	`setCleanupJournalOnComplete(Boolean cleanupJournalOnComplete)` Setter for cleanupJournalOnComplete
`void`	`setConnectionTimeout(Integer connectionTimeout)` Set the connection timeout
`void`	`setDataTimeout(Integer dataTimeout)` Set the 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)` Set the poll rate
`void`	`setRemoteHostname(String remoteHostname)` Set the host name
`void`	`setRemotePort(Integer remotePort)` Set the port
`void`	`setSocketTimeout(Integer socketTimeout)` Set the socket timeout
`void`	`setSystemKey(String systemKey)` Set the systemKey
`void`	`setUsername(String username)` Set the username
`String`	`toString()` String representation of the ConnectionRequestInfo

Methods inherited from class org.ikasan.connector.base.outbound.EISConnectionRequestInfo
getClientID, setClientID

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FTPConnectionRequestInfo
```
public FTPConnectionRequestInfo()
```
- Method Detail
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface javax.resource.spi.ConnectionRequestInfo
    
    Specified by:
    
    equals in class EISConnectionRequestInfo
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface javax.resource.spi.ConnectionRequestInfo
    
    Specified by:
    
    hashCode in class EISConnectionRequestInfo
  - getActive
```
public Boolean getActive()
```
    Get active
    
    Returns:
    
    active
  - setActive
```
public void setActive(Boolean active)
```
    Set active
    
    Parameters:
    
    active - New value for active flag.
  - cleanupJournalOnComplete
```
public Boolean cleanupJournalOnComplete()
```
    Getter for cleanupJournalOnComplete
    
    Returns:
    
    cleanupJournalOnComplete
  - setCleanupJournalOnComplete
```
public void setCleanupJournalOnComplete(Boolean cleanupJournalOnComplete)
```
    Setter for cleanupJournalOnComplete
    
    Parameters:
    
    cleanupJournalOnComplete - New value for cleanupJournalOnComplete parameter flag.
  - getRemoteHostname
```
public String getRemoteHostname()
```
    Get the host name
    
    Returns:
    
    the host name
  - setRemoteHostname
```
public void setRemoteHostname(String remoteHostname)
```
    Set the host name
    
    Parameters:
    
    remoteHostname - New value for hostname.
  - 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 - New value for maxRetryAttempts.
  - getPassword
```
public String getPassword()
```
    Get the password
    
    Returns:
    
    password
  - setPassword
```
public void setPassword(String password)
```
    Set the password
    
    Parameters:
    
    password - New value for password.
  - getPollTime
```
public Integer getPollTime()
```
    Get the poll rate
    
    Returns:
    
    poll rate
  - setPollTime
```
public void setPollTime(Integer pollTime)
```
    Set the poll rate
    
    Parameters:
    
    pollTime - New value for pollTime.
  - getRemotePort
```
public Integer getRemotePort()
```
    Get the port
    
    Returns:
    
    port
  - setRemotePort
```
public void setRemotePort(Integer remotePort)
```
    Set the port
    
    Parameters:
    
    remotePort - New value for port.
  - getUsername
```
public String getUsername()
```
    Get the username
    
    Returns:
    
    the username
  - setUsername
```
public void setUsername(String username)
```
    Set the username
    
    Parameters:
    
    username - New value for username.
  - getSystemKey
```
public String getSystemKey()
```
    Get the systemKey
    
    Returns:
    
    the systemKey
  - setSystemKey
```
public void setSystemKey(String systemKey)
```
    Set the systemKey
    
    Parameters:
    
    systemKey - The system key to set
  - setConnectionTimeout
```
public void setConnectionTimeout(Integer connectionTimeout)
```
    Set the connection timeout
    
    Parameters:
    
    connectionTimeout - The connection timeout to set
  - getConnectionTimeout
```
public Integer getConnectionTimeout()
```
    Get the connection timeout
    
    Returns:
    
    int - connectionT
  - setDataTimeout
```
public void setDataTimeout(Integer dataTimeout)
```
    Set the data timeout
    
    Parameters:
    
    dataTimeout - The data timeout to set
  - getDataTimeout
```
public Integer getDataTimeout()
```
    Get the data timeout
    
    Returns:
    
    Integer - dataTimeout
  - setSocketTimeout
```
public void setSocketTimeout(Integer socketTimeout)
```
    Set the socket timeout
    
    Parameters:
    
    socketTimeout - The connection timeout to set
  - getSocketTimeout
```
public Integer getSocketTimeout()
```
    Get the connection timeout
    
    Returns:
    
    Integer - socketTimeout
  - 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 ConnectionRequestInfo
    
    Overrides:
    
    toString in class Object

Class FTPConnectionRequestInfo

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

FTPConnectionRequestInfo

Method Detail

equals

hashCode

getActive

setActive

cleanupJournalOnComplete

setCleanupJournalOnComplete

getRemoteHostname

setRemoteHostname

getMaxRetryAttempts

setMaxRetryAttempts

getPassword

setPassword

getPollTime

setPollTime

getRemotePort

setRemotePort

getUsername

setUsername

getSystemKey

setSystemKey

setConnectionTimeout

getConnectionTimeout

setDataTimeout

getDataTimeout

setSocketTimeout

getSocketTimeout

getIsFTPS

setIsFTPS

getFtpsPort

setFtpsPort

getFtpsProtocol

setFtpsProtocol

getFtpsIsImplicit

setFtpsIsImplicit

getFtpsKeyStoreFilePath

setFtpsKeyStoreFilePath

getFtpsKeyStoreFilePassword

setFtpsKeyStoreFilePassword

toString