[ARVADOS] created: 2.1.0-1727-g49a8f11dc
Git user
git at public.arvados.org
Tue Dec 14 16:52:00 UTC 2021
at 49a8f11dc32bf1d7d5282d5bdb0b66493df90277 (commit)
commit 49a8f11dc32bf1d7d5282d5bdb0b66493df90277
Author: Ward Vandewege <ward at curii.com>
Date: Tue Dec 14 11:51:27 2021 -0500
18585: remove the old Java SDK, it has been deprecated for years and the
Java SDK v2 works much better.
Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <ward at curii.com>
diff --git a/doc/_config.yml b/doc/_config.yml
index 83be731e8..eb0f173df 100644
--- a/doc/_config.yml
+++ b/doc/_config.yml
@@ -100,9 +100,6 @@ navbar:
- sdk/java-v2/index.html.textile.liquid
- sdk/java-v2/example.html.textile.liquid
- sdk/java-v2/javadoc.html.textile.liquid
- - Java v1:
- - sdk/java/index.html.textile.liquid
- - sdk/java/example.html.textile.liquid
- Perl:
- sdk/perl/index.html.textile.liquid
- sdk/perl/example.html.textile.liquid
diff --git a/doc/sdk/index.html.textile.liquid b/doc/sdk/index.html.textile.liquid
index 844f1ff71..0bfe7ea72 100644
--- a/doc/sdk/index.html.textile.liquid
+++ b/doc/sdk/index.html.textile.liquid
@@ -17,7 +17,6 @@ This section documents language bindings for the "Arvados API":{{site.baseurl}}/
* "R SDK":{{site.baseurl}}/sdk/R/index.html
* "Ruby SDK":{{site.baseurl}}/sdk/ruby/index.html
* "Java SDK v2":{{site.baseurl}}/sdk/java-v2/index.html
-* "Java SDK v1":{{site.baseurl}}/sdk/java/index.html
* "Perl SDK":{{site.baseurl}}/sdk/perl/index.html
Many Arvados Workbench pages, under the *Advanced* tab, provide examples of API and SDK use for accessing the current resource .
diff --git a/doc/sdk/java/example.html.textile.liquid b/doc/sdk/java/example.html.textile.liquid
deleted file mode 100644
index bc15b83f4..000000000
--- a/doc/sdk/java/example.html.textile.liquid
+++ /dev/null
@@ -1,83 +0,0 @@
----
-layout: default
-navsection: sdk
-navmenu: Java
-title: "Examples"
-...
-{% comment %}
-Copyright (C) The Arvados Authors. All rights reserved.
-
-SPDX-License-Identifier: CC-BY-SA-3.0
-{% endcomment %}
-
-h2. Initialize SDK
-
-{% codeblock as java %}
-import org.arvados.sdk.Arvados;
-{% endcodeblock %}
-
-{% codeblock as java %}
- String apiName = "arvados";
- String apiVersion = "v1";
-
- Arvados arv = new Arvados(apiName, apiVersion);
-{% endcodeblock %}
-
-h2. create
-
-{% codeblock as java %}
- Map<String, String> collection = new HashMap<String, String>();
- collection.put("name", "create example");
-
- Map<String, Object> params = new HashMap<String, Object>();
- params.put("collection", collection);
- Map response = arv.call("collections", "create", params);
-{% endcodeblock %}
-
-h2. delete
-
-{% codeblock as java %}
- Map<String, Object> params = new HashMap<String, Object>();
- params.put("uuid", uuid);
- Map response = arv.call("collections", "delete", params);
-{% endcodeblock %}
-
-h2. get
-
-{% codeblock as java %}
- params = new HashMap<String, Object>();
- params.put("uuid", userUuid);
- Map response = arv.call("users", "get", params);
-{% endcodeblock %}
-
-h2. list
-
-{% codeblock as java %}
- Map<String, Object> params = new HashMap<String, Object>();
- Map response = arv.call("users", "list", params);
-
- // get uuid of the first user from the response
- List items = (List)response.get("items");
-
- Map firstUser = (Map)items.get(0);
- String userUuid = (String)firstUser.get("uuid");
-{% endcodeblock %}
-
-h2. update
-
-{% codeblock as java %}
- Map<String, String> collection = new HashMap<String, String>();
- collection.put("name", "update example");
-
- Map<String, Object> params = new HashMap<String, Object>();
- params.put("uuid", uuid);
- params.put("collection", collection);
- Map response = arv.call("collections", "update", params);
-{% endcodeblock %}
-
-h2. Get current user
-
-{% codeblock as java %}
- Map<String, Object> params = new HashMap<String, Object>();
- Map response = arv.call("users", "current", params);
-{% endcodeblock %}
diff --git a/doc/sdk/java/index.html.textile.liquid b/doc/sdk/java/index.html.textile.liquid
deleted file mode 100644
index 25b705754..000000000
--- a/doc/sdk/java/index.html.textile.liquid
+++ /dev/null
@@ -1,146 +0,0 @@
----
-layout: default
-navsection: 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.
-
-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.
-
-* 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
-
-
-h3. Setting up the environment
-
-* The SDK requires a running Arvados API server. The following information
- about the API server needs to be passed to the SDK using environment
- variables or during the construction of the Arvados instance.
-
-<notextile>
-<pre>
-ARVADOS_API_TOKEN: API client token to be used to authorize with API server.
-
-ARVADOS_API_HOST: Host name of the API server.
-
-ARVADOS_API_HOST_INSECURE: Set this to true if you are using self-signed
- certificates and would like to bypass certificate validations.
-</pre>
-</notextile>
-
-* Please see "api-tokens":{{site.baseurl}}/user/reference/api-tokens.html for full details.
-
-
-h3. Building the Arvados SDK
-
-<notextile>
-<pre>
-$ <code class="userinput">cd $ARVADOS_HOME/sdk/java</code>
-
-$ <code class="userinput">mvn -Dmaven.test.skip=true clean package</code>
- This will generate arvados sdk jar file in the target directory
-</pre>
-</notextile>
-
-
-h3. Implementing your code to use SDK
-
-* The following two sample programs serve as sample implementations using the SDK.
-<code class="userinput">$ARVADOS_HOME/sdk/java/ArvadosSDKJavaExample.java</code> is a simple program
- that makes a few calls to API server.
-<code class="userinput">$ARVADOS_HOME/sdk/java/ArvadosSDKJavaExampleWithPrompt.java</code> can be
- used to make calls to API server interactively.
-
-Please use these implementations to see how you would use the SDK from your java program.
-
-Also, refer to <code class="userinput">$ARVADOS_HOME/arvados/sdk/java/src/test/java/org/arvados/sdk/java/ArvadosTest.java</code>
-for more sample API invocation examples.
-
-Below are the steps to compile and run these java program.
-
-* These programs create an instance of Arvados SDK class and use it to
-make various <code class="userinput">call</code> requests.
-
-* To compile the examples
-<notextile>
-<pre>
-$ <code class="userinput">javac -cp $ARVADOS_HOME/sdk/java/target/arvados-sdk-1.1-jar-with-dependencies.jar \
-ArvadosSDKJavaExample*.java</code>
-This results in the generation of the ArvadosSDKJavaExample*.class files
-in the same directory as the java files
-</pre>
-</notextile>
-
-* To run the samples
-<notextile>
-<pre>
-$ <code class="userinput">java -cp .:$ARVADOS_HOME/sdk/java/target/arvados-sdk-1.1-jar-with-dependencies.jar \
-ArvadosSDKJavaExample</code>
-$ <code class="userinput">java -cp .:$ARVADOS_HOME/sdk/java/target/arvados-sdk-1.1-jar-with-dependencies.jar \
-ArvadosSDKJavaExampleWithPrompt</code>
-</pre>
-</notextile>
-
-
-h3. Viewing and Managing SDK logging
-
-* SDK uses log4j logging
-
-* The default location of the log file is
- <code class="userinput">$ARVADOS_HOME/sdk/java/log/arvados_sdk_java.log</code>
-
-* Update <code class="userinput">log4j.properties</code> file to change name and location of the log file.
-
-<notextile>
-<pre>
-$ <code class="userinput">nano $ARVADOS_HOME/sdk/java/src/main/resources/log4j.properties</code>
-and modify the <code class="userinput">log4j.appender.fileAppender.File</code> property as needed.
-
-Rebuild the SDK:
-$ <code class="userinput">mvn -Dmaven.test.skip=true clean package</code>
-</pre>
-</notextile>
-
-
-h3. Using the SDK in eclipse
-
-* To develop in eclipse, you can use the provided <code class="userinput">eclipse project</code>
-
-* Install "m2eclipse":https://www.eclipse.org/m2e/ plugin in your eclipse
-
-* Set <code class="userinput">M2_REPO</code> classpath variable in eclipse to point to your local repository.
-The local repository is usually located in your home directory at <code class="userinput">$HOME/.m2/repository</code>.
-
-<notextile>
-<pre>
-In Eclipse IDE:
-Window -> Preferences -> Java -> Build Path -> Classpath Variables
- Click on the "New..." button and add a new
- M2_REPO variable and set it to your local Maven repository
-</pre>
-</notextile>
-
-
-* Open the SDK project in eclipse
-<notextile>
-<pre>
-In Eclipse IDE:
-File -> Import -> Existing Projects into Workspace -> Next -> Browse
- and select $ARVADOS_HOME/sdk/java
-</pre>
-</notextile>
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list