Difference between revisions of "Developer's Guide"

From Gcube Wiki
Jump to: navigation, search
(Contents)
(How-tos)
 
(322 intermediate revisions by 42 users not shown)
Line 1: Line 1:
Documents technical-oriented information that will help developers further extend and exploit DILIGENT’s source code. The document will target two classes of programmers:
+
[[Category: Developer's Guide]]
 +
{|align=right
 +
||__TOC__
 +
|}
 +
Documents technical-oriented information that will help developers further extend and exploit gCube’s source code. The document will target two classes of programmers:
  
* Those who want to reuse the code – Programmers who will use DILIGENT’s libraries to build their own tools, without need to access the source code.
+
* Those who want to interface with gCube or to reuse gCube code – Programmers who will use gCube’s libraries to build their own tools, without need to access the source code.
 
* Those who want to modify/extend the source code – Programmers who will use the platforms source code to enhance it, correct it, adapt it to different environments and applications domains.
 
* Those who want to modify/extend the source code – Programmers who will use the platforms source code to enhance it, correct it, adapt it to different environments and applications domains.
  
== Contents ==
+
The Guide is organised as follows.
 +
[[#Overview | Overview]] provides the developer with a general summary of the gCube technology. 
 +
[[#How-tos | How-to]] provides the developer with pragmatic, detailed and practical advice on gCube technology.
 +
Components Programming Reference Sections provide the developer with a detailed description of the gCube constituents organising them according to a [[#Components Programming Reference: Functionality-oriented View | Functionality-oriented View]] and a
 +
[[#Components Programming Reference: Data-typology-oriented View | Data-typology-oriented View]].
  
# [[Developer's Guide:Introduction|Introduction]]
+
The gCube team welcomes contributions from everyone who shares our vision and wishes to contribute in a constructive manner to improve and enhance the available software assets.
# DILIGENT Components
+
As such, gCube have adopted this [[Code of Conduct | Code of Conduct ]] and require all those who wish to participate to agree to these guidelines.
## [[ResultSet Framework]]
+
 
### [[ResultSet Framework#Introduction|Introduction]]
+
=== [[Developer's Guide: Introduction | Overview]] ===
### [[ResultSet Framework#Implementation Overview|Implementation Overview]]
+
: [[Reference_Model | gCube Reference Model]]  
### [[ResultSet Framework#Dependencies|Dependencies]]
+
: [[GCube_Architecture | gCube Reference Architecture]]
### [[ResultSet Framework#Usage Example|Usage Example]]
+
: [[Glossary]]
## [[Content Source Description]]
+
 
### [[Content Source Description#Introduction|Introduction]]
+
=== How-tos ===
### [[Content Source Description#Implementation Overview|Implementation Overview]]
+
: [[How to develop a gCube Component]]
### [[Content Source Description#Dependencies|Dependencies]]
+
: [[How to develop a gCube Portlet]]
### [[Content Source Description#Usage Example|Usage Example]]
+
: [[Featherweight Stack | How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)]]
## [[Content Source Selection]]
+
: [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries_Framework | How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)]]
### [[Content Source Selection#Introduction|Introduction]]
+
: [[SmartGears | How to turn software applications and containers into gCube resources (a.k.a. the gCube SmartGears Framework)]]
### [[Content Source Selection#Implementation Overview|Implementation Overview]]
+
: [[FHNManager | How to integrate gCube system with external Cloud Providers]]
### [[Content Source Selection#Dependencies|Dependencies]]
+
: Accounting
### [[Content Source Selection#Usage Example|Usage Example]]
+
:: [[Accounting Lib | How to produce accounting records]]
## [[Data Fusion]]
+
:: [[Accounting Analytics | How to consume accounting records]]
### [[Data Fusion#Introduction|Introduction]]
+
:: [[Accounting Portlet: How to install and configure |How to install and configure Accounting Portlet(AM)]]
### [[Data Fusion#Implementation Overview|Implementation Overview]]
+
: Data Analytics
### [[Data Fusion#Dependencies|Dependencies]]
+
:: [[Statistical Algorithms Importer: How to install and configure| How to install and configure Statistical Algorithms Importer(SAI)]]
### [[Data Fusion#Usage Example|Usage Example]]
+
:: [[Statistical_Algorithms_Importer | How to Implement Algorithms by Statistical Algorithms Importer(SAI)]]
## [[Annotation Back End]]
+
:: [[How-to Implement Algorithms for DataMiner | How to Implement Algorithms for DataMiner by Java libraries]]
### [[Annotation Back End#Introduction|Introduction]]
+
:: [[How_to_Interact_with_the_DataMiner_by_client | How to Interact with the DataMiner by client]]
### [[Annotation Back End#Implementation Overview|Implementation Overview]]
+
:: [[How to use the DataMiner Pool Manager | How to use the DataMiner Pool Manager]]
### [[Annotation Back End#Dependencies|Dependencies]]
+
<!-- :: <strike>[[Legacy_applications_integration | How to integrate legacy applications and offer them via WPS]]</strike> -->
### [[Annotation Back End#Usage Example|Usage Example]]
+
: Data Publishing
## [[DIS-IP]]
+
:: [[How to programmatically publishing a spatial dataset and the associated metadata by the gCube SDI]]
### [[DIS-IP#Introduction|Introduction]]
+
:: [[How to use Data Transfer 2]]
### [[DIS-IP#Implementation Overview|Implementation Overview]]
+
: Data Discovery and Access
#### [[DIS-IP#Resource Manager|Resource Manager]]
+
:: [[GeoNetwork library | How to programmatically discover geospatial metadata]]
#### [[DIS-IP#DILIGENTProfile Manager|DILIGENTProfile Manager]]
+
 
#### [[DIS-IP#Profile Manager|Profile Manager]]
+
=== Components Programming Reference: Functionality-oriented View ===
#### [[DIS-IP#Broker Manager|Broker Manager]]
+
; [[Core-facilities]]
### [[DIS-IP#Dependencies|Dependencies]]
+
: [[Core-facilities#Data_Infrastructure_Management_Facilities | Data Infrastructure Management Facilities]]
### [[DIS-IP#Usage Example|Usage Example]]
+
: [[Core-facilities#Data_Infrastructure_Policy-oriented_Security_Facilities | Data Infrastructure Policy-oriented Security Facilities]]  
### [[DIS-IP#How to disableAuthentication on Providers operations|How to disable Authentication on Providers operations]]
+
: [[Core-facilities#Workflow_Management_Facilities | Workflow Management Facilities]]
## [[DIS-HLS-Client]]
+
 
### [[DIS-HLS-Client#Introduction|Introduction]]
+
; [[Data Management Facilities]]
### [[DIS-HLS-Client#Implementation Overview|Implementation Overview]]
+
: [[Data_Management_Facilities#Data_Access_and_Storage_Facilities | Data Access and Storage Facilities]]  
### [[DIS-HLS-Client#Dependencies|Dependencies]]
+
: [[Data_Management_Facilities#Data_Transfer_Facilities | Data Transfer Facilities]]  
### [[DIS-HLS-Client#Usage Example|Usage Example]]
+
: [[Data_Management_Facilities#Data_Assessment,_Harmonisation,_and_Certification_Facilities | Data Assessment, Harmonisation, and Certification Facilities]]  
### [[DIS-HLS-Client#How to adapt the existing xQuery to eXist 1.1|How to adapt the existing xQuery to eXist 1.1]]
+
 
## [[NAL]]
+
; [[Data Consumption Facilities]]  
### [[NAL#Introduction|Introduction]]
+
: [[Data_Consumption_Facilities#Data_Retrieval_Facilities | Data Retrieval Facilities]]
### [[NAL#Implementation Overview|Implementation Overview]]
+
: [[Data_Consumption_Facilities#Data_Manipulation_Facilities | Data Manipulation Facilities]]
### [[NAL#Dependencies|Dependencies]]
+
: [[Data Mining Facilities | Data Mining Facilities]]  
### [[NAL#Usage Example|Usage Example]]
+
: [[Data_Consumption_Facilities#Data_Visualisation_Facilities | Data Visualisation Facilities]]  
## [[DILIGENT Provider]]
+
: [[Data_Consumption_Facilities#Semantic_Data_Analysis_Facilities | Semantic Data Analysis Facilities]]
### [[DILIGENT Provider#DILIGENT Provider|How to Plug the DILIGENTProvider into DILIGENT Services]]
+
 
## [[Process Optimisation Services]]
+
; [[gCube APIs]]
### [[Process Optimisation Services#Introduction|Introduction]]
+
: [http://wiki.gcube-system.org/gcube/Social_Networking_Library Social Networking Library] and [[Social Networking Service]]
### [[Process Optimisation Services#Implementation Overview|Implementation Overview]]
+
: [[Social Networking Data Discovery]]
### [[Process Optimisation Services#Dependencies|Dependencies]]
+
: [https://wiki.gcube-system.org/gcube/Storage_Manager Storage Manager Service]
### [[Process Optimisation Services#Usage Example|Usage Example]]
+
: [https://wiki.gcube-system.org/gcube/Home_Library_2.0_API_Framework_Specification Home Library Service (DEPRECATED, see StorageHub)]
## [[Metadata Broker]]
+
: [https://gcube.wiki.gcube-system.org/gcube/StorageHub_REST_API Storage Hub Service]
### [[Metadata Broker#Introduction|Introduction]]
+
:[https://wiki.gcube-system.org/gcube/Portal_Context Portal Context] and [https://wiki.gcube-system.org/gcube/UserManagement_Core Portal User, Group and Roles Management]
### [[Metadata Broker#Implementation Overview|Implementation Overview]]
+
: [[Portal Mailing API]]
### [[Metadata Broker#Dependencies|Dependencies]]
+
; [[gCube Presentation Services]]
### [[Metadata Broker#Usage Example|Usage Example]]
+
 
## ''Component''
+
:[https://wiki.gcube-system.org/gcube/GCube_Widgets_Store GCube Widgets Store]
### ''Component'' Introduction
+
 
### Implementation Overview
+
=== Components Programming Reference: Data-typology-oriented View ===
### Algorithms
+
; [[Biodiversity Data Facilities]]
### Dependencies
+
; [[Geospatial Data Facilities]]
### Usage Example
+
; [[Semantic Data Facilities]]
# [[Developing a DILIGENT Component]]
+
; [[Statistical Data Facilities]]
## [[Programming Environment]]
+
## [[Development support Tools]]
+
### [[Developer's Guide:Eclipse|Eclipse]]
+
### [[Developer's Guide:ETICS|ETICS]]
+
### [[Developer's Guide:Savane|Savane]]
+
### [[Developer's Guide:Javadoc|Javadoc]]
+
## [[Profile Specification]]
+
## [[Developing Portlets]]
+
### [[Developing Portlets with GWT]]
+
## [[Developing a Service]]
+
## [[How To Enable Security|Component Security]]
+
# [[References]]
+
# [[Glossary]]
+

Latest revision as of 11:00, 13 July 2020

Documents technical-oriented information that will help developers further extend and exploit gCube’s source code. The document will target two classes of programmers:

  • Those who want to interface with gCube or to reuse gCube code – Programmers who will use gCube’s libraries to build their own tools, without need to access the source code.
  • Those who want to modify/extend the source code – Programmers who will use the platforms source code to enhance it, correct it, adapt it to different environments and applications domains.

The Guide is organised as follows. Overview provides the developer with a general summary of the gCube technology. How-to provides the developer with pragmatic, detailed and practical advice on gCube technology. Components Programming Reference Sections provide the developer with a detailed description of the gCube constituents organising them according to a Functionality-oriented View and a Data-typology-oriented View.

The gCube team welcomes contributions from everyone who shares our vision and wishes to contribute in a constructive manner to improve and enhance the available software assets. As such, gCube have adopted this Code of Conduct and require all those who wish to participate to agree to these guidelines.

Overview

gCube Reference Model
gCube Reference Architecture
Glossary

How-tos

How to develop a gCube Component
How to develop a gCube Portlet
How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)
How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)
How to turn software applications and containers into gCube resources (a.k.a. the gCube SmartGears Framework)
How to integrate gCube system with external Cloud Providers
Accounting
How to produce accounting records
How to consume accounting records
How to install and configure Accounting Portlet(AM)
Data Analytics
How to install and configure Statistical Algorithms Importer(SAI)
How to Implement Algorithms by Statistical Algorithms Importer(SAI)
How to Implement Algorithms for DataMiner by Java libraries
How to Interact with the DataMiner by client
How to use the DataMiner Pool Manager
Data Publishing
How to programmatically publishing a spatial dataset and the associated metadata by the gCube SDI
How to use Data Transfer 2
Data Discovery and Access
How to programmatically discover geospatial metadata

Components Programming Reference: Functionality-oriented View

Core-facilities
Data Infrastructure Management Facilities
Data Infrastructure Policy-oriented Security Facilities
Workflow Management Facilities
Data Management Facilities
Data Access and Storage Facilities
Data Transfer Facilities
Data Assessment, Harmonisation, and Certification Facilities
Data Consumption Facilities
Data Retrieval Facilities
Data Manipulation Facilities
Data Mining Facilities
Data Visualisation Facilities
Semantic Data Analysis Facilities
gCube APIs
Social Networking Library and Social Networking Service
Social Networking Data Discovery
Storage Manager Service
Home Library Service (DEPRECATED, see StorageHub)
Storage Hub Service
Portal Context and Portal User, Group and Roles Management
Portal Mailing API
gCube Presentation Services
GCube Widgets Store

Components Programming Reference: Data-typology-oriented View

Biodiversity Data Facilities
Geospatial Data Facilities
Semantic Data Facilities
Statistical Data Facilities