Join us at our Google Groups forum to ask questions, or see frequently asked questions.
See our Setup Guide which explains how to setup Eclipse with all the dependencies that you will need to build the sdk from source.
If using Intellij, simply import the project as a Gradle project.
To install the latest ds3_java_sdk either download the latest release jar file from the Releases page or clone the repository with git clone https://github.com/SpectraLogic/ds3_java_sdk.git, cd to ds3_java_sdk and run ./gradlew clean ds3-sdk:install to install the sdk into your local maven repository. It is compatible with Java 7 and above.
The SDK can also be included directly into a Maven or Gradle build. There is also a fatjar version that you can optionally use with the all classifier, take a look at the commented out code in the examples below. To include the SDK into maven add the following to the pom.xml file:
<project>
...
<repositories>
<repository>
<id>Spectra-Github</id>
<url>http://dl.bintray.com/spectralogic/ds3</url>
</repository>
</repositories>
...
<dependencies>
...
<dependency>
<groupId>com.spectralogic.ds3</groupId>
<artifactId>ds3-sdk</artifactId>
<version>1.2.5</version>
<!-- <classifier>all</classifier> -->
</dependency>
...
</dependencies>
</project>
To include the sdk into Gradle include the following in the build.gradle file:
repositories {
...
maven {
url 'http://dl.bintray.com/spectralogic/ds3'
}
...
}
dependencies {
...
compile 'com.spectralogic.ds3:ds3-sdk:1.2.5'
// compile 'com.spectralogic.ds3:ds3-sdk:1.2.5:all'
...
}
The latest javadoc is located at http://spectralogic.github.io/ds3_java_sdkj/javadoc/
All the examples are listed in the ds3-sdk-samples module.
In addition to unit tests in the main ds3-sdk module, there are additional integration tests in the ds3-integration module. Please see the integration README for details on running the tests. To just run the SDK's unit tests use:
./gradlew clean ds3-sdk:test