[ARVADOS] updated: 1.3.0-614-gd66aa1521

Git user git at public.curoverse.com
Wed Apr 10 19:55:11 UTC 2019


Summary of changes:
 doc/Rakefile                                       |   5 +-
 doc/sdk/java-v2/index.html.textile.liquid          |  85 +++++-----
 sdk/java-v2/gradle/wrapper/gradle-wrapper.jar      | Bin 54727 -> 0 bytes
 .../gradle/wrapper/gradle-wrapper.properties       |   5 -
 sdk/java-v2/gradlew                                | 172 ---------------------
 sdk/java-v2/gradlew.bat                            |  84 ----------
 .../org/arvados/client/facade/ArvadosFacade.java   |   8 +
 sdk/java-v2/test-in-docker.sh                      |   4 +-
 8 files changed, 57 insertions(+), 306 deletions(-)
 delete mode 100644 sdk/java-v2/gradle/wrapper/gradle-wrapper.jar
 delete mode 100644 sdk/java-v2/gradle/wrapper/gradle-wrapper.properties
 delete mode 100755 sdk/java-v2/gradlew
 delete mode 100644 sdk/java-v2/gradlew.bat

       via  d66aa15210d809c64a046b1133865015095ac172 (commit)
       via  a7e7392d54753f52b44a207fec134bce931a5a06 (commit)
       via  6289afb4f83c5412552f1605046c3c8fb75ccd3a (commit)
      from  9a7e2a24f5f3d261e554ac3815b7e2a4c2e24503 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit d66aa15210d809c64a046b1133865015095ac172
Author: Tom Morris <tfmorris at veritasgenetics.com>
Date:   Wed Apr 10 15:52:46 2019 -0400

    Remove Gradle from source repo. Update docs & build to reflect change.
    
    Arvados-DCO-1.1-Signed-off-by: Tom Morris <tfmorris at veritasgenetics.com>

diff --git a/doc/Rakefile b/doc/Rakefile
index e1e91c0b7..752128331 100644
--- a/doc/Rakefile
+++ b/doc/Rakefile
@@ -6,7 +6,8 @@
 require "rubygems"
 require "colorize"
 
-task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
+#task :generate => [ :realclean, 'sdk/python/arvados/index.html', 'sdk/R/arvados/index.html', 'sdk/java-v2/javadoc/index.html' ] do
+task :generate => [ :realclean, 'sdk/python/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]
@@ -93,7 +94,7 @@ file "sdk/java-v2/javadoc/index.html" do |t|
     tgt = Dir.pwd
     docfiles = []
     Dir.chdir("../sdk/java-v2") do
-      STDERR.puts `./gradlew javadoc 2>&1`
+      STDERR.puts `gradle javadoc 2>&1`
     end
     cp_r("../sdk/java-v2/build/docs/javadoc", "sdk/java-v2")
     raise if $? != 0
diff --git a/doc/sdk/java-v2/index.html.textile.liquid b/doc/sdk/java-v2/index.html.textile.liquid
index ee7e6cdb4..90e8cfe00 100644
--- a/doc/sdk/java-v2/index.html.textile.liquid
+++ b/doc/sdk/java-v2/index.html.textile.liquid
@@ -119,8 +119,8 @@ Dependencies:
 <pre>
 $ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
 $ <code class="userinput">cd arvados/sdk/java-v2</code>
-$ <code class="userinput">./gradlew test</code>
-$ <code class="userinput">./gradlew jar</code>
+$ <code class="userinput">gradle test</code>
+$ <code class="userinput">gradle jar</code>
 </pre>
 This will build the SDK and run all unit tests, then generate an Arvados Java sdk jar file in build/libs/arvados-java-2.0.0.jar
 </notextile>
diff --git a/sdk/java-v2/gradle/wrapper/gradle-wrapper.jar b/sdk/java-v2/gradle/wrapper/gradle-wrapper.jar
deleted file mode 100644
index 27768f1bb..000000000
Binary files a/sdk/java-v2/gradle/wrapper/gradle-wrapper.jar and /dev/null differ
diff --git a/sdk/java-v2/gradle/wrapper/gradle-wrapper.properties b/sdk/java-v2/gradle/wrapper/gradle-wrapper.properties
deleted file mode 100644
index 9d2dc020a..000000000
--- a/sdk/java-v2/gradle/wrapper/gradle-wrapper.properties
+++ /dev/null
@@ -1,5 +0,0 @@
-distributionBase=GRADLE_USER_HOME
-distributionPath=wrapper/dists
-zipStoreBase=GRADLE_USER_HOME
-zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.8-bin.zip
diff --git a/sdk/java-v2/gradlew b/sdk/java-v2/gradlew
deleted file mode 100755
index cccdd3d51..000000000
--- a/sdk/java-v2/gradlew
+++ /dev/null
@@ -1,172 +0,0 @@
-#!/usr/bin/env sh
-
-##############################################################################
-##
-##  Gradle start up script for UN*X
-##
-##############################################################################
-
-# Attempt to set APP_HOME
-# Resolve links: $0 may be a link
-PRG="$0"
-# Need this for relative symlinks.
-while [ -h "$PRG" ] ; do
-    ls=`ls -ld "$PRG"`
-    link=`expr "$ls" : '.*-> \(.*\)$'`
-    if expr "$link" : '/.*' > /dev/null; then
-        PRG="$link"
-    else
-        PRG=`dirname "$PRG"`"/$link"
-    fi
-done
-SAVED="`pwd`"
-cd "`dirname \"$PRG\"`/" >/dev/null
-APP_HOME="`pwd -P`"
-cd "$SAVED" >/dev/null
-
-APP_NAME="Gradle"
-APP_BASE_NAME=`basename "$0"`
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
-
-# Use the maximum available, or set MAX_FD != -1 to use that value.
-MAX_FD="maximum"
-
-warn () {
-    echo "$*"
-}
-
-die () {
-    echo
-    echo "$*"
-    echo
-    exit 1
-}
-
-# OS specific support (must be 'true' or 'false').
-cygwin=false
-msys=false
-darwin=false
-nonstop=false
-case "`uname`" in
-  CYGWIN* )
-    cygwin=true
-    ;;
-  Darwin* )
-    darwin=true
-    ;;
-  MINGW* )
-    msys=true
-    ;;
-  NONSTOP* )
-    nonstop=true
-    ;;
-esac
-
-CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
-
-# Determine the Java command to use to start the JVM.
-if [ -n "$JAVA_HOME" ] ; then
-    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
-        # IBM's JDK on AIX uses strange locations for the executables
-        JAVACMD="$JAVA_HOME/jre/sh/java"
-    else
-        JAVACMD="$JAVA_HOME/bin/java"
-    fi
-    if [ ! -x "$JAVACMD" ] ; then
-        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
-
-Please set the JAVA_HOME variable in your environment to match the
-location of your Java installation."
-    fi
-else
-    JAVACMD="java"
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-
-Please set the JAVA_HOME variable in your environment to match the
-location of your Java installation."
-fi
-
-# Increase the maximum file descriptors if we can.
-if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
-    MAX_FD_LIMIT=`ulimit -H -n`
-    if [ $? -eq 0 ] ; then
-        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
-            MAX_FD="$MAX_FD_LIMIT"
-        fi
-        ulimit -n $MAX_FD
-        if [ $? -ne 0 ] ; then
-            warn "Could not set maximum file descriptor limit: $MAX_FD"
-        fi
-    else
-        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
-    fi
-fi
-
-# For Darwin, add options to specify how the application appears in the dock
-if $darwin; then
-    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
-fi
-
-# For Cygwin, switch paths to Windows format before running java
-if $cygwin ; then
-    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
-    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
-    JAVACMD=`cygpath --unix "$JAVACMD"`
-
-    # We build the pattern for arguments to be converted via cygpath
-    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
-    SEP=""
-    for dir in $ROOTDIRSRAW ; do
-        ROOTDIRS="$ROOTDIRS$SEP$dir"
-        SEP="|"
-    done
-    OURCYGPATTERN="(^($ROOTDIRS))"
-    # Add a user-defined pattern to the cygpath arguments
-    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
-        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
-    fi
-    # Now convert the arguments - kludge to limit ourselves to /bin/sh
-    i=0
-    for arg in "$@" ; do
-        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
-        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
-
-        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
-            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
-        else
-            eval `echo args$i`="\"$arg\""
-        fi
-        i=$((i+1))
-    done
-    case $i in
-        (0) set -- ;;
-        (1) set -- "$args0" ;;
-        (2) set -- "$args0" "$args1" ;;
-        (3) set -- "$args0" "$args1" "$args2" ;;
-        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
-    esac
-fi
-
-# Escape application args
-save () {
-    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
-    echo " "
-}
-APP_ARGS=$(save "$@")
-
-# Collect all arguments for the java command, following the shell quoting and substitution rules
-eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
-
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
-exec "$JAVACMD" "$@"
diff --git a/sdk/java-v2/gradlew.bat b/sdk/java-v2/gradlew.bat
deleted file mode 100644
index f9553162f..000000000
--- a/sdk/java-v2/gradlew.bat
+++ /dev/null
@@ -1,84 +0,0 @@
- at if "%DEBUG%" == "" @echo off
- at rem ##########################################################################
- at rem
- at rem  Gradle startup script for Windows
- at rem
- at rem ##########################################################################
-
- at rem Set local scope for the variables with windows NT shell
-if "%OS%"=="Windows_NT" setlocal
-
-set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
-set APP_BASE_NAME=%~n0
-set APP_HOME=%DIRNAME%
-
- at rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
-
- at rem Find java.exe
-if defined JAVA_HOME goto findJavaFromJavaHome
-
-set JAVA_EXE=java.exe
-%JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
-
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
-
-goto fail
-
-:findJavaFromJavaHome
-set JAVA_HOME=%JAVA_HOME:"=%
-set JAVA_EXE=%JAVA_HOME%/bin/java.exe
-
-if exist "%JAVA_EXE%" goto init
-
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
-
-goto fail
-
-:init
- at rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
- at rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
-:execute
- at rem Setup the command line
-
-set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
-
- at rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
-
-:end
- at rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
-
-:fail
-rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
-rem the _cmd.exe /c_ return code!
-if  not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
-
-:mainEnd
-if "%OS%"=="Windows_NT" endlocal
-
-:omega
diff --git a/sdk/java-v2/test-in-docker.sh b/sdk/java-v2/test-in-docker.sh
index d74934b00..160190978 100755
--- a/sdk/java-v2/test-in-docker.sh
+++ b/sdk/java-v2/test-in-docker.sh
@@ -6,5 +6,5 @@
 #
 
 set -e
-UID=$(id -u)
-exec docker run --rm --user $UID -v $PWD:$PWD -w $PWD java:8 /bin/sh -c '(./gradlew clean && ./gradlew test); ./gradlew --stop'
+#UID=$(id -u) # UID is read-only on many systems
+exec docker run --rm --user $UID -v $PWD:$PWD -w $PWD gradle /bin/sh -c '(gradle clean && gradle test); gradle --stop'

commit a7e7392d54753f52b44a207fec134bce931a5a06
Author: Tom Morris <tfmorris at veritasgenetics.com>
Date:   Wed Apr 10 15:39:09 2019 -0400

    Reorganize, clean up, and copy edit docs.
    
    Arvados-DCO-1.1-Signed-off-by: Tom Morris <tfmorris at veritasgenetics.com>

diff --git a/doc/sdk/java-v2/index.html.textile.liquid b/doc/sdk/java-v2/index.html.textile.liquid
index f4a4f6f85..ee7e6cdb4 100644
--- a/doc/sdk/java-v2/index.html.textile.liquid
+++ b/doc/sdk/java-v2/index.html.textile.liquid
@@ -10,57 +10,45 @@ 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.
-
-<notextile>
-<pre>
-$ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
-$ <code class="userinput">cd arvados/sdk/java-v2</code>
-$ <code class="userinput">./gradlew jar</code>
-  This will generate arvados sdk jar file in build/libs/arvados-java-2.0.0.jar
-</pre>
-</notextile>
+The Arvados Java SDK v2 provides a high level API for working with Arvados resources. It is packaged as a single JAR named
+arvados-java-<version>.jar, e.g. arvados-java-2.0.0.jar
+which can be included in your project using Gradle, Maven, or by hand.
 
 h2. Using the SDK
 
+FIXME - Add intro text here
+
 h3. Logging
 
-SLF4J is used for logging. Concrete logging framework and configuration must be provided by a client.
+The SDK uses the SLF4J facade library for logging. A concrete logging "binding":https://www.slf4j.org/manual.html#swapping (and configuration, if required) must be provided by a client. For small applications, you can use the Simple implementation by adding slf4j-simple-1.8.0-beta4.jar to your classpath.
 
 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.
+Please review src/main/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
+* **keepweb-host** - host of your Keep-Web server (default: localhost)
+* **keepweb-port** - port of your Keep-Web server (default: 8000)
+* **host** - host of your Arvados API server
+* **port** - port of your Arvados API server
+* **token** - Arvados token to authenticate 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 (default: https)
+* **host-insecure** - ignores SSL certificate verification if true (default: false Don't change to *true* unless really needed)
+* **split-size** - size of chunk files in megabytes (default: 64)
 * **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)
+* **retries** - UNIMPLEMENTED
 
-In order to override default settings one can create application.conf file in an application.  Example: src/test/resources/application.conf.
+In order to override default settings one can create an 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.
+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.
+ at ArvadosFacade@ has two constructors, one without arguments that uses values from application.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.
+All API clients inherit from @BaseStandardApiClient at . This class contains implementation of all common methods as described in "Arvados Common Resource Methods":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:
 
@@ -86,7 +74,7 @@ Non-standard API clients must inherit from BaseApiClient. For example: KeepServe
 
 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:
+More advanced API data handling could be implemented as *Facade* classes. In current version functionalities provided by SDK are handled by @ArvadosFacade at . They include:
 
 * **downloading single file from collection** - using Keep-Web
 * **downloading whole collection** - using Keep-Web or Keep Server API
@@ -101,24 +89,39 @@ More advanced API data handling could be implemented as *Facade* classes. In cur
 
 h3. Note regarding Keep-Web
 
-Current version requires both Keep Web and standard Keep Server API configured in order to use Keep-Web functionalities.
+The Java SDK requires Keep Web (which is part of the standard configuration) as well as the API server and Keep server(s).
 
 h3. Integration tests
 
-In order to run integration tests all fields within following configuration file must be provided:
+In order to run the integration tests, all fields within following configuration file must be provided: @src/test/resources/integration-test-appliation.conf@
 
-<code>
-src/test/resources/integration-test-appliation.conf
-</code>
 
-Parameter **integration-tests.project-uuid** should contain UUID of one project available to user, whose token was provided within configuration file.
+The parameter @integration-tests.project-uuid@ should contain UUID of one project available to user who's token was provided within configuration file.
 
-Integration tests require connection to real Arvados server.
+Integration tests require connection to a 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.
+When uploading via the current implementation of the Java 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 currently implemented.
 
 h3. Javadoc
 
 See "Javadoc":javadoc.html
+
+h2. Building the Arvados SDK
+
+Dependencies:
+* JDK for Java 8 or later https://www.oracle.com/technetwork/java/javase/downloads/index.html
+* Gradle https://gradle.org/install/
+
+
+<notextile>
+<pre>
+$ <code class="userinput">git clone https://github.com/curoverse/arvados.git</code>
+$ <code class="userinput">cd arvados/sdk/java-v2</code>
+$ <code class="userinput">./gradlew test</code>
+$ <code class="userinput">./gradlew jar</code>
+</pre>
+This will build the SDK and run all unit tests, then generate an Arvados Java sdk jar file in build/libs/arvados-java-2.0.0.jar
+</notextile>
+

commit 6289afb4f83c5412552f1605046c3c8fb75ccd3a
Author: Tom Morris <tfmorris at veritasgenetics.com>
Date:   Wed Apr 10 15:29:21 2019 -0400

    Add missing Javadoc for overloaded methods.
    
    Arvados-DCO-1.1-Signed-off-by: Tom Morris <tfmorris at veritasgenetics.com>

diff --git a/sdk/java-v2/src/main/java/org/arvados/client/facade/ArvadosFacade.java b/sdk/java-v2/src/main/java/org/arvados/client/facade/ArvadosFacade.java
index b80b528fe..858edf598 100644
--- a/sdk/java-v2/src/main/java/org/arvados/client/facade/ArvadosFacade.java
+++ b/sdk/java-v2/src/main/java/org/arvados/client/facade/ArvadosFacade.java
@@ -120,6 +120,8 @@ public class ArvadosFacade {
      * Created collection has a default name and is uploaded to user's 'Home' project.
      *
      * @see ArvadosFacade#upload(List, String, String)
+     * @param files    list of files to be uploaded within new collection
+     * @return collection object mapped from JSON that is returned from server after successful upload
      */
     public Collection upload(List<File> files) {
         return upload(files, null, null);
@@ -130,6 +132,8 @@ public class ArvadosFacade {
      * Created collection has a default name and is uploaded to user's 'Home' project.
      *
      * @see ArvadosFacade#upload(List, String, String)
+     * @param file file to be uploaded
+     * @return collection object mapped from JSON that is returned from server after successful upload
      */
     public Collection upload(File file) {
         return upload(Collections.singletonList(file), null, null);
@@ -157,6 +161,10 @@ public class ArvadosFacade {
      * Uploads a file to a specified collection.
      *
      * @see ArvadosFacade#uploadToExistingCollection(List, String)
+     * @param file           file to be uploaded to existing collection. Filenames must be unique
+     *                       in comparison with files already existing within collection.
+     * @param collectionUUID UUID of collection to which files should be uploaded
+     * @return collection object mapped from JSON that is returned from server after successful upload
      */
     public Collection uploadToExistingCollection(File file, String collectionUUID) {
         return fileUploader.uploadToExistingCollection(Collections.singletonList(file), collectionUUID);

-----------------------------------------------------------------------


hooks/post-receive
-- 




More information about the arvados-commits mailing list