Difference between revisions of "Developer's Guide"

From Gcube Wiki
Jump to: navigation, search
(How-tos)
 
(172 intermediate revisions by 17 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 Architecture]]
+
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.
# [[Reference Model]]
+
# gCube Components Programming Reference
+
## [[gCube Infrastructure Enabling Services]]
+
### [[Information System]]
+
### [[Virtual Organisation Management]]
+
#### [[Security Library]] (NEW)
+
#### [[Virtual Organisation Management LEGACY]]
+
### [[VRE Management]]
+
### [[ExecutionEngine | Execution Engine]]
+
### [[WorkflowEngine | Workflow Engine]]
+
### [[Messaging Infrastructure]]
+
### [[Utility and Common Libraries]]
+
#### [[common-utils-encryption]]
+
## [[The_GCube_Information_Organisation_Services|gCube Information Organisation Services]]
+
### [[Storage Management|Storage Manager]]
+
### [[Content_Manager_(NEW)|Content Manager]]
+
### [[Content_Manager_Library|Content Manager Library]]
+
### [[gCube_Document_Model| gCube Document Model and gCube Model Library]]
+
### [[GCube_Document_Library_(2.0)|gCube Document Library]]
+
### [[View Manager | View Manager]]
+
## [[gCube Information Organisation Services|gCube Information Organisation Services  (LEGACY)]]
+
### [[Storage Management]]
+
### [[Content Management]]
+
### [[Collection Management]]
+
### [[Metadata Management]]
+
### [[Annotation Management]]
+
### [[Archive Import Service|Content Import]]
+
## [[gCube Information Retrieval Services]]
+
### [[gCube ResultSet (gRS)]]
+
### [[gRS2 | gCube ResultSet 2 (gRS2)]]
+
### [[Search Framework|Search Framework (LEGACY)]]
+
### [[Search 2 Framework (NEW)]]
+
### [[OpenSearch Framework]]
+
### [[Index Management Framework]]
+
### [[Data Transformation]]
+
### [[Personalisation]]
+
### [[Distributed Information Retrieval Support Framework]]
+
### [[gCube Ontology Management Service]]
+
## [[gCube Data Consumption Facilities]]
+
### [[Ecological Modeling| Ecological Modeling: Features for Analyzing Biological Phenomena and Species]]
+
### [[Environment Explorer| Environment Explorer: Features for Retrieving environmental data associated to a set of coordinates]]
+
## [[gCube Data Transfer Facilities]]
+
### [[Data Transfer Agent| Data Transfer Agent]]
+
## [[gCube Presentation Services]]
+
### [[ASL|Application Support Layer]]
+
### [[gCube Portal Engine]]
+
### [[ASL HTTP Front End]]
+
## [[gCube Infrastructure Tools]]
+
### [[SAM Tools| SAM Tools]]
+
### [[Developer's_Guide/ResourceManagerClient| Resource Manager Client]]
+
## [[INSPIRE Community Applications]]
+
## [[DRIVER Community Applications]]
+
  
 +
=== [[Developer's Guide: Introduction | Overview]] ===
 +
: [[Reference_Model | gCube Reference Model]]
 +
: [[GCube_Architecture | gCube Reference Architecture]]
 +
: [[Glossary]]
  
# Step by step guide
+
=== How-tos ===
## Developing a gCube Component
+
: [[How to develop a gCube Component]]
### [https://gcore.wiki.gcube-system.org/gCube/index.php/Developer_Guide Developing a Service]
+
: [[How to develop a gCube Portlet]]
### [[Profile Specification]]
+
: [[Featherweight Stack | How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)]]
### [[Software Archive Specification]]
+
: [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries_Framework | How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)]]
## Portlet Development
+
: [[SmartGears | How to turn software applications and containers into gCube resources (a.k.a. the gCube SmartGears Framework)]]
### [[Developing gCube Portlets Guide]]
+
: [[FHNManager | How to integrate gCube system with external Cloud Providers]]
### [[Adding a Quick tour guide to your portlet]]
+
: Accounting
<!-- ### [[Using credentials in Portlets and Servlets]] -->
+
:: [[Accounting Lib | How to produce accounting records]]
### [[GCube Widgets Library - General guidelines about Portlet StyleSheets]]
+
:: [[Accounting Analytics | How to consume accounting records]]
### [[GCube Portlets common icon set]]
+
:: [[Accounting Portlet: How to install and configure |How to install and configure Accounting Portlet(AM)]]
### [[Inter Portlet Subscription/Notification Mechanism (Client side)]]
+
: Data Analytics
### [[Building your gCube Portlet in ETICS]]
+
:: [[Statistical Algorithms Importer: How to install and configure| How to install and configure Statistical Algorithms Importer(SAI)]]
## Security
+
:: [[Statistical_Algorithms_Importer | How to Implement Algorithms by Statistical Algorithms Importer(SAI)]]
### [[DILIGENT Security Model|Security Model]]
+
:: [[How-to Implement Algorithms for DataMiner | How to Implement Algorithms for DataMiner by Java libraries]]
### [[How To Configure Service Security]]
+
:: [[How_to_Interact_with_the_DataMiner_by_client | How to Interact with the DataMiner by client]]
### [[Common Security Troubleshooting]]
+
:: [[How to use the DataMiner Pool Manager | How to use the DataMiner Pool Manager]]
### [[How to use VOMS api library]]
+
<!-- :: <strike>[[Legacy_applications_integration | How to integrate legacy applications and offer them via WPS]]</strike> -->
# [[References]]
+
: Data Publishing
# [[Glossary]]   
+
:: [[How to programmatically publishing a spatial dataset and the associated metadata by the gCube SDI]]
# [[Lexical Convention]]
+
:: [[How to use Data Transfer 2]]
<!--
+
: Data Discovery and Access
# [[Developer's Guide:Introduction|Introduction]]
+
:: [[GeoNetwork library | How to programmatically discover geospatial metadata]]
# gCube Components Programming Reference
+
 
## Collective Layer
+
=== Components Programming Reference: Functionality-oriented View ===
### [[Broker and Match Maker]]
+
; [[Core-facilities]]
### [[VREManager]]
+
: [[Core-facilities#Data_Infrastructure_Management_Facilities | Data Infrastructure Management Facilities]]
### [[GHNManager]]
+
: [[Core-facilities#Data_Infrastructure_Policy-oriented_Security_Facilities | Data Infrastructure Policy-oriented Security Facilities]]  
### [[Deployer]]
+
: [[Core-facilities#Workflow_Management_Facilities | Workflow Management Facilities]]
### [[DIS-BDII-Client]]
+
 
### [[IS-Notifier]]
+
; [[Data Management Facilities]]
### [[ExistClient]]
+
: [[Data_Management_Facilities#Data_Access_and_Storage_Facilities | Data Access and Storage Facilities]]  
### [[IS-IC]]
+
: [[Data_Management_Facilities#Data_Transfer_Facilities | Data Transfer Facilities]]  
### [[IS-IP]]
+
: [[Data_Management_Facilities#Data_Assessment,_Harmonisation,_and_Certification_Facilities | Data Assessment, Harmonisation, and Certification Facilities]]  
### [[IS-Registry]]
+
 
### [[DVOS Authorization]]
+
; [[Data Consumption Facilities]]  
### [[Package Repository]]
+
: [[Data_Consumption_Facilities#Data_Retrieval_Facilities | Data Retrieval Facilities]]
### [[Software Repository]]
+
: [[Data_Consumption_Facilities#Data_Manipulation_Facilities | Data Manipulation Facilities]]
## Digital Library Creation and Management
+
: [[Data Mining Facilities | Data Mining Facilities]]  
### [[VDL Definition Repository]]
+
: [[Data_Consumption_Facilities#Data_Visualisation_Facilities | Data Visualisation Facilities]]  
## Content and Metadata Management
+
: [[Data_Consumption_Facilities#Semantic_Data_Analysis_Facilities | Semantic Data Analysis Facilities]]
### [[Annotation Back End]]
+
 
### [[Archive Import Service]]
+
; [[gCube APIs]]
### [[Metadata Broker]]
+
: [http://wiki.gcube-system.org/gcube/Social_Networking_Library Social Networking Library] and [[Social Networking Service]]
### [[Metadata Manager]]
+
: [[Social Networking Data Discovery]]
### [[XML Indexer]]
+
: [https://wiki.gcube-system.org/gcube/Storage_Manager Storage Manager Service]
## Index and Search Management
+
: [https://wiki.gcube-system.org/gcube/Home_Library_2.0_API_Framework_Specification Home Library Service (DEPRECATED, see StorageHub)]
### [[Content Source Description]]
+
: [https://gcube.wiki.gcube-system.org/gcube/StorageHub_REST_API Storage Hub Service]
### [[Content Source Selection]]
+
:[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]
### [[Data Fusion]]
+
: [[Portal Mailing API]]
### [[Full Text Index]]
+
; [[gCube Presentation Services]]
### [[Geographical - Spatial Index]]
+
 
### [[Forward Index]]
+
:[https://wiki.gcube-system.org/gcube/GCube_Widgets_Store GCube Widgets Store]
### [[ResultSet Framework]]
+
 
### [[Search Management]]
+
=== Components Programming Reference: Data-typology-oriented View ===
### [[Search Operators]]
+
; [[Biodiversity Data Facilities]]
### [[Personalization Management]]
+
; [[Geospatial Data Facilities]]
## Process Management
+
; [[Semantic Data Facilities]]
### [[Process Design System - BPELParser]]
+
; [[Statistical Data Facilities]]
### [[Process Design System - CSDesignApplet]]
+
### [[Process Design System - CSValidator]]
+
### [[Process Resources System - ServiceQueryBridge]]
+
### [[Process Resources System - CSResourceManager]]
+
### [[Process Execution - CSEngine]]
+
### [[Process Execution - GLiteJobWrapper]]
+
### [[Process Optimisation Services]]
+
## Application Suport Layer
+
### [[ASL]]
+
# Developing a gCube Component
+
## [[Developing a Service]]
+
## [[DILIGENT Provider]]
+
## [[Profile Specification]]
+
## [[Service Archive Specification]]
+
# Portlet Development
+
## [[Developing Portlets with GWT]]
+
## [[Using credentials in Portlets and Servlets]]
+
## [[General guidelines about Portlet StyleSheets]]
+
# Security
+
## [[DILIGENT Security Model]]
+
## [[How To Configure Service Security]]
+
## [[Common Security Troubleshooting]]
+
## [[How to use VOMS api library]]
+
# [[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