[jira] [Comment Edited] (OODT-611) Implement a JAX-RS interface to access File Manager products and associated metadata as raw data

["Ross Laidlaw (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/OODT-611?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13696454#comment-13696454 ] 

Ross Laidlaw edited comment on OODT-611 at 7/1/13 3:40 AM:
-----------------------------------------------------------

Hi Rishi!

Apologies for taking a long time to submit an update on this task.  I've been experimenting with various designs and ways of testing the JAX-RS code.  I've attached a patch (still work in progress) and a report with some info on what I've been doing.  The current design seems to gel quite well but I'm not sure if it fits with overall REST design guidelines.

The patch captures most of my local changes and additions, but I think it omits some things.  For example, I tried to move the old unit tests (2 classes) to a new directory (src/test/java) but it looks like the patch hasn't picked up the move, it just deletes the old test classes!  I'll try to fix that.

The code seems to be working well for flat products, but the zip part isn't working yet for hierarchical products.

I've mapped the JAX-RS servlet to the /service URL so as not to clash with the existing servlets.  Example URLs are as follows:

{panel}
/fmprod/service/reference?productID=...&format=file&refIndex=3
/fmprod/service/product?productID=...&format=zip
/fmprod/service/dataset?typeID=urn:oodt:GenericFile&format=zip
{panel}


Ross
                
      was (Author: rlaidlaw):
    Hi Rishi!

Apologies for taking a long time to submit an update on this task.  I've been experimenting with various designs and ways of testing the JAX-RS code.  I've attached a patch (still work in progress) and a report with some info on what I've been doing.  The current design seems to gel quite well but I'm not sure if it fits with overall REST design guidelines.

The patch captures most of my local changes and additions, but I think it omits some things.  For example, I tried to move the old unit tests (2 classes) to a new directory (src/test/java) but it looks like the patch hasn't picked up the move, it just deletes the old test classes!  I'll try to fix that.

The code seems to be working well for flat products, but the zip part isn't working yet for hierarchical products.

I've mapped the JAX-RS servlet to the /service URL so as not to clash with the existing servlets.  Example URLs are as follows:

{panel}
/service/reference?productID=...&format=file&refIndex=3
/service/product?productID=...&format=zip
/service/dataset?typeID=urn:oodt:GenericFile&format=zip
{panel}


Ross
                  
> Implement a JAX-RS interface to access File Manager products and associated metadata as raw data
> ------------------------------------------------------------------------------------------------
>
>                 Key: OODT-611
>                 URL: https://issues.apache.org/jira/browse/OODT-611
>             Project: OODT
>          Issue Type: Sub-task
>          Components: product server
>    Affects Versions: 0.6
>            Reporter: Ross Laidlaw
>            Assignee: Ross Laidlaw
>              Labels: gsoc2013
>             Fix For: 0.7
>
>         Attachments: OODT-611-Progress-2013-06-30.pdf, OODT-611.rlaidlaw.2013-06-30.patch.txt
>
>
> Add Java classes to the org.apache.oodt.cas.product.service package and add XML configuration files to allow File Manager products and associated metadata to be served as resources via a JAX-RS RESTful interface (URLs).
> The RESTful interface should return product-metadata combinations as zip (application/zip MIME type) files.
> The URLs should allow products to be retrieved by product ID and allow product sets to be retrieved by product type.
> The new JAX-RS interface should also maintain backwards-compatibility with the URLs supported by the servlets in the org.apache.oodt.cas.product.data package, as detailed in the user guide: https://cwiki.apache.org/confluence/display/OODT/File+Manager+REST+API.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira