Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master

Getting Started

There are three ways to get this package.

  1. Add it as a Maven dependency Your pom.xml will look something like:
  1. Download the jar from Maven Repo.

  2. Build from source with Apache Buildr:

    buildr package

The .jar file will appear under the target directory.

Basic Usage

Visit for more details.

This is very basic guide. Note that this library supports all IronWorker API features, it just lacks documentation.

Create Client

It'll be used for all IronWorker interactions.

import io.iron.ironworker.client.Client;

Client client = new Client("IRON_IO_TOKEN", "IRON_IO_PROJECT_ID");

Create Code Package

This isn't implemented in this library yet, so you need to create zip which will contain all jars you need and which will simply run java executable.

root() {
  while [ $# -gt 0 ]; do
    if [ "$1" = "-d" ]; then
      printf "%s\n" "$2"

cd "$(root "$@")"

java -cp xerces.jar -jar worker.jar "$@"

You can also use to create and upload code package.

Upload Code Package

You need to specify name by which you'll call your worker later and path to zip created at previous step.


JavaCode code = new JavaCode("MyWorker", "path/to/");

Run It

Prefered way is to use provided builders like Params or TaskOptions, but you can fall back and pass Map<String, Object> instead.

import io.iron.ironworker.client.entities.TaskEntity;

// specififying some options
TaskEntity t = client.createTask("MyWorker",
        Params.add("param", 13).add("another", "value"),

// alternate params syntax
client.createTask("MyWorker", Params.create("param", 13, "another", "value"));

Setting Task Priority

You can specify priority of the task by setting the corresponding parameter of Client.createTask method.

// Run the task with highest priority
TaskEntity t = client.createTask("MyWorker", params, TaskOptions.priority(2));

Value of parameter means the priority queue to run the task in. Valid values are 0, 1, and 2. 0 is the default.

Get Results

At the moment entities just hold data, you need to call client yourself.

  t = client.getTask(t.getId()); // update information
  String status = t.getStatus();

  String log = client.getTaskLog(t.getId()); 
Something went wrong with that request. Please try again.