- Index

< Previous |  | Next >

# FTP Operator Sample

## About This Sample

This operator sample illustrates the use of the TIBCO StreamBase® operator for FTP by sending an FTP client `GET` command to an FTP server to retrieve a file.

## Importing This Sample into StreamBase Studio

In StreamBase Studio, import this sample with the following steps:

- From the top-level menu, select File → Load StreamBase Sample.

- Enter `ftp` to narrow the list of options.

- Select FTP Java operator from the Data Constructs and Operators category.

- Click OK.

StreamBase Studio creates a project for the sample.

## Running This Sample in StreamBase Studio

1. In the Project Explorer view, open the sample you just loaded.

   If you see red marks on a project folder, wait a moment for the project to load its features.

   If the red marks do not resolve themselves after a minute, select the project, right-click, and select Maven → Update Project from the context menu.

2. Open the `src/main/eventflow/`packageName`` folder.

3. Open the `FTPGet.sbapp` file and click the Run button. This opens the SB Test/Debug perspective and starts the module.

4. Press F9 or click the Terminate EventFlow Fragment button.

5. Look in the Output Streams view for the `OutputStream` stream. Open the inputTuple field to determine the location of the locally written file.

   Observe that there is now a new file in the node directory for this sample. This was the file retrieved via the FTP `GET` command. Node directories in Studio are written to the hidden folder `.nodes` by default, and are not visible from within Studio. Navigate to the current workspace's `.nodes` folder if you wish to open the actual file retrieved.

6. Restart the application.

   In the `cmd` field, enter the value `FREE_FORM` and click Send Data.

   Observe in the Output Streams view that the `object` field contains two numbers. The first is the server response code and the second is the size of the file that you just retrieved, in bytes.

7. Experiment with different values for `cmd`, `local`, `remote` and the operator properties.

   If you want more functionality, be sure to change the `Server hostname`, `Username` and `Password` operator properties to a server for which you have write access.

8. When done, press F9 or click the Terminate EventFlow Fragment button.

## Sample Location

When you load the sample into StreamBase Studio, Studio copies the sample project's files to your Studio workspace, which is normally part of your home directory, with full access rights.

### Important

Load this sample in StreamBase Studio, and thereafter use the Studio workspace copy of the sample to run and test it, even when running from the command prompt.

Using the workspace copy of the sample avoids permission problems. The default workspace location for this sample is:

    studio-workspace/sample_ftp

See Default Installation Directories for the default location of `studio-workspace` on your system.