FTP/SFTP/SCP Connector
Those connectors, known by the type names FTP, SFTP and SCP, expose stored procedures to leverage file resources stored servers that are accessible using these protocols.
Connector Specific Connection Properties Shared by FTP, SFTP, SCP
name | description | default value |
---|---|---|
host | host | localhost |
port | port | ftp, ftpes: 21 |
user | user | no default value |
password | password | no default value |
remoteDirectory | default remote directory | no default value |
Connector Specific Connection Properties - FTP Only
name | description | default value |
---|---|---|
secure | Specifies if the remote server shall be accessed using TLS.
| false |
explicit | Enables FTPES (explicit TLS). This parameter works only with | false |
passive | Specifies if the remote server shall be accessed using passive mode. | false |
proxy | possible values: value | no default value |
proxyHost | host address of the proxy server | no default value |
proxyPort | the port used by the proxy server | no default value |
proxyUser | user at proxy server server | no default value |
proxyPassword | password for the proxy server | no default value |
serverTimeout | server read timeout | 60 |
Connector Specific Connection Properties - SFTP Only
name | description | default value |
---|---|---|
privatekey | Specifies the s path to a keyfile. This parameter may be set instead of the password-parameter. | no default value |
proxy | possible values: NONE , HTTP , SOCKS4 , SOCKS5 | no default value |
| host adress of the proxy server | no default value |
| the port used by the proxy server | no default value |
| a user at the proxy server | no default value |
| password for proxy server | no default value |
Examples
Usage
call SYSADMIN.createConnection(name => <ftp_alias>, jbossCLITemplateName => 'ftp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>,secure=<true/false>,passive=<true/false>') ;;
call SYSADMIN.createDataSource(name => <sftp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;
call SYSADMIN.createConnection(name => <sftp_alias>, jbossCLITemplateName => 'sftp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>') ;;
call SYSADMIN.createDataSource(name => <sftp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;
call SYSADMIN.createConnection(name => <scp_alias>, jbossCLITemplateName => 'scp', connectionOrResourceAdapterProperties => 'host=<HOSTNAME>,port=<PORT_NUMBER>,user=<USERNAME>,password=<PASSWORD>') ;;
call SYSADMIN.createDataSource(name => <scp_alias>, translator => 'ufile', modelProperties => '', translatorProperties => '') ;;
CODE
Examples
call SYSADMIN.createConnection(name => 'ftp', jbossCLITemplateName => 'ftp', connectionOrResourceAdapterProperties => 'host=myserver,poer=21,user=JohnDoe,password=mySecretPassword,secure=false,passive=true') ;;
call SYSADMIN.createDataSource(name => 'ftp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;
call SYSADMIN.createConnection(name => 'sftp', jbossCLITemplateName => 'sftp', connectionOrResourceAdapterProperties => 'host=myserver,port=22, user=JohnDoe,password=JohnsSecretPassword') ;;
call SYSADMIN.createDataSource(name => 'sftp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;
call SYSADMIN.createConnection(name => 'scp', jbossCLITemplateName => 'scp', cconnectionOrResourceAdapterProperties => 'host=myserver,port=22, user=JohnDoe,password=JohnsSecretPassword') ;;
call SYSADMIN.createDataSource(name => 'scp', translator => 'ufile', modelProperties => '', translatorProperties => '') ;;
CODE
serverTimeout
in FTP connector since v2.1.16