Table of contents

Getting started with the Java Application API

There are three primary ways to get started with the API. If you are trying the API for the first time, the Streams Quick Start Edition VM is likely the fastest way to start working with a few sample applications. If you would like to install the Java Application API on your own machine to use or contribute to streamsx.topology, follow the instructions for cloning the Gitub repository and integrating it with eclipse or running via command line.

Streams Quick Start Edition VM

The Streams Quick Start Edition VM contains the first release of the Java Application API, a ready-to-go release of IBM InfoSphere Streams, and a selection of commented sample applications that range from "Hello World" to a Volume Weighted Average Price stock trading simulation. Additionally, the Quick Start VM comes bundled with IBM Streams Studio, which provides an intuitive, visual representation of your streaming application.

For information on using the Quick Start VM and getting started with samples, please follow the Quick Start VM setup guide.

Download the VM: Streams Quick Start Edition VM

Integrating with Eclipse/Streams Studio

If you would like to use the Java Application API with Eclipse or Streams Studio on your own machine, make sure it already has a working release of IBM Streams (minimum version -- it's not sufficient to have just the API. Detailed instruction on installing and configuring IBM Streams can be found at the IBM Knowledge Center.

The Eclipse/Streams Studio integration guide may be found here. It provides instructions on linking Eclipse with an IBM Streams install, including the Java Application API libraries, and setting relevant environment variables.

Command line usage & Log Viewing

If you are a command line user, instructions on manually compiling and running Java Application API programs can be found in the command line getting guide. The guide also contains instructions for viewing the logs of distributed applications, both from the command line and the Streams Console GUI.