Difference between revisions of "Data Access and Storage APIs"

From Gcube Wiki
Jump to: navigation, search
Line 39: Line 39:
 
|}
 
|}
  
===Tree-Based Access APIs===
+
===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 47: Line 46:
 
* '''Key Features''':
 
* '''Key Features''':
  
====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 52:
 
* '''Framework''': [https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
 
* '''Framework''': [https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
 
* '''Key Features''':
 
* '''Key Features''':
====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 59: Line 58:
 
* '''Framework''': N/A
 
* '''Framework''': N/A
 
* '''Key Features''':
 
* '''Key Features''':
====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 65: Line 64:
 
* '''Framework''': N/A
 
* '''Framework''': N/A
 
* '''Key Features''':
 
* '''Key Features''':
 
+
===gDoc-model-library===
===Document-Based Access APIs===
+
====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 73: Line 70:
 
* '''Framework''': N/A
 
* '''Framework''': N/A
 
* '''Key Features''':
 
* '''Key Features''':
====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 79: Line 76:
 
* '''Framework''': N/A
 
* '''Framework''': N/A
 
* '''Key Features''':
 
* '''Key Features''':
====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 85: Line 82:
 
* '''Framework''': gCore
 
* '''Framework''': gCore
 
* '''Key Features''':
 
* '''Key Features''':
====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 91: Line 88:
 
* '''Framework''': [https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
 
* '''Framework''': [https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]
 
* '''Key Features''':
 
* '''Key Features''':
 
+
===Storage Manager===
===Storage APIs===
+
====Storage Manager====
+
 
* '''Description''':  
 
* '''Description''':  
 
* '''Type''':  
 
* '''Type''':  
Line 99: Line 94:
 
* '''Framework''':  
 
* '''Framework''':  
 
* '''Key Features''':
 
* '''Key Features''':
 
+
===Species Products Discovery===
===Species Products-Based Access APIs===
+
====Species Products Discovery====
+
 
* '''Description''':  
 
* '''Description''':  
 
* '''Type''':  
 
* '''Type''':  
Line 107: Line 100:
 
* '''Framework''':  
 
* '''Framework''':  
 
* '''Key Features''':
 
* '''Key Features''':
====Spd-Plugin-Framework====
+
===Spd-Plugin-Framework===
 
* '''Description''':  
 
* '''Description''':  
 
* '''Type''':  
 
* '''Type''':  
Line 113: Line 106:
 
* '''Framework''':  
 
* '''Framework''':  
 
* '''Key Features''':
 
* '''Key Features''':
====Spd-Client-Library====
+
===Spd-Client-Library===
 
* '''Description''':  
 
* '''Description''':  
 
* '''Type''':  
 
* '''Type''':  

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

  • Description: Tree-based access to arbitrary sources to structured data.
  • Type: gCube Web Service
  • Protocol: SOAP
  • Framework: gCore
  • Key Features:

Tree-Manager-Library

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

Tree-Manager-Framework

  • Description: Java APIs for source-specific plugins of the tree-manager-service.
  • Type: Java
  • Protocol: Local
  • Framework: N/A
  • Key Features:

Common-Trees

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

gDoc-model-library

  • Description: Java API for gDoc creation, inspection, and tree serialization of gDoc document structures.
  • Type: Java
  • Protocol: Local
  • Framework: N/A
  • Key Features:

gDoc-Document-Library

  • Description: Java API for gDoc-based access to the tree-manager service.
  • Type: Java
  • Protocol: Local
  • Framework: N/A
  • Key Features:

View-Manager-Service

  • Description: SOAP-accessible APIs for the management of views over data sources accessible via the tree-manager-service.
  • Type: gCube Web Service
  • Protocol: SOAP
  • Framework: gCore
  • Key Features:

View-Manager-Library

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

Storage Manager

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

Species Products Discovery

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

Spd-Plugin-Framework

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

Spd-Client-Library

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