Difference between revisions of "Data Access and Storage APIs"
From Gcube Wiki
(→Overview) |
|||
Line 14: | Line 14: | ||
| align="center" style="background:#f0f0f0;"|'''Framework''' | | align="center" style="background:#f0f0f0;"|'''Framework''' | ||
|- | |- | ||
− | | [[#Tree Manager API|Tree Manager]]||Tree-based CRUD operations over pluggable | + | | [[#Tree Manager API|Tree Manager]]||Tree-based CRUD operations over pluggable remote sources of structured data||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore] |
|- | |- | ||
− | | [[#Tree Manager Client API|Tree Manager Client]]||Client proxies for | + | | [[#Tree Manager Client API|Tree Manager Client]]||Client proxies for [[#Tree Manager API|Tree Manager]] endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|- | |- | ||
− | | [[#Tree Manager Plugin API|Tree Manager Plugin]]||Development framework for | + | | [[#Tree Manager Plugin API|Tree Manager Plugin]]||Development framework for [[#Tree Manager API|Tree Manager]] plugins||Java||Local||none |
|- | |- | ||
| [[#Trees API|Trees]]||Tree and tree pattern model implementations||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]]||<code>gDoc</code> model implementation||Java||Local||none |
|- | |- | ||
− | | [[#gDoc Client API|gDoc Client]]||gDoc-based client proxies for | + | | [[#gDoc Client API|gDoc Client]]||<code>gDoc</code>-based client proxies for [[#Tree Manager API|Tree Manager]] endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|- | |- | ||
− | | [[#View Manager API|View Manager]]||View management for data sources accessible via Tree Manager endpoints||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore] | + | | [[#View Manager API|View Manager]]||View management for data sources accessible via [[#Tree Manager API|Tree Manager]] endpoints||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore] |
|- | |- | ||
− | | [[#View Manager Client API|View Manager Client]]||Client proxies for | + | | [[#View Manager Client API|View Manager Client]]||Client proxies for [[#View Manager API|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]] | | [[#Storage Manager API|Storage Manager]]||TODO||Java||Java||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] | ||
Line 34: | Line 34: | ||
| [[#SPD API|Species Products Discovery (SPD)]]||Read access to pluggable, remote sources of biodiversity data||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore] | | [[#SPD API|Species Products Discovery (SPD)]]||Read access to pluggable, remote sources of biodiversity data||WS||SOAP||[https://gcore.wiki.gcube-system.org/gCube gCore] | ||
|- | |- | ||
− | | [[#SPD Plugin API|SPD Plugin]]||Development framework for | + | | [[#SPD Plugin API|SPD Plugin]]||Development framework for [[#SPD API|SPD]] plugins||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|- | |- | ||
− | | [[#SPD Client API|SPD Client]]||Client proxies for | + | | [[#SPD Client API|SPD Client]]||Client proxies for [[#SPD API|SPD]] endpoints||Java||Local||[[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries|CL]] |
|} | |} | ||
==Tree Manager API== | ==Tree Manager API== | ||
− | * '''Description''': Tree-based CRUD operations over remote sources of structured data. | + | * '''Description''': Tree-based CRUD operations over pluggable remote sources of structured data. |
* '''Type''': Web Service | * '''Type''': Web Service | ||
* '''Protocol''': SOAP | * '''Protocol''': SOAP | ||
Line 67: | Line 67: | ||
==Tree Manager Plugin API== | ==Tree Manager Plugin API== | ||
− | * '''Description''': Development framework for Tree Manager plugins. | + | * '''Description''': Development framework for [[#Tree Manager API|Tree Manager]] plugins. |
* '''Type''': Java | * '''Type''': Java | ||
* '''Protocol''': Local | * '''Protocol''': Local | ||
Line 85: | Line 85: | ||
==gDoc API== | ==gDoc API== | ||
− | * '''Description''': gDoc model implementation. | + | * '''Description''': <code>gDoc</code> model implementation. |
* '''Type''': Java | * '''Type''': Java | ||
* '''Protocol''': Local | * '''Protocol''': Local | ||
Line 94: | Line 94: | ||
==gDoc Client API== | ==gDoc Client API== | ||
− | * '''Description''': gDoc | + | * '''Description''': <code>gDoc</code>-based client proxies for [[#Tree Manager API|Tree Manager]] endpoints. |
* '''Type''': Java | * '''Type''': Java | ||
* '''Protocol''': Local | * '''Protocol''': Local | ||
Line 103: | Line 103: | ||
==View Manager API == | ==View Manager API == | ||
− | * '''Description''': View management for data sources accessible via Tree Manager endpoints. | + | * '''Description''': View management for data sources accessible via [[#Tree Manager API|Tree Manager]] endpoints. |
* '''Type''': Web Service | * '''Type''': Web Service | ||
* '''Protocol''': SOAP | * '''Protocol''': SOAP | ||
Line 113: | Line 113: | ||
==View Manager Client API== | ==View Manager Client API== | ||
− | * '''Description''': | + | * '''Description''': Client proxies for [[#View Manager API|View Manager]] endpoints. |
* '''Type''': Java | * '''Type''': Java | ||
* '''Protocol''': Local | * '''Protocol''': Local | ||
Line 132: | Line 132: | ||
==SPD API== | ==SPD API== | ||
− | * '''Description''': | + | * '''Description''': Read access to pluggable, remote sources of biodiversity data. |
* '''Type''': Web Service | * '''Type''': Web Service | ||
* '''Protocol''': SOAP | * '''Protocol''': SOAP | ||
Line 142: | Line 142: | ||
==SPD Plugin API== | ==SPD Plugin API== | ||
− | * '''Description''': | + | * '''Description''': Development framework for [[#SPD API|SPD]] plugins. |
* '''Type''': Java | * '''Type''': Java | ||
* '''Protocol''': Local | * '''Protocol''': Local | ||
Line 151: | Line 151: | ||
==SPD Client API== | ==SPD Client API== | ||
− | * '''Description''': | + | * '''Description''': Client proxies for [[#SPD API|SPD]] endpoints. |
* '''Type''': Java | * '''Type''': Java | ||
* '''Protocol''': Local | * '''Protocol''': Local |
Revision as of 10:15, 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.
Contents
Overview
Name | Description | Type | Protocol | Framework |
Tree Manager | Tree-based CRUD operations over pluggable remote sources of structured data | WS | SOAP | gCore |
Tree Manager Client | Client proxies for 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 -based client proxies for 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 proxies for View Manager endpoints | Java | Java | CL |
Storage Manager | TODO | Java | Java | CL |
Species Products Discovery (SPD) | Read access to pluggable, remote sources of biodiversity data | WS | SOAP | gCore |
SPD Plugin | Development framework for SPD plugins | Java | Local | CL |
SPD Client | Client proxies for SPD endpoints | Java | Local | CL |
Tree Manager API
- Description: Tree-based CRUD operations over pluggable remote sources of structured data.
- Type: Web Service
- Protocol: SOAP
- Framework: gCore
- Wiki Documentation
- Key Features
- lookup of whole trees as well as individual nodes
- tree pattern matching on lookups and queries
- in-place updates
- streaming on all operations
- native storage based on graph database technology
Tree Manager Client API
- Description: Client proxies for Tree Manager endpoints.
- Type: Java
- Protocol: Local
- Framework: CL
- Wiki Documentation
- Key Features
- high-level proxy API
- transparent endpoint discovery and caching
- transparent fault tolerance over endpoint replicas
- polling and notifications for asynchronous bindings
- fluent proxy configuration API
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
-based client proxies for 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: Client proxies for View Manager endpoints.
- Type: Java
- Protocol: Local
- Framework: CL
- Wiki Documentation
- Key Features
- TODO
- TODO
Storage Manager API
- Description: TODO
- Type: Java
- Protocol: Local
- Wiki Documentation
- Key Features
- TODO
- TODO
SPD API
- Description: Read access to pluggable, remote sources of biodiversity data.
- Type: Web Service
- Protocol: SOAP
- Framework: gCore
- Wiki Documentation
- Key Features
- TODO
- TODO
SPD Plugin API
- Description: Development framework for SPD plugins.
- Type: Java
- Protocol: Local
- Wiki Documentation
- Key Features
- TODO
- TODO
SPD Client API
- Description: Client proxies for SPD endpoints.
- Type: Java
- Protocol: Local
- Framework: CL
- Wiki Documentation
- Key Features
- TODO
- TODO