Difference between revisions of "Data Access and Storage APIs"

From Gcube Wiki
Jump to: navigation, search
Line 20: Line 20:
 
| [[#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 plugins||Java||Local||none
 
|-
 
|-
| [[#Trees API|Trees]]||Tree and tree pattern model implementation||Java||Local||none
+
| [[#Trees API|Trees]]||Tree and tree pattern model implementations||Java||Local||none
 
|-
 
|-
 
| [[#gDoc API|gDoc]]||gDoc model implementation||Java||Local||none
 
| [[#gDoc API|gDoc]]||gDoc model implementation||Java||Local||none
Line 40: Line 40:
  
 
==Tree Manager API==
 
==Tree Manager API==
* '''Description''': Tree-based access to arbitrary sources to structured data.
+
* '''Description''': Tree-based read-write access to arbitrary sources of structured data.
* '''Type''': gCube Web Service
+
* '''Type''': Web Service
 
* '''Protocol''': SOAP
 
* '''Protocol''': SOAP
* '''Framework''': gCore
+
* '''Framework''': [[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|gCore]]
* '''Key Features''':
+
* [[The_Tree_Manager|'''Wiki Documentation''']]
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager
+
 
 +
 
 +
* '''Key Features'''
 +
:TODO
 +
:TODO
  
 
==Tree Manager Client API==
 
==Tree Manager Client API==
* '''Description''': Java APIs for accessing the tree-manager-service from within client runtimes.
+
 
 +
* '''Description''': Client front-end to Tree Manager endpoints.
 
* '''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''':
+
* [[The_Tree_Manager_Library|'''Wiki Documentation''']]
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Library
+
* '''Key Features'''
 +
:TODO
 +
:TODO
  
 
==Tree Manager Plugin API==
 
==Tree Manager Plugin API==
* '''Description''': Java APIs for source-specific plugins of the tree-manager-service.
+
* '''Description''': Development framework for Tree Manager plugins.
 
* '''Type''': Java
 
* '''Type''': Java
 
* '''Protocol''': Local
 
* '''Protocol''': Local
* '''Framework''': N/A
+
* [[The_Tree_Manager_Framework|'''Wiki Documentation''']]
* '''Key Features''':
+
* '''Key Features'''
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Framework
+
:TODO
 +
:TODO
  
 
==Trees API==
 
==Trees API==
* '''Description''': Java API for creation, inspection, filtering, and serialisation of tree structures.
+
* '''Description''': Tree and tree pattern model implementations.
 
* '''Type''': Java
 
* '''Type''': Java
 
* '''Protocol''': Local
 
* '''Protocol''': Local
* '''Framework''': N/A
+
* [[The_Trees_Library|'''Wiki Documentation''']]
* '''Key Features''':
+
* '''Key Features'''
* '''Wiki Doc''':
+
:TODO
 +
:TODO
  
 
==gDoc API==
 
==gDoc API==

Revision as of 23:46, 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-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 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

gDoc Client API

View Manager API

View Manager Client API

  • 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 API

SPD API

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

SPD Plugin API

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

SPD Client API

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