Action Bit Storage Web Service

Assigned

KFC, BAM, TSH

Prev assigned

Tasks adressed

TaskA.4, TaskA.5

Time estimated

8 md

Time used

0md

Priority

1

Status

In progress (semi-done)

Iteration

15

Notes

This action comprises the implementation of 3 web services, in order to provide a web service for ingesting a file and attaching it to a FOXML object in the DOMS. Thus, two of the web services are only implemented as helpers for this one public web service (and in order to achive a pretty design).

What we need is:

1. Implement a web service for ingesting and attaching a file to a FOXML object for the GUI. This web service takes a (Windows) file path to the file to ingest and a PID of the FOXML object to attach it to as a parameter. It is a prerequisite that the file is located on a network drive / Window share.
   
   

   This web service must have a embedded web server, e.g. Jetty, which is able to serve the files from that network drive.
   
   

   When this web service is called, it must translate the windows file path to a URL in order to make it possible for web service #2 to download the file from the web server, using this URL.
   

2. Implement a web service that is capable of ingesting a file and attach it to an existing FOXML object in the DOMS, given a URL and a PID of a FOXML object.
   
   

   This web service must upload the file, represented by the URL, to bit storage by calling web service #3. This web service will return characterization information for the file and a URL referencing to the version stored in the bit storage.
   
   

   The URL and the characterization information received from web service #3 must be appended to the FOXML object identified by the PID given to this web service. This can be achieved by calling methods on the Fedora API.
   
   

   Please read a more detailed description of this web service on the DomsFileHandling page.

3. Implement a web service that is capable of uploading a file to the bit storage (a.k.a. BitFinder) and return a URL referencing to the file in the storage along with characterization information for the file.
   
   

   This web service is more or less implemented in the current test bed, however, this web service just stores files on a local disc and not in BitFinder. The IT department has already provided shell scripts for upload of files to BitFinder in the miniDOMS project, so they are also ready for use and should just be integrated.

Checklist For Working On An Action

The Life Cycle of an Action:

• Assign people for action definition: Done at start of iteration status meeting. Fill out Assigned

• Define the action: Describe information about what is to be done and how. Fill out Tasks Addressed and Time Estimated.

• Review the definition: Get another project group member to review the action definition, and update it.

• Assign people for action implementation: Done by project manager, usually the same persons who wrote the definition. Fill out Assigned and Prev assigned if new persons are assigned.

• Implement the action: See details below

• Review the action: Get another project group member to review what is implemented (code and documentation), and update it.

• Finish the action: Change the status to "Finished" and update the "time used" field on the action page.

Please make sure that you address the below issues, when working on an action:

• Update the state of the action to "In Progress" when you start working on it.
• Check if the tasks addressed by this action have their status set to "In Progress". If that is not the case, then change the state of them.

• Keep track of how much time that has been spent working on the action. If it addresses more than one task, then make a note on the action page about how much of the elapsed time that has been spent on the individual tasks. Hint: Continually updating the "Time used" field will make it easier for you.

• Update the "Progress History" and documentation pages of each task addressed by this action when appropriate. This depends on the situation, but in general, the task pages should hold all important related information about the work done, experiences gathered, identified requirements and so on.