Difference between revisions of "Data Access and Storage APIs"

From Gcube Wiki
Jump to: navigation, search
(Tree Manager Client API)
(Overview)
Line 14: Line 14:
 
| align="center" style="background:#f0f0f0;"|'''Framework'''
 
| align="center" style="background:#f0f0f0;"|'''Framework'''
 
|-
 
|-
| [[#Tree Manager API|Tree Manager]]||Tree-based CRUD operations over remote sources of structured data||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore]
+
| [[#Tree Manager API|Tree Manager]]||Tree-based CRUD operations over pluggable, remote sources of structured data||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore]
 
|-
 
|-
| [[#Tree Manager Client API|Tree Manager Client]]||Client front-end to Tree Manager endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
+
| [[#Tree Manager Client API|Tree Manager Client]]||Client proxies for  [[#Tree Manager API|Tree Manager]] endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
| [[#Tree Manager Plugin API|Tree Manager Plugin]]||Development framework for Tree Manager plugins||Java||Local||none
+
| [[#Tree Manager Plugin API|Tree Manager Plugin]]||Development framework for [[#Tree Manager API|Tree Manager]] plugins||Java||Local||none
 
|-
 
|-
 
| [[#Trees API|Trees]]||Tree and tree pattern model implementations||Java||Local||none
 
| [[#Trees API|Trees]]||Tree and tree pattern model implementations||Java||Local||none
Line 24: Line 24:
 
| [[#gDoc API|gDoc]]||gDoc model implementation||Java||Local||none
 
| [[#gDoc API|gDoc]]||gDoc model implementation||Java||Local||none
 
|-
 
|-
| [[#gDoc Client API|gDoc Client]]||gDoc client front-end to Tree Manager endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
+
| [[#gDoc Client API|gDoc Client]]||gDoc-based client proxies for  [[#Tree Manager API|Tree Manager]] endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
 
| [[#View Manager API|View Manager]]||View management for data sources accessible via Tree Manager endpoints||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore]
 
| [[#View Manager API|View Manager]]||View management for data sources accessible via Tree Manager endpoints||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore]
 
|-
 
|-
| [[#View Manager Client API|View Manager Client]]||Client front-end to View Manager endpoints||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
+
| [[#View Manager Client API|View Manager Client]]||Client proxies for  [[#View Manager API|View Manager]] endpoints||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
 
| [[#Storage Manager API|Storage Manager]]||TODO||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
| [[#Storage Manager API|Storage Manager]]||TODO||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
| [[#SPD API|Species Products Discovery]]||TODO||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore]
+
| [[#SPD API|Species Products Discovery (SPD)]]||Read access to pluggable, remote sources of biodiversity data||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore]
 
|-
 
|-
| [[#SPD Plugin API|SPD Plugin]]||TODO||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
+
| [[#SPD Plugin API|SPD Plugin]]||Development framework for  [[#SPD API|SPD]] plugins||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
| [[#SPD Client API|SPD Client]]||TODO||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
+
| [[#SPD Client API|SPD Client]]||Client proxies for  [[#SPD API|SPD]] endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|}
 
|}
  

Revision as of 10:09, 1 July 2012

Data Access and Storage APIs provide access to a wide range of system processes, including indexing, transfer, transformation and presentation. They make up a main driver for clients that interface the resources managed by the system or accessible through facilities available within the system.

A large number of APIs are dedicated to meet data access requirements including APIs of services, service plugins, client-side libraries, server-side libraries and front-end interfaces.

This document outlines the design rational and the key features for those APIs.

Overview

Name Description Type Protocol Framework
Tree Manager Tree-based CRUD operations over pluggable, remote sources of structured data WS SOAP gCore
Tree Manager Client Client proxies for Tree Manager endpoints Java Local CL
Tree Manager Plugin Development framework for Tree Manager plugins Java Local none
Trees Tree and tree pattern model implementations Java Local none
gDoc gDoc model implementation Java Local none
gDoc Client gDoc-based client proxies for Tree Manager endpoints Java Local CL
View Manager View management for data sources accessible via Tree Manager endpoints WS SOAP gCore
View Manager Client Client proxies for View Manager endpoints Java Java CL
Storage Manager TODO Java Java CL
Species Products Discovery (SPD) Read access to pluggable, remote sources of biodiversity data WS SOAP gCore
SPD Plugin Development framework for SPD plugins Java Local CL
SPD Client Client proxies for SPD endpoints Java Local CL

Tree Manager API

  • Description: Tree-based CRUD operations over remote sources of structured data.
  • Type: Web Service
  • Protocol: SOAP
  • Framework: gCore
  • Wiki Documentation
  • Key Features
  • lookup of whole trees as well as individual nodes
  • tree pattern matching on lookups and queries
  • in-place updates
  • streaming on all operations
  • native storage based on graph database technology

Tree Manager Client API

  • high-level proxy API
  • transparent endpoint discovery and caching
  • transparent fault tolerance over endpoint replicas
  • polling and notifications for asynchronous bindings
  • fluent proxy configuration API

Tree Manager Plugin API

  • Description: Development framework for Tree Manager plugins.
  • Type: Java
  • Protocol: Local
  • Wiki Documentation
  • Key Features
TODO
TODO

Trees API

  • Description: Tree and tree pattern model implementations.
  • Type: Java
  • Protocol: Local
  • Wiki Documentation
  • Key Features
TODO
TODO

gDoc API

  • Description: gDoc model implementation.
  • Type: Java
  • Protocol: Local
  • Wiki Documentation
  • Key Features
TODO
TODO

gDoc Client API

  • Description: gDoc client front-end to Tree Manager endpoints.
  • Type: Java
  • Protocol: Local
  • Wiki Documentation
  • Key Features
TODO
TODO

View Manager API

  • Description: View management for data sources accessible via Tree Manager endpoints.
  • Type: Web Service
  • Protocol: SOAP
  • Framework: gCore
  • Wiki Documentation
  • Key Features
TODO
TODO

View Manager Client API

  • Description: Java APIs for accessing the view-manager-service from within client runtimes.
  • Type: Java
  • Protocol: Local
  • Framework: CL
  • Wiki Documentation
  • Key Features
TODO
TODO

Storage Manager API

TODO
TODO

SPD API

  • Description: TODO
  • Type: Web Service
  • Protocol: SOAP
  • Framework: gCore
  • Wiki Documentation
  • Key Features
TODO
TODO

SPD Plugin API

  • Description: TODO
  • Type: Java
  • Protocol: Local
  • Wiki Documentation
  • Key Features
TODO
TODO

SPD Client API

  • Description: TODO
  • Type: Java
  • Protocol: Local
  • Framework: CL
  • Wiki Documentation
  • Key Features
TODO
TODO