From 8cd2bd00d2ef2b816bc4f9af008f97f44e258e17 Mon Sep 17 00:00:00 2001 From: Peter Amstutz Date: Fri, 8 Mar 2019 14:20:32 -0500 Subject: [PATCH] 14670: Add java sdk v2 to docs Arvados-DCO-1.1-Signed-off-by: Peter Amstutz --- .gitignore | 1 + doc/Rakefile | 18 ++- doc/_config.yml | 5 +- doc/sdk/index.html.textile.liquid | 3 +- doc/sdk/java-v2/index.html.textile.liquid | 126 ++++++++++++++++++++ doc/sdk/java-v2/javadoc.html.textile.liquid | 15 +++ doc/sdk/java/index.html.textile.liquid | 4 +- 7 files changed, 167 insertions(+), 5 deletions(-) create mode 100644 doc/sdk/java-v2/index.html.textile.liquid create mode 100644 doc/sdk/java-v2/javadoc.html.textile.liquid diff --git a/.gitignore b/.gitignore index db3020ae82..877ccdf4df 100644 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ docker/config.yml doc/.site doc/sdk/python/arvados doc/sdk/R/arvados +doc/sdk/java-v2/javadoc sdk/perl/MYMETA.* sdk/perl/Makefile sdk/perl/blib diff --git a/doc/Rakefile b/doc/Rakefile index 9deca3a28c..e1e91c0b72 100644 --- a/doc/Rakefile +++ b/doc/Rakefile @@ -6,7 +6,7 @@ require "rubygems" require "colorize" -task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html' ] do +task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do vars = ['baseurl', 'arvados_cluster_uuid', 'arvados_api_host', 'arvados_workbench_host'] vars.each do |v| if ENV[v] @@ -87,6 +87,21 @@ EOF end end +file "sdk/java-v2/javadoc/index.html" do |t| + `which java` + if $? == 0 + tgt = Dir.pwd + docfiles = [] + Dir.chdir("../sdk/java-v2") do + STDERR.puts `./gradlew javadoc 2>&1` + end + cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2") + raise if $? != 0 + else + puts "Warning: java not found, java sdk documentation will not be generated".colorize(:light_red) + end +end + task :linkchecker => [ :generate ] do Dir.chdir(".site") do `which linkchecker` @@ -101,6 +116,7 @@ end task :clean do rm_rf "sdk/python/arvados" rm_rf "sdk/R" + rm_rf "sdk/java-v2/javadoc" end require "zenweb/tasks" diff --git a/doc/_config.yml b/doc/_config.yml index 1e17d04706..837e2a8680 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -104,7 +104,10 @@ navbar: - Ruby: - sdk/ruby/index.html.textile.liquid - sdk/ruby/example.html.textile.liquid - - Java: + - Java v2: + - sdk/java-v2/index.html.textile.liquid + - sdk/java-v2/javadoc.html.textile.liquid + - Java v1: - sdk/java/index.html.textile.liquid - sdk/java/example.html.textile.liquid api: diff --git a/doc/sdk/index.html.textile.liquid b/doc/sdk/index.html.textile.liquid index dbfcaedc71..8ff5ddc099 100644 --- a/doc/sdk/index.html.textile.liquid +++ b/doc/sdk/index.html.textile.liquid @@ -17,6 +17,7 @@ This section documents language bindings for the "Arvados API":{{site.baseurl}}/ * "R SDK":{{site.baseurl}}/sdk/R/index.html * "Perl SDK":{{site.baseurl}}/sdk/perl/index.html * "Ruby SDK":{{site.baseurl}}/sdk/ruby/index.html -* "Java SDK":{{site.baseurl}}/sdk/java/index.html +* "Java SDK v2":{{site.baseurl}}/sdk/java-v2/index.html +* "Java SDK v1":{{site.baseurl}}/sdk/java/index.html Many Arvados Workbench pages, under the the *Advanced* tab, provide examples of API and SDK use for accessing the current resource . diff --git a/doc/sdk/java-v2/index.html.textile.liquid b/doc/sdk/java-v2/index.html.textile.liquid new file mode 100644 index 0000000000..2be3970c73 --- /dev/null +++ b/doc/sdk/java-v2/index.html.textile.liquid @@ -0,0 +1,126 @@ +--- +layout: default +navsection: sdk +navmenu: Java SDK v2 +title: "Installation" +... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} + +The Java SDK v2 provides a high level API for working with Arvados resources and files in Keep. + +h2. Building the Arvados SDK + +* The Java SDK requires Java 8 or later + +* The Java SDK is implemented as a Gradle project. Gradle is included in the source tree. + + +
+$ git clone https://github.com/curoverse/arvados-sdk-java.git
+
+$ cd arvados-sdk-java
+
+$ ./gradlew jar
+  This will generate arvados sdk jar file in build/libs/arvados-java-2.0.0.jar
+
+ + +h2. Using the SDK + +h3. Logging + +SLF4J is used for logging. Concrete logging framework and configuration must be provided by a client. + +h3. Configuration + +"TypeSafe Configuration":https://github.com/lightbend/config is used for configuring this library. + +Please, have a look at java/resources/reference.conf for default values provided with this library. + +* **keepweb-host** - change to host of your Keep-Web installation +* **keepweb-port** - change to port of your Keep-Web installation +* **host** - change to host of your Arvados installation +* **port** - change to port of your Arvados installation +* **token** - authenticates registered user, one must provide "token obtained from Arvados Workbench":https://doc.arvados.org/user/reference/api-tokens.html +* **protocol** - don't change to unless really needed +* **host-insecure** - insecure communication with Arvados (ignores SSL certificate verification), don't change to *true* unless really needed +* **split-size** - size of chunk files in megabytes +* **temp-dir** - temporary chunk files storage +* **copies** - amount of chunk files duplicates per Keep server +* **retries** - in case of chunk files send failure this should allow to repeat send + (*NOTE*: this parameter is not used at the moment but was left for future improvements) + +In order to override default settings one can create application.conf file in an application. Example: src/test/resources/application.conf. + +Alternatively ExternalConfigProvider class can be used to pass configuration via code. ExternalConfigProvider comes with a builder and all of the above values must be provided in order for it to work properly. + +ArvadosFacade has two constructors, one without arguments that uses values from reference.conf and second one taking ExternalConfigProvider as an argument. + +h3. API clients + +All API clients inherit from BaseStandardApiClient. This class contains implementation of all common methods as described in http://doc.arvados.org/api/methods.html. + +Parameters provided to common or specific methods are String UUID or fields wrapped in Java objects. For example: + +{% codeblock as java %} +String uuid = "ardev-4zz18-rxcql7qwyakg1r1"; + +Collection actual = client.get(uuid); +{% endcodeblock %} + +{% codeblock as java %} +ListArgument listArgument = ListArgument.builder() + .filters(Arrays.asList( + Filter.of("owner_uuid", Operator.LIKE, "ardev%"), + Filter.of("name", Operator.LIKE, "Super%"), + Filter.of("portable_data_hash", Operator.IN, Lists.newArrayList("54f6d9f59065d3c009d4306660989379+65") + ))) + .build(); + +CollectionList actual = client.list(listArgument); +{% endcodeblock %} + +Non-standard API clients must inherit from BaseApiClient. For example: KeepServerApiClient communicates directly with Keep servers using exclusively non-common methods. + +h3. Business logic + +More advanced API data handling could be implemented as *Facade* classes. In current version functionalities provided by SDK are handled by *ArvadosFacade*. They include: + +* **downloading single file from collection** - using Keep-Web +* **downloading whole collection** - using Keep-Web or Keep Server API +* **listing file info from certain collection** - information is returned as list of *FileTokens* providing file details +* **uploading single file** - to either new or existing collection +* **uploading list of files** - to either new or existing collection +* **creating an empty collection** +* **getting current user info** +* **listing current user's collections** +* **creating new project** +* **deleting certain collection** + +h3. Note regarding Keep-Web + +Current version requires both Keep Web and standard Keep Server API configured in order to use Keep-Web functionalities. + +h3. Integration tests + +In order to run integration tests all fields within following configuration file must be provided: + + +src/test/resources/integration-test-appliation.conf + + +Parameter **integration-tests.project-uuid** should contain UUID of one project available to user, whose token was provided within configuration file. + +Integration tests require connection to real Arvados server. + +h3. Note regarding file naming + +While uploading via this SDK all uploaded files within single collection must have different names. This applies also to uploading files to already existing collection. Renaming files with duplicate names is not implemented in current version. + +h3. Javadoc + +See "Javadoc":javadoc.html diff --git a/doc/sdk/java-v2/javadoc.html.textile.liquid b/doc/sdk/java-v2/javadoc.html.textile.liquid new file mode 100644 index 0000000000..872150f625 --- /dev/null +++ b/doc/sdk/java-v2/javadoc.html.textile.liquid @@ -0,0 +1,15 @@ +--- +layout: default +navsection: sdk +navmenu: Java v2 +title: "Javadoc Reference" + +no_nav_left: true +... +{% comment %} +Copyright (C) The Arvados Authors. All rights reserved. + +SPDX-License-Identifier: CC-BY-SA-3.0 +{% endcomment %} + +notextile.