Java Client for BOSH

A Java client for the bosh.io Director API.

While the client implements a large portion of the BOSH API, it doesn't yet have full coverage.

Maven Dependency

The library is available in Maven Central.

<dependency>
    <groupId>io.bosh.client</groupId>
    <artifactId>bosh-java-client</artifactId>
    <version>${bosh-java-client.version}</version>
</dependency>

See Maven Search for released versions.

Usage

The BOSH Director API is primarily an asynchronous, task-based API and many operations can be long running. The bosh-java-client uses RxJava Observables as the return type for all API calls to allow the client applications to choose how they wish to deal with the asynchronous nature of the BOSH API.

The DirectorClient is the entry point into the API. Each domin area has its own interface that you can access through the DirectorClient. To create instances of the DirectorClient, use the SpringDirectorClientBuilder

DirectorClient client = new SpringDirectorClientBuilder()
                .withHost("192.168.50.4")
                .withCredentials("admin", "admin")
                .build();

You can consume the Observables in a variety of ways such as examples below. Unless otherwise noted in the API, the Observables returned will only emit a single item.

FetchLogsRequest request = new FetchLogsRequest()
        .withDeploymentName("my-deployment")
        .withJobName("my-job")
        .withJobIndex(2)
        .withLogType(LogType.JOB);
InputStream logs = client.jobs().fetchLogs(request).toBlocking().single();
// do something with the logs

Deployments deployments = client.deployments();
deployments.list().subscribe(deploymentList -> {
            
			// ...
        });         

// or
Deployments deployments = client.deployments();
deployments.list().subscribe(deploymentList -> {
    // ...
    }, error -> {
        // handle error
    });

Compatibility

The BOSH team does not currently consider the Director API to be public and it may be subject to breaking changes between releases. Please test against the specific version of BOSH that you are running.

Logging

The project uses commons-logging. To enable logging of all the calls (the URL being called, not the payload) to the BOSH Director, set the logging level of the BOSH_DIRECTOR_API to INFO.

Continuous Integration

The CI server for the project is hosted at https://gaptap.atlassian.net/builds/browse/BJC-BOS.