Difference between revisions of "Data Access and Storage APIs"

From Gcube Wiki
Jump to: navigation, search
(Overview)
Line 39: Line 39:
 
|}
 
|}
  
===Tree-Manager-Service===
+
==Tree-Manager-Service==
 
* '''Description''': Tree-based access to arbitrary sources to structured data.
 
* '''Description''': Tree-based access to arbitrary sources to structured data.
 
* '''Type''': gCube Web Service
 
* '''Type''': gCube Web Service
Line 46: Line 46:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager
===Tree-Manager-Library===
+
==Tree-Manager-Library==
 
* '''Description''': Java APIs for accessing the tree-manager-service from within client runtimes.
 
* '''Description''': Java APIs for accessing the tree-manager-service from within client runtimes.
 
* '''Type''': Java
 
* '''Type''': Java
Line 53: Line 53:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Library
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Library
===Tree-Manager-Framework===
+
==Tree-Manager-Framework==
 
* '''Description''': Java APIs for source-specific plugins of the tree-manager-service.
 
* '''Description''': Java APIs for source-specific plugins of the tree-manager-service.
 
* '''Type''': Java
 
* '''Type''': Java
Line 60: Line 60:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Framework
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Framework
===Common-Trees===
+
==Common-Trees==
 
* '''Description''': Java API for creation, inspection, filtering, and serialisation of tree structures.
 
* '''Description''': Java API for creation, inspection, filtering, and serialisation of tree structures.
 
* '''Type''': Java
 
* '''Type''': Java
Line 67: Line 67:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''':
 
* '''Wiki Doc''':
===gDoc-model-library===
+
==gDoc-model-library==
 
* '''Description''': Java API for gDoc creation, inspection, and tree serialization of gDoc document structures.
 
* '''Description''': Java API for gDoc creation, inspection, and tree serialization of gDoc document structures.
 
* '''Type''': Java
 
* '''Type''': Java
Line 74: Line 74:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model
===gDoc-Document-Library===
+
==gDoc-Document-Library==
 
* '''Description''': Java API for gDoc-based access to the tree-manager service.
 
* '''Description''': Java API for gDoc-based access to the tree-manager service.
 
* '''Type''': Java
 
* '''Type''': Java
Line 81: Line 81:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model
===View-Manager-Service===
+
==View-Manager-Service==
 
* '''Description''': SOAP-accessible APIs for the management of views over data sources accessible via the tree-manager-service.
 
* '''Description''': SOAP-accessible APIs for the management of views over data sources accessible via the tree-manager-service.
 
* '''Type''': gCube Web Service
 
* '''Type''': gCube Web Service
Line 88: Line 88:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/View_Manager
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/View_Manager
===View-Manager-Library===
+
==View-Manager-Library==
 
* '''Description''': Java APIs for accessing the view-manager-service from within client runtimes.
 
* '''Description''': Java APIs for accessing the view-manager-service from within client runtimes.
 
* '''Type''': Java
 
* '''Type''': Java
Line 95: Line 95:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''':
 
* '''Wiki Doc''':
===Storage Manager===
+
==Storage Manager==
 
* '''Description''':  
 
* '''Description''':  
 
* '''Type''':  
 
* '''Type''':  
Line 102: Line 102:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/Storage_Management_NEW
 
* '''Wiki Doc''': https://gcube.wiki.gcube-system.org/gcube/index.php/Storage_Management_NEW
===Species Products Discovery===
+
==Species Products Discovery==
 
* '''Description''':  
 
* '''Description''':  
 
* '''Type''':  
 
* '''Type''':  
Line 109: Line 109:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''':
 
* '''Wiki Doc''':
===Spd-Plugin-Framework===
+
==Spd-Plugin-Framework==
 
* '''Description''':  
 
* '''Description''':  
 
* '''Type''':  
 
* '''Type''':  
Line 116: Line 116:
 
* '''Key Features''':
 
* '''Key Features''':
 
* '''Wiki Doc''':
 
* '''Wiki Doc''':
===Spd-Client-Library===
+
==Spd-Client-Library==
 
* '''Description''':  
 
* '''Description''':  
 
* '''Type''':  
 
* '''Type''':  

Revision as of 19:18, 29 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

APIs

Name Description Type Protocol Framework
Tree-Manager-Service Tree-based access to arbitrary sources to structured data gCube Web Service SOAP gCore
Tree-Manager-Library Java APIs for accessing the tree-manager-service from within client runtimes Java Local CL
Tree-Manager-Framework Java APIs for source-specific plugins of the tree-manager-service Java Local N/A
Common-Trees Java API for creation, inspection, filtering, and serialisation of tree structures Java Local N/A
gDoc-model-library Java API for gDoc creation, inspection, and tree serialization of gDoc document structures Java Local N/A
gDoc-document-library Java API for gDoc-based access to the tree-manager service Java Local N/A
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-library Java APIs for accessing the view-manager-service from within client runtimes Java Java CL
Storage Manager Java Java CL
Species Products Discovery gCube Web Service SOAP gCore
Spd-plugin-framework Java Local CL
Spd-client-library 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: