FtpManagedConnectionFactory (Teiid 14.0.0 API)

java.lang.Object
- org.teiid.resource.spi.BasicManagedConnectionFactory
- - org.teiid.resource.adapter.ftp.FtpManagedConnectionFactory

All Implemented Interfaces:

Serializable, javax.resource.spi.ManagedConnectionFactory, javax.resource.spi.ResourceAdapterAssociation, javax.resource.spi.ValidatingManagedConnectionFactory, FtpConfiguration
```
public class FtpManagedConnectionFactory
extends BasicManagedConnectionFactory
implements FtpConfiguration
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`bufferSize`
`protected Integer`	`clientMode`
`protected org.apache.commons.net.ftp.FTPClientConfig`	`config`
`protected String`	`controlEncoding`
`protected Integer`	`fileType`
`protected String`	`host`
`protected String`	`password`
`protected Integer`	`port`
`protected String`	`username`
`static BundleUtil`	`UTIL`

Constructor Summary

Constructors
Constructor and Description

FtpManagedConnectionFactory()

Constructors
Constructor and Description
`FtpManagedConnectionFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BasicConnectionFactory<FtpFileConnectionImpl>`	`createConnectionFactory()`
`boolean`	`equals(Object obj)`
`String`	`getAuthValue()`
`Integer`	`getBufferSize()`
`String`	`getCertificate()`
`String`	`getCipherSuites()`
`Integer`	`getClientMode()` MUST be one of the values with default set, Default value required `FTPClient.ACTIVE_LOCAL_DATA_CONNECTION_MODE` `FTPClient.PASSIVE_LOCAL_DATA_CONNECTION_MODE`
`org.apache.commons.net.ftp.FTPClientConfig`	`getConfig()`
`Integer`	`getConnectTimeout()`
`String`	`getControlEncoding()`
`Integer`	`getDataTimeout()`
`Integer`	`getDefaultTimeout()`
`String`	`getExecProt()` Default value needed, when SFTP is chosen
`String`	`getFileMapping()`
`Integer`	`getFileType()` File types defined by `FTP` constants: default file required `FTP.ASCII_FILE_TYPE` `FTP.EBCDIC_FILE_TYPE` `FTP.BINARY_FILE_TYPE` `FTP.LOCAL_FILE_TYPE`
`String`	`getHost()` Required Property
`Boolean`	`getIsFtps()`
`KeyManager`	`getKeyManager()`
`String`	`getKeyPassword()`
`String`	`getKeyPath()`
`Boolean`	`getNeedClientAuth()`
`String`	`getParentDirectory()` Required Property
`String`	`getPassword()` Required Property
`Integer`	`getPort()`
`String`	`getProtocol()`
`String`	`getProtocols()`
`Boolean`	`getSessionCreation()`
`String[]`	`getSupportedCipherSuites()`
`String[]`	`getSupportedProtocols()`
`TrustManager`	`getTrustManager()`
`Boolean`	`getUseClientMode()`
`String`	`getUsername()` Required Property
`Boolean`	`getWantsClientAuth()`
`int`	`hashCode()`
`Boolean`	`isImplicit()`
`void`	`setAuthValue(String authValue)`
`void`	`setBufferSize(Integer bufferSize)`
`void`	`setCertificate(String certificate)`
`void`	`setCipherSuites(String cipherSuites)`
`void`	`setClientMode(Integer clientMode)`
`void`	`setConfig(org.apache.commons.net.ftp.FTPClientConfig config)`
`void`	`setConnectTimeout(Integer connectTimeout)`
`void`	`setControlEncoding(String controlEncoding)`
`void`	`setDataTimeout(Integer dataTimeout)`
`void`	`setDefaultTimeout(Integer defaultTimeout)`
`void`	`setExecProt(String execProt)`
`void`	`setFileMapping(String fileMapping)`
`void`	`setFileType(Integer fileType)` File types defined by `FTP` constants: `FTP.ASCII_FILE_TYPE` `FTP.EBCDIC_FILE_TYPE` `FTP.BINARY_FILE_TYPE` `FTP.LOCAL_FILE_TYPE`
`void`	`setHost(String host)`
`void`	`setImplicit(Boolean implicit)`
`void`	`setIsFtps(Boolean isFtps)`
`void`	`setKeyPassword(String keyPassword)`
`void`	`setKeyPath(String keyPath)`
`void`	`setNeedClientAuth(Boolean needClientAuth)`
`void`	`setParentDirectory(String parentDirectory)`
`void`	`setPassword(String password)`
`void`	`setPort(Integer port)`
`void`	`setProtocol(String protocol)`
`void`	`setProtocols(String protocols)`
`void`	`setSessionCreation(Boolean sessionCreation)`
`void`	`setUseClientMode(Boolean useClientMode)`
`void`	`setUsername(String username)`
`void`	`setWantsClientAuth(Boolean wantsClientAuth)`

Methods inherited from class org.teiid.resource.spi.BasicManagedConnectionFactory
checkEquals, createConnectionFactory, createManagedConnection, getInstance, getInvalidConnections, getLogWriter, getResourceAdapter, matchManagedConnections, setLogWriter, setResourceAdapter

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

- Field Detail
  - UTIL
```
public static final BundleUtil UTIL
```
  - config
```
protected org.apache.commons.net.ftp.FTPClientConfig config
```
  - username
```
protected String username
```
  - host
```
protected String host
```
  - password
```
protected String password
```
  - port
```
protected Integer port
```
  - bufferSize
```
protected Integer bufferSize
```
  - clientMode
```
protected Integer clientMode
```
  - fileType
```
protected Integer fileType
```
  - controlEncoding
```
protected String controlEncoding
```
- Constructor Detail
  - FtpManagedConnectionFactory
```
public FtpManagedConnectionFactory()
```
- Method Detail
  - getConfig
```
public org.apache.commons.net.ftp.FTPClientConfig getConfig()
```
  - getParentDirectory
```
public String getParentDirectory()
```
    Description copied from interface: FtpConfiguration
    
    Required Property
    
    Specified by:
    
    getParentDirectory in interface FtpConfiguration
  - setParentDirectory
```
public void setParentDirectory(String parentDirectory)
```
  - getFileMapping
```
public String getFileMapping()
```
    Specified by:
    
    getFileMapping in interface FtpConfiguration
  - setFileMapping
```
public void setFileMapping(String fileMapping)
```
  - setConfig
```
public void setConfig(org.apache.commons.net.ftp.FTPClientConfig config)
```
  - getUsername
```
public String getUsername()
```
    Description copied from interface: FtpConfiguration
    
    Required Property
    
    Specified by:
    
    getUsername in interface FtpConfiguration
  - setUsername
```
public void setUsername(String username)
```
  - getHost
```
public String getHost()
```
    Description copied from interface: FtpConfiguration
    
    Required Property
    
    Specified by:
    
    getHost in interface FtpConfiguration
  - setHost
```
public void setHost(String host)
```
  - getPassword
```
public String getPassword()
```
    Description copied from interface: FtpConfiguration
    
    Required Property
    
    Specified by:
    
    getPassword in interface FtpConfiguration
  - setPassword
```
public void setPassword(String password)
```
  - getPort
```
public Integer getPort()
```
    Specified by:
    
    getPort in interface FtpConfiguration
  - setPort
```
public void setPort(Integer port)
```
  - getBufferSize
```
public Integer getBufferSize()
```
    Specified by:
    
    getBufferSize in interface FtpConfiguration
  - setBufferSize
```
public void setBufferSize(Integer bufferSize)
```
  - getClientMode
```
public Integer getClientMode()
```
    Description copied from interface: FtpConfiguration
    MUST be one of the values with default set, Default value required
    - FTPClient.ACTIVE_LOCAL_DATA_CONNECTION_MODE
    - FTPClient.PASSIVE_LOCAL_DATA_CONNECTION_MODE
    Specified by:
    
    getClientMode in interface FtpConfiguration
    
    Returns:
  - setClientMode
```
public void setClientMode(Integer clientMode)
```
  - getFileType
```
public Integer getFileType()
```
    Description copied from interface: FtpConfiguration
    File types defined by FTP constants: default file required
    - FTP.ASCII_FILE_TYPE
    - FTP.EBCDIC_FILE_TYPE
    - FTP.BINARY_FILE_TYPE
    - FTP.LOCAL_FILE_TYPE
    Specified by:
    
    getFileType in interface FtpConfiguration
    
    Returns:
    
    fileType The file type.
  - setFileType
```
public void setFileType(Integer fileType)
```
    File types defined by FTP constants:
    - FTP.ASCII_FILE_TYPE
    - FTP.EBCDIC_FILE_TYPE
    - FTP.BINARY_FILE_TYPE
    - FTP.LOCAL_FILE_TYPE
    Parameters:
    
    fileType - The file type.
  - getControlEncoding
```
public String getControlEncoding()
```
    Specified by:
    
    getControlEncoding in interface FtpConfiguration
  - setControlEncoding
```
public void setControlEncoding(String controlEncoding)
```
  - getConnectTimeout
```
public Integer getConnectTimeout()
```
    Specified by:
    
    getConnectTimeout in interface FtpConfiguration
  - setConnectTimeout
```
public void setConnectTimeout(Integer connectTimeout)
```
  - getDefaultTimeout
```
public Integer getDefaultTimeout()
```
    Specified by:
    
    getDefaultTimeout in interface FtpConfiguration
  - setDefaultTimeout
```
public void setDefaultTimeout(Integer defaultTimeout)
```
  - getDataTimeout
```
public Integer getDataTimeout()
```
    Specified by:
    
    getDataTimeout in interface FtpConfiguration
  - setDataTimeout
```
public void setDataTimeout(Integer dataTimeout)
```
  - getIsFtps
```
public Boolean getIsFtps()
```
    Specified by:
    
    getIsFtps in interface FtpConfiguration
  - setIsFtps
```
public void setIsFtps(Boolean isFtps)
```
  - getUseClientMode
```
public Boolean getUseClientMode()
```
    Specified by:
    
    getUseClientMode in interface FtpConfiguration
  - setUseClientMode
```
public void setUseClientMode(Boolean useClientMode)
```
  - getSessionCreation
```
public Boolean getSessionCreation()
```
    Specified by:
    
    getSessionCreation in interface FtpConfiguration
  - setSessionCreation
```
public void setSessionCreation(Boolean sessionCreation)
```
  - getAuthValue
```
public String getAuthValue()
```
    Specified by:
    
    getAuthValue in interface FtpConfiguration
  - setAuthValue
```
public void setAuthValue(String authValue)
```
  - getCertificate
```
public String getCertificate()
```
  - setCertificate
```
public void setCertificate(String certificate)
```
  - getCipherSuites
```
public String getCipherSuites()
```
  - setCipherSuites
```
public void setCipherSuites(String cipherSuites)
```
  - getProtocols
```
public String getProtocols()
```
  - setProtocols
```
public void setProtocols(String protocols)
```
  - getKeyPath
```
public String getKeyPath()
```
  - setKeyPath
```
public void setKeyPath(String keyPath)
```
  - getKeyPassword
```
public String getKeyPassword()
```
  - setKeyPassword
```
public void setKeyPassword(String keyPassword)
```
  - getNeedClientAuth
```
public Boolean getNeedClientAuth()
```
    Specified by:
    
    getNeedClientAuth in interface FtpConfiguration
  - setNeedClientAuth
```
public void setNeedClientAuth(Boolean needClientAuth)
```
  - getWantsClientAuth
```
public Boolean getWantsClientAuth()
```
    Specified by:
    
    getWantsClientAuth in interface FtpConfiguration
  - setWantsClientAuth
```
public void setWantsClientAuth(Boolean wantsClientAuth)
```
  - isImplicit
```
public Boolean isImplicit()
```
    Specified by:
    
    isImplicit in interface FtpConfiguration
  - setImplicit
```
public void setImplicit(Boolean implicit)
```
  - getExecProt
```
public String getExecProt()
```
    Description copied from interface: FtpConfiguration
    
    Default value needed, when SFTP is chosen
    
    Specified by:
    
    getExecProt in interface FtpConfiguration
  - setExecProt
```
public void setExecProt(String execProt)
```
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface FtpConfiguration
  - setProtocol
```
public void setProtocol(String protocol)
```
  - createConnectionFactory
```
public BasicConnectionFactory<FtpFileConnectionImpl> createConnectionFactory()
                                                                      throws javax.resource.ResourceException
```
    Specified by:
    
    createConnectionFactory in interface javax.resource.spi.ManagedConnectionFactory
    
    Specified by:
    
    createConnectionFactory in class BasicManagedConnectionFactory
    
    Throws:
    
    javax.resource.ResourceException
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface javax.resource.spi.ManagedConnectionFactory
    
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface javax.resource.spi.ManagedConnectionFactory
    
    Overrides:
    
    equals in class Object
  - getTrustManager
```
public TrustManager getTrustManager()
```
    Specified by:
    
    getTrustManager in interface FtpConfiguration
  - getKeyManager
```
public KeyManager getKeyManager()
```
    Specified by:
    
    getKeyManager in interface FtpConfiguration
  - getSupportedCipherSuites
```
public String[] getSupportedCipherSuites()
```
    Specified by:
    
    getSupportedCipherSuites in interface FtpConfiguration
  - getSupportedProtocols
```
public String[] getSupportedProtocols()
```
    Specified by:
    
    getSupportedProtocols in interface FtpConfiguration

Class FtpManagedConnectionFactory

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.teiid.resource.spi.BasicManagedConnectionFactory

Methods inherited from class java.lang.Object

Field Detail

UTIL

config

username

host

password

port

bufferSize

clientMode

fileType

controlEncoding

Constructor Detail

FtpManagedConnectionFactory

Method Detail

getConfig

getParentDirectory

setParentDirectory

getFileMapping

setFileMapping

setConfig

getUsername

setUsername

getHost

setHost

getPassword

setPassword

getPort

setPort

getBufferSize

setBufferSize

getClientMode

setClientMode

getFileType

setFileType

getControlEncoding

setControlEncoding

getConnectTimeout

setConnectTimeout

getDefaultTimeout

setDefaultTimeout

getDataTimeout

setDataTimeout

getIsFtps

setIsFtps

getUseClientMode

setUseClientMode

getSessionCreation

setSessionCreation

getAuthValue

setAuthValue

getCertificate

setCertificate

getCipherSuites

setCipherSuites

getProtocols

setProtocols

getKeyPath

setKeyPath

getKeyPassword

setKeyPassword

getNeedClientAuth

setNeedClientAuth

getWantsClientAuth

setWantsClientAuth

isImplicit

setImplicit

getExecProt

setExecProt

getProtocol

setProtocol

createConnectionFactory

hashCode

equals

getTrustManager