WmPublic. Connects to a remote FTP server and logs in with a specified user name and password.
You must use this service to initiate an FTP session before using most other services in pub.client.ftp.
Input Parameters
username String The login user name through the FTP Listener. filename String The absolute path name of the file.
serverhost String Name or IP address of the FTP server (for example,
ftp.netscape.com).
serverport String Port number on which the FTP server listens for requests (for
example, 4566). The default is 21.
3 Client Folder
dataport String Optional. Listener port number of the data transfer channel (for
example, 3345).
If you do not specify dataport, the Integration Server will choose the listener port number. This value is used only when the transfertype value is active.
username String Valid FTP user on the remote FTP server (for example,
anonymous).
password String Optional. Valid password for the FTP user specified in username
(for example, someone@somewhere).
account String Optional. The user name for an account on the FTP server.
Specify account if your FTP host requires account information. The account is defined in the FTP protocol to further identify the user that is identified by the username and password input variables.
transfertype String Type of the FTP data transfer mode (passive or active). The default is active.
encoding String Optional. Default character set for encoding data transferred
during this session. Specify an IANA-registered character set (for example, ISO-8859-1).
If you do not set encoding, the default JVM encoding is used.
serverencoding String Optional. Specifies the encoding this service uses to convert the
incoming FTP command string to encoded bytes that are supported by IANA and the FTP server. If the parameter is null, the service uses the 'UTF-8' character set to encode the FTP command String to bytes.
timeout String Optional. Time (measured in seconds) to wait for a response
from the FTP server before timing out and terminating the request. The default is to wait forever.
secure Document Indicates whether the FTP session is with a secure FTP
server.
Key Description
auth String The kind of authentication mechanism to use:
None, SSL, TLS, or TLS-P.
None specifies that the FTP session is with a non- secure FTP server. This is the default. If the value of
auth is None, the securedata variable is ignored.
TLS-P is a shortcut that is equivalent to the sequence AUTH TLS, PBSZ 0, and PROT P. If the value of auth is TLS-P, the securedata variable is ignored.
3 Client Folder
Output Parameters
securedata String Use the value false for a client sending PROT C (Data Channel Protection Level Clear).
Use the value true for a client sending PROT P (Data Channel Protection Level Private).
Note: If you do not set a value, the default is false.
newSession String Optional. Flag indicating whether a a new FTP session will be
created for this FTP operation. Set to:
yes to create a new session for this FTP operation.
no to use the current session, if one is available, for this FTP operation. This is the default.
clientTimeout String Optional. Specifies the idle time-out, measured in seconds, for
this FTP session. If clientTimeout is set to 0 (zero), the session will never time out. The default is 600 seconds (10 minutes).
proxyAlias String Optional. Name of the proxy alias for the proxy server through
which Integration Server routes the FTP request.
If you do not specify a proxyAlias, Integration Server routes the FTP request through the proxy server specified in the default FTP proxy alias. If there is no default FTP proxy alias, the action taken by Integration Server depends on the value specified for the watt.net.proxy.useNonDefaultProxies parameter.
If the watt.net.proxy.useNonDefaultProxies parameter is set to true, Integration Server routes the FTP request through the proxy server in any configured FTP proxy alias. If the Integration Server does not have any defined FTP proxy aliases, Integration Server sends the FTP request directly to the FTP server or throws an exception depending on the settings specified for the
watt.net.proxy.fallbackToDirectConnection parameter.
If the watt.server.proxy.useNonDefaultProxies parameter is set to false, Integration Server sends the request to the remote server using a direct connection.
For more information about proxy server usage, refer to webMethods
Integration Server Administrator’s Guide.
sessionkey String Unique key for the current FTP session. This session key must be
provided to execute most other services in pub.client.ftp.
3 Client Folder
Usage Notes
If you set the auth variable in the secure parameter to SSL, TLS, or TLS-P,
pub.client.ftp:login automatically sends the following sequence of FTP commands prior to sending the USER command:
AUTH <SSL | TLS | TLS-P> PBSZ 0 PROT <P | C>
The client FTP services will not negotiate for less security than you have specified with the auth parameter. However, if you set the auth variable to None, the client FTP services can operate (in a non-secure mode) with any FTP server.
The FTP services will always connect to a secure FTP server using a non-secure (SSL) socket. After getting a valid reply from the AUTH command, the FTP services will convert the connected socket to an SSL socket and initiate SSL handshaking.