X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/a87ad3026e4f7e1cc2e22082a523fa7143388c88..2f66d4cc05e9442a9bb69969744d0750a02a1ed4:/doc/sdk/java/index.html.textile.liquid diff --git a/doc/sdk/java/index.html.textile.liquid b/doc/sdk/java/index.html.textile.liquid index 11b1172399..25b7057542 100644 --- a/doc/sdk/java/index.html.textile.liquid +++ b/doc/sdk/java/index.html.textile.liquid @@ -1,20 +1,26 @@ --- layout: default navsection: sdk -navmenu: Java -title: "Java SDK" - +navmenu: Java SDK v1 +title: "Installation" ... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} + +The Java SDK v1 provides a low level API to call Arvados from Java. -The Java SDK provides a generic set of wrappers so you can make API calls in java. +This is a legacy SDK. It is no longer used or maintained regularly. The "Arvados Java SDK v2":../java-v2/index.html should be used. h3. Introdution * The Java SDK requires Java 6 or later - + * The Java SDK is implemented as a maven project. Hence, you would need a working maven environment to be able to build the source code. If you do not have maven setup, -you may find the "Maven in 5 Minutes":http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html link useful. +you may find the "Maven in 5 Minutes":http://maven.apache.org/guides/getting-started/maven-in-five-minutes.html link useful. * In this document $ARVADOS_HOME is used to refer to the directory where arvados code is cloned in your system. For ex: $ARVADOS_HOME = $HOME/arvados @@ -38,7 +44,7 @@ ARVADOS_API_HOST_INSECURE: Set this to true if you are using self-signed * Please see "api-tokens":{{site.baseurl}}/user/reference/api-tokens.html for full details. - + h3. Building the Arvados SDK @@ -60,7 +66,7 @@ h3. Implementing your code to use SDK $ARVADOS_HOME/sdk/java/ArvadosSDKJavaExampleWithPrompt.java can be used to make calls to API server interactively. -Please use these implementations to see how you would want use the SDK from your java program. +Please use these implementations to see how you would use the SDK from your java program. Also, refer to $ARVADOS_HOME/arvados/sdk/java/src/test/java/org/arvados/sdk/java/ArvadosTest.java for more sample API invocation examples. @@ -73,7 +79,7 @@ make various call requests. * To compile the examples
-$ javac -cp $ARVADOS_HOME/sdk/java/target/arvados-sdk-1.0-jar-with-dependencies.jar \
+$ javac -cp $ARVADOS_HOME/sdk/java/target/arvados-sdk-1.1-jar-with-dependencies.jar \
 ArvadosSDKJavaExample*.java
 This results in the generation of the ArvadosSDKJavaExample*.class files
 in the same directory as the java files
@@ -83,9 +89,9 @@ in the same directory as the java files
 * To run the samples
 
 
-$ java -cp .:$ARVADOS_HOME/sdk/java/target/arvados-sdk-1.0-jar-with-dependencies.jar \
+$ java -cp .:$ARVADOS_HOME/sdk/java/target/arvados-sdk-1.1-jar-with-dependencies.jar \
 ArvadosSDKJavaExample
-$ java -cp .:$ARVADOS_HOME/sdk/java/target/arvados-sdk-1.0-jar-with-dependencies.jar \
+$ java -cp .:$ARVADOS_HOME/sdk/java/target/arvados-sdk-1.1-jar-with-dependencies.jar \
 ArvadosSDKJavaExampleWithPrompt
 
@@ -124,7 +130,7 @@ The local repository is usually located in your home directory at