Difference between revisions of "Data Access and Storage APIs"
From Gcube Wiki
(→Overview) |
|||
Line 6: | Line 6: | ||
==Overview== | ==Overview== | ||
+ | |||
{| {{table}} | {| {{table}} | ||
| align="center" style="background:#f0f0f0;"|'''Name''' | | align="center" style="background:#f0f0f0;"|'''Name''' | ||
Line 13: | Line 14: | ||
| align="center" style="background:#f0f0f0;"|'''Framework''' | | align="center" style="background:#f0f0f0;"|'''Framework''' | ||
|- | |- | ||
− | | [[#Tree | + | | [[#Tree Manager API|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]] |
|- | |- | ||
− | | [[#Tree | + | | [[#Tree Manager Client API|Tree Manager Client]]||Client front-end to Tree Manager endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|- | |- | ||
− | | [[#Tree | + | | [[#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 |
|- | |- | ||
− | | [[#gDoc | + | | [[#gDoc API|gDoc]]||gDoc model implementation||Java||Local||none |
|- | |- | ||
− | | [[#gDoc | + | | [[#gDoc Client API|gDoc Client]]||gDoc-oriented front-end to Tree Manager endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|- | |- | ||
− | | [[#View | + | | [[#View Manager API|View Manager]]||View management for data sources accessible via Tree Manager endpoints||WS||SOAP||[[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|gCore]] |
|- | |- | ||
− | | [[#View | + | | [[#View Manager Client API|View Manager Client]]||Client front-end to View Manager endpoints||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|- | |- | ||
− | | [[# | + | | [[#Storage Manager API|Storage Manager]]||TODO||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|- | |- | ||
− | | [[# | + | | [[#SPD API|Species Products Discovery]]||TODO||WS||SOAP||[[Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification|gCore]] |
|- | |- | ||
− | | [[# | + | | [[#SPD Plugin API|SPD Plugin]]||TODO||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|- | |- | ||
− | | [[# | + | | [[#SPD Client API|SPD Client]]||TODO||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|} | |} | ||
− | ==Tree | + | ==Tree Manager API== |
* '''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 45: | 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 | + | |
+ | ==Tree Manager Client API== | ||
* '''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 52: | Line 54: | ||
* '''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 | + | |
+ | ==Tree Manager Plugin API== | ||
* '''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 62: | ||
* '''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 | ||
− | == | + | |
+ | ==Trees API== | ||
* '''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 66: | Line 70: | ||
* '''Key Features''': | * '''Key Features''': | ||
* '''Wiki Doc''': | * '''Wiki Doc''': | ||
− | ==gDoc | + | |
+ | ==gDoc API== | ||
* '''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 78: | ||
* '''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 | + | |
+ | ==gDoc Client API== | ||
* '''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 80: | Line 86: | ||
* '''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 | + | |
+ | ==View Manager API == | ||
* '''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 87: | Line 94: | ||
* '''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 | + | |
+ | ==View Manager Client API== | ||
* '''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 94: | Line 102: | ||
* '''Key Features''': | * '''Key Features''': | ||
* '''Wiki Doc''': | * '''Wiki Doc''': | ||
− | ==Storage Manager== | + | |
+ | ==Storage Manager API== | ||
* '''Description''': | * '''Description''': | ||
* '''Type''': | * '''Type''': | ||
Line 101: | Line 110: | ||
* '''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 | ||
− | == | + | |
+ | ==SPD API== | ||
* '''Description''': | * '''Description''': | ||
* '''Type''': | * '''Type''': | ||
Line 108: | Line 118: | ||
* '''Key Features''': | * '''Key Features''': | ||
* '''Wiki Doc''': | * '''Wiki Doc''': | ||
− | == | + | |
+ | ==SPD Plugin API== | ||
* '''Description''': | * '''Description''': | ||
* '''Type''': | * '''Type''': | ||
Line 115: | Line 126: | ||
* '''Key Features''': | * '''Key Features''': | ||
* '''Wiki Doc''': | * '''Wiki Doc''': | ||
− | == | + | |
+ | ==SPD Client API== | ||
* '''Description''': | * '''Description''': | ||
* '''Type''': | * '''Type''': |
Revision as of 23:32, 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.
Contents
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 implementation | 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 access to arbitrary sources to structured data.
- Type: gCube Web Service
- Protocol: SOAP
- Framework: gCore
- Key Features:
- Wiki Doc: https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager
Tree Manager Client API
- Description: Java APIs for accessing the tree-manager-service from within client runtimes.
- Type: Java
- Protocol: Local
- Framework: CL
- Key Features:
- Wiki Doc: https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Library
Tree Manager Plugin API
- Description: Java APIs for source-specific plugins of the tree-manager-service.
- Type: Java
- Protocol: Local
- Framework: N/A
- Key Features:
- Wiki Doc: https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Framework
Trees API
- Description: Java API for creation, inspection, filtering, and serialisation of tree structures.
- Type: Java
- Protocol: Local
- Framework: N/A
- Key Features:
- Wiki Doc:
gDoc API
- Description: Java API for gDoc creation, inspection, and tree serialization of gDoc document structures.
- Type: Java
- Protocol: Local
- Framework: N/A
- Key Features:
- Wiki Doc: https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model
gDoc Client API
- Description: Java API for gDoc-based access to the tree-manager service.
- Type: Java
- Protocol: Local
- Framework: N/A
- Key Features:
- Wiki Doc: https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model
View Manager API
- 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:
- Wiki Doc: https://gcube.wiki.gcube-system.org/gcube/index.php/View_Manager
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
- Description:
- Type:
- Protocol:
- Framework:
- Key Features:
- Wiki Doc: https://gcube.wiki.gcube-system.org/gcube/index.php/Storage_Management_NEW
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: