This wiki space contains archival documentation of Project Bamboo, April 2008 - March 2013.
The Result Set Caching (RSC) service is a general service that stores and retrieves a set of results -- generally results returned by another service -- to for a limited period of time.
This page describes the Result Set Caching service API, v0.8
To discover the version and other metadata about deployed service code that fulfills this API, please utilize the Service Catalog Service - BDOC.
The Result Set Caching (RSC) service is a general service that stores and retrieves a set of results -- generally results returned by another service -- to for a limited period of time. The purpose of this temporary storage is to keep service results available for application to further service-processing (e.g., in a "pipeline" process) without unnecessary transport of the result set over the network (e.g., between the service host and a caller/client of a series of services, in a "pipeline" process).
When the RSC sends / receives content, it relies on the Media type provided as a parameter by the RSC's client at the time content is added to the cache. The asserted Media type is stored as part of the Cache Item's metadata.
The RSC does not verify that the content provided constitutes a valid instance of the asserted Media type, nor does it modify the content, nor does it perform any exception handling beyond returning a "404 Not Found" if a requested item is not available from the cache.
For a full description, visit the Result Set Caching Service Description and Assumptions page of Project Bamboo's development wiki.
RESTful service methods performing Create, Read, Update, Delete, and List functions over content cached by this service, described here as a Cached Item.
The only RESTful method currently exposed on Cached Item is READ. Other methods are accessible via the SOA layer of the architecture, see API below.
Currently available instances of the Bamboo Services Platform are INSECURE, are operated with NO EXPLICIT SLA, and should be considered STATELESS: that is, data may be wiped from persistent stores at any time.
A secure instances of the BSP, with URLs that do not require explicit inclusion of a port number, and for which data will be preserved on future upgrades is anticipated in Fall 2012.
Currently available base URLs:
There is no schema associated with this API.
A Cached Item is assumed to be a set of results generated by another service. It's structure is opaque to this service. Its metadata is set by the service that creates a Cached Item; this service does not validate the accuracy of the provided metadata.
Retrieve an existing cached item, specified by its ID.
Invoked as an HTTP GET method on a specific instance of a cached item, qualified with an ID value. Send an HTTP request of the form:
The unique identifier for the cached item as originally assigned when the item was cached. Usually provided to the client by either the Notification service or a Scholarly service
On success, a response with a "200 OK" HTTP status code will be returned. The body of the HTTP message will contain the cached item in whatever format it was originally stored in the cache by a Scholarly service.
HTTP Header Content Type
The Media (aka Mime) type of the content returned in the body of the HTTP response
If an error occurred, some non-2xx code will be returned. Check the HTTP Status Code that is returned in the response's HTTP headers for the specific error. The following errors may be returned in response to the Get request:
Error (Status Code)
The resource could not be created because the client submitting the request either has not provided authentication credentials, or authentication failed, or authorization has been refused for those credentials
The resource requested for reading does not exist
Internal Server Error
A service error prevented the resource from being returned
Link to Javadoc here; or, include note: Javadoc will be linked once it is generated and published.