Difference between revisions of "Developer's Guide"

From Gcube Wiki
Jump to: navigation, search
m
(How-tos)
 
(55 intermediate revisions by 7 users not shown)
Line 5: Line 5:
 
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.
  
<!-- OLD VERSION - PRE July 2013 
+
The Guide is organised as follows.
== Contents ==
+
[[#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]]
+
#### [[GCube Clients Integration with security]]
+
### [[VRE Management]]
+
### [[ExecutionEngine | Execution Engine]]
+
### [[WorkflowEngine | Workflow Engine]]
+
### [[Messaging Infrastructure]]
+
#### [[Common_Messaging_endpoints|Common Messaging Endpoints Library]]
+
### [[Featherweight Stack| Featherweight Client Stack ]]
+
### [[Utility and Common Libraries]]
+
#### [[common-utils-encryption]]
+
#### [[common-encryption]]
+
#### [[common-accounting-model]]
+
#### [[common-accounting]]
+
## [[The_GCube_Information_Organisation_Services|gCube Information Organisation Services]]
+
### [[Storage_Management_NEW|Storage Manager]]
+
### [[The_Tree_Manager| Tree Manager]]
+
#### [[The_Tree_Manager_Framework | Tree Manager Framework]]
+
#### [[The_Tree_Library | Tree Library]]
+
#### [[The_Tree_Manager_Library | Tree Manager Library]]
+
#### [[OAITMPlugin| OAI TM Plugin]]
+
#### [[SpeciesTMPlugin| Species TM Plugin]]
+
#### [[FigisTMPlugin| FIGIS TM Plugin]]
+
### Species Product Discovery
+
#### [[Species_Product_Discovery:_client_library|Species Product Discovery Client Library]]
+
#### [[Species_Products_Discovery_Objects|Species Product Discovery Objects]]
+
#### [[Darwin_Core_Terms| Darwin Core Terms]]
+
#### [[Species_Discovery_Plugin_Test_Suite|Species Product Discovery TestSuite ]]
+
## [[gCube Information Retrieval Services]]
+
### [[gRS2 | gCube ResultSet 2 (gRS2)]]
+
### [[gRS2Broker | gRS2 Broker]]
+
### [[Search 2 Framework (NEW)]]
+
### [[OpenSearch Framework]]
+
### [[Index Management Framework]]
+
### [[Data Transformation]]
+
### [[Personalisation]]
+
### <strike>[[Distributed Information Retrieval Support Framework]]</strike>
+
### <strike>[[gCube Ontology Management Service]]</strike>
+
## [[gCube Data Consumption Facilities]]
+
### [[Algorithms Implementation| Implementation of Algorithms for the Statistical Manager Service]]
+
### [[Ecological Modeling| Ecological Modeling: Features for Analyzing Biological Phenomena and Species]]
+
## [[gCube Data Transfer Facilities]]
+
### [[Data Transfer Agent|Data Transfer Agent]]
+
### [[Data_Transfer_Scheduler|Data Transfer Scheduler]]
+
###[[Web_Application_Scheduler_Portlet|The Data Transfer Portlet]]
+
### [[Data_Transfer_Common_Messaging|The Data Transfer Common Messaging Interface]]
+
### [[URI_Resolver|URI resolver]]
+
## [[gCube Data Assessment, Harmonization and Certification Facilities]]
+
### [[Time Series Management| Time Series Management and Analysis]]
+
## gCube Data Publishing Facilities
+
### [[gCube SDMX Statistical Data Dissemination System]]
+
## Geospatial Data Facilities
+
### [[Legacy ISO Metadata Publishing]]
+
### [[GeoNetwork library]]
+
### [[GIS Interface]]
+
### [[GIS Publisher service]]
+
### [[Environment Explorer| Environment Explorer: Features for Retrieving environmental data associated to a set of coordinates]]
+
### [[Geo Spatial Data Processing| Geo Spatial Data Processing: Features for processing geo-spatial data]]
+
### [[gCube GeoExplorer Portlet| gCube GeoExplorer Portlet: A web interface for performing discovery of layers in a distributed GeoServer network]]
+
### [[Data_Visualisation_Plugins| GeoExplorer Data Visualization Plugins : A set of GeoExplorer plugins to support visualization of the underlying data]]
+
## [[gCube Presentation Services]]
+
### [[ASL|Application Support Layer]]
+
### [[gCube Portal Engine]]
+
### [[ASL HTTP Front End]]
+
### [[Social Networking Library]]
+
  
# Step by step guide
+
=== [[Developer's Guide: Introduction | Overview]] ===
## Developing a gCube Component
+
### [https://gcore.wiki.gcube-system.org/gCube/index.php/Developer_Guide Developing a Service]
+
### [[Profile Specification]]
+
### [[Software Archive Specification]]
+
## Portlet Development
+
### [[Developing gCube Portlets Guide]]
+
#### [[Create a new Mavenized gCube GWT Portlet Guide (NEW)]]
+
### [[Adding a Quick tour guide to your portlet]]
+
### [[Publish App News in User Feeds (Social Portal)]]
+
### [[GCube Widgets Library - General guidelines about Portlet StyleSheets]]
+
### [[GCube Portlets common icon set]]
+
### [[Inter Portlet Subscription/Notification Mechanism (Client side)]]
+
### [[Building your gCube Portlet in ETICS]]
+
# <strike>[[References]]</strike>
+
# [[Glossary]]   
+
# <strike>[[Lexical Convention]]</strike>
+
 
+
== Alternative TOC ==
+
-->
+
=== [[Developer's Guide:Introduction | Overview]] ===
+
 
: [[Reference_Model | gCube Reference Model]]  
 
: [[Reference_Model | gCube Reference Model]]  
 
: [[GCube_Architecture | gCube Reference Architecture]]
 
: [[GCube_Architecture | gCube Reference Architecture]]
 
: [[Glossary]]
 
: [[Glossary]]
  
=== Basic How-tos ===
+
=== How-tos ===
 
: [[How to develop a gCube Component]]
 
: [[How to develop a gCube Component]]
 
: [[How to develop a gCube Portlet]]
 
: [[How to develop a gCube Portlet]]
 
: [[Featherweight Stack | How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)]]
 
: [[Featherweight Stack | How to interface with a gCube-based Infrastructure (a.k.a. Featherweight Stack Client)]]
 
: [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries_Framework | How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)]]
 
: [[Integration_and_Interoperability_Facilities_Framework:_Client_Libraries_Framework | How to interface with a gCube-based Infrastructure (a.k.a. the gCube Client Libraries Framework)]]
: [[How-to Implement Algorithms for the Statistical Manager]]
+
: [[SmartGears | How to turn software applications and containers into gCube resources (a.k.a. the gCube SmartGears Framework)]]
 +
: [[FHNManager | How to integrate gCube system with external Cloud Providers]]
 +
: Accounting
 +
:: [[Accounting Lib | How to produce accounting records]]
 +
:: [[Accounting Analytics | How to consume accounting records]]
 +
:: [[Accounting Portlet: How to install and configure |How to install and configure Accounting Portlet(AM)]]
 +
: Data Analytics
 +
:: [[Statistical Algorithms Importer: How to install and configure| How to install and configure Statistical Algorithms Importer(SAI)]]
 +
:: [[Statistical_Algorithms_Importer | How to Implement Algorithms by Statistical Algorithms Importer(SAI)]]
 +
:: [[How-to Implement Algorithms for DataMiner | How to Implement Algorithms for DataMiner by Java libraries]]
 +
:: [[How_to_Interact_with_the_DataMiner_by_client | How to Interact with the DataMiner by client]]
 +
:: [[How to use the DataMiner Pool Manager | How to use the DataMiner Pool Manager]]
 +
<!-- :: <strike>[[Legacy_applications_integration | How to integrate legacy applications and offer them via WPS]]</strike> -->
 +
: 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
 +
:: [[GeoNetwork library | How to programmatically discover geospatial metadata]]
  
 
=== Components Programming Reference: Functionality-oriented View ===
 
=== Components Programming Reference: Functionality-oriented View ===
; Core-facilities
+
; [[Core-facilities]]
: Data Infrastructure Management Facilities
+
: [[Core-facilities#Data_Infrastructure_Management_Facilities | Data Infrastructure Management Facilities]]
:: [[Information System]]
+
: [[Core-facilities#Data_Infrastructure_Policy-oriented_Security_Facilities | Data Infrastructure Policy-oriented Security Facilities]]  
:: [[VRE Management | Resource and VRE Management]]
+
: [[Core-facilities#Workflow_Management_Facilities | Workflow Management Facilities]]
: [[Utilities and Common Libraries]]
+
: [[Data Infrastructure Policy-oriented Security Facilities]]  
+
: Workflow Management Facilities
+
:: [[Workflow Engine]]
+
:: [[Execution Engine]]
+
  
 
; [[Data Management Facilities]]
 
; [[Data Management Facilities]]
: Data Access and Storage Facilities  
+
: [[Data_Management_Facilities#Data_Access_and_Storage_Facilities | Data Access and Storage Facilities]]  
:: [[Storage Manager | File-based Data Access]]
+
: [[Data_Management_Facilities#Data_Transfer_Facilities | Data Transfer Facilities]]  
:: [[Tree-based Data Access]]
+
: [[Data_Management_Facilities#Data_Assessment,_Harmonisation,_and_Certification_Facilities | Data Assessment, Harmonisation, and Certification Facilities]]  
:: [[Biodiversity Data Access]]
+
: Data Transfer Facilities  
+
:: [[Result Set]]
+
:: [[Data Transfer]]
+
: Data Assessment, Harmonisation, and Certification Facilities
+
:: [[Time Series Management | Tabular Data Facilities]]
+
:: [[gCube SDMX Statistical Data Dissemination System]]
+
:: Biodiversity Data Facilities
+
  
 
; [[Data Consumption Facilities]]  
 
; [[Data Consumption Facilities]]  
 
: [[Data_Consumption_Facilities#Data_Retrieval_Facilities | Data Retrieval Facilities]]
 
: [[Data_Consumption_Facilities#Data_Retrieval_Facilities | Data Retrieval Facilities]]
<!-- :: [[Search Framework 2.0 | Search Framework]]
 
:: [[OpenSearch Framework]]
 
:: [[Index Management Framework]]
 
:: [[Personalisation]] -->
 
 
: [[Data_Consumption_Facilities#Data_Manipulation_Facilities | Data Manipulation Facilities]]
 
: [[Data_Consumption_Facilities#Data_Manipulation_Facilities | Data Manipulation Facilities]]
<!-- :: [[Data Transformation]] -->
+
: [[Data Mining Facilities | Data Mining Facilities]]  
: [[Data_Consumption_Facilities#Data_Mining_Facilities | Data Mining Facilities]]  
+
 
: [[Data_Consumption_Facilities#Data_Visualisation_Facilities | Data Visualisation Facilities]]  
 
: [[Data_Consumption_Facilities#Data_Visualisation_Facilities | Data Visualisation Facilities]]  
 
: [[Data_Consumption_Facilities#Semantic_Data_Analysis_Facilities | Semantic Data Analysis Facilities]]
 
: [[Data_Consumption_Facilities#Semantic_Data_Analysis_Facilities | Semantic Data Analysis Facilities]]
  
 
; [[gCube APIs]]
 
; [[gCube APIs]]
 
+
: [http://wiki.gcube-system.org/gcube/Social_Networking_Library Social Networking Library] and [[Social Networking Service]]
 +
: [[Social Networking Data Discovery]]
 +
: [https://wiki.gcube-system.org/gcube/Storage_Manager Storage Manager Service]
 +
: [https://wiki.gcube-system.org/gcube/Home_Library_2.0_API_Framework_Specification Home Library Service (DEPRECATED, see StorageHub)]
 +
: [https://gcube.wiki.gcube-system.org/gcube/StorageHub_REST_API Storage Hub Service]
 +
:[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]
 +
: [[Portal Mailing API]]
 
; [[gCube Presentation Services]]
 
; [[gCube Presentation Services]]
  
=== Components Programming Reference: Data-typology-oriented View ===
+
:[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]]
 
; [[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