taskcluster-client-java

README

taskcluster-client-java

[](https://maven-badges.herokuapp.com/maven-central/org.mozilla.taskcluster/taskcluster-client/) [](http://travis-ci.org/taskcluster/taskcluster-client-java) [](http://taskcluster.github.io/taskcluster-client-java/apidocs) [](https://coveralls.io/github/taskcluster/taskcluster-client-java?branch=master) [](http://mozilla.org/MPL/2.0)

A java port of taskcluster-client.

HTTP APIs

• Auth
  Authentication related API end-points for taskcluster.

• AWS Provisioner
  The AWS Provisioner is responsible for provisioning instances on EC2 for use in TaskCluster.

• Github
  The Github service is responsible for publishing pulse messages for supported Github events.

• Hooks
  Hooks are a mechanism for creating tasks in response to events.

• Index
  The task index is responsible for indexing tasks.

• Purge Cache
  The purge-cache service is responsible for publishing a pulse message for workers, so they can purge cache upon request.

• Queue
  The queue is responsible for accepting tasks and track their state as they are executed by workers.

• Scheduler
  The task-graph scheduler is responsible for accepting task-graphs and scheduling tasks for evaluation by the queue as their dependencies are satisfied.

• Secrets
  The secrets service is responsible for managing secure data in TaskCluster.

AMQP APIs

Currently AMQP APIs are not supported in the java client.

Using

Maven

In order to use this library from your maven project, simply include it as a project dependency:

<project>
  ...
  <dependencies>
    ...
    <dependency>
      <groupId>org.mozilla.taskcluster</groupId>
      <artifactId>taskcluster-client</artifactId>
    </dependency>
  </dependencies>
</project>

The taskcluster-client artifacts are now available from the maven central repository:

• Search Results
• Directory Listing

Calling API End-Points

To invoke an API end-point, instantiate one of the HTTP API classes (from section HTTP APIs). In the following example we instantiate an instance of the Queue client class and use it to create a task.

import org.mozilla.taskcluster.client.*;
import org.mozilla.taskcluster.client.queue.*;

...

    // Instantiate the Queue Client class
    Queue queue = new Queue(System.getenv("TASKCLUSTER_CLIENT_ID"), System.getenv("TASKCLUSTER_ACCESS_TOKEN"));

    // Certificate must also be provided if using temporary credentials
    // Queue queue = new Queue(System.getenv("TASKCLUSTER_CLIENT_ID"), System.getenv("TASKCLUSTER_ACCESS_TOKEN"), System.getenv("TASKCLUSTER_CERTIFICATE"));

    // Supply a unique task name
    String taskId = "...";

    // Define the task
    TaskDefinition td = new TaskDefinition();

    // Set properties, as required...
    td.created = new java.util.Date();
    td.provisionerId = "...";
    td.routes = new String[] { "...", "...", "..." };
    td.XYZ = ...

    // Execute the API call
    try {
        TaskStatusResponse tsr = queue.defineTask(taskId, td).responsePayload;

        // Process API response
        System.out.println("State is " + tsr.status.state);

    } catch (APICallFailure e) {
        // handle exception ...
    }

...

See the HTTP API javadocs for more information, or browse the unit tests for further examples.

Building

The java libraries provided by this client are auto-generated in go using the schemas defined in http://references.taskcluster.net/manifest.json combined with supplementary information stored in apis.json.

In order to completely regenerate all of the HTTP and AMQP libraries, please run build.sh found in the top level directory. This will completely regenerate the library. Please note you will need an active internet connection as the build process must download several json files and schemas in order to build the library. The code generation requires go (golang) is installed on your system, and java, and apache maven. All three need to be setup and configured correctly.

The code which generates the library can all be found under the top level codegenerator directory.

Contributing

Contributions are welcome. Please fork, and issue a Pull Request back with an explanation of your changes.