Difference between revisions of "Data Access and Storage APIs"

From Gcube Wiki
Jump to: navigation, search
Line 14: Line 14:
 
| align="center" style="background:#f0f0f0;"|'''Framework'''
 
| align="center" style="background:#f0f0f0;"|'''Framework'''
 
|-
 
|-
| [[#Tree Manager API|Tree Manager]]||Tree-based read-write access to arbitrary sources of structured data||WS||SOAP||[[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|gCore]]
+
| [[#Tree Manager API|Tree Manager]]||Tree-based read-write access to arbitrary 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 front-end to Tree Manager endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
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-oriented front-end to Tree Manager endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
+
| [[#gDoc Client API|gDoc Client]]||gDoc client front-end to 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||[[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|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 front-end to View Manager endpoints||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
Line 32: Line 32:
 
| [[#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||[[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|gCore]]
+
| [[#SPD API|Species Products Discovery]]||TODO||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]]||TODO||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
Line 43: Line 43:
 
* '''Type''': Web Service
 
* '''Type''': Web Service
 
* '''Protocol''': SOAP
 
* '''Protocol''': SOAP
* '''Framework''': [[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|gCore]]
+
* '''Framework''': [https://gcore.wiki.gcube-system.org/gCube gCore]
 
* [[The_Tree_Manager|'''Wiki Documentation''']]
 
* [[The_Tree_Manager|'''Wiki Documentation''']]
  
Line 81: Line 81:
  
 
==gDoc API==
 
==gDoc API==
* '''Description''': Java API for gDoc creation, inspection, and tree serialization of gDoc document structures.
+
* '''Description''': gDoc model implementation.
 
* '''Type''': Java
 
* '''Type''': Java
 
* '''Protocol''': Local
 
* '''Protocol''': Local
* '''Framework''': N/A
+
* [[GCube_Document_Model|'''Wiki Documentation''']]
* '''Key Features''':
+
* '''Key Features'''
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model
+
:TODO
 +
:TODO
  
 
==gDoc Client API==
 
==gDoc Client API==
* '''Description''': Java API for gDoc-based access to the tree-manager service.
+
* '''Description''': gDoc client front-end to Tree Manager endpoints.
 
* '''Type''': Java
 
* '''Type''': Java
 
* '''Protocol''': Local
 
* '''Protocol''': Local
* '''Framework''': N/A
+
* [[GCube_Document_Library|'''Wiki Documentation''']]
* '''Key Features''':
+
* '''Key Features'''
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model
+
:TODO
 +
:TODO
  
 
==View Manager API ==
 
==View Manager API ==
* '''Description''': SOAP-accessible APIs for the management of views over data sources accessible via the tree-manager-service.
+
* '''Description''': View management for data sources accessible via Tree Manager endpoints.
* '''Type''': gCube Web Service
+
* '''Type''': Web Service
 
* '''Protocol''': SOAP
 
* '''Protocol''': SOAP
* '''Framework''': gCore
+
* '''Framework''': [https://gcore.wiki.gcube-system.org/gCube gCore]
* '''Key Features''':
+
* [[View_Manager|'''Wiki Documentation''']]
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/View_Manager
+
* '''Key Features'''
 +
:TODO
 +
:TODO
  
 
==View Manager Client API==
 
==View Manager Client API==
Line 108: Line 112:
 
* '''Type''': Java
 
* '''Type''': Java
 
* '''Protocol''': Local
 
* '''Protocol''': Local
* '''Framework''': [https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
+
* '''Framework''': [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
* '''Key Features''':
+
* [[View_Manager|'''Wiki Documentation''']]
* '''Wiki Doc''':
+
* '''Key Features'''
 +
:TODO
 +
:TODO
  
 
==Storage Manager API==
 
==Storage Manager API==
* '''Description''':  
+
* '''Description''': TODO
* '''Type''':  
+
* '''Type''': Java
* '''Protocol''':
+
* '''Protocol''': Local
* '''Framework''':
+
* [[Storage_Management_NEW|'''Wiki Documentation''']]
* '''Key Features''':
+
* '''Key Features'''
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/Storage_Management_NEW
+
:TODO
 +
:TODO
  
 
==SPD API==
 
==SPD API==
* '''Description''':  
+
* '''Description''': TODO
* '''Type''':  
+
* '''Type''': Web Service
* '''Protocol''':
+
* '''Protocol''': SOAP
* '''Framework''':  
+
* '''Framework''': [https://gcore.wiki.gcube-system.org/gCube gCore]
* '''Key Features''':
+
* '''Wiki Documentation'''
* '''Wiki Doc''':
+
* '''Key Features'''
 +
:TODO
 +
:TODO
  
 
==SPD Plugin API==
 
==SPD Plugin API==
* '''Description''':  
+
* '''Description''': TODO
* '''Type''':  
+
* '''Type''': Java
* '''Protocol''':
+
* '''Protocol''': Local
* '''Framework''':
+
* '''Wiki Documentation'''
* '''Key Features''':
+
* '''Key Features'''
* '''Wiki Doc''':
+
:TODO
 +
:TODO
  
 
==SPD Client API==
 
==SPD Client API==
* '''Description''':  
+
* '''Description''': TODO
* '''Type''':  
+
* '''Type''': Java
* '''Protocol''':
+
* '''Protocol''': Local
* '''Framework''':  
+
* '''Framework''': [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
* '''Key Features''':
+
* '''Wiki Documentation'''
* '''Wiki Doc''':
+
* '''Key Features'''
 +
:TODO
 +
:TODO

Revision as of 23:58, 30 June 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 read-write access to arbitrary sources of structured data WS SOAP gCore
Tree Manager Client Client front-end to 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 client front-end to 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 front-end to View Manager endpoints Java Java CL
Storage Manager TODO Java Java CL
Species Products Discovery TODO WS SOAP gCore
SPD Plugin TODO Java Local CL
SPD Client TODO Java Local CL

Tree Manager API

  • Description: Tree-based read-write access to arbitrary sources of structured data.
  • Type: Web Service
  • Protocol: SOAP
  • Framework: gCore
  • Wiki Documentation


  • Key Features
TODO
TODO

Tree Manager Client API

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

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