Page History

Download

Download the Store Client, Service Client, and Report Client from the Downloads page

Available clients

StoreClient

DuraCloud provides access to files stored in cloud storage systems through an application called DuraStore. DuraStore is installed and running on your DuraCloud instance and can be accessed via a REST interface. In order to aid Java developers in communicating with DuraStore, a Java client, called StoreClient was written.

ServiceClient

DuraCloud provides management capabilities to deploy, undeploy, configure, and gain status of the services within DuraCloud through an application called DuraService. DuraService is installed and running on your DuraCloud instance and can be accessed via a REST interface. In order to aid Java developers in communicating with DuraService, a Java client, called ServiceClient was written.

ReportClient

DuraCloud provides reporting capabilities which assist in understanding and managing the content stored in DuraCloud and services run through DuraCloud. These capabilities are included as part of an application called DuraBoss. DuraBoss is installed and running on your DuraCloud instance and the reporting capabilities can be accessed via a REST interface. In order to aid Java developers in communicating with the reporting features of DuraBoss, a Java client, called ReportClient was written.

ExecutorClient

DuraCloud includes a component called the Executor, which performs actions over the storage and services maintained by DuraStore and DuraService. The Executor allows services to be run in an automated and scheduled fashion. Similar to the reporting functions noted above, the Executor is part of an application called DuraBoss. DuraBoss is installed and running on your DuraCloud instance and the Executor can be accessed via a REST interface. In order to aid Java developers in communicating with the Executor in DuraBoss, a Java client, called ExecutorClient was written.

ManifestClient

DuraCloud provides the ability to retrieve a manifest file for any space maintained in storage. These manifests list all of the content items and their MD5 checksums, which can be used to compare with your local file system, or with the contents of your DuraCloud space at a later date. This manifest capability is part of the DuraBoss application, which is installed and running on your DuraCloud instance, and can be accessed via a REST interface. In order to aid Java developers in retrieving manifest documents, a Java client, called ManifestClient was written.

Using the clients

To use any of the above clients, you will need all of the jars included in the libs directory of the download package to be available on your classpath. You will then be able to write code using the provided Javadocs to interact with the client.

Example code

For each of the clients listed above, an example Java class has been provided to assist in set up and testing, as well as a starting point for writing your client code. The example client (found in ExampleClient.java) includes a simple main class which performs a subset calls the client is capable of performing, and printing information to the console. To run an example:

...

Using the client

To use the StoreClinet, you will need to include the necessary dependencies. This is best done using Maven, as follows:

StoreClient

<dependency>
  <groupId>org.duracloud</groupId>
  <artifactId>storeclient</artifactId>
  <version>{duracloud-version}</version>
</dependency>

Example code

StoreClient

An example Maven-based project which provides examples for using the storeclient can be found on Github here: https://github.com/duracloud/rest-client-example

...