Difference between revisions of "Developer's Guide"

Latest revision as of 12:00, 13 July 2020

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

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

Difference between revisions of "Developer's Guide"

Latest revision as of 12:00, 13 July 2020

Contents

Overview

How-tos

Components Programming Reference: Functionality-oriented View

Components Programming Reference: Data-typology-oriented View

Navigation menu

Views

Personal tools

gCube Wiki

gCube features

gCube documentation

Integration and Distribution

Search

Tools