Difference between revisions of "Data Access and Storage APIs"

From Gcube Wiki
Jump to: navigation, search
(APIs)
(Overview)
Line 6: Line 6:
  
 
==Overview==
 
==Overview==
===APIs===
 
 
{| {{table}}
 
{| {{table}}
 
| align="center" style="background:#f0f0f0;"|'''Name'''
 
| align="center" style="background:#f0f0f0;"|'''Name'''
Line 14: Line 13:
 
| align="center" style="background:#f0f0f0;"|'''Framework'''
 
| align="center" style="background:#f0f0f0;"|'''Framework'''
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#Tree-Manager-Service Tree-Manager-Service]||Tree-based access to arbitrary sources to structured data||gCube Web Service||SOAP||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification gCore]
+
| [[#Tree-Manager-Service|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]]
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#Tree-Manager-Library Tree-Manager-Library]||Java APIs for accessing the tree-manager-service from within client runtimes||Java||Local||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
+
| [[#Tree-Manager-Library|Tree Manager Client]]||Client front-end to Tree Manager endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#Tree-Manager-Framework Tree-Manager-Framework]||Java APIs for source-specific plugins of the tree-manager-service||Java||Local||N/A
+
| [[#Tree-Manager-Framework|Tree Manager Plugin]]||Development framework for Tree Manager plugins||Java||Local||N/A
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#Common-Trees Common-Trees]||Java API for creation, inspection, filtering, and serialisation of tree structures||Java||Local||N/A
+
| [[#Common-Trees|Trees]]||Tree and tree pattern models||Java||Local||N/A
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#gDoc-model-library gDoc-model-library]||Java API for gDoc creation, inspection, and tree serialization of gDoc document structures||Java||Local||N/A
+
| [[#gDoc-model-library|gDoc]]||gDoc model||Java||Local||N/A
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#gDoc-document-library gDoc-document-library]||Java API for gDoc-based access to the tree-manager service||Java||Local||N/A
+
| [[#gDoc-document-library|gDoc Client]]||gDoc-oriented front-end to Tree Manager endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#View-manager-service View-manager-service]||SOAP-accessible APIs for the management of views over data sources accessible via the tree-manager-service||gCube Web Service||SOAP||gCore
+
| [[#View-manager-service|View Manager]]||View management for data sources accessible via Tree Manager endpoints||WS||SOAP||[[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|gCore]]
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#View-manager-library View-manager-library]||Java APIs for accessing the view-manager-service from within client runtimes||Java||Java||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
+
| [[#View-manager-library|View Manager Client]]||Client front-end to View Manager endpoints||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#Storage_Manager Storage Manager]||||Java||Java||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
+
| [[#Storage_Manager|Storage Manager]]||TODO||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#Species_Products_Discovery Species Products Discovery]||||gCube Web Service||SOAP||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification gCore]
+
| [[#Species_Products_Discovery|Species Products Discovery API]]||TODO||WS||SOAP||[[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|gCore]]
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#Spd-plugin-framework Spd-plugin-framework]||||Java||Local||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
+
| [[#Spd-plugin-framework|Spd Plugin]]||TODO||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|-
 
|-
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Access_and_Storage_APIs#Spd-client-library Spd-client-library]||||Java||Local||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
+
| [[#Spd-client-library|Spd Client]]||TODO||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]]
 
|}
 
|}
  

Revision as of 00:22, 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 N/A
Trees Tree and tree pattern models Java Local N/A
gDoc gDoc model Java Local N/A
gDoc Client gDoc-oriented 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 API TODO WS SOAP gCore
Spd Plugin TODO Java Local CL
Spd Client TODO Java Local CL

Tree-Manager-Service

Tree-Manager-Library

Tree-Manager-Framework

Common-Trees

  • Description: Java API for creation, inspection, filtering, and serialisation of tree structures.
  • Type: Java
  • Protocol: Local
  • Framework: N/A
  • Key Features:
  • Wiki Doc:

gDoc-model-library

gDoc-Document-Library

View-Manager-Service

View-Manager-Library

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

Storage Manager

Species Products Discovery

  • Description:
  • Type:
  • Protocol:
  • Framework:
  • Key Features:
  • Wiki Doc:

Spd-Plugin-Framework

  • Description:
  • Type:
  • Protocol:
  • Framework:
  • Key Features:
  • Wiki Doc:

Spd-Client-Library

  • Description:
  • Type:
  • Protocol:
  • Framework:
  • Key Features:
  • Wiki Doc: