Difference between revisions of "Developer's Guide"

From Gcube Wiki
Jump to: navigation, search
(Contents)
(How-tos)
 
(270 intermediate revisions by 28 users not shown)
Line 1: Line 1:
 +
[[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:
 
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 gCube’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.
# gCube Components Programming Reference
+
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.
## Collective Layer
+
 
### [[Broker and Match Maker]]
+
=== [[Developer's Guide: Introduction | Overview]] ===
### [[DL Management]]
+
: [[Reference_Model | gCube Reference Model]]
### [[DIS-BDII-Client]]
+
: [[GCube_Architecture | gCube Reference Architecture]]
### [[DIS-Broker]]
+
: [[Glossary]]
### [[DIS-HLS-Client]]
+
 
### [[DIS-IC]]
+
=== How-tos ===
### [[DIS-IP]]
+
: [[How to develop a gCube Component]]
### [[DIS-Registry]]
+
: [[How to develop a gCube Portlet]]
### [[DVOS Authorization]]
+
: [[Featherweight Stack | How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)]]
### [[NAL]]
+
: [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries_Framework | How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)]]
### [[Package Repository]]
+
: [[SmartGears | How to turn software applications and containers into gCube resources (a.k.a. the gCube SmartGears Framework)]]
### [[GAS]]
+
: [[FHNManager | How to integrate gCube system with external Cloud Providers]]
## Digital Library Creation and Management
+
: Accounting
### [[VDL Definition Repository]]
+
:: [[Accounting Lib | How to produce accounting records]]
## Content and Metadata Management
+
:: [[Accounting Analytics | How to consume accounting records]]
### [[Annotation Back End]]
+
:: [[Accounting Portlet: How to install and configure |How to install and configure Accounting Portlet(AM)]]
### [[Metadata Broker]]
+
: Data Analytics
### [[Metadata Catalog]]
+
:: [[Statistical Algorithms Importer: How to install and configure| How to install and configure Statistical Algorithms Importer(SAI)]]
### [[XML Indexer]]
+
:: [[Statistical_Algorithms_Importer | How to Implement Algorithms by Statistical Algorithms Importer(SAI)]]
## Index and Search Management
+
:: [[How-to Implement Algorithms for DataMiner | How to Implement Algorithms for DataMiner by Java libraries]]
### [[Content Source Description]]
+
:: [[How_to_Interact_with_the_DataMiner_by_client | How to Interact with the DataMiner by client]]
### [[Content Source Selection]]
+
:: [[How to use the DataMiner Pool Manager | How to use the DataMiner Pool Manager]]
### [[Data Fusion]]
+
<!-- :: <strike>[[Legacy_applications_integration | How to integrate legacy applications and offer them via WPS]]</strike> -->
### [[Full Text Index]]
+
: Data Publishing
### [[Geographical - Spatial Index]]
+
:: [[How to programmatically publishing a spatial dataset and the associated metadata by the gCube SDI]]
### [[Forward Index]]
+
:: [[How to use Data Transfer 2]]
### [[ResultSet Framework]]
+
: Data Discovery and Access
### [[Search Management]]
+
:: [[GeoNetwork library | How to programmatically discover geospatial metadata]]
### [[Search Operators]]
+
 
## Process Management
+
=== Components Programming Reference: Functionality-oriented View ===
### [[Process Design System - BPELParser]]
+
; [[Core-facilities]]
### [[Process Design System - CSDesignApplet]]
+
: [[Core-facilities#Data_Infrastructure_Management_Facilities | Data Infrastructure Management Facilities]]
### [[Process Design System - CSValidator]]
+
: [[Core-facilities#Data_Infrastructure_Policy-oriented_Security_Facilities | Data Infrastructure Policy-oriented Security Facilities]]  
### [[Process Resources System - ServiceQueryBridge]]
+
: [[Core-facilities#Workflow_Management_Facilities | Workflow Management Facilities]]
### [[Process Resources System - CSResourceManager]]
+
 
### [[Process Execution - CSEngine]]
+
; [[Data Management Facilities]]
### [[Process Execution - GLiteJobWrapper]]
+
: [[Data_Management_Facilities#Data_Access_and_Storage_Facilities | Data Access and Storage Facilities]]  
### [[Process Optimisation Services]]
+
: [[Data_Management_Facilities#Data_Transfer_Facilities | Data Transfer Facilities]]  
# Developing a gCube Component
+
: [[Data_Management_Facilities#Data_Assessment,_Harmonisation,_and_Certification_Facilities | Data Assessment, Harmonisation, and Certification Facilities]]  
## [[Developing a Service]]
+
 
## [[DILIGENT Provider]]
+
; [[Data Consumption Facilities]]  
## [[Profile Specification]]
+
: [[Data_Consumption_Facilities#Data_Retrieval_Facilities | Data Retrieval Facilities]]
## [[Service Archive Specification]]
+
: [[Data_Consumption_Facilities#Data_Manipulation_Facilities | Data Manipulation Facilities]]
# Portlet Development
+
: [[Data Mining Facilities | Data Mining Facilities]]  
## [[Developing Portlets with GWT]]
+
: [[Data_Consumption_Facilities#Data_Visualisation_Facilities | Data Visualisation Facilities]]  
## [[Using credentials in Portlets and Servlets]]
+
: [[Data_Consumption_Facilities#Semantic_Data_Analysis_Facilities | Semantic Data Analysis Facilities]]
## [[General guidelines about Portlet StyleSheets]]
+
 
# Security
+
; [[gCube APIs]]
## [[DILIGENT Security Model]]
+
: [http://wiki.gcube-system.org/gcube/Social_Networking_Library Social Networking Library] and [[Social Networking Service]]
## [[How To Configure Service Security]]
+
: [[Social Networking Data Discovery]]
## [[Common Security Troubleshooting]]
+
: [https://wiki.gcube-system.org/gcube/Storage_Manager Storage Manager Service]
## [[DILIGENT Gridsphere and Portal Security patch]]
+
: [https://wiki.gcube-system.org/gcube/Home_Library_2.0_API_Framework_Specification Home Library Service (DEPRECATED, see StorageHub)]
## [[How to use VOMS api library]]
+
: [https://gcube.wiki.gcube-system.org/gcube/StorageHub_REST_API Storage Hub Service]
# [[References]]
+
:[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]
# [[Glossary]]
+
: [[Portal Mailing API]]
 +
; [[gCube Presentation Services]]
 +
 
 +
:[https://wiki.gcube-system.org/gcube/GCube_Widgets_Store GCube Widgets Store]
 +
 
 +
=== Components Programming Reference: Data-typology-oriented View ===
 +
; [[Biodiversity Data Facilities]]
 +
; [[Geospatial Data Facilities]]
 +
; [[Semantic Data Facilities]]
 +
; [[Statistical Data Facilities]]

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