WebSphere Adapter for FTP
WebSphere® Adapter for FTP supports the operations described in the following table for outbound processing.
Operation | Result |
---|---|
Create | A file with the specified name is created in
the specified directory of the FTP server. The content of the file arrives
as either part of the request from the client or it can be retrieved from
the local file system where the adapter is running. This content retrieval
is configurable. If the file to be created does not exist, the file is created
and null is returned to the J2EE application. The file is created in a staging
directory (if present) and from there it is moved to the specified directory.
If a staging directory is not present, the file is created in the specified
directory. If the file to be created already exists, an FTPFileCreateException exception is sent, the file is not created, and the existing file is not overwritten. |
Append | The file with the specified name in the specified directory of the FTP server is appended with the content sent across in the request. If the file exists, the content is appended and null is returned to the J2EE application. The file to be appended is copied from the specified directory to the staging directory (if present) and the content is appended to that file in the staging directory. The file is then moved back to the original specified directory. If the staging directory is not present, the content is directly appended to the file in the specified directory. If the file to be appended does not exist, an FTPFileAppendException exception is sent to the calling component. |
Delete | The file in the specified directory is deleted on the FTP server. After deleting the file, null is returned to the J2EE application. If the file does not exist, an FTPFileDeleteException exception is sent to the calling component. |
Retrieve | The content of the file, or files, that is specified in the request is returned. If the file, or files, specified in the request exists, the content of the file is retrieved and sent as the response. The file content can either be sent back to the J2EE application as business object or it can be saved to the local file system where the adapter is running. This is configurable. The file names are input as a comma separated list in the fileName attribute. If the files do not exist, an FTPFileRetrieveException exception is sent to the calling component. |
Overwrite | This operation overwrites the file in the directory with the content specified in the request. If the file to be overwritten exists, the content is overwritten and null is returned to the J2EE application. The file to be overwritten is copied from the specified directory to the staging directory (if used) and the content is overwritten for that file in the staging directory. The file is then moved back to the original specified directory. If the staging directory is not present, the content is overwritten on the file in the specified directory. If the file to be updated does not exist, an FTPFileOverwriteException exception is sent to the calling component. |
Exists | If the file name in the request exists in the specified directory, the adapter returns the ExistsResponse business object, with the DoesFileExists attribute set to true. If the file name does not exist, or the directory does not exist, the adapter returns the ExistsResponse business object, with the DoesFileExists attribute set to false. |
List | This operation returns all the file names and subdirectory names in the directory specified in the request. The file names and subdirectory names in the directory are retrieved and sent as a response in the ListResponse business object. If the specified directory does not exist, an FTPFileListException exception is sent to the calling component. |
ServerToServer FileTransfer |
Transfers the specified file from one FTP server
directory to another FTP server directory. If the request does not contain
all of the information about the two servers, the adapter sends an FTPFileServerToServer FileTransferException exception. |
ExecuteFTPScript | This operation runs the commands present in an FTP script file in WebSphere Process Server. The operation runs only those commands that are supported by the FTP server and ignores the rest. If the operation fails, it sends an FTPFileExecuteFTPScriptException exception. The script file must not contain connection related commands such as open or connect because the adapter uses an already established connection to run the commands. If the commands in the script file need to be run in a particular directory on the FTP server, then the script file must contain the first command to change to that directory. |
Last updated: Mon 30 Oct 2006 03:48:53
(c) Copyright IBM Corporation 2005, 2006.
This information center is powered by Eclipse technology (http://www.eclipse.org)