Difference between revisions of "Data Access and Storage APIs"

From Gcube Wiki
Jump to: navigation, search
(Tree Manager API)
(Tree Manager API)
Line 40: Line 40:
  
 
==Tree Manager API==
 
==Tree Manager API==
* '''Description''': Tree-based read-write access to arbitrary sources of structured data.
+
* '''Description''': Tree-based read and write access to structured data sources.
 
* '''Type''': Web Service
 
* '''Type''': Web Service
 
* '''Protocol''': SOAP
 
* '''Protocol''': SOAP
Line 46: Line 46:
 
* [[The_Tree_Manager|'''Wiki Documentation''']]
 
* [[The_Tree_Manager|'''Wiki Documentation''']]
 
* '''Key Features'''
 
* '''Key Features'''
:TODO
+
:* ''lookup of whole trees as well as individual nodes'';
:TODO
+
:* ''sophisticated tree pattern matching on lookups and queries'';
 +
:* ''in-place updates and deletions'';
 +
:* ''optional streaming for all operations''
  
 
==Tree Manager Client API==
 
==Tree Manager Client API==

Revision as of 09:16, 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 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 and write access to structured data sources.
  • Type: Web Service
  • Protocol: SOAP
  • Framework: gCore
  • Wiki Documentation
  • Key Features
  • lookup of whole trees as well as individual nodes;
  • sophisticated tree pattern matching on lookups and queries;
  • in-place updates and deletions;
  • optional streaming for all operations

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