You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

SEAD's restful service api (see http://sead.ncsa.illinois.edu/sead-acr-api ) allows you to read/write/annotate/tag/delete datasets and collections (among other things). These services are used within SEAD's bulk upload/sync command line tool and can be called from Curl or your own code to allow your application to read/write directly to/from ACR spaces.

 

SEAD Uploader

The SEAD Uploader is a command line tool that can be used to upload or sync portions of your disk with an ACR project space. (The upload speed you achieve will depend on your disk and network speed, but the client itself can manage >10K file uploads and we've seen at least 250MB/minute transfer speeds over a mix of large and small files.)

The uploader is invoked as

java -cp sead1.jar <-listonly> <-merge> <-limit<X>> <serverUrl> <directories/files list...>

where:

-listonly: write information about what would/would not be transferred without doing any upload

-merge: do not create new collections or datasets if ones uploaded from the same path already exist

-limit<X>: limit this run to at most X dataset uploads (any required collections will be automatically created)

serverUrl: the base URL of the ACR project space you're interacting with, e.g. http://sead-demo.ncsa.illinois.edu/acr

directories/files lists - a list of one or more directory or file names the Uploader should work on. The Uploader will recurse (depth first) through the files and subdirectories contained within any listed directory.

Examples:

java -cp sead1.jar -listonly http://sead-demo.ncsa.illinois.edu/acr mydir

Check ./mydir and list all collections and datasets that would be created without the -listonly flag

java -cp sead1.jar http://sead-demo.ncsa.illinois.edu/acr mydir

Create a "mydir" collection in the project space and create collections and datasets for all contained items. Each item will be annotated with metadata indicating the original path (user metadata: "instanceOf (http://purl.org/vocab/frbr/core#embodimentOf) with the value /mydir for the mydir directory in this example and /mydir/<relative path> for all children).

Note that if this command is run a second time, new collections and datasets will be created - probably not what you'd want. Instead use:

java -cp sead1.jar -merge http://sead-demo.ncsa.illinois.edu/acr mydir

This command will only create collections and datasets that have not previously been uploaded. (The "instanceOf" metadata is used to identify matching items, so starting with the same directory on your disk is required (i.e. starting up or down one directory will result in new uploads))

java -cp sead1.jar -merge -limit100 http://sead-demo.ncsa.illinois.edu/acr mydir

Upload a maximum of 100 datasets (files) and only create the collections (directories) required. Using this command repeatedly (with the -merge flag) will upload the next 100 datasets, so repeated use will eventually upload all datasets, as though the limit flag had not been used. Since this mode (with -merge and -limit) requires the Uploader to check for existing files to identify where to begin, it will be slower than not using the -limit switch.

java -cp sead1.jar -merge http://sead-demo.ncsa.illinois.edu/acr file1.txt file2.txt file3.txt

Upload the three listed files if the do not exist in the ACR space

 

The SEADUploader requires authentication. The first time it is invoked, it will initiate a Google "device" authorization request for SEAD (similar to what you may have seen with Netflix or other services on your TV). The Uploader will generate a code and provide a Google URL. Using a browser on any machine, you can go to the URL and enter the code. Once you've completed that, hit <enter> and the SEADUploader will continue and acquire a Google token it will use to authenticate you to SEAD. After the first time, the Uploader will use the acquired refresh_token to automatically log in on your behalf. This process requires the information in the sead-google.json file provided with the Uploader, and it will write a refresh.txt file to your disk to remember your login. Deleting refresh.txt will cause the Uploader to generate a new code as it did the first time. Deleting sead-google.json (or not having it in the same directory your invoking the client from) will cause the Uplaoder to fail.

 

Curl

Curl (curl.haxx.se) is a command line tool useful for invoking web services. 

  • No labels