Difference between revisions of "Data Management APIs"

From Gcube Wiki
Jump to: navigation, search
m
 
(22 intermediate revisions by one other user not shown)
Line 1: Line 1:
 +
[[Category:gCube Features]]
 
== Overview ==
 
== Overview ==
 +
gCube Data Management APIs provide access to the management of the e-Infrastructure resources by facilitating the integration of technology external to the e-Infrastructure. Towards the directions of openness and interoperability, management APIs move along:
 +
* the adoption of standards
 +
* the implementation of a variety of protocols (e.g. Java, REST, SOAP, depending on the need and relevance)
 +
* the compliance to the [https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework Integration and Interoperability Facilities Framework]
  
Data Management APIs intend to provide their users with rich interfaces for accessing the data management facilities of the gCube infrastructure.
+
==Key Features==
 +
;Consistency across different client APIs
 +
:Uniformity for APIs across standalone framework layers in inputs and outpus, context management, fault management, operation modes provision, etc.
  
This page collects the APIs of the components related to the functional category and indicates their roles in respect to the support of protocols, the implementation of standard specifications and the planned compliance to the Integration and Interoperability Framework.
+
;Transparent system integration
 +
:Design of APIs simplifying client usage, with respect to requirements specific to the system
  
==Key Feautures==
+
;Environment propagation
 +
:Operational information among services transparently propagated over a range of protocols (SOAP, HTTP/S, and more)
  
== Specifications ==
+
;Testability ensuring
{| {{table}}
+
:Design solutions that facilitate testing for clients
| align="center" style="background:#f0f0f0;"|'''Component'''
+
 
| align="center" style="background:#f0f0f0;"|'''Functionality Accessed'''
+
;Support to standards
| align="center" style="background:#f0f0f0;"|'''API Type'''
+
:Crucial functionalities are accessible via recognized standards in order to enhance interoperability
| align="center" style="background:#f0f0f0;"|'''Protocol'''
+
 
| align="center" style="background:#f0f0f0;"|'''Framework Compliance'''
+
;Compatibility endorsement
| align="center" style="background:#f0f0f0;"|'''Framework Layer'''
+
:Exploitation of framework simplifying building of modular systems
| align="center" style="background:#f0f0f0;"|'''Standard Spec Support'''
+
 
|-
+
;
| [https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager Tree-Manager-Service]||Tree-based access to arbitrary sources to structured data||gCube Web Service||SOAP||N/A||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification WSRF]||no
+
 
|-
+
==Subsystems==
| [https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Library Tree-Manager-Library]||Java APIs for accessing the tree-manager-service from within client runtimes||gCube CL||Java||planned||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]||no
+
Data Management APIs are collectively delivered by the following sets of software subsystems:
|-
+
 
| [https://gcube.wiki.gcube-system.org/gcube/index.php/The_Tree_Manager_Framework Tree-Manager-Framework]||Java APIs for source-specific plugins of the tree-manager-service||Java Library||Java||N/A||N/A||no
+
[[Data Access and Storage APIs]]
|-
+
 
| Common-Trees||Java API for creation, inspection, filtering, and serialisation of tree structures||Java Library||Java||N/A||N/A||no
+
[[Data Transfer APIs]]
|-
+
 
| Common-Streams||Java API for arbitrary data stream modelling, transformation, and publication||Java Library||Java||N/A||N/A||no
+
[[Data Assessment and Harmonisation APIs]]
|-
+
| [https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model gDoc-model-library]||Java API for gDoc creation, inspection, and tree serialisation of gDoc document structures||Java Library||Java||N/A||N/A||no
+
|-
+
| [https://gcube.wiki.gcube-system.org/gcube/index.php/GCube_Document_Model gDoc-document-library]||Java API for gDoc-based access to the tree-manager servcie||Java Library||Java||N/A||N/A||no
+
|-
+
| [https://gcube.wiki.gcube-system.org/gcube/index.php/View_Manager View-manager-service]||SOAP-accessible APIs for the management of views over data sources accessible via the tree-manager-service||Web Service||SOAP||N/A||N/A||no
+
|-
+
| View-manager-library||Java APIs for accessing the view-manager-service from within client runtimes||gCube CL||Java||planned||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]||no
+
|-
+
| Species Products Discovery||||gCube Web Service||SOAP||N/A||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification WSRF]||no
+
|-
+
| Occurrence Data Management||||gCube Web Service||SOAP||N/A||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification WSRF]||no
+
|-
+
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Storage_Management_NEW Storage Manager]||||gCube CL||Java||Not yet available||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]||no
+
|-
+
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Time_Series_Management Time-Series-Service]||||gCube Web Service||SOAP||N/A||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification WSRF]||no
+
|-
+
| Spd-plugin-framework||||gCube CL||Java||planned||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]||no
+
|-
+
| Spd-client-library||||gCube CL||Java||planned||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]||no
+
|-
+
| Odm-client-library||||gCube CL||Java||planned||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]||no
+
|-
+
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Transfer_Agent Data Transfer Agent Library]||||gCube CL||Java||planned||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]||no
+
|-
+
| [https://gcube.wiki.gcube-system.org/gcube/index.php/Data_Transfer_Agent Data Transfer Agent Service]||||gCube Web Service||SOAP||N/A||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification WSRF]||no
+
|-
+
| Data Transfer Scheduler Service||||gCube Web Service||SOAP||N/A||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_WSRF_API_Framework_Specification WSRF]||no
+
|-
+
| Data Transfer Scheduler Library||||gCube CL||Java||planned||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_Client_Libraries CL]||no
+
|-
+
| gRS2 Broker||This component exposes the gCube Resultset as an http endpoint||yes||Java Servlet||yes||[https://gcube.wiki.gcube-system.org/gcube/index.php/Integration_and_Interoperability_Facilities_Framework:_HTTP_API_Framework_Specification HTTP Front End]||no
+
|-
+
|}
+

Latest revision as of 09:25, 24 July 2013

Overview

gCube Data Management APIs provide access to the management of the e-Infrastructure resources by facilitating the integration of technology external to the e-Infrastructure. Towards the directions of openness and interoperability, management APIs move along:

Key Features

Consistency across different client APIs
Uniformity for APIs across standalone framework layers in inputs and outpus, context management, fault management, operation modes provision, etc.
Transparent system integration
Design of APIs simplifying client usage, with respect to requirements specific to the system
Environment propagation
Operational information among services transparently propagated over a range of protocols (SOAP, HTTP/S, and more)
Testability ensuring
Design solutions that facilitate testing for clients
Support to standards
Crucial functionalities are accessible via recognized standards in order to enhance interoperability
Compatibility endorsement
Exploitation of framework simplifying building of modular systems

Subsystems

Data Management APIs are collectively delivered by the following sets of software subsystems:

Data Access and Storage APIs

Data Transfer APIs

Data Assessment and Harmonisation APIs