Page tree
Skip to end of metadata
Go to start of metadata

Introduction

The Stitcher Tool is a utility which provides a simple way to retrieve "chunked" files from DuraCloud. When files are moved to DuraCloud using either the Chunker Tool or the Sync Tool and they exceed a defined size limit, they are split (chunked) into multiple files for transfer. The Stitcher tool provides the means by which those files can be retrieved and combined to result in the original file. It should be noted that the Stitcher Tool is also embedded into the Retrieval Tool. If you are using Retrieval Tool, stitching will be automatically performed.

The Retrieval Tool is a better choice for retrieving files from DuraCloud, whether they be chunked or not. The Stitcher Tool can be build from DuraCloud source, but is no longer provided as a binary distribution.

Operational notes

  • If you want to jump directly into using the tool, download it from the link above and run the following command

    java -jar stitch-{version}-driver.jar
    

    The resulting usage statement (detailed below) should be enough to help you get started.

  • When using the Stitcher Tool, you need to know the ID of the manifest which was generated to list all of the chunks of the original file. If the chunking was done by either the Chunker or Sync tool, then the name of the manifest is the name of the original file (prefixed with any enclosing directory names) followed by ".dura-manifest".

Prerequisites

As of DuraCloud version 4.0.0, the Stitcher Tool requires Java 8 to run. The latest version of Java can be downloaded from here.

Using the Stitcher Tool

  • To run the Stitcher Tool, open a terminal or command prompt and navigate to the directory where the Stitcher Tool is located and run the above command.
  • The following options are available when running the Stitcher Tool

    Short Option

    Long Option

    Argument Expected

    Required

    Description

    Default Value (if optional)

    -m

    --manifest-id

    Yes

    Yes

    The ID of the manifest file used to contain the listing of content chunks

     

    -d

    --to-dir

    Yes

    Yes

    Retrieved and stitched content is stored in this local directory

     

    -s

    --space-id

    Yes

    Yes

    The space ID in which content and manifest files reside

     

    -i

    --store-id

    Yes

    No

    The store ID for the DuraCloud storage provider

    The default store is used

    -h

    --host

    Yes

    Yes

    The host address of the DuraCloud instance

     

    -r

    --port

    Yes

    No

    The port of the DuraCloud instance

    443

    -u

    --username

    Yes

    Yes

    The username necessary to perform writes to DuraCloud

     

    -p

    --password

    Yes

    Yes

    The password necessary to perform writes to DuraCloud

     

  • No labels