gCubeSystem
/
gcube-cms-suite
14
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

event_manager #18

Merged
francesco.mangiacrapa merged 168 commits from event_manager into master 2024-06-28 16:55:02 +02:00
Conversation 0 Commits 168 Files Changed 152 +9385 -1701
152 changed files with 9385 additions and 1701 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
CHANGELOG.md
View File

@ -2,18 +2,29 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
# Changelog for org.gcube.spatial.data.gcube-sdi-suite
## [v1.0.6-SNAPSHOT]
- Integrated an EventManager centrally [#26321]
- sdi-plugins: add the logic to apply a regex to the value that must be added to index [#26322]
- notifications-plugins: integrated [#26453]
- catalogue-binding-plugins: integrated [#26454]
## [v1.0.5]
- Added maven profiles `geoportal-release-profile` and `geoportal-snapshot-profile` [#25570]
- Moved to maven-parent.v1.2.0 [#25570]
## [v1.0.4] - 2023-01-10
- Updated plugin framework
## [v1.0.3] - 2022-12-07
- Updated plugin framework
- Introduced module default-lc-managers
## [v1.0.2] - 2021-02-24
-Introduced module sdi-plugins
-Introduced module notifications-plugins
-Introduced module dataminer-plugins
@ -21,6 +32,7 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
-Introduced module ckan-plugin
## [v1.0.1] - 2021-12-07
- Introduced cms-plugin-framework
- Introduced concessioni use case
- Fixed internal group ids

BIN
D4S_Export_PDF/PRE/preVRE/pdf_footer.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 67 KiB

BIN
D4S_Export_PDF/PRE/preVRE/pdf_header.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 25 KiB

238
D4S_UCDs/DEV/devVRE/Concessioni.json
View File

@ -94,7 +94,7 @@
"_description": "Embedded profile for concessioni [mibac] management",
"_creationInfo": {
"_user": {
"_username": "fabio.sinibaldi"
"_username": "francesco.mangiacrapa"
}
},
"_dataAccessPolicies": [
@ -212,21 +212,11 @@
"path": "$._theDocument.descrizioneContenuto",
"type": "TEXT"
},
{
"name": "autore",
"path": "$._theDocument.authors",
"type": "TEXT"
},
{
"name": "contributore",
"path": "$._theDocument.contributore",
"type": "TEXT"
},
{
"name": "titolare",
"path": "$._theDocument.titolari",
"type": "TEXT"
},
{
"name": "responsabile",
"path": "$._theDocument.responsabile",
@ -237,6 +227,16 @@
"path": "$._theDocument.editore",
"type": "TEXT"
},
{
"name": "ufficio_mic_competente",
"path": "$._theDocument.ufficioMic",
"type": "TEXT"
},
{
"name": "funzionario_responsabile",
"path": "$._theDocument.funzionarioResponsabile",
"type": "TEXT"
},
{
"name": "finanziamento",
"path": "$._theDocument.fontiFinanziamento",
@ -272,11 +272,6 @@
"path": "$._info._access._license",
"type": "TEXT"
},
{
"name": "titolare_licenza",
"path": "$._theDocument.titolareLicenza",
"type": "TEXT"
},
{
"name": "accesso",
"path": "$._info._access._license",
@ -286,6 +281,56 @@
"name": "parole_chiave",
"path": "$._theDocument.paroleChiaveLibere",
"type": "TEXT"
},
{
"name": "modalita_individuazione",
"path": "$._theDocument.modalitaIndividuazione",
"type": "TEXT"
},
{
"name": "contesto_indagine",
"path": "$._theDocument.contestoIndagine",
"type": "TEXT"
},
{
"name": "denominazione",
"path": "$._theDocument.denominazione",
"type": "TEXT"
},
{
"name": "stato_attuale",
"path": "$._theDocument.statoAttuale",
"type": "TEXT"
},
{
"name": "accessibilita",
"path": "$._theDocument.accessibilita",
"type": "TEXT"
},
{
"name": "cronologia_macrofase",
"path": "$._theDocument.cronologiaMacrofase",
"type": "TEXT",
"apply_regex": {
"type": "replaceAll",
"regex": "(\\s)?\\([\\s\\S]*",
"replacement": ""
}
},
{
"name": "specifiche_cronologia",
"path": "$._theDocument.specificheCronologia",
"type": "TEXT"
},
{
"name": "quota_max",
"path": "$._theDocument.quotaMax",
"type": "TEXT"
},
{
"name": "quota_min",
"path": "$._theDocument.quotaMin",
"type": "TEXT"
}
],
"jslt": {},
@ -299,6 +344,132 @@
]
}
},
{
"_id": "Catalogue-Binding-Plugin",
"_type": "EventListener",
"_configuration": {
"subscribeEvents": [
{
"event": "LIFECYCLE_STEP_PERFORMED",
"when": [
{
"target_phase": [
"Published"
],
"last_invoked_step": "APPROVE-SUBMITTED"
},
{
"target_phase": [
"DRAFT"
],
"last_invoked_step": "UNPUBLISH"
}
]
},
{
"event": "PROJECT_DELETED"
}
],
"freemarker_template_host": "https://code-repo.d4science.org",
"freemarker_template_path": "gCubeSystem/gcube-cms-suite/raw/branch/event_manager/D4S_UCDs/DEV/devVRE/catalogue/binding/freemarker_templates/d4gna_to_catalogue.ftl",
"enabled": true
}
},
{
"_id": "Notifications-Plugin",
"_type": "EventListener",
"_configuration": {
"subscribeNotifications": [
{
"event": "LIFECYCLE_STEP_PERFORMED",
"notificationFor": [
{
"roles": [
"Data-Manager"
],
"when": [
{
"target_phase": [
"Pending Approval"
],
"last_invoked_step": "SUBMIT-FOR-REVIEW",
"notify": [
{
"type": "USER_NOTIFICATION",
"send": true,
"placeholder_title": "TITLE_REVIEW_REQUIRED",
"placeholder_msg": "MSG_REVIEW_REQUIRED"
}
]
},
{
"target_phase": [
"DRAFT"
],
"last_invoked_step": "REJECT-DRAFT",
"notify": [
{
"type": "USER_NOTIFICATION",
"send": true,
"placeholder_title": "TITLE_ITEM_REJECTED",
"placeholder_msg": "MSG_ITEM_REJECTED"
}
]
}
]
},
{
"roles": [
"Item_Creator"
],
"when": [
{
"target_phase": [
"DRAFT"
],
"last_invoked_step": "REJECT-DRAFT",
"notify": [
{
"type": "USER_NOTIFICATION",
"send": true,
"placeholder_title": "TITLE_ITEM_REJECTED_REVIEW_REQUIRED",
"placeholder_msg": "MSG_ITEM_REJECTED_REVIEW_REQUIRED"
}
]
}
]
},
{
"roles": [
"Any"
],
"when": [
{
"target_phase": [
"Published"
],
"last_invoked_step": "APPROVE-SUBMITTED",
"notify": [
{
"type": "VRE_POST",
"send": true,
"placeholder_msg": "MSG_ITEM_PUBLISHED",
"export_as_pdf": {
"export": false,
"placeholder_msg": "MSG_GO_TO_PDF"
}
}
]
}
]
}
]
}
],
"enabled": true,
"link_to_notifications_messages": "https://code-repo.d4science.org/gCubeSystem/gcube-cms-suite/raw/branch/event_manager/D4S_UCDs/DEV/devVRE/notifications/Notifications_Messages_ita.properties"
}
},
{
"_id": "org.gcube.portlets.user.geoportal-data-entry-app",
"_type": "DATA_ENTRY_GUI",
@ -399,17 +570,16 @@
"_configuration": {
"itemFields": [
{
"label": "Descriptive Fields",
"label": "Any Field",
"paths": [
"_theDocument.nome",
"_theDocument.introduzione",
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.dataInizioProgetto",
"_theDocument.editore",
"_theDocument.responsabile",
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.contestoIndagine",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -437,16 +607,6 @@
"sortable": false,
"asResult": true
},
{
"label": "Author/s",
"paths": [
"_theDocument.authors"
],
"operator": "$and",
"searchable": false,
"sortable": true,
"asResult": true
},
{
"label": "Project Start (yyyy-mm-dd)",
"paths": [
@ -460,11 +620,9 @@
{
"label": "Director/Staff",
"paths": [
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile"
"_theDocument.responsabile",
"_theDocument.editore"
],
"operator": "$or",
"searchable": true,
@ -475,6 +633,7 @@
"label": "Keywords",
"paths": [
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -535,12 +694,12 @@
"paths": [
"_theDocument.nome",
"_theDocument.introduzione",
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile",
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.contestoIndagine",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -591,11 +750,9 @@
{
"label": "Director/Staff",
"paths": [
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile"
"_theDocument.responsabile",
"_theDocument.editore"
],
"operator": "$or",
"searchable": true,
@ -606,6 +763,7 @@
"label": "Keywords",
"paths": [
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",

62
D4S_UCDs/DEV/devVRE/Esquilino.json
View File

@ -83,7 +83,7 @@
"Member"
],
"_enforcer": {
"_filter": "{\"_lifecycleInformation._phase\" : {\"$eq\" : \"PUBLISHED\"}}"
"_filter": "{\"_lifecycleInformation._phase\" : {\"$eq\" : \"Published\"}}"
}
},
{
@ -106,12 +106,6 @@
"Data-Manager",
"Data-Editor"
]
},
{
"STEP": "UNPUBLISH",
"roles": [
"Data-Manager"
]
}
]
}
@ -123,7 +117,7 @@
"registeredFileSetPaths": [
{
"schemaField": "datiAltimetrici",
"documentPath": "datiAltimetrici[*].fileset"
"documentPath": "datiAltimetrici.fileset"
},
{
"schemaField": "planimetria",
@ -500,59 +494,15 @@
"display_on_phase": []
},
{
"id": "submit_for_review",
"title": "Submit for Review",
"id": "publish",
"title": "Publish the Project",
"call_STEPS": [
"SUBMIT-FOR-REVIEW"
"PUBLISH"
],
"description": "Submit the Project (for review)",
"description": "Publish the Project",
"display_on_phase": [
"DRAFT"
]
},
{
"id": "reject",
"title": "Reject",
"call_STEPS": [
"REJECT-DRAFT"
],
"description": "Reject the Project",
"display_on_phase": [
"Pending Approval"
]
},
{
"id": "approve",
"title": "Approve",
"call_STEPS": [
"APPROVE-SUBMITTED"
],
"description": "Approve the Project",
"display_on_phase": [
"Pending Approval"
]
},
{
"id": "unpublish",
"title": "UnPublish",
"call_STEPS": [
"UNPUBLISH"
],
"description": "UnPublish the Project",
"display_on_phase": [
"Published"
]
},
{
"id": "unpublish",
"title": "UnPublish",
"call_STEPS": [
"UNPUBLISH"
],
"description": "UnPublish the Project",
"display_on_phase": [
"PUBLISHED"
]
}
]
}

333
D4S_UCDs/DEV/devVRE/Test_BaseModel.json Normal file
View File

@ -0,0 +1,333 @@
{
"_id": "test_basemodel",
"_version": "1.0.0",
"_name": "Test_BaseModel",
"_schema": {
"planimetria": {
"_children": [
{
"fileset": {
"_type": "RegisteredFileSet"
}
}
]
}
},
"_description": "UCD for BaseModel Test",
"_creationInfo": {
"_user": {
"_username": "francesco.mangiacrapa"
}
},
"_dataAccessPolicies": [
{
"_policy": {
"_read": "any",
"_write": "any"
},
"_roles": [
"Data-Manager"
]
},
{
"_policy": {
"_read": "own",
"_write": "own"
},
"_roles": [
"Data-Editor"
]
},
{
"_policy": {
"_read": "any",
"_write": "none"
},
"_roles": [
"Member"
],
"_enforcer": {
"_filter": "{\"_lifecycleInformation._phase\" : {\"$eq\" : \"Published\"}}"
}
},
{
"_policy": {
"_read": "none",
"_write": "none"
},
"_roles": [
]
}
],
"_handlers": [
{
"_id": "DEFAULT-SINGLE-STEP",
"_type": "LifecycleManagement",
"_configuration": {
"step_access": [
{
"STEP": "PUBLISH",
"roles": [
"Data-Manager",
"Data-Editor"
]
}
]
}
},
{
"_id": "SDI-Default-Materializer",
"_type": "Materializer",
"_configuration": {
"registeredFileSetPaths": [
{
"schemaField": "planimetria",
"documentPath": "planimetria.fileset"
}
]
}
},
{
"_id": "SDI-Indexer-Plugin",
"_type": "Indexer",
"_configuration": {
"bboxEvaluation": [
"$..planimetria.._bbox"
],
"explicitFieldMapping": [
{
"name": "titolo",
"path": "$._theDocument.titolo",
"type": "TEXT"
},
{
"name": "denominazione",
"path": "$._theDocument.denominazione",
"type": "TEXT"
},
{
"name": "descrizione",
"path": "$._theDocument.descrizione",
"type": "TEXT"
},
{
"name": "cronologia",
"path": "$._theDocument.cronologia",
"type": "TEXT"
}
],
"jslt": {
},
"additionalLayers": [
{
"source": {
"url": "..."
},
"toSetTitle": ""
}
]
}
},
{
"_id": "org.gcube.portlets.user.geoportal-data-entry-app",
"_type": "DATA_ENTRY_GUI",
"_configuration": {
"gcubeProfiles": [
{
"gcubeSecondaryType": "GeoportalMetadata",
"gcubeName": "Test_Dati_Descrittivi",
"sectionName": "$.",
"sectionTitle": "Dati Descrittivi"
},
{
"gcubeSecondaryType": "GeoportalMetadata",
"gcubeName": "Test_Planimetria",
"sectionName": "planimetria",
"sectionTitle": "Planimetria",
"parentName": "$.",
"filePaths": [
{
"gcubeProfileFieldName": "File",
"fieldDefinition": "$.planimetria._children[?(@.fileset)]",
"fieldName": "fileset"
}
]
}
],
"saveStep": ""
}
},
{
"_id": "org.gcube.portlets.user.geoportal-data-list",
"_type": "DATA_LIST_GUI",
"_configuration": {
"itemFields": [
{
"label": "Any Field",
"paths": [
"_theDocument.titolo",
"_theDocument.denominazione",
"_theDocument.descrizione",
"_theDocument.cronologia"
],
"operator": "$or",
"searchable": true,
"sortable": false,
"asResult": false
},
{
"label": "Titolo",
"paths": [
"_theDocument.titolo"
],
"operator": "$and",
"searchable": true,
"sortable": true,
"asResult": true
},
{
"label": "Denominazione/Descrizione",
"paths": [
"_theDocument.denominazione",
"_theDocument.descrizione"
],
"operator": "$or",
"searchable": true,
"sortable": false,
"asResult": false
},
{
"label": "Chronology",
"paths": [
"_theDocument.cronologia"
],
"operator": "$and",
"searchable": true,
"sortable": true,
"asResult": true
},
{
"label": "Creator",
"paths": [
"_info._creationInfo._user._username"
],
"operator": "$or",
"searchable": true,
"sortable": false,
"asResult": false
},
{
"label": "Updated",
"paths": [
"_info._lastEditInfo._instant"
],
"operator": "$or",
"searchable": false,
"sortable": true,
"asResult": false
},
{
"label": "Phase",
"paths": [
"_lifecycleInformation._phase"
],
"operator": "$or",
"searchable": true,
"sortable": true,
"asResult": false
},
{
"label": "Status",
"paths": [
"_lifecycleInformation._lastOperationStatus"
],
"operator": "$or",
"searchable": true,
"sortable": true,
"asResult": false
}
]
}
},
{
"_id": "org.gcube.portlets.user.geoportal-basic-data-list",
"_type": "BASIC_DATA_LIST_GUI",
"_configuration": {
"itemFields": [
{
"label": "Any Field",
"paths": [
"_theDocument.titolo",
"_theDocument.denominazione",
"_theDocument.descrizione",
"_theDocument.cronologia"
],
"operator": "$or",
"searchable": true,
"sortable": false,
"asResult": false
},
{
"label": "Title",
"paths": [
"_theDocument.titolo"
],
"operator": "$and",
"searchable": true,
"sortable": true,
"asResult": true
},
{
"label": "Name",
"paths": [
"_theDocument.denominazione"
],
"operator": "$and",
"searchable": true,
"sortable": true,
"asResult": true
},
{
"label": "Chronology",
"paths": [
"_theDocument.cronologia"
],
"operator": "$or",
"searchable": true,
"sortable": false,
"asResult": true
}
]
}
},
{
"_id": "org.gcube.portlets.user.geoportal-workflow-action-list",
"_type": "WORKFLOW_ACTION_LIST_GUI",
"_configuration": {
"actionsDefinition": [
{
"id": "post_creation_action",
"title": "Post Creation Action",
"call_STEPS": [
"PUBLISH"
],
"description": "Action fired after the Project creation",
"display_on_phase": [
]
},
{
"id": "publish",
"title": "Publish the Project",
"call_STEPS": [
"PUBLISH"
],
"description": "Publish the Project",
"display_on_phase": [
"DRAFT"
]
}
]
}
}
]
}

350
D4S_UCDs/DEV/devVRE/catalogue/binding/freemarker_templates/d4gna_to_catalogue.ftl Normal file
View File

@ -0,0 +1,350 @@
<#assign jsonProj=doc>
<#assign theDocument=jsonProj._theDocument>
<#assign resources=[]>
<#assign groups=[]>
<#assign tags=[]>
<#assign extras=[]>
<#function sanitizeString(value)>
<#if value??>
<#return value?trim?replace('\n','')?replace('\"','')>
</#if>
<#return "">
</#function>
<#function onlyAlphanumericString(value)>
<#if value??>
<#return value?trim?replace('\n','')?replace('\"','')?replace("[^\\w]+", "-", "r")>
</#if>
<#return "">
</#function>
<#-- Macro to assign Tags -->
<#macro assignTag in_tags>
<#if in_tags??>
<#if in_tags?is_sequence>
<#list in_tags as my_tag>
<#assign tags = tags + [onlyAlphanumericString(my_tag)] />
</#list>
<#else>
<#assign tags = tags + [onlyAlphanumericString(in_tags)] />
</#if>
</#if>
</#macro>
<#-- Macro to assign a Resource -->
<#macro assignResource name url description format>
<#if description??>
<#else>
<#assign description = ""/>
</#if>
<#if url??>
<#assign resource = {"name": name, "url": url, "description": sanitizeString(description), "format": format}>
<#assign resources = resources + [resource]/>
</#if>
</#macro>
<#-- Macro to assign Groups -->
<#macro assignGroup in_groups>
<#if in_groups??>
<#if in_groups?is_sequence>
<#list in_groups as my_group>
<#assign groups = groups + [my_group] />
</#list>
<#else>
<#assign groups = groups + [in_groups] />
</#if>
</#if>
</#macro>
<#-- Macro to assign Extras field -->
<#macro assignExtraField key value asObject>
<#if key??>
<#assign checkedValue = value/>
<#if key != "spatial">
<#assign checkedValue = sanitizeString(value)/>
</#if>
<#assign extra = {"key": sanitizeString(key), "value": checkedValue, "asObject": asObject}>
<#assign extras = extras + [extra]/>
</#if>
</#macro>
<#-- Macro to build the tags as [{},{},..{}] -->
<#macro buildTags the_tags>
<#if the_tags??>
"tags": [
<#list the_tags as tag>
{
"name": "${tag}"
}
<#if tag?is_last==false>,</#if>
</#list>
],
</#if>
</#macro>
<#-- Macro to build the groups as [{},{},..{}] -->
<#macro buildGroups the_groups>
<#if the_groups??>
"groups": [
<#list the_groups as the_group>
{
"name": "${the_group}"
}
<#if the_group?is_last==false>,</#if>
</#list>
],
</#if>
</#macro>
<#-- Macro to build the resources as [{},{},..{}] -->
<#macro buildResources the_resources>
<#if the_resources??>
"resources": [
<#list the_resources as resource>
{
"name": "${resource.name}",
"url": "${resource.url}",
"description": "${resource.description}",
"format": "${resource.format}"
}
<#if resource?is_last==false>,</#if>
</#list>
],
</#if>
</#macro>
<#-- Macro to build the extras as [{},{},..{}] -->
<#macro buildExtrasFields the_extras>
<#if the_extras??>
"extras": [
<#list the_extras as extra>
<#if extra.asObject?? && extra.asObject>
{
"key": "${extra.key}",
"value": ${extra.value}
}
<#else>
{
"key": "${extra.key}",
"value": "${extra.value}"
}
</#if>
<#if extra?is_last==false>,</#if>
</#list>
]
</#if>
</#macro>
<#--
############################################################
#
#
# Starting document mapping to Catalogue
#
#
############################################################
-->
<#compress>
{
"name": "${jsonProj._id}",
"title": "${sanitizeString(theDocument.nome)}",
"license_id": "CC-BY-SA-4.0",
"private": false,
<#assign sanitizedNotes = sanitizeString(theDocument.introduzione) />
"notes": "${sanitizedNotes}",
<#--
######################
RESOURCES
######################
-->
<#-- Mapping "Relazione Scavo" as resource -->
<#if theDocument.relazioneScavo?? && theDocument.relazioneScavo.fileset?? && theDocument.relazioneScavo.fileset._payloads??>
<#assign payloads = theDocument.relazioneScavo.fileset._payloads>
<#if payloads?size!=0>
<#-- Getting the first payload -->
<#assign payload = payloads[0]>
<@assignResource name=payload._name url=payload._link description=theDocument.relazioneScavo.titolo format=payload._mimetype></@assignResource>
</#if>
</#if>
<#-- Mapping "Immagine Rappresentative" as resource -->
<#if theDocument.immaginiRappresentative??>
<#if theDocument.immaginiRappresentative?is_sequence && theDocument.immaginiRappresentative?size gt 0>
<#list theDocument.immaginiRappresentative as the_image>
<#if the_image.fileset?? && the_image.fileset._payloads??>
<#assign payloads = the_image.fileset._payloads>
<#if payloads?size!=0>
<#-- Getting the first payload -->
<#assign payload = payloads[0]>
<@assignResource name=payload._name url=payload._link description=the_image.didascalia format=payload._mimetype></@assignResource>
</#if>
</#if>
</#list>
</#if>
<#assign payloads = theDocument.immaginiRappresentative[0].fileset._payloads>
<#if payloads?size!=0>
<#-- Getting the first payload -->
<#assign payload = payloads[0]>
<@assignResource name=payload._name url=payload._link description=theDocument.immaginiRappresentative[0].didascalia format=payload._mimetype></@assignResource>
</#if>
</#if>
<#-- Building Resources -->
<@buildResources the_resources=resources></@buildResources>
<#--
######################
TAGS
######################
-->
<#-- Mapping "paroleChiaveLibere" as tag -->
<#if theDocument.paroleChiaveLibere??>
<@assignTag in_tags=theDocument.paroleChiaveLibere></@assignTag>
</#if>
<#-- Building tags -->
<@buildTags the_tags=tags></@buildTags>
<#--
######################
GROUPS
######################
-->
<#-- Mapping the year of the "dataInizioProgetto" as group -->
<#assign dateString = theDocument.dataInizioProgetto?trim>
<#assign dataInizioYear = dateString?split("-")[0]>
<#-- <@assignGroup in_groups=dataInizioYear></@assignGroup> -->
<#-- Building groups -->
<@buildGroups the_groups=groups></@buildGroups>
<#--
######################
EXTRAS
######################
-->
<#-- Mapping extras fields -->
<#if theDocument.contributore??>
<@assignExtraField key="Contributore" value=theDocument.contributore asObject=false></@assignExtraField>
</#if>
<#if theDocument.responsabile??>
<@assignExtraField key="Responsabile dei contenuti" value=theDocument.responsabile asObject=false></@assignExtraField>
</#if>
<#if theDocument.editore??>
<@assignExtraField key="Ente responsabile del progetto" value=theDocument.editore asObject=false></@assignExtraField>
</#if>
<#if theDocument.ufficioMic??>
<@assignExtraField key="Ufficio MiC competente per territorio" value=theDocument.ufficioMic asObject=false></@assignExtraField>
</#if>
<#if theDocument.funzionarioResponsabile??>
<@assignExtraField key="Funzionario Responsabile" value=theDocument.funzionarioResponsabile asObject=false></@assignExtraField>
</#if>
<#if theDocument.fontiFinanziamento??>
<#if theDocument.fontiFinanziamento?is_sequence>
<#list theDocument.fontiFinanziamento as my_extra>
<@assignExtraField key="Fonte del finanziamento" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Fonte del finanziamento" value=theDocument.fontiFinanziamento asObject=false></@assignExtraField>
</#if>
</#if>
<#if theDocument.risorseCorrelate??>
<#if theDocument.risorseCorrelate?is_sequence>
<#list theDocument.risorseCorrelate as my_extra>
<@assignExtraField key="Risorse Correlate" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Risorse Correlate" value=theDocument.risorseCorrelate asObject=false></@assignExtraField>
</#if>
</#if>
<#if theDocument.dataInizioProgetto??>
<@assignExtraField key="Data inizio Campagna" value=theDocument.dataInizioProgetto?trim asObject=false></@assignExtraField>
</#if>
<#if theDocument.dataFineProgetto??>
<@assignExtraField key="Data fine Campagna" value=theDocument.dataFineProgetto?trim asObject=false></@assignExtraField>
</#if>
<#if theDocument.modalitaIndividuazione??>
<#if theDocument.modalitaIndividuazione?is_sequence>
<#list theDocument.modalitaIndividuazione as my_extra>
<@assignExtraField key="Modalità di individuazione" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Modalità di individuazione" value=theDocument.modalitaIndividuazione asObject=false></@assignExtraField>
</#if>
</#if>
<#if theDocument.contestoIndagine??>
<#if theDocument.contestoIndagine?is_sequence>
<#list theDocument.contestoIndagine as my_extra>
<@assignExtraField key="Contesto Indagine" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Contesto Indagine" value=theDocument.contestoIndagine asObject=false></@assignExtraField>
</#if>
</#if>
<#if theDocument.statoAttuale??>
<@assignExtraField key="Stato attuale" value=theDocument.statoAttuale asObject=false></@assignExtraField>
</#if>
<#if theDocument.accessibilita??>
<@assignExtraField key="Accessibilità" value=theDocument.accessibilita asObject=false></@assignExtraField>
</#if>
<#if theDocument.cronologiaMacrofase??>
<#if theDocument.cronologiaMacrofase?is_sequence>
<#list theDocument.cronologiaMacrofase as my_extra>
<@assignExtraField key="Cronologia Macrofase" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Cronologia Macrofase" value=theDocument.cronologiaMacrofase asObject=false></@assignExtraField>
</#if>
</#if>
<#-- spatial field -->
<#if jsonProj._identificationReferences?? && jsonProj._identificationReferences?size!=0 && jsonProj._identificationReferences[0].geoJSON??>
<#assign geoJSON = jsonProj._identificationReferences[0].geoJSON>
<#-- if coordinates exists, managing it as a Point -->
<#if geoJSON.coordinates?? && geoJSON.coordinates?is_sequence && geoJSON.coordinates?size gt 2>
<#assign point_Coordinates = [geoJSON.coordinates[0], geoJSON.coordinates[1]]>
<#assign spatialField = '{\\"type\\": \\"${geoJSON.type}\\", \\"coordinates\\": [${point_Coordinates?join(", ")}]}'>
<@assignExtraField key="spatial" value=spatialField asObject=false></@assignExtraField>
</#if>
</#if>
<#-- Adding extra field "Anno" to add it as group -->
<@assignExtraField key="Anno" value=dataInizioYear asObject=false></@assignExtraField>
<@buildExtrasFields the_extras=extras></@buildExtrasFields>
}
</#compress>

23
D4S_UCDs/DEV/devVRE/notifications/Notifications_Messages.properties Normal file
View File

@ -0,0 +1,23 @@
# REVIEW ACTION
TITLE_REVIEW_REQUIRED=Review required for ${project_name}
MSG_REVIEW_REQUIRED=@${user_caller} submitted the project ${project_name}. You are kindly requested to review it and decide either to APPROVE or REJECT it. See the Project at ${private_data_entry_link}
# REJECTED ACTION
TITLE_ITEM_REJECTED=Rejected ${project_name}
MSG_ITEM_REJECTED=The project ${project_name} (id: ${project_id}) has just been rejected by @${user_caller}. See the Project at ${private_data_entry_link}
# REJECTED ACTION
TITLE_ITEM_REJECTED_REVIEW_REQUIRED=Rejected ${project_name}
MSG_ITEM_REJECTED_REVIEW_REQUIRED=The project ${project_name} has just been rejected. You are kindly requested to review it. See the Project at ${private_data_entry_link}
# PUBLISHED ACTION
TITLE_ITEM_PUBLISHED=Published ${project_name}
MSG_ITEM_PUBLISHED=The project ${project_name} created by @${item_creator} has just been published. See the Project at ${public_data_viewer_link}
# CREATED ACTION
TITLE_ITEM_CREATED=Created ${project_name}
MSG_ITEM_CREATED=The project ${project_name} has just been created. See the Project at ${private_data_entry_link}
# DELETED ACTION
TITLE_ITEM_DELETED=Deleted ${project_name}
MSG_ITEM_DELETED=The project ${project_name} has just been deleted
# UPDATED ACTION
TITLE_ITEM_UPDATED=Updated ${project_name}
MSG_ITEM_UPDATED=The project ${project_name} (id: ${project_id}) has just been updated. See the Project at ${private_data_entry_link}
# GO TO PDF ACTION
MSG_GO_TO_PDF=Go to PDF report at ${project_as_pdf_link}

23
D4S_UCDs/DEV/devVRE/notifications/Notifications_Messages_ita.properties Normal file
View File

@ -0,0 +1,23 @@
# REVIEW ACTION
TITLE_REVIEW_REQUIRED=Richiesta di revisione per ${project_name}
MSG_REVIEW_REQUIRED=@${user_caller} ha sottomesso il progetto ${project_name}. Si prega di esaminarlo e decidere se APPROVARLO o RIFIUTARLO. Vedi il progetto ${private_data_entry_link}
# REJECTED ACTION
TITLE_ITEM_REJECTED=Rigettato ${project_name}
MSG_ITEM_REJECTED=Il progetto ${project_name} (id: ${project_id}) è stato rigettato da @${user_caller}. Vedi il progetto ${private_data_entry_link}
# REJECTED ACTION
TITLE_ITEM_REJECTED_REVIEW_REQUIRED=Rigettato ${project_name}
MSG_ITEM_REJECTED_REVIEW_REQUIRED=Il progetto ${project_name} è stato rigettato. Si prega di rivederlo. Vedi il progetto ${private_data_entry_link}
# PUBLISHED ACTION
TITLE_ITEM_PUBLISHED=Pubblicato ${project_name}
MSG_ITEM_PUBLISHED=Il progetto ${project_name} creato da @${item_creator} è stato pubblicato. Vedi il progetto ${public_data_viewer_link}
# CREATED ACTION
TITLE_ITEM_CREATED=Creato ${project_name}
MSG_ITEM_CREATED=Il progetto ${project_name} è stato creato. Vedi il progetto ${private_data_entry_link}
# DELETED ACTION
TITLE_ITEM_DELETED=Cancellato ${project_name}
MSG_ITEM_DELETED=Il progetto ${project_name} è stato cancellato
# UPDATED ACTION
TITLE_ITEM_UPDATED=Aggiornato ${project_name}
MSG_ITEM_UPDATED=Il progetto ${project_name} (id: ${project_id}) è stato aggiornato. Vedi il progetto ${private_data_entry_link}
# GO TO PDF ACTION
MSG_GO_TO_PDF=Vai al report PDF ${project_as_pdf_link}

109
D4S_UCDs/PRE/preVRE/Concessioni.json
View File

@ -94,7 +94,7 @@
"_description": "Embedded profile for concessioni [mibac] management",
"_creationInfo": {
"_user": {
"_username": "fabio.sinibaldi"
"_username": "francesco.mangiacrapa"
}
},
"_dataAccessPolicies": [
@ -212,21 +212,11 @@
"path": "$._theDocument.descrizioneContenuto",
"type": "TEXT"
},
{
"name": "autore",
"path": "$._theDocument.authors",
"type": "TEXT"
},
{
"name": "contributore",
"path": "$._theDocument.contributore",
"type": "TEXT"
},
{
"name": "titolare",
"path": "$._theDocument.titolari",
"type": "TEXT"
},
{
"name": "responsabile",
"path": "$._theDocument.responsabile",
@ -237,6 +227,16 @@
"path": "$._theDocument.editore",
"type": "TEXT"
},
{
"name": "ufficio_mic_competente",
"path": "$._theDocument.ufficioMic",
"type": "TEXT"
},
{
"name": "funzionario_responsabile",
"path": "$._theDocument.funzionarioResponsabile",
"type": "TEXT"
},
{
"name": "finanziamento",
"path": "$._theDocument.fontiFinanziamento",
@ -272,11 +272,6 @@
"path": "$._info._access._license",
"type": "TEXT"
},
{
"name": "titolare_licenza",
"path": "$._theDocument.titolareLicenza",
"type": "TEXT"
},
{
"name": "accesso",
"path": "$._info._access._license",
@ -286,6 +281,56 @@
"name": "parole_chiave",
"path": "$._theDocument.paroleChiaveLibere",
"type": "TEXT"
},
{
"name": "modalita_individuazione",
"path": "$._theDocument.modalitaIndividuazione",
"type": "TEXT"
},
{
"name": "contesto_indagine",
"path": "$._theDocument.contestoIndagine",
"type": "TEXT"
},
{
"name": "denominazione",
"path": "$._theDocument.denominazione",
"type": "TEXT"
},
{
"name": "stato_attuale",
"path": "$._theDocument.statoAttuale",
"type": "TEXT"
},
{
"name": "accessibilita",
"path": "$._theDocument.accessibilita",
"type": "TEXT"
},
{
"name": "cronologia_macrofase",
"path": "$._theDocument.cronologiaMacrofase",
"type": "TEXT",
"apply_regex": {
"type": "replaceAll",
"regex": "(\\s)?\\([\\s\\S]*",
"replacement": ""
}
},
{
"name": "specifiche_cronologia",
"path": "$._theDocument.specificheCronologia",
"type": "TEXT"
},
{
"name": "quota_max",
"path": "$._theDocument.quotaMax",
"type": "TEXT"
},
{
"name": "quota_min",
"path": "$._theDocument.quotaMin",
"type": "TEXT"
}
],
"jslt": {},
@ -403,12 +448,12 @@
"paths": [
"_theDocument.nome",
"_theDocument.introduzione",
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile",
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.contestoIndagine",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -436,16 +481,6 @@
"sortable": false,
"asResult": true
},
{
"label": "Author/s",
"paths": [
"_theDocument.authors"
],
"operator": "$and",
"searchable": false,
"sortable": true,
"asResult": true
},
{
"label": "Project Start (yyyy-mm-dd)",
"paths": [
@ -459,11 +494,9 @@
{
"label": "Director/Staff",
"paths": [
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile"
"_theDocument.responsabile",
"_theDocument.editore"
],
"operator": "$or",
"searchable": true,
@ -474,6 +507,7 @@
"label": "Keywords",
"paths": [
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -534,12 +568,12 @@
"paths": [
"_theDocument.nome",
"_theDocument.introduzione",
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile",
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.contestoIndagine",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -590,11 +624,9 @@
{
"label": "Director/Staff",
"paths": [
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile"
"_theDocument.responsabile",
"_theDocument.editore"
],
"operator": "$or",
"searchable": true,
@ -605,6 +637,7 @@
"label": "Keywords",
"paths": [
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",

178
D4S_UCDs/PRE/preVRE/Concessioni_estere.json
View File

@ -98,15 +98,43 @@
}
},
"_dataAccessPolicies": [
{"_policy": {"_read": "any","_write": "any"},
"_roles": ["Data-Manager"]},
{"_policy": {"_read": "own","_write": "own"},
"_roles": ["Data-Editor"]},
{"_policy": {"_read": "any","_write": "none"},
"_roles": ["Member"],
"_enforcer": {"_filter": "{\"_lifecycleInformation._phase\" : {\"$eq\" : \"Published\"}}"}},
{"_policy": {"_read": "none","_write": "none"},
"_roles": []}
{
"_policy": {
"_read": "any",
"_write": "any"
},
"_roles": [
"Data-Manager"
]
},
{
"_policy": {
"_read": "own",
"_write": "own"
},
"_roles": [
"Data-Editor"
]
},
{
"_policy": {
"_read": "any",
"_write": "none"
},
"_roles": [
"Member"
],
"_enforcer": {
"_filter": "{\"_lifecycleInformation._phase\" : {\"$eq\" : \"Published\"}}"
}
},
{
"_policy": {
"_read": "none",
"_write": "none"
},
"_roles": []
}
],
"_handlers": [
{
@ -184,21 +212,11 @@
"path": "$._theDocument.descrizioneContenuto",
"type": "TEXT"
},
{
"name": "autore",
"path": "$._theDocument.authors",
"type": "TEXT"
},
{
"name": "contributore",
"path": "$._theDocument.contributore",
"type": "TEXT"
},
{
"name": "titolare",
"path": "$._theDocument.titolari",
"type": "TEXT"
},
{
"name": "responsabile",
"path": "$._theDocument.responsabile",
@ -209,6 +227,16 @@
"path": "$._theDocument.editore",
"type": "TEXT"
},
{
"name": "ufficio_competente",
"path": "$._theDocument.ufficioCompetente",
"type": "TEXT"
},
{
"name": "funzionario_responsabile",
"path": "$._theDocument.funzionarioResponsabile",
"type": "TEXT"
},
{
"name": "finanziamento",
"path": "$._theDocument.fontiFinanziamento",
@ -244,11 +272,6 @@
"path": "$._info._access._license",
"type": "TEXT"
},
{
"name": "titolare_licenza",
"path": "$._theDocument.titolareLicenza",
"type": "TEXT"
},
{
"name": "accesso",
"path": "$._info._access._license",
@ -258,6 +281,56 @@
"name": "parole_chiave",
"path": "$._theDocument.paroleChiaveLibere",
"type": "TEXT"
},
{
"name": "modalita_individuazione",
"path": "$._theDocument.modalitaIndividuazione",
"type": "TEXT"
},
{
"name": "contesto_indagine",
"path": "$._theDocument.contestoIndagine",
"type": "TEXT"
},
{
"name": "denominazione",
"path": "$._theDocument.denominazione",
"type": "TEXT"
},
{
"name": "stato_attuale",
"path": "$._theDocument.statoAttuale",
"type": "TEXT"
},
{
"name": "accessibilita",
"path": "$._theDocument.accessibilita",
"type": "TEXT"
},
{
"name": "cronologia_macrofase",
"path": "$._theDocument.cronologiaMacrofase",
"type": "TEXT",
"apply_regex": {
"type": "replaceAll",
"regex": "(\\s)?\\([\\s\\S]*",
"replacement": ""
}
},
{
"name": "specifiche_cronologia",
"path": "$._theDocument.specificheCronologia",
"type": "TEXT"
},
{
"name": "quota_max",
"path": "$._theDocument.quotaMax",
"type": "TEXT"
},
{
"name": "quota_min",
"path": "$._theDocument.quotaMin",
"type": "TEXT"
}
],
"jslt": {},
@ -278,9 +351,9 @@
"gcubeProfiles": [
{
"gcubeSecondaryType": "GeoNaMetadata",
"gcubeName": "Informazioni_di_progetto",
"gcubeName": "Informazioni_di_progetto_estero",
"sectionName": "$.",
"sectionTitle": "Informazioni di Progetto"
"sectionTitle": "Informazioni di Progetto per l'Estero"
},
{
"gcubeSecondaryType": "GeoNaMetadata",
@ -375,12 +448,12 @@
"paths": [
"_theDocument.nome",
"_theDocument.introduzione",
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile",
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.contestoIndagine",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -408,16 +481,6 @@
"sortable": false,
"asResult": true
},
{
"label": "Author/s",
"paths": [
"_theDocument.authors"
],
"operator": "$and",
"searchable": false,
"sortable": true,
"asResult": true
},
{
"label": "Project Start (yyyy-mm-dd)",
"paths": [
@ -431,11 +494,9 @@
{
"label": "Director/Staff",
"paths": [
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile"
"_theDocument.responsabile",
"_theDocument.editore"
],
"operator": "$or",
"searchable": true,
@ -446,6 +507,7 @@
"label": "Keywords",
"paths": [
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -495,7 +557,7 @@
}
]
}
},
},
{
"_id": "org.gcube.portlets.user.geoportal-basic-data-list",
"_type": "BASIC_DATA_LIST_GUI",
@ -506,12 +568,12 @@
"paths": [
"_theDocument.nome",
"_theDocument.introduzione",
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile",
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.contestoIndagine",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -562,11 +624,9 @@
{
"label": "Director/Staff",
"paths": [
"_theDocument.authors",
"_theDocument.contributore",
"_theDocument.titolari",
"_theDocument.editore",
"_theDocument.responsabile"
"_theDocument.responsabile",
"_theDocument.editore"
],
"operator": "$or",
"searchable": true,
@ -577,6 +637,7 @@
"label": "Keywords",
"paths": [
"_theDocument.paroleChiaveLibere",
"_theDocument.cronologiaMacrofase",
"_theDocument.paroleChiaveICCD"
],
"operator": "$or",
@ -586,8 +647,7 @@
}
]
}
}
,
},
{
"_id": "org.gcube.portlets.user.geoportal-timeline-json-template",
"_type": "TIMELINE_JSON_TEMPLATE",
@ -660,10 +720,16 @@
}
}
],
"_relationshipDefinitions" : [
{"_id": "precedes", "_label" : "Precede",
"_reverseRelationId" : "follows"},
{"_id": "follows", "_label" : "Segue",
"_reverseRelationId" : "precedes"}
"_relationshipDefinitions": [
{
"_id": "precedes",
"_label": "Precede",
"_reverseRelationId": "follows"
},
{
"_id": "follows",
"_label": "Segue",
"_reverseRelationId": "precedes"
}
]
}

4
D4S_UCDs/PRE/preVRE/Esquilino.json
View File

@ -83,7 +83,7 @@
"Member"
],
"_enforcer": {
"_filter": "{\"_lifecycleInformation._phase\" : {\"$eq\" : \"PUBLISHED\"}}"
"_filter": "{\"_lifecycleInformation._phase\" : {\"$eq\" : \"Published\"}}"
}
},
{
@ -123,7 +123,7 @@
"registeredFileSetPaths": [
{
"schemaField": "datiAltimetrici",
"documentPath": "datiAltimetrici[*].fileset"
"documentPath": "datiAltimetrici.fileset"
},
{
"schemaField": "planimetria",

62
README.md
View File

@ -3,29 +3,17 @@ gCube CMS Suite
gCube CMS Suite is a distributed full stack application for publication management in a gCube Hybrid e-infrastructure. Check wiki [here](https://sublime-and-sphinx-guide.readthedocs.io)
[<img src="https://gcube.wiki.gcube-system.org/images_gcube/e/e4/Geo_Portale%281%29.png">](https://www.sphinx-doc.org/en/master/)
[<img src="https://gcube.wiki.gcube-system.org/images_gcube/e/e4/Geo_Portale%281%29.png">](https://geoportal.cloud.d4science.org/geoportal-service/docs/index.html)
Rationale :
Publication involves lots of common features as well as custom behaviour and formats. The service implements the basic common logic, delegating to installed plugin both cutom and configurable functions ranging from validation, data manifestazion, indexing and lifecycle management.
Lifecycle management is itself an extension allowing for both common and complex ad-hoc workflows.
High modularity of plugins allows for the composition of ad hoc use cases with maximized re-usability.
Publication involves lots of common features as well as custom behaviour and formats. The service implements the basic common logic, delegating to installed plugin both custom and configurable functions ranging from validation, data manifestation, indexing and lifecycle management.
**Lifecycle management** is itself an extension allowing for both common and complex ad-hoc workflows.
**High modularity of plugins** allows for the composition of ad hoc use cases with maximized re-usability.
The suite comes with a set of pre-built plugins and GUIs that communities can easily extend and / or reuse.
## Use Case
##### D4GNA: component diagram
<img src="https://gcube.wiki.gcube-system.org/images_gcube/2/2e/Geoportal-Service_Workflow_and_Interactions_with_Engines.png" style="max-width:800px;" alt="D4GNA context: engines involved">
## Documentation
* [Dedicated Wiki](https://geoportal.d4science.org/geoportal-service/docs/index.html#) - powered by [Sphynx](https://www.sphinx-doc.org/en/master/)
* [Service Interactive API](https://geoportal.d4science.org/geoportal-service/api-docs/index.html) - powered by [Enunciate](http://enunciate.webcohesion.com/)
* [Gcube System Wiki](https://gcube.wiki.gcube-system.org/gcube/GeoPortal).
* [Guide Notebooks](use-cases) - powered by [Jupyter](https://jupyter.org/)
## Built with
* [gCube SmartGears](https://gcube.wiki.gcube-system.org/gcube/SmartGears) - The gCube SmartGears framework
* [OpenJDK](https://openjdk.java.net/) - The JDK used
@ -34,6 +22,43 @@ The suite comes with a set of pre-built plugins and GUIs that communities can ea
* [Maven](https://maven.apache.org/) - Dependency Management
* [Enunciate](http://enunciate.webcohesion.com/) - API Documentation
## General Architecture
[<img src="https://gcube.wiki.gcube-system.org/images_gcube/c/ce/Geoportal_General_Architecture.jpg">](https://geoportal.cloud.d4science.org/geoportal-service/docs/architecture.html)
## Lifecycle Managements
Document Lifecycle Managements in action:
##### Single Step (no moderation)
<img src="https://gcube.wiki.gcube-system.org/images_gcube/8/8c/SingleStep_LC.png" style="max-width:600px;" alt="Default Single Step lifecycle">
##### 3 Phases (content moderation)
<img src="https://gcube.wiki.gcube-system.org/images_gcube/d/d8/Default3Phases_LC.png" style="max-width:750px;" alt="Default 3 Phases lifecycle">
## Plugins
Plugins in action:
* [Lifecycle Manager](/gCubeSystem/gcube-cms-suite/src/branch/master/default-lc-managers)
* [Spatial Data Infrastructure "SDI"](/gCubeSystem/gcube-cms-suite/src/branch/master/sdi-plugins)
* [Notifications](/gCubeSystem/gcube-cms-suite/src/branch/master/notifications-plugins)
* [Catalogue Binding](/gCubeSystem/gcube-cms-suite/src/branch/event_manager/catalogue-binding-plugin)
## Use Case
##### The D4GNA
["Dataset per il Geoportale Nazionale per l’Archeologia"](https://gna.d4science.org)
Component diagram:
<img src="https://gcube.wiki.gcube-system.org/images_gcube/2/2e/Geoportal-Service_Workflow_and_Interactions_with_Engines.png" style="max-width:800px;" alt="D4GNA context: engines involved">
## Documentation
* [Dedicated Wiki](https://geoportal.d4science.org/geoportal-service/docs/index.html#) - powered by [Sphynx](https://www.sphinx-doc.org/en/master/)
* [Service Interactive API](https://geoportal.d4science.org/geoportal-service/api-docs/index.html) - powered by [Enunciate](http://enunciate.webcohesion.com/)
* [Gcube System Wiki](https://gcube.wiki.gcube-system.org/gcube/GeoPortal).
* [Guide Notebooks](use-cases) - powered by [Jupyter](https://jupyter.org/)
## Change log
@ -41,10 +66,9 @@ See [CHANGELOG.md](CHANGELOG.md).
## Authors
* **Fabio Sinibaldi** ([ORCID](https://orcid.org/0000-0003-1013-6203)) Computer Scientist at ISTI-CNR
* **Francesco Mangiacrapa** ([ORCID](https://orcid.org/0000-0002-6528-664X)) Computer Scientist at [ISTI-CNR Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience)
* **Fabio Sinibaldi** as "Architect", "Developer" ([ORCID](https://orcid.org/0000-0003-1013-6203)) Computer Scientist at ISTI-CNR
* **Francesco Mangiacrapa** as "Architect", "Developer" and "Maintainer" ([ORCID](https://orcid.org/0000-0002-6528-664X)) Computer Scientist at [ISTI-CNR Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience)
## License

33
catalogue-binding-plugin/.classpath Normal file
View File

@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8"?>
<classpath>
<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
<attributes>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="src" output="target/classes" path="src/main/java">
<attributes>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="src" output="target/test-classes" path="src/test/java">
<attributes>
<attribute name="test" value="true"/>
<attribute name="optional" value="true"/>
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
<attributes>
<attribute name="maven.pomderived" value="true"/>
<attribute name="test" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="output" path="target/classes"/>
</classpath>

1
catalogue-binding-plugin/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
/target/

23
catalogue-binding-plugin/.project Normal file
View File

@ -0,0 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>ckan-plugin</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.jdt.core.javabuilder</name>
<arguments>
</arguments>
</buildCommand>
<buildCommand>
<name>org.eclipse.m2e.core.maven2Builder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.jdt.core.javanature</nature>
<nature>org.eclipse.m2e.core.maven2Nature</nature>
</natures>
</projectDescription>

8
catalogue-binding-plugin/CHANGELOG.md Normal file
View File

@ -0,0 +1,8 @@
# Changelog for org.gcube.application.cms.catalogue-binding-plugin
## [v1.0.0-SNAPSHOT] - 2024-06-19
- First release, implemented the plugin [#26454]
- This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

26
catalogue-binding-plugin/FUNDING.md Normal file
View File

@ -0,0 +1,26 @@
# Acknowledgments
The projects leading to this software have received funding from a series of European Union programmes including:
- the Sixth Framework Programme for Research and Technological Development
- [DILIGENT](https://cordis.europa.eu/project/id/004260) (grant no. 004260).
- the Seventh Framework Programme for research, technological development and demonstration
- [D4Science](https://cordis.europa.eu/project/id/212488) (grant no. 212488);
- [D4Science-II](https://cordis.europa.eu/project/id/239019) (grant no.239019);
- [ENVRI](https://cordis.europa.eu/project/id/283465) (grant no. 283465);
- [iMarine](https://cordis.europa.eu/project/id/283644) (grant no. 283644);
- [EUBrazilOpenBio](https://cordis.europa.eu/project/id/288754) (grant no. 288754).
- the H2020 research and innovation programme
- [SoBigData](https://cordis.europa.eu/project/id/654024) (grant no. 654024);
- [PARTHENOS](https://cordis.europa.eu/project/id/654119) (grant no. 654119);
- [EGI-Engage](https://cordis.europa.eu/project/id/654142) (grant no. 654142);
- [ENVRI PLUS](https://cordis.europa.eu/project/id/654182) (grant no. 654182);
- [BlueBRIDGE](https://cordis.europa.eu/project/id/675680) (grant no. 675680);
- [PerformFISH](https://cordis.europa.eu/project/id/727610) (grant no. 727610);
- [AGINFRA PLUS](https://cordis.europa.eu/project/id/731001) (grant no. 731001);
- [DESIRA](https://cordis.europa.eu/project/id/818194) (grant no. 818194);
- [ARIADNEplus](https://cordis.europa.eu/project/id/823914) (grant no. 823914);
- [RISIS 2](https://cordis.europa.eu/project/id/824091) (grant no. 824091);
- [EOSC-Pillar](https://cordis.europa.eu/project/id/857650) (grant no. 857650);
- [Blue Cloud](https://cordis.europa.eu/project/id/862409) (grant no. 862409);
- [SoBigData-PlusPlus](https://cordis.europa.eu/project/id/871042) (grant no. 871042);

312
catalogue-binding-plugin/LICENSE.md Normal file
View File

@ -0,0 +1,312 @@
# European Union Public Licence V. 1.1
EUPL © the European Community 2007
This European Union Public Licence (the “EUPL”) applies to the Work or Software
(as defined below) which is provided under the terms of this Licence. Any use of
the Work, other than as authorised under this Licence is prohibited (to the
extent such use is covered by a right of the copyright holder of the Work).
The Original Work is provided under the terms of this Licence when the Licensor
(as defined below) has placed the following notice immediately following the
copyright notice for the Original Work:
Licensed under the EUPL V.1.1
or has expressed by any other mean his willingness to license under the EUPL.
## 1. Definitions
In this Licence, the following terms have the following meaning:
- The Licence: this Licence.
- The Original Work or the Software: the software distributed and/or
communicated by the Licensor under this Licence, available as Source Code and
also as Executable Code as the case may be.
- Derivative Works: the works or software that could be created by the Licensee,
based upon the Original Work or modifications thereof. This Licence does not
define the extent of modification or dependence on the Original Work required
in order to classify a work as a Derivative Work; this extent is determined by
copyright law applicable in the country mentioned in Article 15.
- The Work: the Original Work and/or its Derivative Works.
- The Source Code: the human-readable form of the Work which is the most
convenient for people to study and modify.
- The Executable Code: any code which has generally been compiled and which is
meant to be interpreted by a computer as a program.
- The Licensor: the natural or legal person that distributes and/or communicates
the Work under the Licence.
- Contributor(s): any natural or legal person who modifies the Work under the
Licence, or otherwise contributes to the creation of a Derivative Work.
- The Licensee or “You”: any natural or legal person who makes any usage of the
Software under the terms of the Licence.
- Distribution and/or Communication: any act of selling, giving, lending,
renting, distributing, communicating, transmitting, or otherwise making
available, on-line or off-line, copies of the Work or providing access to its
essential functionalities at the disposal of any other natural or legal
person.
## 2. Scope of the rights granted by the Licence
The Licensor hereby grants You a world-wide, royalty-free, non-exclusive,
sub-licensable licence to do the following, for the duration of copyright vested
in the Original Work:
- use the Work in any circumstance and for all usage, reproduce the Work, modify
- the Original Work, and make Derivative Works based upon the Work, communicate
- to the public, including the right to make available or display the Work or
- copies thereof to the public and perform publicly, as the case may be, the
- Work, distribute the Work or copies thereof, lend and rent the Work or copies
- thereof, sub-license rights in the Work or copies thereof.
Those rights can be exercised on any media, supports and formats, whether now
known or later invented, as far as the applicable law permits so.
In the countries where moral rights apply, the Licensor waives his right to
exercise his moral right to the extent allowed by law in order to make effective
the licence of the economic rights here above listed.
The Licensor grants to the Licensee royalty-free, non exclusive usage rights to
any patents held by the Licensor, to the extent necessary to make use of the
rights granted on the Work under this Licence.
## 3. Communication of the Source Code
The Licensor may provide the Work either in its Source Code form, or as
Executable Code. If the Work is provided as Executable Code, the Licensor
provides in addition a machine-readable copy of the Source Code of the Work
along with each copy of the Work that the Licensor distributes or indicates, in
a notice following the copyright notice attached to the Work, a repository where
the Source Code is easily and freely accessible for as long as the Licensor
continues to distribute and/or communicate the Work.
## 4. Limitations on copyright
Nothing in this Licence is intended to deprive the Licensee of the benefits from
any exception or limitation to the exclusive rights of the rights owners in the
Original Work or Software, of the exhaustion of those rights or of other
applicable limitations thereto.
## 5. Obligations of the Licensee
The grant of the rights mentioned above is subject to some restrictions and
obligations imposed on the Licensee. Those obligations are the following:
Attribution right: the Licensee shall keep intact all copyright, patent or
trademarks notices and all notices that refer to the Licence and to the
disclaimer of warranties. The Licensee must include a copy of such notices and a
copy of the Licence with every copy of the Work he/she distributes and/or
communicates. The Licensee must cause any Derivative Work to carry prominent
notices stating that the Work has been modified and the date of modification.
Copyleft clause: If the Licensee distributes and/or communicates copies of the
Original Works or Derivative Works based upon the Original Work, this
Distribution and/or Communication will be done under the terms of this Licence
or of a later version of this Licence unless the Original Work is expressly
distributed only under this version of the Licence. The Licensee (becoming
Licensor) cannot offer or impose any additional terms or conditions on the Work
or Derivative Work that alter or restrict the terms of the Licence.
Compatibility clause: If the Licensee Distributes and/or Communicates Derivative
Works or copies thereof based upon both the Original Work and another work
licensed under a Compatible Licence, this Distribution and/or Communication can
be done under the terms of this Compatible Licence. For the sake of this clause,
“Compatible Licence” refers to the licences listed in the appendix attached to
this Licence. Should the Licensee’s obligations under the Compatible Licence
conflict with his/her obligations under this Licence, the obligations of the
Compatible Licence shall prevail.
Provision of Source Code: When distributing and/or communicating copies of the
Work, the Licensee will provide a machine-readable copy of the Source Code or
indicate a repository where this Source will be easily and freely available for
as long as the Licensee continues to distribute and/or communicate the Work.
Legal Protection: This Licence does not grant permission to use the trade names,
trademarks, service marks, or names of the Licensor, except as required for
reasonable and customary use in describing the origin of the Work and
reproducing the content of the copyright notice.
## 6. Chain of Authorship
The original Licensor warrants that the copyright in the Original Work granted
hereunder is owned by him/her or licensed to him/her and that he/she has the
power and authority to grant the Licence.
Each Contributor warrants that the copyright in the modifications he/she brings
to the Work are owned by him/her or licensed to him/her and that he/she has the
power and authority to grant the Licence.
Each time You accept the Licence, the original Licensor and subsequent
Contributors grant You a licence to their contributions to the Work, under the
terms of this Licence.
## 7. Disclaimer of Warranty
The Work is a work in progress, which is continuously improved by numerous
contributors. It is not a finished work and may therefore contain defects or
“bugs” inherent to this type of software development.
For the above reason, the Work is provided under the Licence on an “as is” basis
and without warranties of any kind concerning the Work, including without
limitation merchantability, fitness for a particular purpose, absence of defects
or errors, accuracy, non-infringement of intellectual property rights other than
copyright as stated in Article 6 of this Licence.
This disclaimer of warranty is an essential part of the Licence and a condition
for the grant of any rights to the Work.
## 8. Disclaimer of Liability
Except in the cases of wilful misconduct or damages directly caused to natural
persons, the Licensor will in no event be liable for any direct or indirect,
material or moral, damages of any kind, arising out of the Licence or of the use
of the Work, including without limitation, damages for loss of goodwill, work
stoppage, computer failure or malfunction, loss of data or any commercial
damage, even if the Licensor has been advised of the possibility of such
damage. However, the Licensor will be liable under statutory product liability
laws as far such laws apply to the Work.
## 9. Additional agreements
While distributing the Original Work or Derivative Works, You may choose to
conclude an additional agreement to offer, and charge a fee for, acceptance of
support, warranty, indemnity, or other liability obligations and/or services
consistent with this Licence. However, in accepting such obligations, You may
act only on your own behalf and on your sole responsibility, not on behalf of
the original Licensor or any other Contributor, and only if You agree to
indemnify, defend, and hold each Contributor harmless for any liability incurred
by, or claims asserted against such Contributor by the fact You have accepted
any such warranty or additional liability.
## 10. Acceptance of the Licence
The provisions of this Licence can be accepted by clicking on an icon “I agree”
placed under the bottom of a window displaying the text of this Licence or by
affirming consent in any other similar way, in accordance with the rules of
applicable law. Clicking on that icon indicates your clear and irrevocable
acceptance of this Licence and all of its terms and conditions.
Similarly, you irrevocably accept this Licence and all of its terms and
conditions by exercising any rights granted to You by Article 2 of this Licence,
such as the use of the Work, the creation by You of a Derivative Work or the
Distribution and/or Communication by You of the Work or copies thereof.
## 11. Information to the public
In case of any Distribution and/or Communication of the Work by means of
electronic communication by You (for example, by offering to download the Work
from a remote location) the distribution channel or media (for example, a
website) must at least provide to the public the information requested by the
applicable law regarding the Licensor, the Licence and the way it may be
accessible, concluded, stored and reproduced by the Licensee.
## 12. Termination of the Licence
The Licence and the rights granted hereunder will terminate automatically upon
any breach by the Licensee of the terms of the Licence.
Such a termination will not terminate the licences of any person who has
received the Work from the Licensee under the Licence, provided such persons
remain in full compliance with the Licence.
## 13. Miscellaneous
Without prejudice of Article 9 above, the Licence represents the complete
agreement between the Parties as to the Work licensed hereunder.
If any provision of the Licence is invalid or unenforceable under applicable
law, this will not affect the validity or enforceability of the Licence as a
whole. Such provision will be construed and/or reformed so as necessary to make
it valid and enforceable.
The European Commission may publish other linguistic versions and/or new
versions of this Licence, so far this is required and reasonable, without
reducing the scope of the rights granted by the Licence. New versions of the
Licence will be published with a unique version number.
All linguistic versions of this Licence, approved by the European Commission,
have identical value. Parties can take advantage of the linguistic version of
their choice.
## 14. Jurisdiction
Any litigation resulting from the interpretation of this License, arising
between the European Commission, as a Licensor, and any Licensee, will be
subject to the jurisdiction of the Court of Justice of the European Communities,
as laid down in article 238 of the Treaty establishing the European Community.
Any litigation arising between Parties, other than the European Commission, and
resulting from the interpretation of this License, will be subject to the
exclusive jurisdiction of the competent court where the Licensor resides or
conducts its primary business.
## 15. Applicable Law
This Licence shall be governed by the law of the European Union country where
the Licensor resides or has his registered office.
This licence shall be governed by the Belgian law if:
- a litigation arises between the European Commission, as a Licensor, and any
- Licensee; the Licensor, other than the European Commission, has no residence
- or registered office inside a European Union country.
## Appendix
“Compatible Licences” according to article 5 EUPL are:
- GNU General Public License (GNU GPL) v. 2
- Open Software License (OSL) v. 2.1, v. 3.0
- Common Public License v. 1.0
- Eclipse Public License v. 1.0
- Cecill v. 2.0

103
catalogue-binding-plugin/README.md Normal file
View File

@ -0,0 +1,103 @@
gCube CMS Suite : Catalogue Binding Plugin
--------------------------------------------------
The "Catalogue Binding Plugin" implements the binding from
(the products registered in) the Geoportal system to the D4Science Catalogue system.
## Built with
* [gCube SmartGears] (https://gcube.wiki.gcube-system.org/gcube/SmartGears) - The gCube SmartGears framework
* [OpenJDK](https://openjdk.java.net/) - The JDK used
* [Maven](https://maven.apache.org/) - Dependency Management
**Uses**
* Apache [FreeMarker](https://freemarker.apache.org/) is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
## Documentation
[gCube CMS Suite](../) parent module containing references, documentation, guides ad utilities.
The "Catalogue Binding Plugin" requires a handler registered in the UCD so defined:
```
{
"_id": "Catalogue-Binding-Plugin",
"_type": "EventListener",
"_configuration": {
"subscribeEvents": [
{
"event": "{EVENT_1}",
"when": [
{
"target_phase": [
"{TARGET_PHASE}"
],
"last_invoked_step": "{LAST_INVOKED_STEP}"
}
]
},
{
"event": "{EVENT_2}"
}
],
"freemarker_template_host": "{FREEMARKER_TEMPLATE_HOST}",
"freemarker_template_path": "{PATH_TO_FREEMARKER_TEMPLATE_NAME.ftl}",
"enabled": {true|false}
}
}
```
About the config:
the "event" part.. `"event": "{EVENT_1}",` is mandatory:
* `{EVENT_X}` (mandatory) - can be ```PROJECT_CREATED, PROJECT_UPDATED, PROJECT_DELETED, LIFECYCLE_STEP_PERFORMED```
the "when" part.. `"when": [{...}]`, is optional:
* `{TARGET_PHASE}` (optional) - can be: `DRAFT`, `Pending Approval`, `Published`, `Any`;
* `{LAST_INVOKED_STEP}` (optional) can be: `SUBMIT-FOR-REVIEW​`, `APPROVE-SUBMITTED`, `REJECT-DRAFT​`, `UNPUBLISH`;
the `{FREEMARKER_TEMPLATE_HOST}` is the host where the FREEMARKER_TEMPLATE.ftl is located and the `{FREEMARKER_TEMPLATE_NAME.ftl}` is the (complete) path to the FREEMARKER_TEMPLATE.ftl file.
The template pointed by `{FREEMARKER_TEMPLATE_HOST}/{PATH_TO_FREEMARKER_TEMPLATE_NAME.ftl}` URL is applied to transform a Geoportal project to Catalogue Item object.
`enabled` : set to `ŧrue` to activate the plugin `false` otherwise.
NB. The configuration must contain the "when" part with `{TARGET_PHASE}` and `{LAST_INVOKED_STEP}` if the `{EVENT_X}` is `LIFECYCLE_STEP_PERFORMED`
## Change log
See [CHANGELOG.md](CHANGELOG.md).
## Authors
* **Francesco Mangiacrapa** ([ORCID](https://orcid.org/0000-0002-6528-664X)) Computer Scientist at [ISTI-CNR Infrascience Group](http://nemis.isti.cnr.it/groups/infrascience)
## License
This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details.
## About the gCube Framework
This software is part of the [gCubeFramework](https://www.gcube-system.org/ "gCubeFramework"): an
open-source software toolkit used for building and operating Hybrid Data
Infrastructures enabling the dynamic deployment of Virtual Research Environments
by favouring the realisation of reuse oriented policies.
The projects leading to this software have received funding from a series of European Union programmes including:
- the Sixth Framework Programme for Research and Technological Development
- DILIGENT (grant no. 004260).
- the Seventh Framework Programme for research, technological development and demonstration
- D4Science (grant no. 212488);
- D4Science-II (grant no.239019);
- ENVRI (grant no. 283465);
- iMarine(grant no. 283644);
- EUBrazilOpenBio (grant no. 288754).
- the H2020 research and innovation programme
- SoBigData (grant no. 654024);
- PARTHENOS (grant no. 654119);
- EGIEngage (grant no. 654142);
- ENVRIplus (grant no. 654182);
- BlueBRIDGE (grant no. 675680);
- PerformFish (grant no. 727610);
- AGINFRAplus (grant no. 731001);
- DESIRA (grant no. 818194);
- ARIADNEplus (grant no. 823914);
- RISIS2 (grant no. 824091);

151
catalogue-binding-plugin/pom.xml Normal file
View File

@ -0,0 +1,151 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>catalogue-binding-plugins</artifactId>
<version>1.0.0-SNAPSHOT</version>
<name>gCube CMS - Catalogue Binding Plugin</name>
<parent>
<groupId>org.gcube.application.cms</groupId>
<artifactId>gcube-cms-suite</artifactId>
<version>[1.0.0, 2.0.0-SNAPSHOT)</version>
</parent>
<properties>
<gitBaseUrl>https://code-repo.d4science.org/gCubeSystem</gitBaseUrl>
</properties>
<scm>
<connection>scm:git:${gitBaseUrl}/gcube-cms-suite</connection>
<developerConnection>scm:git:${gitBaseUrl}/gcube-cms-suite</developerConnection>
<url>${gitBaseUrl}/gcube-cms-suite</url>
</scm>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.gcube.distribution</groupId>
<artifactId>gcube-smartgears-bom</artifactId>
<version>${gcube-smartgears-bom-version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.gcube.application.cms</groupId>
<artifactId>cms-plugin-framework</artifactId>
<version>${plugin-framework-version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.gcube.application.cms</groupId>
<artifactId>cms-plugin-framework</artifactId>
</dependency>
<dependency>
<groupId>org.gcube.application.cms</groupId>
<artifactId>default-lc-managers</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.gcube.portlets.user</groupId>
<artifactId>uri-resolver-manager</artifactId>
<version>[1.0.0,2.0.0-SNAPSHOT)</version>
</dependency>
<dependency>
<groupId>org.gcube.data-catalogue</groupId>
<artifactId>gcat-client</artifactId>
<version>[2.0.0,3.0.0-SNAPSHOT)</version>
</dependency>
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.32</version>
</dependency>
<!-- JSON PARSER -->
<dependency>
<groupId>org.json</groupId>
<artifactId>json</artifactId>
<version>20090211</version>
</dependency>
<dependency>
<groupId>org.gcube.application</groupId>
<artifactId>geoportal-client</artifactId>
<version>[1.1.0-SNAPSHOT, 2.0.0-SNAPSHOT)</version>
<exclusions>
<exclusion>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
</exclusion>
<exclusion>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</exclusion>
</exclusions>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.gcube.application</groupId>
<artifactId>geoportal-data-mapper</artifactId>
<version>[1.0.0, 2.0.0-SNAPSHOT)</version>
<!-- Excluding these beacuse geoportal uses [2-3] ranges conflicting with
[3-4] used by URI-Resolver -->
<exclusions>
<exclusion>
<groupId>org.gcube.contentmanagement</groupId>
<artifactId>storage-manager-wrapper</artifactId>
</exclusion>
<exclusion>
<groupId>org.gcube.contentmanagement</groupId>
<artifactId>storage-manager-core</artifactId>
</exclusion>
</exclusions>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.gcube.application.cms</groupId>
<artifactId>cms-test-commons</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<executions>
<execution>
<id>make-uberjar</id>
<phase>package</phase>
</execution>
<execution>
<id>make-servicearchive</id>
<phase>package</phase>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>

376
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/CatalogueBindingPlugin.java Normal file
View File

@ -0,0 +1,376 @@
package org.gcube.application.cms.cataloguebinding;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import org.bson.Document;
import org.gcube.application.cms.cataloguebinding.config.CatalogueBindingPluginConfigModel;
import org.gcube.application.cms.cataloguebinding.config.SubscribeEventsConfig;
import org.gcube.application.cms.cataloguebinding.doaction.BindingAction;
import org.gcube.application.cms.cataloguebinding.util.SerializationUtil;
import org.gcube.application.cms.implementations.utils.UserUtils;
import org.gcube.application.cms.plugins.EventListenerPluginInterface;
import org.gcube.application.cms.plugins.events.EventListener;
import org.gcube.application.cms.plugins.events.EventManager;
import org.gcube.application.cms.plugins.events.EventManager.Event;
import org.gcube.application.cms.plugins.events.ItemObserved;
import org.gcube.application.cms.plugins.faults.InitializationException;
import org.gcube.application.cms.plugins.faults.InvalidProfileException;
import org.gcube.application.cms.plugins.faults.MaterializationException;
import org.gcube.application.cms.plugins.faults.ShutDownException;
import org.gcube.application.cms.plugins.implementations.AbstractPlugin;
import org.gcube.application.cms.plugins.reports.InitializationReport;
import org.gcube.application.cms.plugins.reports.Report;
import org.gcube.application.cms.plugins.reports.Report.Status;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.plugins.PluginDescriptor;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import com.vdurmont.semver4j.Semver;
import lombok.Synchronized;
import lombok.extern.slf4j.Slf4j;
/**
* The Class CatalogueBindingPlugin.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Jan 19, 2024
*/
@Slf4j
public class CatalogueBindingPlugin extends AbstractPlugin implements EventListenerPluginInterface {
public static final String SUBSCRIBE_EVENTS_CONFIG = "subscribeEvents";
public static final String PLUGIN_ID = "Catalogue-Binding-Plugin";
public static final String PLUGIN_TYPE = "EventListener";
public static final PluginDescriptor DESCRIPTOR = new PluginDescriptor(PLUGIN_ID, PLUGIN_TYPE);
private static final String FREEMARKER_TEMPLATE_PATH = "freemarker_template_path";
private static final String FREEMARKER_TEMPLATE_HOST = "freemarker_template_host";
private static final String CONFIG_ENABLED = "enabled";
static {
DESCRIPTOR.setVersion(new Semver("1.0.0"));
DESCRIPTOR.setDescription("Manage the data binding from geoportal to catalogue");
}
/**
* Gets the descriptor.
*
* @return the descriptor
*/
@Override
public PluginDescriptor getDescriptor() {
return DESCRIPTOR;
}
/**
* Inits the.
*
* @return the initialization report
* @throws InitializationException the initialization exception
*/
@Override
public InitializationReport init() throws InitializationException {
log.debug("Called init");
InitializationReport report = null;
try {
// Creating all listeners
EventListener<ItemObserved<Project>> listenerCreated = new EventListener<ItemObserved<Project>>() {
@Override
public void updated(ItemObserved<Project> observerd) {
log.info("listenerCreated fired on item: {} " + observerd);
boolean subscribed = checkIfSubscribedEvent(observerd);
if (subscribed) {
doAction(observerd);
}
}
};
EventListener<ItemObserved<Project>> listenerUpdated = new EventListener<ItemObserved<Project>>() {
@Override
public void updated(ItemObserved<Project> observerd) {
log.info("listenerUpdated fired on item: {} " + observerd);
boolean subscribed = checkIfSubscribedEvent(observerd);
if (subscribed) {
doAction(observerd);
}
}
};
EventListener<ItemObserved<Project>> listenerDeleted = new EventListener<ItemObserved<Project>>() {
@Override
public void updated(ItemObserved<Project> observerd) {
log.info("listenerDeleted fired on item: {} " + observerd);
boolean subscribed = checkIfSubscribedEvent(observerd);
if (subscribed) {
doAction(observerd);
}
}
};
EventListener<ItemObserved<Project>> listenerLCStepPerformed = new EventListener<ItemObserved<Project>>() {
@Override
public void updated(ItemObserved<Project> observerd) {
log.info("listenerLCStepPerformed fired on item: {} " + observerd);
boolean subscribed = checkIfSubscribedEvent(observerd);
if (subscribed) {
doAction(observerd);
}
}
};
// Subscribing all events
EventManager eventMngInst = EventManager.getInstance();
eventMngInst.subscribe(Event.PROJECT_CREATED, listenerCreated);
eventMngInst.subscribe(Event.PROJECT_UPDATED, listenerUpdated);
eventMngInst.subscribe(Event.PROJECT_DELETED, listenerDeleted);
eventMngInst.subscribe(Event.LIFECYCLE_STEP_PERFORMED, listenerLCStepPerformed);
report = new InitializationReport(Status.OK, PLUGIN_ID + " init performed");
} catch (Exception e) {
InitializationException exc = new InitializationException("Unable to initialize " + DESCRIPTOR.getId(), e);
log.error("init error: {} ", exc);
throw exc;
}
return report;
}
/**
* Inits the in context.
*
* @return the initialization report
* @throws InitializationException the initialization exception
*/
@Override
@Synchronized
public InitializationReport initInContext() throws InitializationException {
InitializationReport report = new InitializationReport();
try {
String context = UserUtils.getCurrent().getContext();
if (getCatalogueBindingMapPerContext() == null) {
log.info("Initializing in " + context);
catalogueBindingMap.put(context, new LinkedHashMap<String, CatalogueBindingPluginConfigModel>());
}
report.setStatus(Report.Status.OK);
report.putMessage("Initialized " + DESCRIPTOR.getId() + " in the " + context);
} catch (Exception e) {
InitializationException exc = new InitializationException("Unable to initialize " + DESCRIPTOR.getId(), e);
log.error("initInContext error: {} ", exc);
throw exc;
}
return report;
}
// Map<Scope<Map<UDC_ID, CatalogueBindingPluginConfigModel>>
protected Map<String, Map<String, CatalogueBindingPluginConfigModel>> catalogueBindingMap = null;
/**
* Gets the catalogue binding map per context.
*
* @return the catalogue binding map per context
*/
protected Map<String, CatalogueBindingPluginConfigModel> getCatalogueBindingMapPerContext() {
String context = UserUtils.getCurrent().getContext();
log.debug("Getting {} from cache map for context {}", CatalogueBindingPlugin.PLUGIN_ID, context);
if (catalogueBindingMap == null) {
catalogueBindingMap = new LinkedHashMap<String, Map<String, CatalogueBindingPluginConfigModel>>();
}
// Map<UDC_ID, EventSubscribed>
Map<String, CatalogueBindingPluginConfigModel> map = catalogueBindingMap.get(context);
return map == null ? new LinkedHashMap<String, CatalogueBindingPluginConfigModel>() : map;
}
/**
* Read events subscribed from configuration in the UCD.
*
* @param useCaseDescriptor the use case descriptor
* @return the catalogue binding plugin config model
* @throws Exception the exception
*/
public CatalogueBindingPluginConfigModel readEventsSubscribedFromConfigurationInTheUCD(
UseCaseDescriptor useCaseDescriptor) throws Exception {
log.debug("Reading subscribed events from UCD");
CatalogueBindingPluginConfigModel cbpcm = null;
if (useCaseDescriptor == null)
throw new Exception("Error reading UCD null found");
try {
String context = UserUtils.getCurrent().getContext();
final Map<String, CatalogueBindingPluginConfigModel> mapCatalogBindingPerContext = getCatalogueBindingMapPerContext();
cbpcm = mapCatalogBindingPerContext.get(useCaseDescriptor.getId());
if (cbpcm == null) {
cbpcm = new CatalogueBindingPluginConfigModel();
List<EventSubscribed> eventsSubscrInTheUCD = new ArrayList<EventSubscribed>();
Document profileConfiguration = getConfigurationFromProfile(useCaseDescriptor).getConfiguration();
log.debug("UseCaseDescriptor Configuration is {} ", profileConfiguration);
boolean configEnabled = profileConfiguration.getBoolean(CONFIG_ENABLED, false);
log.info("Is Config enabled? {} ", CONFIG_ENABLED, configEnabled);
if(configEnabled) {
for (Object fsConfigObj : profileConfiguration.get(SUBSCRIBE_EVENTS_CONFIG, List.class)) {
log.debug("Managing {} ", fsConfigObj);
SubscribeEventsConfig fsConfig = SerializationUtil.convert(fsConfigObj,
SubscribeEventsConfig.class);
log.debug("Converted config {}", fsConfig);
String theEventSubsribed = fsConfig.getEvent();
if (theEventSubsribed == null || theEventSubsribed.isEmpty())
throw new MaterializationException(
"Invalid Field Definition path in configuration [NO MATCH] : " + fsConfig.getEvent());
EventSubscribed eventSub = new EventSubscribed();
Event event = SerializationUtil.convert(theEventSubsribed, Event.class);
log.debug("Added event {} ", event);
eventSub.setEvent(event);
if (fsConfig.getWhen() != null)
eventSub.setWhen(fsConfig.getWhen());
eventsSubscrInTheUCD.add(eventSub);
}
}
String freemarkerTPath = profileConfiguration.get(FREEMARKER_TEMPLATE_PATH, String.class);
String freemakerTHost = profileConfiguration.get(FREEMARKER_TEMPLATE_HOST, String.class);
cbpcm.setContext(context);
cbpcm.setFreemarker_template_host(freemakerTHost);
cbpcm.setFreemarker_template_path(freemarkerTPath);
cbpcm.setListEventSubscribed(eventsSubscrInTheUCD);
// updating the cache
mapCatalogBindingPerContext.put(useCaseDescriptor.getId(), cbpcm);
catalogueBindingMap.put(context, mapCatalogBindingPerContext);
log.info("Events subscribed read from config {} ", eventsSubscrInTheUCD);
}
} catch (InvalidProfileException e) {
log.warn("Unable to read configuration for {} in the UCD {}", CatalogueBindingPlugin.PLUGIN_ID,
useCaseDescriptor.getId());
} catch (Exception e) {
log.error("Unable to read configuration ", e);
} catch (Throwable t) {
log.error("Exception, Unable to read configuration ", t);
}
return cbpcm;
}
/**
* Check if subscribed event.
*
* @param observerd the observerd
* @return true, if successful
*/
public boolean checkIfSubscribedEvent(ItemObserved<Project> observerd) {
log.info("Checking if {} is an subscribed event", observerd.getEvent());
try {
CatalogueBindingPluginConfigModel cbpcm = readEventsSubscribedFromConfigurationInTheUCD(
observerd.getUseCaseDescriptor());
List<EventSubscribed> listEvents = cbpcm.getListEventSubscribed();
log.info("List events is {}", listEvents);
if (listEvents == null) {
log.info("no event subscribed, returing false");
return false;
}
if (listEvents.stream().filter(e -> e.getEvent().equals(observerd.getEvent())).count() > 0) {
log.info("the event {} is subscribed from config ", observerd.getEvent());
return true;
}
log.info("the event {} is not subscribed from config ", observerd.getEvent());
return false;
} catch (Exception e) {
log.error("Exception, Error on checking subscribed events", e);
return false;
}
}
/**
* Shutdown.
*
* @throws ShutDownException the shut down exception
*/
@Override
public void shutdown() throws ShutDownException {
// TODO Auto-generated method stub
}
/**
* Do action.
*
* @param itemObserved the item observed
*/
@Override
public void doAction(ItemObserved<Project> itemObserved) {
log.debug("doAction called...");
boolean isSubscribedEvent = checkIfSubscribedEvent(itemObserved);
log.info("Is the event {} subscribed by " + CatalogueBindingPlugin.class.getSimpleName()
+ " configured in the UCD? {} ", itemObserved.getEvent(), isSubscribedEvent);
if (isSubscribedEvent) {
// Map (UCD_ID, CatalogueBindingPluginConfigModel)
Map<String, CatalogueBindingPluginConfigModel> mapCatalogBindingPerContext = getCatalogueBindingMapPerContext();
// CatalogueBindingPluginConfigModel per UCD
CatalogueBindingPluginConfigModel cbm = mapCatalogBindingPerContext.get(itemObserved.getUCD_Id());
List<EventSubscribed> list = cbm.getListEventSubscribed().stream()
.filter(e -> e.getEvent().equals(itemObserved.getEvent())).collect(Collectors.toList());
if (list.size() > 0) {
// expected one configuration for event type
EventSubscribed eventSubscribed = list.get(0);
BindingAction ba = new BindingAction(itemObserved, eventSubscribed, cbm.getFreemarker_template_host(),
cbm.getFreemarker_template_path());
ba.doAction();
}
}
}
}

14
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/EventSubscribed.java Normal file
View File

@ -0,0 +1,14 @@
package org.gcube.application.cms.cataloguebinding;
import java.util.List;
import org.gcube.application.cms.cataloguebinding.config.BindingWhen;
import org.gcube.application.cms.plugins.events.EventManager.Event;
import lombok.Data;
@Data
public class EventSubscribed {
Event event;
List<BindingWhen> when;
}

19
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/config/BindingWhen.java Normal file
View File

@ -0,0 +1,19 @@
package org.gcube.application.cms.cataloguebinding.config;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.Data;
/**
* Instantiates a new notification when.
*/
@Data
@JsonIgnoreProperties(ignoreUnknown = true)
public class BindingWhen {
List<String> target_phase;
String last_invoked_step;
}

21
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/config/CatalogueBindingPluginConfigModel.java Normal file
View File

@ -0,0 +1,21 @@
package org.gcube.application.cms.cataloguebinding.config;
import java.util.List;
import org.gcube.application.cms.cataloguebinding.EventSubscribed;
import lombok.Data;
@Data
public class CatalogueBindingPluginConfigModel {
String context; // the scope
List<EventSubscribed> listEventSubscribed;
String freemarker_template_path;
String freemarker_template_host;
Boolean enabled = false;
}

16
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/config/SubscribeEventsConfig.java Normal file
View File

@ -0,0 +1,16 @@
package org.gcube.application.cms.cataloguebinding.config;
import java.util.List;
import org.gcube.com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
import lombok.NoArgsConstructor;
@Data
@NoArgsConstructor
public class SubscribeEventsConfig {
private String event;
@JsonProperty("when")
private List<BindingWhen> when;
}

152
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/doaction/BindingAction.java Normal file
View File

@ -0,0 +1,152 @@
package org.gcube.application.cms.cataloguebinding.doaction;
import java.io.IOException;
import java.util.List;
import org.gcube.application.cms.cataloguebinding.EventSubscribed;
import org.gcube.application.cms.cataloguebinding.config.BindingWhen;
import org.gcube.application.cms.cataloguebinding.freemarker.FreemarkerConfig;
import org.gcube.application.cms.cataloguebinding.freemarker.MappingToCatalogue;
import org.gcube.application.cms.plugins.events.ItemObserved;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.lifecycle.LifecycleInformation;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class BindingAction {
private static final String TARGET_PHASE_DRAFT = "DRAFT";
private static final String TARGET_PHASE_PUBLISHED = "Published";
private ItemObserved<Project> itemObserved;
private EventSubscribed eventSubscribed;
private String templateHost;
private String templatePath;
public BindingAction(ItemObserved<Project> itemObserved, EventSubscribed eventSubscribed, String templateHost,
String templatePath) {
this.itemObserved = itemObserved;
this.eventSubscribed = eventSubscribed;
this.templateHost = templateHost;
this.templatePath = templatePath;
}
public void doAction() {
log.info("Do action called on: {}", itemObserved.getEvent());
// The project id is the dataset name
String datasetName = itemObserved.getProjectId();
try {
switch (eventSubscribed.getEvent()) {
case PROJECT_CREATED: {
log.info("Going to create item with id {} on the catalogue...", datasetName);
// Create or Update the item on the catalogue
String catalogueItemJSON = toCatalogueItem();
if (catalogueItemJSON != null)
new GCatCaller().createOrUpdateTheDatasetOnCatalogue(datasetName, catalogueItemJSON);
break;
}
case PROJECT_DELETED: {
log.info("Going to delete item with name {} on the catalogue...", datasetName);
new GCatCaller().deleteDatasetOnCatalogue(datasetName);
break;
}
case PROJECT_UPDATED: {
log.info("Going to update item with id {} on the catalogue...", datasetName);
// Create or Update the item on the catalogue
String catalogueItemJSON = toCatalogueItem();
if (catalogueItemJSON != null)
new GCatCaller().createOrUpdateTheDatasetOnCatalogue(datasetName, catalogueItemJSON);
break;
}
case LIFECYCLE_STEP_PERFORMED: {
List<BindingWhen> listBindingWhen = eventSubscribed.getWhen();
if (listBindingWhen == null || listBindingWhen.size() == 0) {
log.warn("No binding found, so returning!!");
return;
}
for (BindingWhen bindingWhen : listBindingWhen) {
log.info("Checking configuration matching on: {}", bindingWhen);
if (bindingWhen.getTarget_phase() == null || bindingWhen.getTarget_phase().size() == 0) {
log.warn("No binding on target_phase, so returning!!");
continue;
}
if (bindingWhen.getLast_invoked_step() == null
|| bindingWhen.getLast_invoked_step().length() == 0) {
log.warn("No binding on last invoked step, so returning!!");
continue;
}
// Reading 'phase' and 'lastInvokedStep' properties from itemObserved
LifecycleInformation lInfo = itemObserved.getProject().getLifecycleInformation();
String itemPhase = lInfo.getPhase();
String lastInvokedStep = lInfo.getLastInvokedStep();
log.info("ItemObserved phase is: {}, lastInvokedStep is: {}", itemPhase, lastInvokedStep);
// If there is matching between the plugin configuration and item observed on
// phase' and 'lastInvokedStep' fields
if (bindingWhen.getTarget_phase().contains(itemPhase)
&& bindingWhen.getLast_invoked_step().equalsIgnoreCase(lastInvokedStep)) {
log.info(
"The item observerd has phase '{}' and lastInvokedStep '{}' like the plugin configuration model",
itemPhase, lastInvokedStep);
if (itemPhase.equalsIgnoreCase(TARGET_PHASE_PUBLISHED)) {
String catalogueItemJSON = toCatalogueItem();
if (catalogueItemJSON != null) {
log.info("Going to create item with name {} on the catalogue...", datasetName);
new GCatCaller().createOrUpdateTheDatasetOnCatalogue(datasetName, catalogueItemJSON);
}
} else if (itemPhase.equalsIgnoreCase(TARGET_PHASE_DRAFT)) {
// Delete the item on the catalogue
log.info("Going to delete item with name {} on the catalogue...", datasetName);
new GCatCaller().deleteDatasetOnCatalogue(datasetName);
}
} else {
log.info(
"Skipping the operation!! No mathing {} status with plugin configuration model [bindingWhen phase '{}', lastInvokedStep '{}']",
ItemObserved.class.getSimpleName(), itemPhase, lastInvokedStep);
}
}
break;
}
default:
break;
}
} catch (Exception e) {
log.error("Error on applying binding action: ", e);
}
}
public String toCatalogueItem() {
String toCatalogueJSON = null;
try {
FreemarkerConfig fmc = new FreemarkerConfig(templateHost);
Template fmTemplate = fmc.getTemplate(templatePath);
toCatalogueJSON = MappingToCatalogue.apply(fmTemplate, itemObserved.getProject(),
itemObserved.getUseCaseDescriptor(), itemObserved.getContext().getId());
} catch (TemplateException | IOException e) {
log.error("Error: ", e);
}
return toCatalogueJSON;
}
}

110
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/doaction/GCatCaller.java Normal file
View File

@ -0,0 +1,110 @@
/*
*
*/
package org.gcube.application.cms.cataloguebinding.doaction;
import java.net.MalformedURLException;
import javax.ws.rs.WebApplicationException;
import org.gcube.gcat.client.Item;
import lombok.extern.slf4j.Slf4j;
/**
* The Class GCatCaller.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Jun 20, 2024
*/
@Slf4j
public class GCatCaller {
/**
* Creates the or update the dataset on catalogue.
*
* @param datasetName the dataset name
* @param datasetJSON the dataset JSON
* @throws Exception
*/
public void createOrUpdateTheDatasetOnCatalogue(String datasetName, String datasetJSON) throws Exception {
log.info("createOrUpdateTheDatasetOnCatalogue with name {} called", datasetName);
try {
boolean datasetExists = false;
try {
String dataset = new Item().read(datasetName);
datasetExists = dataset != null ? true : false;
} catch (Exception e) {
}
log.info("datasetExists is {}", datasetExists);
if (!datasetExists) {
log.info("calling create dataset...");
String itemCreated = new Item().create(datasetJSON, false);
if (itemCreated != null)
log.info("Dataset created with success");
else
log.warn("Dataset not created!");
} else {
log.info("calling update dataset...");
String itemCreated = new Item().update(datasetName, datasetJSON);
if (itemCreated != null)
log.info("Dataset updated with success!");
else
log.warn("Dataset not updated!");
}
} catch (WebApplicationException | MalformedURLException e) {
log.error("Error occurred on creating the dataset " + datasetName + " on the catalogue", e);
throw e;
}
}
/**
* Delete dataset on catalogue.
*
* @param datasetName the dataset name
*/
public void deleteDatasetOnCatalogue(String datasetName) {
log.info("deleteDatasetOnCatalogue with name {} called", datasetName);
try {
boolean datasetExists = false;
try {
String dataset = new Item().read(datasetName);
datasetExists = dataset != null ? true : false;
} catch (Exception e) {
}
log.info("datasetExists is {}", datasetExists);
if (datasetExists) {
log.info("calling delete dataset and purge");
new Item().delete(datasetName, true);
log.info("Dataset deleted and purged with success!");
} else {
log.warn("Dataset does not exists, returning..");
return;
}
} catch (WebApplicationException | MalformedURLException e) {
log.error("Error occurred on deleting the dataset " + datasetName + " on the catalogue", e);
}
}
public String list(int limit, int offset) {
log.info("list called");
try {
return new Item().list(limit, offset);
} catch (WebApplicationException | MalformedURLException e) {
log.error("Error occurred on listing datasets", e);
}
return null;
}
}

47
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/freemarker/FreemarkerConfig.java Normal file
View File

@ -0,0 +1,47 @@
package org.gcube.application.cms.cataloguebinding.freemarker;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.Properties;
import freemarker.core.ParseException;
import freemarker.template.Configuration;
import freemarker.template.MalformedTemplateNameException;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import freemarker.template.TemplateNotFoundException;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class FreemarkerConfig {
private String urlPathToTemplate;
private RemoteTemplateLoader rtl;
private Configuration cfg = new Configuration(Configuration.VERSION_2_3_32);
public FreemarkerConfig(String urlPathToTemplate) throws MalformedURLException, TemplateException {
log.debug("Init "+FreemarkerConfig.class.getSimpleName()+" with root url: "+urlPathToTemplate);
this.urlPathToTemplate = urlPathToTemplate;
this.rtl = new RemoteTemplateLoader(new URL(urlPathToTemplate));
freeMarkerConfigurer();
}
private Configuration freeMarkerConfigurer() throws TemplateException {
Properties properties = new Properties();
properties.setProperty("localized_lookup", "false");
this.cfg.setSettings(properties);
this.cfg.setTemplateLoader(rtl);
this.cfg.setDefaultEncoding("UTF-8");
return cfg;
}
public Template getTemplate(String templateName) throws TemplateNotFoundException, MalformedTemplateNameException, ParseException, IOException {
return cfg.getTemplate(templateName);
}
public String getUrlPathToTemplate() {
return urlPathToTemplate;
}
}

175
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/freemarker/MappingToCatalogue.java Normal file
View File

@ -0,0 +1,175 @@
package org.gcube.application.cms.cataloguebinding.freemarker;
import java.io.IOException;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Map;
import org.bson.Document;
import org.gcube.application.cms.cataloguebinding.gis.GisClient;
import org.gcube.application.cms.cataloguebinding.util.JSONObjectOrdered;
import org.gcube.application.cms.cataloguebinding.util.SerializationUtil;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import org.gcube.portlets.user.uriresolvermanager.resolvers.query.GeoportalResolverQueryStringBuilder.RESOLVE_AS;
import org.gcube.portlets.user.uriresolvermanager.resolvers.query.GeoportalResolverQueryStringBuilder.TARGET_GEOPORTAL_APP;
import org.json.JSONException;
import org.json.JSONObject;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.jayway.jsonpath.DocumentContext;
import com.jayway.jsonpath.JsonPath;
import com.jayway.jsonpath.spi.json.JsonOrgJsonProvider;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import lombok.extern.slf4j.Slf4j;
/**
* The Class MappingToCatalogue.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Jun 20, 2024
*/
@Slf4j
public class MappingToCatalogue {
private static final String SYSTEM_TYPE = "system:type";
private static final String GIS_LINK = "Gis Link";
/**
* Apply.
*
* @param fmTemplate the fm template
* @param theProject the the project
* @param ucd the ucd
* @param scope the scope
* @return the string
* @throws TemplateException
* @throws IOException
*/
public static String apply(Template fmTemplate, Project theProject, UseCaseDescriptor ucd, String scope)
throws TemplateException, IOException {
log.info("Apply template {} to project with id '{}' and ucd id '{}' called", fmTemplate.getName(),
theProject.getId(), ucd.getId());
try {
// Getting project as document
Document asDocument = SerializationUtil.asDocument(theProject);
// Transforming the document as json
String json = asDocument.toJson();
// Getting map from json object
Map toJsonMap = fmtJsonUtil(json);
// Putting the map as doc to apply the freemarker template
StringWriter stringWriter = new StringWriter();
Map root = new HashMap();
root.put("doc", toJsonMap);
// applying the freemarker template
fmTemplate.process(root, stringWriter);
log.info("template applied with success..");
String toCatalogueDatasetJSON = stringWriter.toString();
if (log.isTraceEnabled()) {
log.trace("Template applyed with result: " + toCatalogueDatasetJSON);
}
// Parsing the Catalogue Dataset json as Document Context
com.jayway.jsonpath.Configuration configuration = com.jayway.jsonpath.Configuration.builder()
.jsonProvider(new JsonOrgJsonProvider()).build();
DocumentContext theDoc = JsonPath.parse(toCatalogueDatasetJSON, configuration);
log.info("Adding service fields..");
// Adding GIS LINK to doc
// TODO ACTIVATE THIS FOR GENERATING GIS LINK
JSONObject theGisLinkObj = JSONObjectOrdered.instance();
try {
String link = GisClient.gisLink(RESOLVE_AS.PUBLIC, ucd.getId(), theProject.getId(), scope,
TARGET_GEOPORTAL_APP.GEO_DV, true);
theGisLinkObj.put("key", GIS_LINK);
theGisLinkObj.put("value", link);
theDoc.add("$.extras", theGisLinkObj);
} catch (JSONException e) {
String error = "Error occurrend on adding " + GIS_LINK;
log.warn(error, e);
}
// Adding system:type to doc
try {
JSONObject theSystemType = JSONObjectOrdered.instance();
theSystemType.put("key", SYSTEM_TYPE);
theSystemType.put("value", ucd.getName());
theDoc.add("$.extras", theSystemType);
} catch (JSONException e) {
String error = "Error occurrend on adding " + SYSTEM_TYPE;
log.warn(error, e);
}
String catalogueDatasetJSON = prettyPrintJsonUtil(theDoc.jsonString(), false);
log.info("To catalogue JSON: \n" + catalogueDatasetJSON);
log.info("returning catalogue dataset, json lenght is: " + catalogueDatasetJSON.length());
return catalogueDatasetJSON;
} catch (IOException e) {
log.error(IOException.class.getName() + " on apply mapping to catalogue: ", e);
throw e;
} catch (TemplateException e) {
log.error(TemplateException.class.getName() + " on apply mapping to catalogue: ", e);
throw e;
}
}
/**
* Fmt json util.
*
* @param json the json
* @return the map
* @throws JsonParseException the json parse exception
* @throws JsonMappingException the json mapping exception
* @throws IOException Signals that an I/O exception has occurred.
*/
public static Map<String, Object> fmtJsonUtil(String json)
throws JsonParseException, JsonMappingException, IOException {
ObjectMapper OBJECT_MAPPER = new ObjectMapper();
return OBJECT_MAPPER.readValue(json, new TypeReference<HashMap<String, Object>>() {
});
}
/**
* Pretty print json util.
*
* @param uglyJsonString the ugly json string
* @return the string
*/
public static String prettyPrintJsonUtil(String uglyJsonString, boolean indent) {
ObjectMapper mapper = new ObjectMapper();
if (indent)
mapper.enable(SerializationFeature.INDENT_OUTPUT);
Object jsonObject;
String prettyJson = "";
try {
if (indent)
jsonObject = mapper.readValue(uglyJsonString, Object.class);
else
jsonObject = mapper.readValue(uglyJsonString, JsonNode.class);
prettyJson = mapper.writeValueAsString(jsonObject);
} catch (IOException e) {
return uglyJsonString;
}
return prettyJson;
}
}

44
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/freemarker/RemoteTemplateLoader.java Normal file
View File

@ -0,0 +1,44 @@
package org.gcube.application.cms.cataloguebinding.freemarker;
import java.net.MalformedURLException;
import java.net.URL;
import freemarker.cache.URLTemplateLoader;
/**
* The Class RemoteTemplateLoader.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Jun 19, 2024
*/
public class RemoteTemplateLoader extends URLTemplateLoader {
private URL root;
/**
* Instantiates a new remote template loader.
*
* @param root the root
*/
public RemoteTemplateLoader(URL root) {
super();
this.root = root;
}
/**
* Gets the url.
*
* @param template the template
* @return the url
*/
@Override
protected URL getURL(String template) {
try {
return new URL(root, "/" + template);
} catch (MalformedURLException e) {
e.printStackTrace();
}
return null;
}
}

42
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/gis/GisClient.java Normal file
View File

@ -0,0 +1,42 @@
package org.gcube.application.cms.cataloguebinding.gis;
import java.util.Map;
import org.gcube.portlets.user.uriresolvermanager.UriResolverManager;
import org.gcube.portlets.user.uriresolvermanager.resolvers.query.GeoportalResolverQueryStringBuilder;
import org.gcube.portlets.user.uriresolvermanager.resolvers.query.GeoportalResolverQueryStringBuilder.RESOLVE_AS;
import org.gcube.portlets.user.uriresolvermanager.resolvers.query.GeoportalResolverQueryStringBuilder.TARGET_GEOPORTAL_APP;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class GisClient {
public static String gisLink(RESOLVE_AS resolveAs, String profileID, String projectID, String scope, TARGET_GEOPORTAL_APP targetApp, boolean shortLink) {
log.debug("called gisLink as {} for scope {}, profileId {}, projectId {} ", resolveAs, scope, profileID,
projectID);
String theLink = "";
try {
log.debug("Trying to generate Geoportal Gis Link...");
// Contacting the Geoportal-Resolver via UriResolverManager
UriResolverManager uriResolverManager = new UriResolverManager("GEO");
GeoportalResolverQueryStringBuilder builder = new GeoportalResolverQueryStringBuilder(profileID, projectID);
builder.scope(scope);
builder.resolverAs(resolveAs);
if(targetApp!=null)
builder.targetApp(targetApp);
Map<String, String> params = builder.buildQueryParameters();
theLink = uriResolverManager.getLink(params, shortLink);
log.info("Geoportal GisViewer link is {} ", theLink);
} catch (Exception e) {
log.error("Error on creating the Geoportal GisViewer link for project id {}", projectID, e);
}
return theLink;
}
}

33
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/util/JSONObjectOrdered.java Normal file
View File

@ -0,0 +1,33 @@
package org.gcube.application.cms.cataloguebinding.util;
import java.lang.reflect.Field;
import java.util.LinkedHashMap;
import org.json.JSONObject;
/**
* The Class JSONObjecOrdered.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Mar 10, 2022
*/
public final class JSONObjectOrdered {
/**
* Instance.
*
* @return the JSON object
*/
public static JSONObject instance() {
JSONObject jsonObject = new JSONObject();
try {
Field changeMap = jsonObject.getClass().getDeclaredField("map");
changeMap.setAccessible(true);
changeMap.set(jsonObject, new LinkedHashMap<>());
changeMap.setAccessible(false);
} catch (IllegalAccessException | NoSuchFieldException e) {
}
return jsonObject;
}
}

117
catalogue-binding-plugin/src/main/java/org/gcube/application/cms/cataloguebinding/util/SerializationUtil.java Normal file
View File

@ -0,0 +1,117 @@
package org.gcube.application.cms.cataloguebinding.util;
import java.io.IOException;
import org.bson.Document;
import org.bson.types.ObjectId;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.vdurmont.semver4j.Semver;
public class SerializationUtil {
public static ObjectMapper mapper;
static {
mapper=new ObjectMapper();
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,false);
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
mapper.registerModule(new JavaTimeModule());
SimpleModule s=new SimpleModule();
s.addDeserializer(ObjectId.class,new ObjectIdDeserializer());
s.addSerializer(ObjectId.class,new ObjectIdSerializer());
s.addDeserializer(Semver.class,new SemverDeserializer());
s.addSerializer(Semver.class,new SemverSerializer());
mapper.registerModule(s);
}
public static String write(Object toWrite) throws JsonProcessingException {
String toReturn= mapper.writeValueAsString(toWrite);
return toReturn;
}
//**** PROFILED DOCUMENTS
public static final <T> T convert(Object d,Class<T> clazz){
return mapper.convertValue(d,clazz);
}
public static final Document asDocument(Object obj) throws JsonProcessingException {
return Document.parse(mapper.writeValueAsString(obj));
}
// ***** SerializationUtil Exceptions
// OBJECT ID
private static class ObjectIdSerializer extends JsonSerializer<ObjectId> {
@Override
public void serialize(ObjectId objectId, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
if (objectId == null) jsonGenerator.writeNull();
else jsonGenerator.writeString(objectId.toString());
}
@Override
public Class<ObjectId> handledType() {
return ObjectId.class;
}
}
private static class ObjectIdDeserializer extends JsonDeserializer<ObjectId> {
@Override
public ObjectId deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
String value=jsonParser.getValueAsString();
if(value==null || value.isEmpty() || value.equals("null"))
return null;
else return new ObjectId(value);
}
@Override
public Class<ObjectId> handledType() {
return ObjectId.class;
}
}
//Sem Version
private static class SemverSerializer extends JsonSerializer<Semver> {
@Override
public void serialize(Semver semver, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
if (semver == null) jsonGenerator.writeNull();
else jsonGenerator.writeString(semver.getValue());
}
@Override
public Class<Semver> handledType() {
return Semver.class;
}
}
private static class SemverDeserializer extends JsonDeserializer<Semver> {
@Override
public Semver deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
String value=jsonParser.getValueAsString();
if(value==null || value.isEmpty() || value.equals("null"))
return null;
else return new Semver(value);
}
@Override
public Class<Semver> handledType() {
return Semver.class;
}
}
}

1
catalogue-binding-plugin/src/test/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
/resources/

107
catalogue-binding-plugin/src/test/java/geoportal_to_catalogue/CataloguePurgeDatasets.java Normal file
View File

@ -0,0 +1,107 @@
package geoportal_to_catalogue;
import org.gcube.application.cms.cataloguebinding.doaction.GCatCaller;
import org.gcube.common.authorization.library.provider.SecurityTokenProvider;
import org.gcube.common.scope.api.ScopeProvider;
import org.json.JSONArray;
import org.json.JSONException;
import test.TestContextConfig;
public class CataloguePurgeDatasets {
public static void main(String[] args) {
TestContextConfig.readContextSettings();
System.out.println("CONTEXT: " + TestContextConfig.CONTEXT);
System.out.println("TOKEN: " + TestContextConfig.TOKEN);
int limit = 10;
int offset = 0;
boolean resultExists = true;
while (resultExists) {
System.out.println("offest: " + offset + ", limit: " + limit);
ScopeProvider.instance.set(TestContextConfig.CONTEXT);
SecurityTokenProvider.instance.set(TestContextConfig.TOKEN);
String items = new GCatCaller().list(limit, offset);
System.out.println("items: " + items);
if (items != null) {
resultExists = true;
JSONArray array;
try {
array = new JSONArray(items);
if (array.length() > 0) {
purgeDatasets(array);
} else
resultExists = false;
} catch (JSONException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
offset = limit + offset;
} else
resultExists = false;
}
System.out.println("done!");
}
public static void purgeDatasets(JSONArray array) {
try {
int index = 0;
int sleepingTime = 4000;
for (int i = 0; i < array.length(); i++) {
index++;
String datasetName = array.getString(i);
System.out.println(index + ") Deleting dataset name : " + datasetName);
ScopeProvider.instance.set(TestContextConfig.CONTEXT);
SecurityTokenProvider.instance.set(TestContextConfig.TOKEN);
new GCatCaller().deleteDatasetOnCatalogue(datasetName);
System.out.println("sleeping..." + sleepingTime);
Thread.sleep(sleepingTime);
}
System.out.println("done!");
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
public static void purgeDatasets(int limit, int offset) {
TestContextConfig.readContextSettings();
try {
ScopeProvider.instance.set(TestContextConfig.CONTEXT);
SecurityTokenProvider.instance.set(TestContextConfig.TOKEN);
String items = new GCatCaller().list(limit, offset);
System.out.println("items: " + items);
JSONArray array = new JSONArray(items);
for (int i = 0; i < array.length(); i++) {
String datasetName = array.getString(i);
System.out.println(i + ") name : " + datasetName);
ScopeProvider.instance.set(TestContextConfig.CONTEXT);
SecurityTokenProvider.instance.set(TestContextConfig.TOKEN);
new GCatCaller().deleteDatasetOnCatalogue(datasetName);
Thread.sleep(5000);
}
System.out.println("done!");
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
}

487
catalogue-binding-plugin/src/test/java/geoportal_to_catalogue/GeoportalToCatalogueBatchPublisher.java Normal file
View File

@ -0,0 +1,487 @@
package geoportal_to_catalogue;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.rmi.RemoteException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.concurrent.TimeUnit;
import org.gcube.application.cms.cataloguebinding.doaction.GCatCaller;
import org.gcube.application.cms.cataloguebinding.freemarker.MappingToCatalogue;
import org.gcube.application.geoportal.common.model.configuration.Archive;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import org.gcube.application.geoportal.common.rest.Projects;
import org.gcube.application.geoportalcommon.geoportal.GeoportalClientCaller;
import org.gcube.application.geoportalcommon.geoportal.ProjectsCaller;
import org.gcube.application.geoportalcommon.shared.SearchingFilter;
import org.gcube.application.geoportalcommon.shared.SearchingFilter.LOGICAL_OP;
import org.gcube.application.geoportalcommon.shared.SearchingFilter.ORDER;
import org.gcube.application.geoportalcommon.shared.WhereClause;
import org.gcube.application.geoportalcommon.shared.geoportal.config.ItemFieldDV;
import org.gcube.common.authorization.library.provider.SecurityTokenProvider;
import org.gcube.common.scope.api.ScopeProvider;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;
import lombok.extern.slf4j.Slf4j;
import test.TestContextConfig;
/**
* The Class GeoportalToCatalogueBatchPublisher.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Jun 25, 2024
*/
@Slf4j
public class GeoportalToCatalogueBatchPublisher {
public final static String profileID = "profiledConcessioni";
public final static Integer MAX_ITEMS = 100;
static PrintWriter reportPrintWriter;
static PrintWriter errorPrintWriter;
private static long startTime;
private static final String CSV_DELIMITER = ";";
/**
* The main method.
*
* @param args the arguments
*/
public static void main(String[] args) {
//procedureToPublishProjectsOnCatalogue();
String projectId = " 6663016a312dc236d217be5c";
checkMappingToJSONForProjectByID(projectId);
}
public static void checkMappingToJSONForProjectByID(String projectID) {
TestContextConfig.readContextSettings();
String sourceScope = TestContextConfig.CONTEXT;
String sourceToken = TestContextConfig.TOKEN;
ScopeProvider.instance.set(sourceScope);
SecurityTokenProvider.instance.set(sourceToken);
ProjectsCaller clientProjects = GeoportalClientCaller.projects();
Projects<Project> client = (Projects<Project>) clientProjects.getClient(profileID);
try {
UseCaseDescriptor ucd = GeoportalClientCaller.useCaseDescriptors().getUCDForId(profileID);
Project theProject = client.getById(projectID);
log.info("\n\nConverting the project {}", theProject.getId());
String toCatalogueJSON = mapToCatalogue(theProject, ucd, sourceScope, sourceToken);
String jsonPretty = prettyPrintUsingGson(toCatalogueJSON);
log.info(jsonPretty);
} catch (RemoteException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (Exception e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
}
private static void procedureToPublishProjectsOnCatalogue() {
TestContextConfig.readContextSettings();
String sourceScope = TestContextConfig.CONTEXT;
String sourceToken = TestContextConfig.TOKEN;
String reportFile = TestContextConfig.CONTEXT.replaceAll("/", "_") + "_report_.csv";
String errorFile = TestContextConfig.CONTEXT.replaceAll("/", "_") + "_error_.csv";
try {
Files.deleteIfExists(Paths.get(reportFile));
Files.deleteIfExists(Paths.get(errorFile));
} catch (IOException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
try {
FileWriter reportWriter = new FileWriter(reportFile, true);
FileWriter errorWriter = new FileWriter(errorFile, true);
BufferedWriter reportBW = new BufferedWriter(reportWriter);
BufferedWriter errorBW = new BufferedWriter(errorWriter);
reportPrintWriter = new PrintWriter(reportBW);
reportPrintWriter.println("NB." + CSV_DELIMITER + " PROJECT_ID" + CSV_DELIMITER + " MAPPING_TO_CATALOGUE"
+ CSV_DELIMITER + "");
errorPrintWriter = new PrintWriter(errorBW);
errorPrintWriter.println("NB." + CSV_DELIMITER + " PROJECT_ID" + CSV_DELIMITER + " MAPPING_TO_CATALOGUE"
+ CSV_DELIMITER + " ERROR" + CSV_DELIMITER + "");
} catch (Exception e) {
e.printStackTrace();
}
System.out.println("Procedure starting at: "+getFormattedDateTime());
startTime = System.currentTimeMillis();
Integer totalProjects = null;
try {
ScopeProvider.instance.set(sourceScope);
SecurityTokenProvider.instance.set(sourceToken);
totalProjects = getTotalProjects(profileID);
} catch (Exception e) {
e.printStackTrace();
}
if (totalProjects == null) {
log.error("No document found!!!");
return;
}
log.info("Total projects are: " + totalProjects);
boolean documentFound = true;
boolean maxItemsReached = false;
int limit = 10;
int offset = 0;
int counter = 0;
try {
while (documentFound && !maxItemsReached) {
try {
/**
*
* ##### NB!!!! USING SOURCE SCOPE
*
*/
ScopeProvider.instance.set(sourceScope);
SecurityTokenProvider.instance.set(sourceToken);
List<Project> list = getListProjects(limit, offset);
log.info("limit {}, offset {}", limit, offset);
if (list.size() > 0) {
UseCaseDescriptor ucd = GeoportalClientCaller.useCaseDescriptors().getUCDForId(profileID);
for (int i = 0; i < list.size(); i++) {
counter++;
log.info("\n\nConuter is: " + counter);
if (MAX_ITEMS != null && counter > MAX_ITEMS) {
maxItemsReached = true;
log.info("\n###### MAX_ITEMS reached: " + maxItemsReached);
break;
}
Project theProject = list.get(i);
log.info("\n\nConverting the project {}", theProject.getId());
String toCatalogueJSON = "";
try {
toCatalogueJSON = mapToCatalogue(theProject, ucd, sourceScope, sourceToken);
/**
*
* ##### NB!!!! USING TARGET SCOPE
*
*/
String targetScope = "";
String targetToken = "";
if(targetScope==null || targetToken==null) {
throw new Exception("Check targetScope and/or targetToken!!!");
}
ScopeProvider.instance.set(targetScope);
SecurityTokenProvider.instance.set(targetToken);
log.info("\n publishOnCatalogue the PROJECT N. " + counter + " with id: "
+ theProject.getId());
publishOnCatalogue(theProject, toCatalogueJSON);
log.info("\n end publishOnCatalogue the PROJECT N. " + counter);
writeReport(counter + CSV_DELIMITER + " " + theProject.getId() + CSV_DELIMITER + "'"
+ toCatalogueJSON + "'" + CSV_DELIMITER);
log.info("\n###### sleeping " + counter);
Thread.sleep(3000);
} catch (Exception e) {
log.error("ERROR on publishing project with id: " + theProject.getId());
writeError(counter + CSV_DELIMITER + " " + theProject.getId() + CSV_DELIMITER + " '"
+ toCatalogueJSON + "'" + CSV_DELIMITER + " '" + e.getMessage() + "'"
+ CSV_DELIMITER);
}
}
} else {
documentFound = false;
}
offset = offset + limit;
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
documentFound = false;
}
}
} catch (Exception e) {
log.error("External error");
e.printStackTrace();
} finally {
if (reportPrintWriter != null)
reportPrintWriter.close();
if (errorPrintWriter != null)
errorPrintWriter.close();
System.out.println("\n\nFINISHED!!!");
System.out.println("Procedure terimated at: "+getFormattedDateTime());
long millis = System.currentTimeMillis()-startTime;
long minutes = TimeUnit.MILLISECONDS.toMinutes(millis);
System.out.println("Done! In ms: "+(millis) + ", minutes: "+minutes);
}
}
/**
* Publish on catalogue.
*
* @param theProject the the project
* @param toCatalogueJSON the to catalogue JSON
* @throws Exception the exception
*/
public static void publishOnCatalogue(Project theProject, String toCatalogueJSON) throws Exception {
new GCatCaller().createOrUpdateTheDatasetOnCatalogue(theProject.getId(), toCatalogueJSON);
}
/**
* Map to catalogue.
*
* @param theProject the the project
* @param ucd the ucd
* @param sourceScope the source scope
* @param sourceToken the source token
* @return the string
* @throws TemplateException the template exception
* @throws IOException Signals that an I/O exception has occurred.
*/
public static String mapToCatalogue(Project theProject, UseCaseDescriptor ucd, String sourceScope,
String sourceToken) throws TemplateException, IOException {
log.info("\n\nMapping the PROJECT with id: " + theProject.getId());
ScopeProvider.instance.set(sourceScope);
SecurityTokenProvider.instance.set(sourceToken);
Template fmTemplate = getLocalFreemarkerTemplate();
String toCatalogueJSON = MappingToCatalogue.apply(fmTemplate, theProject, ucd, sourceScope);
log.trace("mapping is: " + toCatalogueJSON);
return toCatalogueJSON;
}
/**
* Gets the list projects.
*
* @return the list projects
* @throws Exception the exception
*/
public static List<Project> getListProjects() throws Exception {
ProjectsCaller clientProjects = GeoportalClientCaller.projects();
return clientProjects.getListForProfileID(profileID);
}
/**
* Gets the list projects.
*
* @param limit the limit
* @param offset the offset
* @return the list projects
* @throws Exception the exception
*/
public static List<Project> getListProjects(int limit, int offset) throws Exception {
ProjectsCaller clientProjects = GeoportalClientCaller.projects();
SearchingFilter filter = new SearchingFilter();
filter.setOrder(ORDER.DESC);
List<ItemFieldDV> orederByFields = new ArrayList<ItemFieldDV>();
// Order By
ItemFieldDV fieldUpdated = new ItemFieldDV("Updated", Arrays.asList("_info._lastEditInfo._instant"), "$or",
true, true, true);
orederByFields.add(fieldUpdated);
// Where Conditions
List<WhereClause> conditions = new ArrayList<WhereClause>();
Map<String, Object> searchInto = new HashMap<String, Object>();
searchInto.put("_lifecycleInformation._phase", "Published");
conditions.add(new WhereClause(LOGICAL_OP.OR, searchInto));
filter.setConditions(conditions);
filter.setOrderByFields(orederByFields);
Iterator<Project> iterator = clientProjects.queryOnMongo(profileID, 300, offset, limit, filter);
List<Project> listP = new ArrayList<Project>();
while (iterator.hasNext()) {
listP.add(iterator.next());
}
return listP;
}
/**
* Gets the total projects.
*
* @param profileID the profile ID
* @return the total projects
* @throws Exception the exception
*/
public static Integer getTotalProjects(String profileID) throws Exception {
System.out.println("getTotalDocument called for profileID: " + profileID);
ProjectsCaller clientProjects = GeoportalClientCaller.projects();
Projects<Project> client = (Projects<Project>) clientProjects.getClient(profileID);
org.gcube.application.geoportal.common.model.configuration.Configuration config = client.getConfiguration();
List<Archive> listArchives = config.getArchives();
for (Archive archive : listArchives) {
String theType = archive.getString("_type");
if (theType.equalsIgnoreCase(ProjectsCaller.DOCUMENT_STORE_COLLECTION)) {
String totalDocumentAre = archive.get("count").toString();
int total = Integer.parseInt(totalDocumentAre);
log.info("total docs for profileID: {}, are: {}", profileID, total);
return total;
}
}
return null;
}
/**
* Fmt json util.
*
* @param json the json
* @return the map
* @throws JsonParseException the json parse exception
* @throws JsonMappingException the json mapping exception
* @throws IOException Signals that an I/O exception has occurred.
*/
public static Map<String, Object> fmtJsonUtil(String json)
throws JsonParseException, JsonMappingException, IOException {
ObjectMapper OBJECT_MAPPER = new ObjectMapper();
return OBJECT_MAPPER.readValue(json, new TypeReference<HashMap<String, Object>>() {
});
}
/**
* Gets the local freemarker template.
*
* @return the local freemarker template
* @throws IOException Signals that an I/O exception has occurred.
*/
public static Template getLocalFreemarkerTemplate() throws IOException {
// Create your Configuration instance, and specify if up to what FreeMarker
// version (here 2.3.32) do you want to apply the fixes that are not 100%
// backward-compatible. See the Configuration JavaDoc for details.
Configuration cfg = new Configuration(Configuration.VERSION_2_3_32);
System.out.println("Working Directory = " + System.getProperty("user.dir"));
// Specify the source where the template files come from. Here I set a
// plain directory for it, but non-file-system sources are possible too:
cfg.setDirectoryForTemplateLoading(
new File(System.getProperty("user.dir") + "/src/test/java/geoportal_to_catalogue"));
// Set the preferred charset template files are stored in. UTF-8 is
// a good choice in most applications:
cfg.setDefaultEncoding("UTF-8");
Template template = cfg.getTemplate("d4gna_to_catalogue_template.ftl");
return template;
}
/**
* Pretty print using gson.
*
* @param uglyJson the ugly json
* @return the string
*/
public static String prettyPrintUsingGson(String uglyJson) {
Gson gson = new GsonBuilder().setPrettyPrinting().create();
JsonElement jsonElement = new JsonParser().parse(uglyJson);
String prettyJsonString = gson.toJson(jsonElement);
return prettyJsonString;
}
/**
* Write report.
*
* @param newline the newline
*/
private static synchronized void writeReport(String newline) {
reportPrintWriter.println(newline);
reportPrintWriter.flush();
}
/**
* Write error.
*
* @param newline the newline
*/
private static synchronized void writeError(String newline) {
errorPrintWriter.println(newline);
errorPrintWriter.flush();
}
/**
* Gets the formatted date time.
*
* @return the formatted date time
*/
public static String getFormattedDateTime(){
long yourmilliseconds = System.currentTimeMillis();
SimpleDateFormat sdf = new SimpleDateFormat("MMM dd,yyyy HH:mm:ss");
Date resultdate = new Date(yourmilliseconds);
return sdf.format(resultdate);
}
/*
* public static void main(String[] args) {
*
* try {
*
* TestContextConfig.readContextSettings();
*
* ScopeProvider.instance.set(TestContextConfig.CONTEXT);
* SecurityTokenProvider.instance.set(TestContextConfig.TOKEN);
*
* ProjectsCaller clientProjects = GeoportalClientCaller.projects(); Project
* theProject = clientProjects.getProjectByID(profileID, projectID); Document
* asDocument = SerializationUtil.asDocument(theProject);
*
* UseCaseDescriptor ucd =
* GeoportalClientCaller.useCaseDescriptors().getUCDForId(profileID);
*
* System.out.println("Source JSON:");
* System.out.println(prettyPrintUsingGson(asDocument.toJson()));
* applyMappingToCatalogue(theProject, ucd);
*
* } catch (Exception e) { // TODO: handle exception }
*
* }
*/
}

33
catalogue-binding-plugin/src/test/java/geoportal_to_catalogue/JSONObjectOrdered.java Normal file
View File

@ -0,0 +1,33 @@
package geoportal_to_catalogue;
import java.lang.reflect.Field;
import java.util.LinkedHashMap;
import org.json.JSONObject;
/**
* The Class JSONObjecOrdered.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Mar 10, 2022
*/
public final class JSONObjectOrdered {
/**
* Instance.
*
* @return the JSON object
*/
public static JSONObject instance() {
JSONObject jsonObject = new JSONObject();
try {
Field changeMap = jsonObject.getClass().getDeclaredField("map");
changeMap.setAccessible(true);
changeMap.set(jsonObject, new LinkedHashMap<>());
changeMap.setAccessible(false);
} catch (IllegalAccessException | NoSuchFieldException e) {
}
return jsonObject;
}
}

350
catalogue-binding-plugin/src/test/java/geoportal_to_catalogue/d4gna_to_catalogue_template.ftl Normal file
View File

@ -0,0 +1,350 @@
<#assign jsonProj=doc>
<#assign theDocument=jsonProj._theDocument>
<#assign resources=[]>
<#assign groups=[]>
<#assign tags=[]>
<#assign extras=[]>
<#function sanitizeString(value)>
<#if value??>
<#return value?trim?replace('\n','')?replace('\"','')>
</#if>
<#return "">
</#function>
<#function onlyAlphanumericString(value)>
<#if value??>
<#return value?trim?replace('\n','')?replace('\"','')?replace("[^\\w]+", "-", "r")>
</#if>
<#return "">
</#function>
<#-- Macro to assign Tags -->
<#macro assignTag in_tags>
<#if in_tags??>
<#if in_tags?is_sequence>
<#list in_tags as my_tag>
<#assign tags = tags + [onlyAlphanumericString(my_tag)] />
</#list>
<#else>
<#assign tags = tags + [onlyAlphanumericString(in_tags)] />
</#if>
</#if>
</#macro>
<#-- Macro to assign a Resource -->
<#macro assignResource name url description format>
<#if description??>
<#else>
<#assign description = ""/>
</#if>
<#if url??>
<#assign resource = {"name": name, "url": url, "description": sanitizeString(description), "format": format}>
<#assign resources = resources + [resource]/>
</#if>
</#macro>
<#-- Macro to assign Groups -->
<#macro assignGroup in_groups>
<#if in_groups??>
<#if in_groups?is_sequence>
<#list in_groups as my_group>
<#assign groups = groups + [my_group] />
</#list>
<#else>
<#assign groups = groups + [in_groups] />
</#if>
</#if>
</#macro>
<#-- Macro to assign Extras field -->
<#macro assignExtraField key value asObject>
<#if key??>
<#assign checkedValue = value/>
<#if key != "spatial">
<#assign checkedValue = sanitizeString(value)/>
</#if>
<#assign extra = {"key": sanitizeString(key), "value": checkedValue, "asObject": asObject}>
<#assign extras = extras + [extra]/>
</#if>
</#macro>
<#-- Macro to build the tags as [{},{},..{}] -->
<#macro buildTags the_tags>
<#if the_tags??>
"tags": [
<#list the_tags as tag>
{
"name": "${tag}"
}
<#if tag?is_last==false>,</#if>
</#list>
],
</#if>
</#macro>
<#-- Macro to build the groups as [{},{},..{}] -->
<#macro buildGroups the_groups>
<#if the_groups??>
"groups": [
<#list the_groups as the_group>
{
"name": "${the_group}"
}
<#if the_group?is_last==false>,</#if>
</#list>
],
</#if>
</#macro>
<#-- Macro to build the resources as [{},{},..{}] -->
<#macro buildResources the_resources>
<#if the_resources??>
"resources": [
<#list the_resources as resource>
{
"name": "${resource.name}",
"url": "${resource.url}",
"description": "${resource.description}",
"format": "${resource.format}"
}
<#if resource?is_last==false>,</#if>
</#list>
],
</#if>
</#macro>
<#-- Macro to build the extras as [{},{},..{}] -->
<#macro buildExtrasFields the_extras>
<#if the_extras??>
"extras": [
<#list the_extras as extra>
<#if extra.asObject?? && extra.asObject>
{
"key": "${extra.key}",
"value": ${extra.value}
}
<#else>
{
"key": "${extra.key}",
"value": "${extra.value}"
}
</#if>
<#if extra?is_last==false>,</#if>
</#list>
]
</#if>
</#macro>
<#--
############################################################
#
#
# Starting document mapping to Catalogue
#
#
############################################################
-->
<#compress>
{
"name": "${jsonProj._id}",
"title": "${sanitizeString(theDocument.nome)}",
"license_id": "CC-BY-SA-4.0",
"private": false,
<#assign sanitizedNotes = sanitizeString(theDocument.introduzione) />
"notes": "${sanitizedNotes}",
<#--
######################
RESOURCES
######################
-->
<#-- Mapping "Relazione Scavo" as resource -->
<#if theDocument.relazioneScavo?? && theDocument.relazioneScavo.fileset?? && theDocument.relazioneScavo.fileset._payloads??>
<#assign payloads = theDocument.relazioneScavo.fileset._payloads>
<#if payloads?size!=0>
<#-- Getting the first payload -->
<#assign payload = payloads[0]>
<@assignResource name=payload._name url=payload._link description=theDocument.relazioneScavo.titolo format=payload._mimetype></@assignResource>
</#if>
</#if>
<#-- Mapping "Immagine Rappresentative" as resource -->
<#if theDocument.immaginiRappresentative??>
<#if theDocument.immaginiRappresentative?is_sequence && theDocument.immaginiRappresentative?size gt 0>
<#list theDocument.immaginiRappresentative as the_image>
<#if the_image.fileset?? && the_image.fileset._payloads??>
<#assign payloads = the_image.fileset._payloads>
<#if payloads?size!=0>
<#-- Getting the first payload -->
<#assign payload = payloads[0]>
<@assignResource name=payload._name url=payload._link description=the_image.didascalia format=payload._mimetype></@assignResource>
</#if>
</#if>
</#list>
</#if>
<#assign payloads = theDocument.immaginiRappresentative[0].fileset._payloads>
<#if payloads?size!=0>
<#-- Getting the first payload -->
<#assign payload = payloads[0]>
<@assignResource name=payload._name url=payload._link description=theDocument.immaginiRappresentative[0].didascalia format=payload._mimetype></@assignResource>
</#if>
</#if>
<#-- Building Resources -->
<@buildResources the_resources=resources></@buildResources>
<#--
######################
TAGS
######################
-->
<#-- Mapping "paroleChiaveLibere" as tag -->
<#if theDocument.paroleChiaveLibere??>
<@assignTag in_tags=theDocument.paroleChiaveLibere></@assignTag>
</#if>
<#-- Building tags -->
<@buildTags the_tags=tags></@buildTags>
<#--
######################
GROUPS
######################
-->
<#-- Mapping the year of the "dataInizioProgetto" as group -->
<#assign dateString = theDocument.dataInizioProgetto?trim>
<#assign dataInizioYear = dateString?split("-")[0]>
<#-- <@assignGroup in_groups=dataInizioYear></@assignGroup> -->
<#-- Building groups -->
<@buildGroups the_groups=groups></@buildGroups>
<#--
######################
EXTRAS
######################
-->
<#-- Mapping extras fields -->
<#if theDocument.contributore??>
<@assignExtraField key="Contributore" value=theDocument.contributore asObject=false></@assignExtraField>
</#if>
<#if theDocument.responsabile??>
<@assignExtraField key="Responsabile dei contenuti" value=theDocument.responsabile asObject=false></@assignExtraField>
</#if>
<#if theDocument.editore??>
<@assignExtraField key="Ente responsabile del progetto" value=theDocument.editore asObject=false></@assignExtraField>
</#if>
<#if theDocument.ufficioMic??>
<@assignExtraField key="Ufficio MiC competente per territorio" value=theDocument.ufficioMic asObject=false></@assignExtraField>
</#if>
<#if theDocument.funzionarioResponsabile??>
<@assignExtraField key="Funzionario Responsabile" value=theDocument.funzionarioResponsabile asObject=false></@assignExtraField>
</#if>
<#if theDocument.fontiFinanziamento??>
<#if theDocument.fontiFinanziamento?is_sequence>
<#list theDocument.fontiFinanziamento as my_extra>
<@assignExtraField key="Fonte del finanziamento" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Fonte del finanziamento" value=theDocument.fontiFinanziamento asObject=false></@assignExtraField>
</#if>
</#if>
<#if theDocument.risorseCorrelate??>
<#if theDocument.risorseCorrelate?is_sequence>
<#list theDocument.risorseCorrelate as my_extra>
<@assignExtraField key="Risorse Correlate" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Risorse Correlate" value=theDocument.risorseCorrelate asObject=false></@assignExtraField>
</#if>
</#if>
<#if theDocument.dataInizioProgetto??>
<@assignExtraField key="Data inizio Campagna" value=theDocument.dataInizioProgetto?trim asObject=false></@assignExtraField>
</#if>
<#if theDocument.dataFineProgetto??>
<@assignExtraField key="Data fine Campagna" value=theDocument.dataFineProgetto?trim asObject=false></@assignExtraField>
</#if>
<#if theDocument.modalitaIndividuazione??>
<#if theDocument.modalitaIndividuazione?is_sequence>
<#list theDocument.modalitaIndividuazione as my_extra>
<@assignExtraField key="Modalità di individuazione" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Modalità di individuazione" value=theDocument.modalitaIndividuazione asObject=false></@assignExtraField>
</#if>
</#if>
<#if theDocument.contestoIndagine??>
<#if theDocument.contestoIndagine?is_sequence>
<#list theDocument.contestoIndagine as my_extra>
<@assignExtraField key="Contesto Indagine" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Contesto Indagine" value=theDocument.contestoIndagine asObject=false></@assignExtraField>
</#if>
</#if>
<#if theDocument.statoAttuale??>
<@assignExtraField key="Stato attuale" value=theDocument.statoAttuale asObject=false></@assignExtraField>
</#if>
<#if theDocument.accessibilita??>
<@assignExtraField key="Accessibilità" value=theDocument.accessibilita asObject=false></@assignExtraField>
</#if>
<#if theDocument.cronologiaMacrofase??>
<#if theDocument.cronologiaMacrofase?is_sequence>
<#list theDocument.cronologiaMacrofase as my_extra>
<@assignExtraField key="Cronologia Macrofase" value=my_extra asObject=false></@assignExtraField>
</#list>
<#else>
<@assignExtraField key="Cronologia Macrofase" value=theDocument.cronologiaMacrofase asObject=false></@assignExtraField>
</#if>
</#if>
<#-- spatial field -->
<#if jsonProj._identificationReferences?? && jsonProj._identificationReferences?size!=0 && jsonProj._identificationReferences[0].geoJSON??>
<#assign geoJSON = jsonProj._identificationReferences[0].geoJSON>
<#-- if coordinates exists, managing it as a Point -->
<#if geoJSON.coordinates?? && geoJSON.coordinates?is_sequence && geoJSON.coordinates?size gt 2>
<#assign point_Coordinates = [geoJSON.coordinates[0], geoJSON.coordinates[1]]>
<#assign spatialField = '{\\"type\\": \\"${geoJSON.type}\\", \\"coordinates\\": [${point_Coordinates?join(", ")}]}'>
<@assignExtraField key="spatial" value=spatialField asObject=false></@assignExtraField>
</#if>
</#if>
<#-- Adding extra field "Anno" to add it as group -->
<@assignExtraField key="Anno" value=dataInizioYear asObject=false></@assignExtraField>
<@buildExtrasFields the_extras=extras></@buildExtrasFields>
}
</#compress>

296
catalogue-binding-plugin/src/test/java/junit/CatalogueBindingPluginTest.java Normal file
View File

@ -0,0 +1,296 @@
package junit;
import org.gcube.application.cms.cataloguebinding.CatalogueBindingPlugin;
import org.gcube.application.cms.cataloguebinding.config.CatalogueBindingPluginConfigModel;
import org.gcube.application.cms.implementations.utils.UserUtils;
import org.gcube.application.cms.plugins.events.EventManager;
import org.gcube.application.cms.plugins.events.EventManager.Event;
import org.gcube.application.cms.plugins.events.ItemObserved;
import org.gcube.application.cms.plugins.faults.InitializationException;
import org.gcube.application.cms.tests.TestProfiles;
import org.gcube.application.cms.tests.plugins.BasicPluginTest;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.AccountingInfo;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.document.lifecycle.LifecycleInformation;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import org.gcube.application.geoportal.common.utils.tests.GCubeTest;
import org.gcube.application.geoportalcommon.geoportal.GeoportalClientCaller;
import org.gcube.application.geoportalcommon.geoportal.ProjectsCaller;
import org.gcube.common.authorization.library.provider.SecurityTokenProvider;
import org.gcube.common.scope.api.ScopeProvider;
import org.junit.Test;
import test.TestContextConfig;
/**
* The Class CatalogueBindingPluginTest.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Jun 20, 2024
*/
public class CatalogueBindingPluginTest extends BasicPluginTest {
public final static String profileID = "profiledConcessioni";
public final static String projectID = "661d2c6f8804530afb90b132";
/**
* Check plugin.
*/
// @Test
public void checkPlugin() {
org.junit.Assume.assumeTrue(GCubeTest.isTestInfrastructureEnabled());
CatalogueBindingPlugin plugin = (CatalogueBindingPlugin) plugins.get(CatalogueBindingPlugin.DESCRIPTOR.getId());
//
// try {
// plugin.init();
// } catch (InitializationException e1) {
// e1.printStackTrace();
// }
// try {
// plugin.initInContext();
// } catch (InitializationException e1) {
// e1.printStackTrace();
// }
System.out.println("Plugin check: " + plugin);
}
/**
* Check plugin config.
*/
//@Test
public void checkPluginConfig() {
org.junit.Assume.assumeTrue(GCubeTest.isTestInfrastructureEnabled());
CatalogueBindingPlugin plugin = (CatalogueBindingPlugin) plugins.get(CatalogueBindingPlugin.DESCRIPTOR.getId());
UseCaseDescriptor descriptor = TestProfiles.profiles.get(profileID);
try {
plugin.init();
} catch (InitializationException e1) {
e1.printStackTrace();
}
try {
plugin.initInContext();
} catch (InitializationException e1) {
e1.printStackTrace();
}
try {
CatalogueBindingPluginConfigModel pluginBindingModel = plugin
.readEventsSubscribedFromConfigurationInTheUCD(descriptor);
System.out.println("CatalogueBindingPluginConfigModel: " + pluginBindingModel);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* Check notify APPROV E SUBMITTE D on catalogue.
*/
@Test
public void checkNotify_APPROVE_SUBMITTED_onCatalogue() {
org.junit.Assume.assumeTrue(GCubeTest.isTestInfrastructureEnabled());
CatalogueBindingPlugin plugin = (CatalogueBindingPlugin) plugins.get(CatalogueBindingPlugin.DESCRIPTOR.getId());
UseCaseDescriptor descriptor = TestProfiles.profiles.get(profileID);
CatalogueBindingPluginConfigModel pluginBindingModel;
try {
pluginBindingModel = plugin.readEventsSubscribedFromConfigurationInTheUCD(descriptor);
System.out.println("Events: " + pluginBindingModel);
} catch (Exception e) {
e.printStackTrace();
}
ItemObserved<Project> item;
try {
EventManager.Event event = Event.LIFECYCLE_STEP_PERFORMED;
item = mockItemObserverd(event);
// Setting creator
User creator = new User();
creator.setUsername("francesco.mangiacrapa");
item.getProject().getInfo().getCreationInfo().setUser(creator);
LifecycleInformation lifecycleInfo = item.getProject().getLifecycleInformation();
// test PUBLISH ON CATALOGUE
lifecycleInfo.setPhase("Published");
lifecycleInfo.setLastInvokedStep("APPROVE-SUBMITTED");
System.out.println("By notifying event " + event + " project " + item.getProjectId());
EventManager.getInstance().notify(event, item);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* Check notify UNPUBLIS H on catalogue.
*/
@Test
public void checkNotify_UNPUBLISH_onCatalogue() {
org.junit.Assume.assumeTrue(GCubeTest.isTestInfrastructureEnabled());
CatalogueBindingPlugin plugin = (CatalogueBindingPlugin) plugins.get(CatalogueBindingPlugin.DESCRIPTOR.getId());
UseCaseDescriptor descriptor = TestProfiles.profiles.get(profileID);
CatalogueBindingPluginConfigModel pluginBindingModel;
try {
pluginBindingModel = plugin.readEventsSubscribedFromConfigurationInTheUCD(descriptor);
System.out.println("Events: " + pluginBindingModel);
} catch (Exception e) {
e.printStackTrace();
}
ItemObserved<Project> item;
try {
EventManager.Event event = Event.LIFECYCLE_STEP_PERFORMED;
item = mockItemObserverd(event);
// Setting creator
User creator = new User();
creator.setUsername("francesco.mangiacrapa");
item.getProject().getInfo().getCreationInfo().setUser(creator);
LifecycleInformation lifecycleInfo = item.getProject().getLifecycleInformation();
// Test delete the dataset on CATALOGUE
lifecycleInfo.setPhase("DRAFT");
lifecycleInfo.setLastInvokedStep("UNPUBLISH");
System.out.println("By notifying event " + event + " project " + item.getProjectId());
EventManager.getInstance().notify(event, item);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* Check notify PROJEC T CREATE D on catalogue.
*/
// @Test
public void checkNotify_PROJECT_CREATED_onCatalogue() {
org.junit.Assume.assumeTrue(GCubeTest.isTestInfrastructureEnabled());
CatalogueBindingPlugin plugin = (CatalogueBindingPlugin) plugins.get(CatalogueBindingPlugin.DESCRIPTOR.getId());
UseCaseDescriptor descriptor = TestProfiles.profiles.get(profileID);
CatalogueBindingPluginConfigModel pluginBindingModel;
try {
pluginBindingModel = plugin.readEventsSubscribedFromConfigurationInTheUCD(descriptor);
System.out.println("Events: " + pluginBindingModel);
} catch (Exception e) {
e.printStackTrace();
}
ItemObserved<Project> item;
try {
EventManager.Event event = Event.PROJECT_CREATED;
item = mockItemObserverd(event);
// Setting creator
User creator = new User();
creator.setUsername("francesco.mangiacrapa");
item.getProject().getInfo().getCreationInfo().setUser(creator);
LifecycleInformation lifecycleInfo = item.getProject().getLifecycleInformation();
// Test delete the dataset on CATALOGUE
lifecycleInfo.setPhase("DRAFT");
System.out.println("By notifying event " + event + " project " + item.getProjectId());
EventManager.getInstance().notify(event, item);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* Check notify PROJEC T DELETE D on catalogue.
*/
//@Test
public void checkNotify_PROJECT_DELETED_onCatalogue() {
org.junit.Assume.assumeTrue(GCubeTest.isTestInfrastructureEnabled());
CatalogueBindingPlugin plugin = (CatalogueBindingPlugin) plugins.get(CatalogueBindingPlugin.DESCRIPTOR.getId());
UseCaseDescriptor descriptor = TestProfiles.profiles.get(profileID);
CatalogueBindingPluginConfigModel pluginBindingModel;
try {
pluginBindingModel = plugin.readEventsSubscribedFromConfigurationInTheUCD(descriptor);
System.out.println("Events: " + pluginBindingModel);
} catch (Exception e) {
e.printStackTrace();
}
ItemObserved<Project> item;
try {
EventManager.Event event = Event.PROJECT_DELETED;
item = mockItemObserverd(event);
// Setting creator
User creator = new User();
creator.setUsername("francesco.mangiacrapa");
item.getProject().getInfo().getCreationInfo().setUser(creator);
LifecycleInformation lifecycleInfo = item.getProject().getLifecycleInformation();
// Test delete the dataset on CATALOGUE
lifecycleInfo.setPhase("DRAFT");
System.out.println("By notifying event " + event + " project " + item.getProjectId());
EventManager.getInstance().notify(event, item);
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
}
/**
* Mock item observerd.
*
* @param event the event
* @return the item observed
* @throws Exception the exception
*/
private static ItemObserved<Project> mockItemObserverd(EventManager.Event event) throws Exception {
UseCaseDescriptor descriptor = TestProfiles.profiles.get(profileID);
// notifying the Event.PROJECT_CREATED;
ItemObserved<Project> item = new ItemObserved<Project>();
AccountingInfo user = UserUtils.getCurrent().asInfo();
// System.out.println(user.getUser());
// sysOut(user);
System.out.println("User is: " + user.getUser());
System.out.println("Context is: " + user.getContext());
item.setUserCaller(user.getUser());
item.setContext(user.getContext());
item.setEvent(event);
item.setUseCaseDescriptor(descriptor);
TestContextConfig.readContextSettings();
ScopeProvider.instance.set(TestContextConfig.CONTEXT);
SecurityTokenProvider.instance.set(TestContextConfig.TOKEN);
ProjectsCaller clientProjects = GeoportalClientCaller.projects();
Project theProject = clientProjects.getProjectByID(profileID, projectID);
item.setProject(theProject);
return item;
}
}

41
catalogue-binding-plugin/src/test/java/test/TestContextConfig.java Normal file
View File

@ -0,0 +1,41 @@
package test;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
public class TestContextConfig {
private static final String GCUBE_CONFIG_PROPERTIES_FILENAME = "gcube_config.properties";
// APP Working Directory + /src/test/resources must be the location of
// gcube_config.properties
private static String gcube_config_path = String.format("%s/%s",
System.getProperty("user.dir") + "/src/test/resources", GCUBE_CONFIG_PROPERTIES_FILENAME);
public static String CONTEXT;
public static String TOKEN;
/**
* Read context settings.
*/
public static void readContextSettings() {
try (InputStream input = new FileInputStream(gcube_config_path)) {
Properties prop = new Properties();
// load a properties file
prop.load(input);
CONTEXT = prop.getProperty("CONTEXT");
TOKEN = prop.getProperty("TOKEN");
// get the property value and print it out
System.out.println("CONTEXT: " + CONTEXT);
System.out.println("TOKEN: " + TOKEN);
} catch (IOException ex) {
ex.printStackTrace();
}
}
}

2
catalogue-binding-plugin/src/test/resources/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
/tokens.properties
/resources/

5
cms-plugin-framework/CHANGELOG.md
View File

@ -1,6 +1,11 @@
# Changelog for org.gcube.application.cms-plugin-framework
## [v1.0.5-SNAPSHOT] - 2023-12-21
- Implemented Event Broker [#26321]
## [v1.0.4] - 2023-09-06
- Using parent range version [#25572]
## [v1.0.3] - 2023-01-10

3
cms-plugin-framework/README.md
View File

@ -6,6 +6,9 @@ Basic and abstract implementations are provided in different module default-lc-m
Basic providers (e.g. WSProvider, ISProvider) used both in test and by the service are implemented here for simplicity.
Morover, this module provides an `EventManager` to notify the events {`PROJECT_CREATED`, `PROJECT_UPDATED`, `PROJECT_DELETED` `LIFECYCLE_STEP_PERFORMED`}
to the plugins that subscribe to them.
## Built with
* [gCube SDI] (https://gcube.wiki.gcube-system.org/gcube/) - The gCube SDI
* [gCube SmartGears] (https://gcube.wiki.gcube-system.org/gcube/SmartGears) - The gCube SmartGears framework

4
cms-plugin-framework/pom.xml
View File

@ -4,7 +4,7 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>cms-plugin-framework</artifactId>
<version>1.0.4</version>
<version>1.0.5-SNAPSHOT</version>
<parent>
<groupId>org.gcube.application.cms</groupId>
@ -70,7 +70,7 @@
<dependency>
<groupId>org.gcube.common</groupId>
<artifactId>authorization-utils</artifactId>
<version>[2.0.0, 3.0.0-SNAPSHOT)</version>
<version>${authorization-utils-range}</version>
</dependency>
<dependency>

6
cms-plugin-framework/src/main/java/org/gcube/application/cms/caches/AbstractScopedMap.java
View File

@ -1,10 +1,10 @@
package org.gcube.application.cms.caches;
import org.gcube.application.cms.implementations.utils.UserUtils;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import lombok.NonNull;
import lombok.extern.slf4j.Slf4j;
import org.gcube.application.cms.implementations.utils.UserUtils;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import org.gcube.application.geoportal.common.utils.ContextUtils;
@Slf4j
/**

4
cms-plugin-framework/src/main/java/org/gcube/application/cms/caches/TTLObject.java
View File

@ -1,11 +1,11 @@
package org.gcube.application.cms.caches;
import java.time.LocalDateTime;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.ToString;
import java.time.LocalDateTime;
@Getter
@ToString
@AllArgsConstructor

11
cms-plugin-framework/src/main/java/org/gcube/application/cms/caches/TimedMap.java
View File

@ -1,15 +1,16 @@
package org.gcube.application.cms.caches;
import java.time.LocalDateTime;
import java.time.temporal.TemporalAmount;
import java.util.concurrent.ConcurrentHashMap;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import lombok.Getter;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import java.time.LocalDateTime;
import java.time.temporal.TemporalAmount;
import java.util.concurrent.ConcurrentHashMap;
@Slf4j
@RequiredArgsConstructor

4
cms-plugin-framework/src/main/java/org/gcube/application/cms/implementations/DefaultISProvider.java
View File

@ -1,5 +1,7 @@
package org.gcube.application.cms.implementations;
import java.util.List;
import org.gcube.application.cms.caches.Engine;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import org.gcube.application.geoportal.common.model.rest.DatabaseConnection;
@ -7,8 +9,6 @@ import org.gcube.application.geoportal.common.utils.ISUtils;
import org.gcube.common.resources.gcore.GenericResource;
import org.gcube.common.resources.gcore.ServiceEndpoint;
import java.util.List;
public class DefaultISProvider implements ISInterface, Engine<ISInterface> {

4
cms-plugin-framework/src/main/java/org/gcube/application/cms/implementations/ISInterface.java
View File

@ -1,12 +1,12 @@
package org.gcube.application.cms.implementations;
import java.util.List;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import org.gcube.application.geoportal.common.model.rest.DatabaseConnection;
import org.gcube.common.resources.gcore.GenericResource;
import org.gcube.common.resources.gcore.ServiceEndpoint;
import java.util.List;
public interface ISInterface {
public DatabaseConnection queryForDatabase(String category, String platform,String flagName, String flagValue) throws ConfigurationException;

13
cms-plugin-framework/src/main/java/org/gcube/application/cms/implementations/ImplementationProvider.java
View File

@ -1,17 +1,18 @@
package org.gcube.application.cms.implementations;
import lombok.Synchronized;
import lombok.extern.slf4j.Slf4j;
import org.gcube.application.cms.caches.Engine;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import org.gcube.common.storagehub.client.dsl.StorageHubClient;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import org.gcube.application.cms.caches.Engine;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import org.gcube.common.storagehub.client.dsl.StorageHubClient;
import lombok.Synchronized;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class ImplementationProvider {

4
cms-plugin-framework/src/main/java/org/gcube/application/cms/implementations/ProjectAccess.java
View File

@ -1,5 +1,7 @@
package org.gcube.application.cms.implementations;
import java.util.List;
import org.bson.Document;
import org.gcube.application.cms.implementations.faults.InvalidUserRoleException;
import org.gcube.application.cms.implementations.faults.ProjectNotFoundException;
@ -10,8 +12,6 @@ import org.gcube.application.geoportal.common.model.document.relationships.Relat
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import org.gcube.application.geoportal.common.model.rest.QueryRequest;
import java.util.List;
public interface ProjectAccess {

12
cms-plugin-framework/src/main/java/org/gcube/application/cms/implementations/WorkspaceManager.java
View File

@ -1,7 +1,7 @@
package org.gcube.application.cms.implementations;
import lombok.*;
import lombok.extern.slf4j.Slf4j;
import java.io.InputStream;
import org.gcube.application.geoportal.common.model.configuration.Archive;
import org.gcube.application.geoportal.common.model.document.filesets.RegisteredFile;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
@ -11,7 +11,13 @@ import org.gcube.common.storagehub.client.dsl.FolderContainer;
import org.gcube.common.storagehub.client.dsl.StorageHubClient;
import org.gcube.common.storagehub.model.exceptions.StorageHubException;
import java.io.InputStream;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.Synchronized;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class WorkspaceManager {

17
cms-plugin-framework/src/main/java/org/gcube/application/cms/implementations/utils/UserUtils.java
View File

@ -1,8 +1,11 @@
package org.gcube.application.cms.implementations.utils;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import org.gcube.application.geoportal.common.model.document.accounting.AccountingInfo;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
@ -11,11 +14,9 @@ import org.gcube.common.authorization.library.provider.SecurityTokenProvider;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class UserUtils {

10
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/EventListenerPluginInterface.java Normal file
View File

@ -0,0 +1,10 @@
package org.gcube.application.cms.plugins;
import org.gcube.application.cms.plugins.events.ItemObserved;
import org.gcube.application.geoportal.common.model.document.Project;
public interface EventListenerPluginInterface extends InitializablePlugin {
public void doAction(ItemObserved<Project> itemObserved);
}

6
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/LifecycleManager.java
View File

@ -1,6 +1,10 @@
package org.gcube.application.cms.plugins;
import org.gcube.application.cms.plugins.faults.*;
import org.gcube.application.cms.plugins.faults.EventException;
import org.gcube.application.cms.plugins.faults.InsufficientPrivileges;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.cms.plugins.faults.InvalidProfileException;
import org.gcube.application.cms.plugins.faults.StepException;
import org.gcube.application.cms.plugins.reports.EventExecutionReport;
import org.gcube.application.cms.plugins.reports.StepExecutionReport;
import org.gcube.application.cms.plugins.requests.BaseRequest;

4
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/PluginManagerInterface.java
View File

@ -1,9 +1,9 @@
package org.gcube.application.cms.plugins;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import java.util.Map;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
public interface PluginManagerInterface {
public Plugin getById(String pluginID) throws ConfigurationException;

13
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/PluginsReflections.java
View File

@ -1,14 +1,15 @@
package org.gcube.application.cms.plugins;
import lombok.extern.slf4j.Slf4j;
import org.reflections.Reflections;
import org.reflections.util.ConfigurationBuilder;
import org.reflections.util.FilterBuilder;
import java.lang.reflect.Modifier;
import java.util.HashMap;
import java.util.Map;
import org.reflections.Reflections;
import org.reflections.util.ConfigurationBuilder;
import org.reflections.util.FilterBuilder;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class PluginsReflections {
@ -25,7 +26,7 @@ public class PluginsReflections {
.filterInputsBy(new FilterBuilder().includePackage("org.gcube.application.cms")));
reflections.getSubTypesOf(Plugin.class).iterator().forEachRemaining(pluginClass->{
log.trace("Evaluating class {}",pluginClass);
log.debug("Evaluating class {}",pluginClass);
if(!pluginClass.isInterface() && !Modifier.isAbstract(pluginClass.getModifiers())){
try {
log.debug("Found implementation {} ",pluginClass);

7
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/events/EventListener.java Normal file
View File

@ -0,0 +1,7 @@
package org.gcube.application.cms.plugins.events;
public interface EventListener<T extends ItemObservable> {
public void updated(T observerd);
}

132
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/events/EventManager.java Normal file
View File

@ -0,0 +1,132 @@
package org.gcube.application.cms.plugins.events;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import org.gcube.application.geoportal.common.model.document.Project;
/**
* The Class EventManager.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Dec 11, 2023
*/
public class EventManager implements EventManagerInterface<ItemObserved<Project>> {
private HashMap<Event, List<EventListener<ItemObserved<Project>>>> listeners = new HashMap<Event, List<EventListener<ItemObserved<Project>>>>();
/**
* The Class Event.
*
* @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
*
* Nov 29, 2023
*/
public static enum Event {
PROJECT_CREATED("PROJECT_CREATED"),
PROJECT_UPDATED("PROJECT_UPDATED"),
PROJECT_DELETED("PROJECT_DELETED"),
LIFECYCLE_STEP_PERFORMED("LIFECYCLE_STEP_PERFORMED");
String name;
/**
* Instantiates a new event.
*
* @param name the name
*/
Event(String name) {
this.name = name;
}
/**
* Gets the name.
*
* @return the name
*/
public String getName() {
return name;
}
}
// private instance, so that it can be
// accessed by only by getInstance() method
private static EventManager instance;
/**
* Instantiates a new event manager.
*/
private EventManager() {
// private constructor
}
/**
* Gets the single instance of EventManager.
*
* @return single instance of EventManager
*/
public static EventManager getInstance() {
if (instance == null) {
// synchronized block to remove overhead
synchronized (EventManager.class) {
if (instance == null) {
// if instance is null, initialize
instance = new EventManager();
}
}
}
return instance;
}
/**
* Subscribe.
*
* @param eventType the event type
* @param listener the listener
*/
public void subscribe(Event eventType, EventListener<ItemObserved<Project>> listener) {
List<EventListener<ItemObserved<Project>>> list = listeners.get(eventType);
if (list == null)
list = new ArrayList<EventListener<ItemObserved<Project>>>();
list.add(listener);
listeners.put(eventType, list);
}
/**
* Unsubscribe.
*
* @param eventType the event type
* @param listener the listener
*/
public void unsubscribe(Event eventType, EventListener<ItemObserved<Project>> listener) {
List<EventListener<ItemObserved<Project>>> list = listeners.get(eventType);
if (list == null)
return;
list.remove(listener);
listeners.put(eventType, list);
}
/**
* Notify.
*
* @param eventType the event type
* @param item the item
*/
public void notify(Event eventType, ItemObserved<Project> item) {
for (EventManager.Event event : listeners.keySet()) {
if (event.equals(eventType)) {
for (EventListener<ItemObserved<Project>> eventListner : listeners.get(eventType)) {
eventListner.updated(item);
}
}
}
}
}

13
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/events/EventManagerInterface.java Normal file
View File

@ -0,0 +1,13 @@
package org.gcube.application.cms.plugins.events;
import org.gcube.application.cms.plugins.events.EventManager.Event;
public interface EventManagerInterface<T extends ItemObservable> {
public void subscribe(Event eventType, EventListener<T> listener);
public void unsubscribe(Event eventType, EventListener<T> listener);
public void notify(Event eventType, T item);
}

9
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/events/ItemObservable.java Normal file
View File

@ -0,0 +1,9 @@
package org.gcube.application.cms.plugins.events;
public interface ItemObservable {
public String getProjectId();
public String getUCD_Id();
}

110
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/events/ItemObserved.java Normal file
View File

@ -0,0 +1,110 @@
package org.gcube.application.cms.plugins.events;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map.Entry;
import org.bson.Document;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Slf4j
public class ItemObserved<T extends Project> implements ItemObservable {
private User userCaller;
private Context context;
private UseCaseDescriptor useCaseDescriptor;
private T project;
private EventManager.Event event;
private Document optional;
public static enum OPTIONAL_FIELD {
message, preview_url
}
public String getProjectId() {
log.debug("Called getProjectId");
if (project == null)
return null;
return project.getId();
}
@Override
public String getUCD_Id() {
log.debug("Called getUCD_Id");
if (useCaseDescriptor == null)
return null;
return useCaseDescriptor.getId();
}
public LinkedHashMap<String, Object> getDocumentEntries(int limit) {
LinkedHashMap<String, Object> documentAsMap = new LinkedHashMap<>();
try {
Iterator<Entry<String, Object>> entrySetsIt = project.getTheDocument().entrySet().iterator();
int i = 0;
while (entrySetsIt.hasNext()) {
if (i + 1 > limit)
break;
Entry<String, Object> entry = entrySetsIt.next();
documentAsMap.put(entry.getKey(), entry.getValue() != null ? entry.getValue().toString() : null);
i++;
}
} catch (Exception e) {
throw e;
}
return documentAsMap;
}
public void setOptional(OPTIONAL_FIELD optionalField, String value) {
this.optional = new Document();
if (optional == null)
this.optional = new Document();
this.optional.put(optionalField.name(), value);
}
public String getOptionalValue(OPTIONAL_FIELD optionalField) {
if (this.optional != null) {
return this.optional.getString(optionalField.name());
}
return null;
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder();
builder.append("ItemObserved [userCaller=");
builder.append(userCaller);
builder.append(", context=");
builder.append(context);
builder.append(", useCaseDescriptor id=");
builder.append(useCaseDescriptor != null ? useCaseDescriptor.getId() : null);
builder.append(", project id=");
builder.append(project != null ? project.getId() : null);
builder.append(", event=");
builder.append(event);
builder.append(", optional=");
builder.append(optional);
builder.append("]");
return builder.toString();
}
}

20
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/model/ComparableVersion.java
View File

@ -1,5 +1,15 @@
package org.gcube.application.cms.plugins.model;
import java.math.BigInteger;
import java.util.ArrayDeque;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Deque;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Properties;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
@ -18,11 +28,11 @@ package org.gcube.application.cms.plugins.model;
* specific language governing permissions and limitations
* under the License.
*/
import lombok.*;
import java.math.BigInteger;
import java.util.*;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.ToString;
/**
* <p>

14
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/DocumentHandlingReport.java
View File

@ -1,9 +1,8 @@
package org.gcube.application.cms.plugins.reports;
import com.fasterxml.jackson.core.JsonProcessingException;
import lombok.Data;
import lombok.NonNull;
import lombok.extern.slf4j.Slf4j;
import java.util.ArrayList;
import java.util.List;
import org.bson.Document;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.cms.plugins.faults.PluginExecutionException;
@ -12,8 +11,11 @@ import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.identification.IdentificationReference;
import org.gcube.application.geoportal.common.model.document.lifecycle.LifecycleInformation;
import java.util.ArrayList;
import java.util.List;
import com.fasterxml.jackson.core.JsonProcessingException;
import lombok.Data;
import lombok.NonNull;
import lombok.extern.slf4j.Slf4j;
@Data

5
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/EventExecutionReport.java
View File

@ -1,11 +1,12 @@
package org.gcube.application.cms.plugins.reports;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.cms.plugins.requests.EventExecutionRequest;
import org.gcube.application.geoportal.common.model.document.lifecycle.LifecycleInformation;
import lombok.ToString;
import lombok.extern.slf4j.Slf4j;
@ToString(callSuper = true)
@Slf4j
public class EventExecutionReport extends DocumentHandlingReport<EventExecutionRequest>{

5
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/IndexDocumentReport.java
View File

@ -1,10 +1,11 @@
package org.gcube.application.cms.plugins.reports;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.cms.plugins.requests.IndexDocumentRequest;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.cms.plugins.requests.IndexDocumentRequest;
@Getter
@Setter

3
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/MaterializationReport.java
View File

@ -1,9 +1,10 @@
package org.gcube.application.cms.plugins.reports;
import lombok.NonNull;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.cms.plugins.requests.MaterializationRequest;
import lombok.NonNull;
public class MaterializationReport extends DocumentHandlingReport<MaterializationRequest>{

9
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/Report.java
View File

@ -1,12 +1,13 @@
package org.gcube.application.cms.plugins.reports;
import java.util.ArrayList;
import java.util.List;
import org.gcube.application.cms.plugins.faults.PluginExecutionException;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import org.gcube.application.cms.plugins.faults.PluginExecutionException;
import java.util.ArrayList;
import java.util.List;
@Getter
@Setter

16
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/StepExecutionReport.java
View File

@ -1,18 +1,20 @@
package org.gcube.application.cms.plugins.reports;
import com.fasterxml.jackson.core.JsonProcessingException;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
import java.util.ArrayList;
import java.util.List;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.cms.plugins.faults.PluginExecutionException;
import org.gcube.application.cms.plugins.requests.EventExecutionRequest;
import org.gcube.application.cms.plugins.requests.StepExecutionRequest;
import org.gcube.application.geoportal.common.model.document.Project;
import java.util.ArrayList;
import java.util.List;
import com.fasterxml.jackson.core.JsonProcessingException;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
@Getter
@Setter

9
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/BaseExecutionRequest.java
View File

@ -1,15 +1,16 @@
package org.gcube.application.cms.plugins.requests;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
@Getter
@Setter
@ToString(callSuper = true)

7
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/BaseRequest.java
View File

@ -1,6 +1,5 @@
package org.gcube.application.cms.plugins.requests;
import lombok.*;
import org.bson.Document;
import org.gcube.application.cms.plugins.faults.InvalidPluginRequestException;
import org.gcube.application.cms.serialization.Serialization;
@ -8,6 +7,12 @@ import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import lombok.Getter;
import lombok.NonNull;
import lombok.RequiredArgsConstructor;
import lombok.Setter;
import lombok.ToString;
@Getter
@Setter
@ToString(callSuper = true)

9
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/EventExecutionRequest.java
View File

@ -1,13 +1,14 @@
package org.gcube.application.cms.plugins.requests;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
@Getter
@Setter

5
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/IndexDocumentRequest.java
View File

@ -1,12 +1,13 @@
package org.gcube.application.cms.plugins.requests;
import lombok.NonNull;
import lombok.ToString;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import lombok.NonNull;
import lombok.ToString;
@ToString(callSuper = true)
public class IndexDocumentRequest extends BaseExecutionRequest{
public IndexDocumentRequest(@NonNull UseCaseDescriptor useCaseDescriptor, @NonNull User caller, @NonNull Context context, Project document) {

5
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/MaterializationRequest.java
View File

@ -1,12 +1,13 @@
package org.gcube.application.cms.plugins.requests;
import lombok.NonNull;
import lombok.ToString;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import lombok.NonNull;
import lombok.ToString;
@ToString(callSuper = true)
public class MaterializationRequest extends BaseExecutionRequest{
public MaterializationRequest(@NonNull UseCaseDescriptor useCaseDescriptor, @NonNull User caller, @NonNull Context context, Project document) {

9
cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/StepExecutionRequest.java
View File

@ -1,13 +1,14 @@
package org.gcube.application.cms.plugins.requests;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import lombok.Getter;
import lombok.NonNull;
import lombok.Setter;
import lombok.ToString;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.accounting.Context;
import org.gcube.application.geoportal.common.model.document.accounting.User;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
@Getter
@Setter

9
cms-plugin-framework/src/main/java/org/gcube/application/cms/serialization/JacksonProvider.java
View File

@ -1,15 +1,16 @@
package org.gcube.application.cms.serialization;
import java.util.EnumSet;
import java.util.Set;
import org.gcube.application.geoportal.common.JSONSerializationProvider;
import com.jayway.jsonpath.Configuration;
import com.jayway.jsonpath.Option;
import com.jayway.jsonpath.spi.json.JacksonJsonProvider;
import com.jayway.jsonpath.spi.json.JsonProvider;
import com.jayway.jsonpath.spi.mapper.JacksonMappingProvider;
import com.jayway.jsonpath.spi.mapper.MappingProvider;
import org.gcube.application.geoportal.common.JSONSerializationProvider;
import java.util.EnumSet;
import java.util.Set;
public class JacksonProvider implements JSONSerializationProvider {

37
cms-plugin-framework/src/main/java/org/gcube/application/cms/serialization/Serialization.java
View File

@ -1,22 +1,30 @@
package org.gcube.application.cms.serialization;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.vdurmont.semver4j.Semver;
import lombok.extern.slf4j.Slf4j;
import java.io.IOException;
import java.time.format.DateTimeFormatter;
import java.util.Iterator;
import org.bson.Document;
import org.bson.types.ObjectId;
import org.gcube.application.cms.plugins.model.ComparableVersion;
import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.rest.QueryRequest;
import java.io.IOException;
import java.time.format.DateTimeFormatter;
import java.util.Iterator;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
import com.vdurmont.semver4j.Semver;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class Serialization {
@ -80,6 +88,13 @@ public class Serialization {
return mapper.convertValue(d,clazz);
}
public static final <T> T convertAcceptStringAsNull(Object d,Class<T> clazz){
mapper.configure(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT,true);
T converted = mapper.convertValue(d,clazz);
mapper.configure(DeserializationFeature.ACCEPT_EMPTY_STRING_AS_NULL_OBJECT,false);
return converted;
}
public static final Document asDocument(Object obj) throws JsonProcessingException {
return Document.parse(mapper.writeValueAsString(obj));
}

2
cms-test-commons/pom.xml
View File

@ -12,7 +12,7 @@
<parent>
<groupId>org.gcube.application.cms</groupId>
<artifactId>gcube-cms-suite</artifactId>
<version>1.0.4</version>
<version>[1.0.0, 2.0.0-SNAPSHOT)</version>
</parent>

4
cms-test-commons/src/main/java/org/gcube/application/cms/tests/TokenSetter.java
View File

@ -37,9 +37,9 @@ public class TokenSetter {
static{
try {
props.load(TokenSetter.class.getResourceAsStream("/tokens.properties"));
props.load(TokenSetter.class.getResourceAsStream("./tokens.properties"));
} catch (Exception e) {
throw new RuntimeException("YOU NEED TO SET TOKEN FILE IN CONFIGURATION",e);
throw new RuntimeException("YOU NEED TO SET tokens.properties TOKEN FILE IN CONFIGURATION",e);
}
}

3
default-lc-managers/CHANGELOG.md
View File

@ -1,5 +1,8 @@
# Changelog for org.gcube.application.cms.ckan-plugin
## [v1.3.0-SNAPSHOT]- 2024-03-22
- Updated visibility of phases and steps
## [v1.2.2]- 2023-09-06
- Using parent version range [#25572]

9
default-lc-managers/README.md
View File

@ -25,6 +25,15 @@ Plugins SHOULD be defined extending the definitions provided in this module.
## Documentation
[gCube CMS Suite](../) parent module containing references, documentation, guides ad utilities.
#### Default Lifecycle Managements
##### Single Step (no moderation)
<img src="https://gcube.wiki.gcube-system.org/images_gcube/8/8c/SingleStep_LC.png" style="max-width:800px;" alt="Default Single Step lifecycle">
##### 3 Phases (content moderation)
<img src="https://gcube.wiki.gcube-system.org/images_gcube/d/d8/Default3Phases_LC.png" style="max-width:800px;" alt="Default 3 Phases lifecycle">
## Change log

2
default-lc-managers/pom.xml
View File

@ -5,7 +5,7 @@
<modelVersion>4.0.0</modelVersion>
<artifactId>default-lc-managers</artifactId>
<version>1.2.2</version>
<version>1.3.0-SNAPSHOT</version>
<name>gCube CMS - Default LC Managers</name>
<parent>

4
default-lc-managers/src/main/java/org/gcube/application/cms/plugins/implementations/AbstractLifeCycleManager.java
View File

@ -132,7 +132,9 @@ public abstract class AbstractLifeCycleManager extends AbstractPlugin implements
request.getUseCaseDescriptor().getId(),
request.getDocument().getId(),
request.getStep());
log.debug("Serving Request full log {}",request);
log.trace("Serving Request full log {}", request);
log.debug("Serving Request on document {}", request.getDocument());
log.debug("Checking is STEP {} is supported by {}",request.getStep(),DESCRIPTOR.getId());
if(!registeredSteps.containsKey(request.getStep()))

2
default-lc-managers/src/main/java/org/gcube/application/cms/plugins/implementations/Default3PhaseManager.java
View File

@ -29,7 +29,7 @@ import lombok.extern.slf4j.Slf4j;
@Slf4j
public class Default3PhaseManager extends SimpleLifeCycleManager implements LifecycleManager {
protected static class Phases {
public static final class Phases {
public static final String PENDING_APPROVAL="Pending Approval";
public static final String PUBLISHED=SimpleLifeCycleManager.Phases.PUBLISHED;

21
default-lc-managers/src/main/java/org/gcube/application/cms/plugins/implementations/SimpleLifeCycleManager.java
View File

@ -34,6 +34,7 @@ import org.gcube.application.geoportal.common.model.plugins.OperationDescriptor;
import org.gcube.application.geoportal.common.model.rest.ConfigurationException;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.HandlerDeclaration;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
import org.gcube.application.geoportal.common.rest.InterfaceConstants;
import org.gcube.application.geoportal.common.utils.Files;
import lombok.extern.slf4j.Slf4j;
@ -49,14 +50,14 @@ public class SimpleLifeCycleManager extends AbstractLifeCycleManager implements
}
//Updated by Francesco
protected static class Phases {
public static final class Phases {
public static final String PUBLISHED="Published";
public static final String UNPUBLISHED="UnPublished";
}
//Updated by Francesco
private static class Steps {
public static final class Steps {
public static final OperationDescriptor PUBLISH = new OperationDescriptor("PUBLISH","Materialize & index project");
public static final OperationDescriptor UNPUBLISH = new OperationDescriptor("UNPUBLISH","UnPublish the project. DeMaterialize and DeIndex the project");
@ -187,6 +188,9 @@ public class SimpleLifeCycleManager extends AbstractLifeCycleManager implements
return super.onUpdateDocument(report);
}
/**
* Updated by Francesco M.
*/
@Override
protected EventExecutionReport onDeleteDocument(EventExecutionReport report) throws ConfigurationException, InvalidPluginRequestException, MaterializationException, EventException {
// Block non draft only if not force
@ -197,8 +201,17 @@ public class SimpleLifeCycleManager extends AbstractLifeCycleManager implements
JSONPathWrapper wrapper = new JSONPathWrapper(report.getTheRequest().getDocument().getTheDocument().toJson());
for (String s : wrapper.getMatchingPaths("$..[?(@." + RegisteredFileSet.PAYLOADS + ")]")){
log.info("Requesting dematerialization for {} ",s);
for(MaterializationPlugin mat : getMaterializers(report.getTheRequest()))
report = deMaterialize(report,mat,new Document("fileSetPath",s));
for(MaterializationPlugin mat : getMaterializers(report.getTheRequest())) {
Document params = new Document("fileSetPath",s);
Boolean ignoreErrors;
try {
ignoreErrors = (Boolean) report.getTheRequest().getCallParameters().getOrDefault(InterfaceConstants.Parameters.IGNORE_ERRORS, false);
}catch (Exception e) {
ignoreErrors = false;
}
params.append(InterfaceConstants.Parameters.IGNORE_ERRORS, ignoreErrors);
report = deMaterialize(report,mat, params);
}
if(!report.getToSetLifecycleInformation().getLastOperationStatus().equals(LifecycleInformation.Status.OK))
break;
}

2
default-lc-managers/src/test/java/org/gcube/application/cms/plugins/SimpleLifecycleTests.java
View File

@ -14,7 +14,7 @@ public class SimpleLifecycleTests {
// public void testFullCycle(){
// SimpleLifeCycleManager manager = plugins.get(SimpleLifeCycleManager.PLUGIN_ID);
//
// StepExecutionRequest request = new StepExecutionRequest();
// PerformStepRequest request = new PerformStepRequest();
//
// Project p = null;
//

3
geoportal-client/CHANGELOG.md
View File

@ -1,5 +1,8 @@
# Changelog for org.gcube.application.geoportal-client
## [v1.2.2-SNAPSHOT] - 2024-04-11
- Refactored
## [v1.2.1] - 2023-09-06
- Using parent version range [#25572]

2
geoportal-client/pom.xml
View File

@ -4,7 +4,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>org.gcube.application</groupId>
<artifactId>geoportal-client</artifactId>
<version>1.2.1</version>
<version>1.2.2-SNAPSHOT</version>
<name>Geoportal Client</name>
<parent>

4
geoportal-client/src/main/java/org/gcube/application/geoportal/client/DefaultDocumentsClient.java
View File

@ -20,7 +20,7 @@ import org.gcube.application.geoportal.common.model.rest.CreateRelationshipReque
import org.gcube.application.geoportal.common.model.rest.DeleteRelationshipRequest;
import org.gcube.application.geoportal.common.model.rest.QueryRequest;
import org.gcube.application.geoportal.common.model.rest.RegisterFileSetRequest;
import org.gcube.application.geoportal.common.model.rest.StepExecutionRequest;
import org.gcube.application.geoportal.common.model.rest.PerformStepRequest;
import org.gcube.application.geoportal.common.rest.InterfaceConstants;
import org.gcube.application.geoportal.common.rest.Projects;
import org.gcube.common.clients.Call;
@ -253,7 +253,7 @@ public class DefaultDocumentsClient<T extends Project> implements Projects<T> {
* @throws RemoteException the remote exception
*/
@Override
public T performStep(String id, StepExecutionRequest request) throws RemoteException {
public T performStep(String id, PerformStepRequest request) throws RemoteException {
try {
log.debug("Executing step on {} (class {}, useCaseDescriptor {}) with request {} ", id, getManagedClass(),
profileID, request);

4
geoportal-client/src/test/java/org/gcube/application/geoportal/StorageTests.java
View File

@ -1,10 +1,10 @@
package org.gcube.application.geoportal;
import java.io.IOException;
import org.gcube.application.cms.tests.TokenSetter;
import org.gcube.application.geoportal.common.utils.StorageUtils;
import java.io.IOException;
public class StorageTests {
public static void main(String[] args) throws IOException {

4
geoportal-client/src/test/java/org/gcube/application/geoportal/clients/BasicVreTests.java
View File

@ -1,11 +1,11 @@
package org.gcube.application.geoportal.clients;
import static org.junit.Assume.assumeTrue;
import org.gcube.application.cms.tests.TokenSetter;
import org.gcube.application.geoportal.common.utils.tests.GCubeTest;
import org.junit.BeforeClass;
import static org.junit.Assume.assumeTrue;
public class BasicVreTests extends GCubeTest {
@BeforeClass

13
geoportal-client/src/test/java/org/gcube/application/geoportal/clients/GenericUseCases.java
View File

@ -1,6 +1,11 @@
package org.gcube.application.geoportal.clients;
import com.fasterxml.jackson.core.JsonProcessingException;
import static org.gcube.application.geoportal.client.plugins.GeoportalAbstractPlugin.projects;
import java.io.File;
import java.io.FileNotFoundException;
import java.rmi.RemoteException;
import org.bson.Document;
import org.gcube.application.cms.tests.Tests;
import org.gcube.application.geoportal.client.utils.Serialization;
@ -12,11 +17,7 @@ import org.gcube.application.geoportal.common.utils.FileSets;
import org.gcube.application.geoportal.common.utils.StorageUtils;
import org.junit.Test;
import java.io.File;
import java.io.FileNotFoundException;
import java.rmi.RemoteException;
import static org.gcube.application.geoportal.client.plugins.GeoportalAbstractPlugin.projects;
import com.fasterxml.jackson.core.JsonProcessingException;
public abstract class GenericUseCases extends BasicVreTests{

31
geoportal-client/src/test/java/org/gcube/application/geoportal/clients/ProfiledConcessioniTest.java
View File

@ -1,8 +1,15 @@
package org.gcube.application.geoportal.clients;
import com.fasterxml.jackson.core.JsonProcessingException;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeTrue;
import java.io.File;
import java.io.FileNotFoundException;
import java.nio.charset.Charset;
import java.rmi.RemoteException;
import java.util.Iterator;
import org.bson.Document;
import org.gcube.application.cms.tests.TestDocuments;
import org.gcube.application.cms.tests.Tests;
@ -17,7 +24,7 @@ import org.gcube.application.geoportal.common.model.document.relationships.Relat
import org.gcube.application.geoportal.common.model.rest.CreateRelationshipRequest;
import org.gcube.application.geoportal.common.model.rest.DeleteRelationshipRequest;
import org.gcube.application.geoportal.common.model.rest.RegisterFileSetRequest;
import org.gcube.application.geoportal.common.model.rest.StepExecutionRequest;
import org.gcube.application.geoportal.common.model.rest.PerformStepRequest;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.Field;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.HandlerDeclaration;
import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDescriptor;
@ -28,16 +35,10 @@ import org.gcube.application.geoportal.common.utils.StorageUtils;
import org.gcube.application.geoportal.common.utils.tests.GCubeTest;
import org.junit.Test;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.nio.charset.Charset;
import java.rmi.RemoteException;
import java.util.Iterator;
import com.fasterxml.jackson.core.JsonProcessingException;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeTrue;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class ProfiledConcessioniTest <M extends Project,C extends Projects<M>> extends GenericUseCases{
@ -66,8 +67,8 @@ public class ProfiledConcessioniTest <M extends Project,C extends Projects<M>> e
Project p=client.createNew(getNewDocument());
p=prepareWithFileSet(p);
p = getClient().performStep(p.getId(), new StepExecutionRequest("SUBMIT-FOR-REVIEW",new Document()));
String optionalMessage = null;
p = getClient().performStep(p.getId(), new PerformStepRequest("SUBMIT-FOR-REVIEW", optionalMessage, new Document()));
System.out.println("Result is "+Serialization.write(p));
}

29
geoportal-client/src/test/java/org/gcube/application/geoportal/clients/ProfiledDocumentsTest.java
View File

@ -1,9 +1,15 @@
package org.gcube.application.geoportal.clients;
import com.fasterxml.jackson.core.JsonProcessingException;
import lombok.extern.slf4j.Slf4j;
import static org.gcube.application.geoportal.client.utils.Serialization.write;
import static org.junit.Assert.assertEquals;
import static org.junit.Assume.assumeTrue;
import java.io.FileNotFoundException;
import java.rmi.RemoteException;
import java.time.LocalDateTime;
import java.util.concurrent.atomic.AtomicLong;
import org.bson.Document;
import org.gcube.application.cms.tests.Tests;
import org.gcube.application.geoportal.client.utils.Serialization;
import org.gcube.application.geoportal.common.faults.InvalidRequestException;
import org.gcube.application.geoportal.common.model.JSONPathWrapper;
@ -12,28 +18,15 @@ import org.gcube.application.geoportal.common.model.document.Project;
import org.gcube.application.geoportal.common.model.document.access.Access;
import org.gcube.application.geoportal.common.model.document.access.AccessPolicy;
import org.gcube.application.geoportal.common.model.document.filesets.RegisteredFileSet;
import org.gcube.application.geoportal.common.model.document.relationships.RelationshipNavigationObject;
import org.gcube.application.geoportal.common.model.rest.CreateRelationshipRequest;
import org.gcube.application.geoportal.common.model.rest.DeleteRelationshipRequest;
import org.gcube.application.geoportal.common.model.rest.QueryRequest;
import org.gcube.application.geoportal.common.model.rest.RegisterFileSetRequest;
import org.gcube.application.geoportal.common.rest.Projects;
import org.gcube.application.geoportal.common.utils.FileSets;
import org.gcube.application.geoportal.common.utils.StorageUtils;
import org.gcube.application.geoportal.common.utils.tests.GCubeTest;
import org.junit.Test;
import java.io.File;
import java.io.FileNotFoundException;
import java.rmi.RemoteException;
import java.time.LocalDateTime;
import java.util.Iterator;
import java.util.concurrent.atomic.AtomicLong;
import com.fasterxml.jackson.core.JsonProcessingException;
import static org.gcube.application.geoportal.client.utils.Serialization.write;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.assumeTrue;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class ProfiledDocumentsTest<M extends Project,C extends Projects<M>> extends GenericUseCases {

17
geoportal-client/src/test/java/org/gcube/application/geoportal/clients/UCDTests.java
View File

@ -1,5 +1,13 @@
package org.gcube.application.geoportal.clients;
import static org.gcube.application.geoportal.client.plugins.GeoportalAbstractPlugin.useCaseDescriptors;
import static org.junit.Assert.assertEquals;
import static org.junit.Assume.assumeTrue;
import java.util.Arrays;
import java.util.HashSet;
import java.util.concurrent.atomic.AtomicLong;
import org.bson.Document;
import org.gcube.application.cms.tests.TokenSetter;
import org.gcube.application.geoportal.client.utils.Serialization;
@ -12,15 +20,6 @@ import org.gcube.application.geoportal.common.utils.tests.GCubeTest;
import org.junit.Assert;
import org.junit.Test;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.concurrent.atomic.AtomicLong;
import static org.gcube.application.geoportal.client.plugins.GeoportalAbstractPlugin.useCaseDescriptors;
import static org.junit.Assert.assertEquals;
import static org.junit.Assume.assumeTrue;
public class UCDTests{

9
geoportal-client/src/test/java/org/gcube/application/geoportal/clients/serialization/SerializationTests.java
View File

@ -1,12 +1,13 @@
package org.gcube.application.geoportal.clients.serialization;
import lombok.extern.slf4j.Slf4j;
import org.gcube.application.geoportal.client.utils.Serialization;
import org.junit.Test;
import java.io.IOException;
import java.time.LocalDateTime;
import org.gcube.application.geoportal.client.utils.Serialization;
import org.junit.Test;
import lombok.extern.slf4j.Slf4j;
@Slf4j
public class SerializationTests {

18
geoportal-client/src/test/java/org/gcube/application/geoportal/clients/serialization/UseCaseDescriptors.java
View File

@ -1,5 +1,14 @@
package org.gcube.application.geoportal.clients.serialization;
import static junit.framework.TestCase.assertEquals;
import static junit.framework.TestCase.assertTrue;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.List;
import java.util.Map;
import org.gcube.application.cms.tests.TestProfiles;
import org.gcube.application.geoportal.client.utils.Serialization;
import org.gcube.application.geoportal.common.model.JSONPathWrapper;
@ -9,15 +18,6 @@ import org.gcube.application.geoportal.common.model.useCaseDescriptor.UseCaseDes
import org.gcube.application.geoportal.common.utils.Files;
import org.junit.Test;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.List;
import java.util.Map;
import static junit.framework.TestCase.assertEquals;
import static junit.framework.TestCase.assertTrue;
public class UseCaseDescriptors {
private static UseCaseDescriptor readProfile(String file) throws IOException {

3
geoportal-common/CHANGELOG.md
View File

@ -1,5 +1,8 @@
# Changelog for org.gcube.application.geoportal-common
## [v1.1.0-SNAPSHOT] - 2024-04-08
- Added message to StepExecutionRequest [#27192]
## [v1.0.13] - 2023-09-06
- Using parent range version [#25572]

2
geoportal-common/pom.xml
View File

@ -3,7 +3,7 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<artifactId>geoportal-common</artifactId>
<version>1.0.13</version>
<version>1.1.0-SNAPSHOT</version>
<name>Geoportal Common</name>
<parent>

Some files were not shown because too many files have changed in this diff Show More