Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • To run the Retrieval Tool, open a terminal or command prompt and navigate to the directory where the Retrieval Tool jar file is located
  • To display the help for the Retrieval Tool, run
    Code Block
     java -jar retrievaltool-[{version]}-driver.jar 
  • When running the Retrieval Tool, you will need to use these options:

    Short Option

    Long Option

    Argument Expected

    Required

    Description

    Default Value (if optional)

    -h

    --host

    Yes

    Yes

    The host address of the DuraCloud DuraStore application

     

    -r

    --port

    Yes

    No

    The port of the DuraCloud DuraStore application

    443

    -u

    --username

    Yes

    Yes

    The username necessary to perform writes to DuraStore

     

    -p

    --password

    Yes

    Yes

    The password necessary to perform writes to DuraStore

     

    -i

    --store-id

    Yes

    No

    The Store ID for the DuraCloud storage provider

    The default store is used

    -s

    --spaces

    Yes

    No

    The space or spaces from which content will be retrieved. Either this option or -a must be included

     

    -a

    --all-spaces

    No

    No

    Indicates that all spaces should be retrieved; if this option is included the -s option is ignored

    Not set

    -c

    --content-dir

    Yes

    Yes

    Retrieved content is stored in this local directory

     

    -w

    --work-dir

    Yes

    Yes

    Logs and output files will be stored in the work directory

     

    -o

    --overwrite

    No

    No

    Indicates that existing local files which differ from files in DuraCloud under the same path and name sould be overwritten rather than copied

    Not set

    -t

    --threads

    Yes

    No

    The number of threads in the pool used to manage file transfers

    3

  • An example for running the Retrieval Tool
    Code Block
    java -jar retrievaltool-1.0.0{version}-driver.jar -c content -h test.duracloud.org -u myname -p mypassword -w work -s space1 space1 -o