Action Bit Storage Web Service Part Two
- Assigned
- BAM, ABR, (TSH)
- Prev assigned
- Time estimated
- 1-3md
- Time used
- ½md (BAM)
- Priority
- 2
- Status
- Finished.
- Iteration
- 16
- Notes
- Need fix todos action later
Description
This action is a continuation of the first two parts of ActionBitStorageWebservice, that is the two services:
- guiobjectmanipulation_webservice (input: file path to the file to ingest, PID of the FOXML object to attach file to, username, password. When this web service is called from the GUI, it must translate the 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)
- and objectmanipulation_webservice (input: URL to the file to ingest, PID of the FOXML object to attach file to, username, password. This web service must upload the file, represented by the URL, to bit storage by calling the bit storage web service. The web service will return characterization information for the file and a URL reference to the version stored in the bit storage. The URL and the characterization information received from bit storage must be appended to the FOXML object identified by the PID given to this web service)
The Bitstorage webservice update to True Bitstorage will be handled by ActionBitStorageForReal.
This action will review the implemented guiobjectmanipulation_webservice and objectmanipulation_webservice to check that they are finished as expected (time estimate 1md). If any bits are missing, they will be implemented (time estimate 0-2md).
Progress
- First question: The objectmanipulation_webservice currently offers a void Addfile operation. The wiki description claims that the operation will return characterization information for the file and a URL reference to the version stored in the bit storage. I think the description is wrong! The characterization information + bit storage URL is put into the file object! This has been agreed on.
- The objectmanipulation_webservice
- updates the content datastream with the bitstorage URI to the uploaded file
- builds characterization datastream with formatURI (pronomID) and validation status. TODO: What is missing?
- If the guiobjectmanipulation_webservice gets a Windows file path it maps this to a unix file path using hardcoded paths. Not used!
- guiobjectmanipulation_webservice makes the file available from a hardcoded host + port. This works for the testbed. Should this be changed later (the base URL of the bundled Jetty should not be hard-coded)?
- objectmanipulation_webservice TODO next version: check if object with the given pid exists and has content model file
- objectmanipulation_webservice TODO next version: the objectmanipulation_webservice approves the file uploaded to bitstorage?. This should not be done until the object is published - we then need to know URI + md5 on publish.
- TODO: exception handling
I will close this action, as we have a working 'add file to object'-service in the testbed. We will need a new action later to handle all the TODOs. -- bam 2008-12-11 08:49:52
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.