taskcluster-client-java

taskcluster-client-java

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.

• EC2 Manager
  A taskcluster service which manages EC2 instances.

• 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.

• Login
  The Login service serves as the interface between external authentication systems and TaskCluster credentials.

• Notify
  The notification service listens for tasks with associated notifications and sends them.

• 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.

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

AMQP APIs

Currently AMQP APIs are not supported in the java client.

Client utilities

• Credentials
  For credentials operations, such as:
  • Creating temporary credentials from permanent credentials
  • Limiting credentials to a set of authorized scopes

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.*;

...

	// Create credentials, e.g. from environment variables...
    Credentials creds = new Credentials(
        System.getenv("TASKCLUSTER_CLIENT_ID"),
        System.getenv("TASKCLUSTER_ACCESS_TOKEN"),
        System.getenv("TASKCLUSTER_CERTIFICATE")
    );

    // Instantiate the Queue client class
    Queue queue = new Queue(creds);

    // 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 ...
    }

...

Temporary credentials

You can generate temporary credentials from permanent credentials using the java client. This may be useful if you wish to issue credentials to a third party. See https://docs.taskcluster.net/manual/apis/temporary-credentials for more information. Both named and unnamed temporary credentials are supported, although named credentials are preferred if you are not sure which type to use.

Example

package org.mozilla.taskcluster;

import java.util.Date;

import org.mozilla.taskcluster.client.APICallFailure;
import org.mozilla.taskcluster.client.CallSummary;
import org.mozilla.taskcluster.client.Credentials;
import org.mozilla.taskcluster.client.EmptyPayload;
import org.mozilla.taskcluster.client.InvalidOptionsException;
import org.mozilla.taskcluster.client.queue.ListArtifactsResponse;
import org.mozilla.taskcluster.client.queue.ListArtifactsResponse.Artifacts;
import org.mozilla.taskcluster.client.queue.Queue;

/**
 * This simple demo lists the artifacts in run 0 of task U7On2dUVS9KlEgw7LUaCMQ.
 * It creates permanent credentials from environment variables
 * TASKCLUSTER_CLIENT_ID and TASKCLUSTER_ACCESS_TOKEN, and then creates
 * temporary credentials, valid for 24 hours, from these permanent credentials.
 * It queries the Queue using the temporary credentials, and with limited
 * authorized scopes.
 *
 * Note, the queue.listArtifacts(...) call doesn't require any scopes, the
 * generation of temporary credentials, and limiting via authorized scopes is
 * purely illustrative. The TASKCLUSTER_CLIENT_ID must satisfy
 * auth:create-client:demo-client/taskcluster-client-java, though.
 */
public class Demo {
    public static void main(String[] args) {
        Credentials permCreds = new Credentials(
            System.getenv("TASKCLUSTER_CLIENT_ID"),
            System.getenv("TASKCLUSTER_ACCESS_TOKEN")
        );
        Date now = new Date();
        try {
            Credentials tempCreds = permCreds.createTemporaryCredentials(
                "demo-client/taskcluster-client-java",
                new String[] {
                    "assume:legacy-permacred"
                },
                // valid immediately
                now,
                // expire in 24 hours
                new Date(now.getTime() + 1000 * 60 * 60 * 24)
            );
            tempCreds.authorizedScopes = new String[] { "queue:get-artifact:private/build/*" };
            Queue queue = new Queue(tempCreds);
            CallSummary<EmptyPayload, ListArtifactsResponse> cs = queue.listArtifacts("U7On2dUVS9KlEgw7LUaCMQ", "0");
            ListArtifactsResponse artifacts = cs.responsePayload;
            System.out.println("Artifacts:");
            for (Artifacts artifact : artifacts.artifacts) {
                System.out.println("  * " + artifact.name);
            }
            System.out.println("Done.");
        } catch (InvalidOptionsException e) {
            System.err.println("Could not create temporary credentials");
            e.printStackTrace();
        } catch (APICallFailure e) {
            System.err.println("Could not query the Queue service");
            e.printStackTrace();
        }
    }
}

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 (not java!) 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.