diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/model/PluginDescriptor.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/model/PluginDescriptor.java index 8df26c6..b05ef30 100644 --- a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/model/PluginDescriptor.java +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/model/PluginDescriptor.java @@ -11,6 +11,10 @@ import org.gcube.application.geoportal.common.model.document.ComparableVersion; @AllArgsConstructor public class PluginDescriptor { + public static class BaseTypes{ + public static final String LIFECYCLE_MANAGER="LifecycleManagement"; + } + @NonNull private String id; @NonNull diff --git a/cms-test-commons/pom.xml b/cms-test-commons/pom.xml index 253b9a6..27320a6 100644 --- a/cms-test-commons/pom.xml +++ b/cms-test-commons/pom.xml @@ -53,6 +53,17 @@ geoportal-common + + + org.reflections + reflections + + + + org.gcube.application.cms + cms-plugin-framework + + ch.qos.logback logback-classic diff --git a/cms-test-commons/src/main/java/org/gcube/application/cms/tests/BasicPluginTest.java b/cms-test-commons/src/main/java/org/gcube/application/cms/tests/BasicPluginTest.java new file mode 100644 index 0000000..6780630 --- /dev/null +++ b/cms-test-commons/src/main/java/org/gcube/application/cms/tests/BasicPluginTest.java @@ -0,0 +1,71 @@ +package org.gcube.application.cms.tests; + +import ch.qos.logback.core.net.SyslogOutputStream; +import org.gcube.application.cms.plugins.InitializablePlugin; +import org.gcube.application.cms.plugins.Plugin; +import org.gcube.application.cms.plugins.faults.InitializationException; +import org.junit.Assert; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; +import org.reflections.Reflections; +import org.reflections.util.ConfigurationBuilder; +import org.reflections.util.FilterBuilder; + +import java.rmi.ServerError; +import java.util.List; +import java.util.ServiceLoader; +import java.util.concurrent.atomic.AtomicLong; + +public class BasicPluginTest { + + static List plugins; + + @BeforeClass + public static void checkPluginRegistration() { + + + Reflections reflections = new Reflections( + new ConfigurationBuilder() + .forPackage("org.gcube.application.cms") + .filterInputsBy(new FilterBuilder().includePackage("org.gcube.application.cms"))); + + reflections.getSubTypesOf(Plugin.class).iterator().forEachRemaining(pluginClass->{ + if(!pluginClass.isInterface()){ + try { + Plugin plugin = pluginClass.newInstance(); + plugins.add(plugin); + }catch (Throwable t){ + t.printStackTrace(System.err); + Assert.fail("Unable to Load "+pluginClass); + } + } + + }); + + + Assert.assertFalse(plugins.isEmpty()); + System.out.println("Plugin Loading OK"); + } + + + @Test + public void basicChecks(){ + plugins.forEach(p->{ + System.out.println("INIT Plugin "+p.getClass()); + Assert.assertNotNull(p.getDescriptor()); + Assert.assertNotNull(p.getDescriptor().getId()); + Assert.assertNotNull(p.getDescriptor().getType()); + Assert.assertNotNull(p.getDescriptor().getVersion()); + if(p instanceof InitializablePlugin){ + InitializablePlugin ip=(InitializablePlugin)p; + try { + ip.init(); + } catch (InitializationException e) { + e.printStackTrace(System.err); + Assert.fail("Unable to Init "+p.getDescriptor().getId()); + } + } + }); + } +} diff --git a/concessioni-use-case/CHANGELOG.md b/concessioni-lifecycle/CHANGELOG.md similarity index 77% rename from concessioni-use-case/CHANGELOG.md rename to concessioni-lifecycle/CHANGELOG.md index 3cf42be..f13e7b1 100644 --- a/concessioni-use-case/CHANGELOG.md +++ b/concessioni-lifecycle/CHANGELOG.md @@ -1,6 +1,6 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -# Changelog for org.gcube.application.cms.concessioni-use-case +# Changelog for org.gcube.application.cms.concessioni-lifecycle This library contains custom extensions for the support of GNA "concessioni" use case diff --git a/concessioni-use-case/FUNDING.md b/concessioni-lifecycle/FUNDING.md similarity index 100% rename from concessioni-use-case/FUNDING.md rename to concessioni-lifecycle/FUNDING.md diff --git a/concessioni-use-case/LICENSE.md b/concessioni-lifecycle/LICENSE.md similarity index 100% rename from concessioni-use-case/LICENSE.md rename to concessioni-lifecycle/LICENSE.md diff --git a/concessioni-use-case/README.md b/concessioni-lifecycle/README.md similarity index 100% rename from concessioni-use-case/README.md rename to concessioni-lifecycle/README.md diff --git a/concessioni-use-case/pom.xml b/concessioni-lifecycle/pom.xml similarity index 95% rename from concessioni-use-case/pom.xml rename to concessioni-lifecycle/pom.xml index 4d5d251..fee5c2f 100644 --- a/concessioni-use-case/pom.xml +++ b/concessioni-lifecycle/pom.xml @@ -4,7 +4,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - concessioni-use-case + concessioni-lifecycle 1.0.0-SNAPSHOT GNA Concessioni Use Case diff --git a/concessioni-lifecycle/src/main/java/org/gcube/application/cms/concessioni/plugins/ConcessioniLifeCycleManager.java b/concessioni-lifecycle/src/main/java/org/gcube/application/cms/concessioni/plugins/ConcessioniLifeCycleManager.java new file mode 100644 index 0000000..4d8d59b --- /dev/null +++ b/concessioni-lifecycle/src/main/java/org/gcube/application/cms/concessioni/plugins/ConcessioniLifeCycleManager.java @@ -0,0 +1,71 @@ +package org.gcube.application.cms.concessioni.plugins; + +import lombok.extern.slf4j.Slf4j; +import org.gcube.application.cms.plugins.LifecycleManager; +import org.gcube.application.cms.plugins.faults.InitializationException; +import org.gcube.application.cms.plugins.faults.ShutDownException; +import org.gcube.application.cms.plugins.faults.StepException; +import org.gcube.application.cms.plugins.model.PluginDescriptor; +import org.gcube.application.cms.plugins.reports.ExecutionReport; +import org.gcube.application.cms.plugins.reports.InitializationReport; +import org.gcube.application.cms.plugins.requests.StepExecutionRequest; +import org.gcube.application.geoportal.common.model.document.ComparableVersion; + +@Slf4j +public class ConcessioniLifeCycleManager implements LifecycleManager { + + private static final PluginDescriptor DESCRIPTOR=new PluginDescriptor("GNA-CONCESSIONI-LC", PluginDescriptor.BaseTypes.LIFECYCLE_MANAGER); + static { + DESCRIPTOR.setDescription("GNA Concessioni. This plugin supports custom lifecycle management for the GNA Concessioni UseCase."); + DESCRIPTOR.setVersion(new ComparableVersion("1.0.0")); + } + + + @Override + public InitializationReport initInContext() throws InitializationException { + return null; + } + + @Override + public InitializationReport init() throws InitializationException { + return null; + } + + @Override + public void shutdown() throws ShutDownException { + + } + + @Override + public ExecutionReport performStep(StepExecutionRequest request) throws StepException { + log.info("Received Request "); + + switch(request.getStep()){ + case StepExecutionRequest.Steps.ON_INIT_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_MATERIALIZE_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_DEMATERIALIZE_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_DEINDEX_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_INDEX_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_DELETE_DOCUMENT:{ + break; + } + default : throw new StepException("Invalid Step "+request.getStep()); + } + throw new StepException("Still to implement"); + } + + @Override + public PluginDescriptor getDescriptor() { + return DESCRIPTOR; + } +} diff --git a/concessioni-lifecycle/src/test/java/org/gcube/application/cms/concessioni/plugins/Tests.java b/concessioni-lifecycle/src/test/java/org/gcube/application/cms/concessioni/plugins/Tests.java new file mode 100644 index 0000000..b297ce4 --- /dev/null +++ b/concessioni-lifecycle/src/test/java/org/gcube/application/cms/concessioni/plugins/Tests.java @@ -0,0 +1,13 @@ +package org.gcube.application.cms.concessioni.plugins; + +import org.gcube.application.cms.tests.BasicPluginTest; +import org.junit.Assert; +import org.junit.Test; + +public class Tests extends BasicPluginTest { + + @Test + public void testLoad(){ + Assert.assertTrue(true); + } +} diff --git a/concessioni-model/CHANGELOG.md b/concessioni-model/CHANGELOG.md new file mode 100644 index 0000000..6c54d43 --- /dev/null +++ b/concessioni-model/CHANGELOG.md @@ -0,0 +1,8 @@ +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +# Changelog for org.gcube.application.cms.concessioni-model + +This library contains custom BEANS for the support of GNA "concessioni" use case + +## [v1.0.0-SNAPSHOT] - 2021-12-15 +- First release diff --git a/concessioni-model/FUNDING.md b/concessioni-model/FUNDING.md new file mode 100644 index 0000000..9e48b94 --- /dev/null +++ b/concessioni-model/FUNDING.md @@ -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); diff --git a/concessioni-model/LICENSE.md b/concessioni-model/LICENSE.md new file mode 100644 index 0000000..3af0507 --- /dev/null +++ b/concessioni-model/LICENSE.md @@ -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 + diff --git a/concessioni-model/README.md b/concessioni-model/README.md new file mode 100644 index 0000000..85dd719 --- /dev/null +++ b/concessioni-model/README.md @@ -0,0 +1,52 @@ +gCube CMS Suite +-------------------------------------------------- + +gCube CMS Suite is a set of components designed to manage complex space-temporal Documents defined by metadata Profiles. + +## Built with +* [gCube SmartGears] (https://gcube.wiki.gcube-system.org/gcube/SmartGears) - The gCube SmartGears framework +* [OpenJDK](https://openjdk.java.net/) - The JDK used +* [JAX-RS](https://github.com/eclipse-ee4j/jaxrs-api) - Java™ API for RESTful Web Services +* [Jersey](https://jersey.github.io/) - JAX-RS runtime +* [Maven](https://maven.apache.org/) - Dependency Management + +## Documentation + +Documentation can be found [here](https://gcube.wiki.gcube-system.org/gcube/GeoPortal_Service). + +## Change log + +See [CHANGELOG.md](CHANGELOG.md). + +## 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); + diff --git a/concessioni-model/pom.xml b/concessioni-model/pom.xml new file mode 100644 index 0000000..fb6f6ea --- /dev/null +++ b/concessioni-model/pom.xml @@ -0,0 +1,44 @@ + + + 4.0.0 + + org.gcube.application.cms + concessioni-model + 1.0.0-SNAPSHOT + + + org.gcube.application.cms + gcube-cms-suite + 1.0.1-SNAPSHOT + + + + https://code-repo.d4science.org/gCubeSystem + + + + + + scm:git:${gitBaseUrl}/gcube-cms-suite + scm:git:${gitBaseUrl}/gcube-cms-suite + ${gitBaseUrl}/gcube-cms-suite + + + + + + + org.gcube.application.cms + geoportal-common + + + + org.gcube.application.cms + cms-test-commons + test + + + + \ No newline at end of file diff --git a/concessioni-model/src/main/java/org/gcube/application/cms/custom/gna/concessioni/model/ProfiledConcessione.java b/concessioni-model/src/main/java/org/gcube/application/cms/custom/gna/concessioni/model/ProfiledConcessione.java new file mode 100644 index 0000000..71fdce8 --- /dev/null +++ b/concessioni-model/src/main/java/org/gcube/application/cms/custom/gna/concessioni/model/ProfiledConcessione.java @@ -0,0 +1,8 @@ +package org.gcube.application.cms.custom.gna.concessioni.model; + +import org.gcube.application.geoportal.common.model.document.ProfiledDocument; + +public class ProfiledConcessione extends ProfiledDocument { + + +} diff --git a/concessioni-use-case/src/main/java/org/gcube/application/cms/concessioni/plugins/ConcessioniLifeCycleManager.java b/concessioni-use-case/src/main/java/org/gcube/application/cms/concessioni/plugins/ConcessioniLifeCycleManager.java deleted file mode 100644 index ae9fde7..0000000 --- a/concessioni-use-case/src/main/java/org/gcube/application/cms/concessioni/plugins/ConcessioniLifeCycleManager.java +++ /dev/null @@ -1,39 +0,0 @@ -package org.gcube.application.cms.concessioni.plugins; - -import org.gcube.application.cms.plugins.LifecycleManager; -import org.gcube.application.cms.plugins.faults.InitializationException; -import org.gcube.application.cms.plugins.faults.ShutDownException; -import org.gcube.application.cms.plugins.faults.StepException; -import org.gcube.application.cms.plugins.model.PluginDescriptor; -import org.gcube.application.cms.plugins.reports.ExecutionReport; -import org.gcube.application.cms.plugins.reports.InitializationReport; -import org.gcube.application.cms.plugins.requests.StepExecutionRequest; - -public class ConcessioniLifeCycleManager implements LifecycleManager { - - - @Override - public InitializationReport initInContext() throws InitializationException { - return null; - } - - @Override - public InitializationReport init() throws InitializationException { - return null; - } - - @Override - public void shutdown() throws ShutDownException { - - } - - @Override - public ExecutionReport performStep(StepExecutionRequest request) throws StepException { - return null; - } - - @Override - public PluginDescriptor getDescriptor() { - return null; - } -} diff --git a/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/profile/Profile.java b/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/profile/Profile.java index d674add..c1f96bb 100644 --- a/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/profile/Profile.java +++ b/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/profile/Profile.java @@ -1,6 +1,9 @@ package org.gcube.application.geoportal.common.model.profile; +import java.util.ArrayList; +import java.util.HashMap; import java.util.List; +import java.util.Map; import javax.xml.bind.annotation.XmlRootElement; @@ -26,4 +29,18 @@ public class Profile{ private Document schema; private List handlers; + + /** + * Returns map Type -> Handler Declaration + * @return + */ + public Map> getHandlersMap(){ + HashMap> toReturn=new HashMap<>(); + handlers.forEach(h->{ + if(!toReturn.containsKey(h.getType())) + toReturn.put(h.getType(),new ArrayList<>()); + toReturn.get(h.getType()).add(h); + }); + return toReturn; + } } diff --git a/geoportal-service/pom.xml b/geoportal-service/pom.xml index 39ca068..7d718a5 100644 --- a/geoportal-service/pom.xml +++ b/geoportal-service/pom.xml @@ -190,6 +190,11 @@ jackson-datatype-jsr310 + + org.reflections + reflections + + org.gcube.contentmanagement @@ -208,6 +213,12 @@ test + + org.gcube.application.cms + concessioni-lifecycle + test + + junit junit diff --git a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/ImplementationProvider.java b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/ImplementationProvider.java index d842d82..1494cd9 100644 --- a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/ImplementationProvider.java +++ b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/ImplementationProvider.java @@ -6,6 +6,7 @@ package org.gcube.application.geoportal.service.engine; import lombok.Getter; import lombok.Setter; import lombok.Synchronized; +import org.gcube.application.cms.plugins.Plugin; import org.gcube.application.geoportal.service.engine.providers.*; public class ImplementationProvider { @@ -41,22 +42,26 @@ public class ImplementationProvider { @Getter @Setter private ProfileMapCache profiles=new ProfileMapCache(); - + + @Getter + @Setter + private PluginManager pluginManager=new PluginManager(); @Getter @Setter private StorageHubProvider sHubProvider=new StorageHubProvider(); - public void shutdown() { - // Stop JPA -// AbstractRecordManager.shutdown(); - - mongoClientProvider.shutdown(); - } - - public void startup() { -// AbstractRecordManager.setDefaultProvider(emfProvider); - - mongoClientProvider.init(); - } +// public void shutdown() { +// // Stop JPA +//// AbstractRecordManager.shutdown(); +// +// mongoClientProvider.shutdown(); +// pluginManager.shutdown(); +// } +// +// public void startup() { +//// AbstractRecordManager.setDefaultProvider(emfProvider); +// pluginManager.init(); +// mongoClientProvider.init(); +// } } diff --git a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/handlers/SimpleLifeCycleManager.java b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/handlers/SimpleLifeCycleManager.java new file mode 100644 index 0000000..689bd5b --- /dev/null +++ b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/handlers/SimpleLifeCycleManager.java @@ -0,0 +1,77 @@ +package org.gcube.application.geoportal.service.engine.handlers; + +import com.google.protobuf.DescriptorProtos; +import lombok.extern.slf4j.Slf4j; +import org.gcube.application.cms.plugins.LifecycleManager; +import org.gcube.application.cms.plugins.faults.InitializationException; +import org.gcube.application.cms.plugins.faults.ShutDownException; +import org.gcube.application.cms.plugins.faults.StepException; +import org.gcube.application.cms.plugins.model.PluginDescriptor; +import org.gcube.application.cms.plugins.reports.ExecutionReport; +import org.gcube.application.cms.plugins.reports.InitializationReport; +import org.gcube.application.cms.plugins.requests.StepExecutionRequest; +import org.gcube.application.geoportal.common.model.document.ComparableVersion; + +@Slf4j +public class SimpleLifeCycleManager implements LifecycleManager { + + + private static final PluginDescriptor DESCRIPTOR=new PluginDescriptor("SIMPLE-LIFECYCLE", "Simple Lifecycle manager"); + static { + DESCRIPTOR.setDescription("Simple Lifecycle Management. This plugin supports a simple publication lifecycle."); + DESCRIPTOR.setVersion(new ComparableVersion("1.0.0")); + } + + @Override + public InitializationReport initInContext() throws InitializationException { + return null; + } + + @Override + public InitializationReport init() throws InitializationException { + return null; + } + + @Override + public void shutdown() throws ShutDownException { + + } + + @Override + public ExecutionReport performStep(StepExecutionRequest request) throws StepException { + log.info("Received Request "); + + switch(request.getStep()){ + case StepExecutionRequest.Steps.ON_INIT_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_MATERIALIZE_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_DEMATERIALIZE_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_DEINDEX_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_INDEX_DOCUMENT:{ + break; + } + case StepExecutionRequest.Steps.ON_DELETE_DOCUMENT:{ + break; + } + default : throw new StepException("Invalid Step "+request.getStep()); + } + + + throw new StepException("Still to implement"); + } + + + + + @Override + public PluginDescriptor getDescriptor() { + return null; + } +} diff --git a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/mongo/ProfiledMongoManager.java b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/mongo/ProfiledMongoManager.java index fc6cb22..b69e8df 100644 --- a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/mongo/ProfiledMongoManager.java +++ b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/mongo/ProfiledMongoManager.java @@ -8,14 +8,17 @@ import org.bson.Document; import org.bson.types.ObjectId; import org.gcube.application.cms.plugins.LifecycleManager; import org.gcube.application.cms.plugins.faults.StepException; +import org.gcube.application.cms.plugins.model.PluginDescriptor; import org.gcube.application.cms.plugins.reports.ExecutionReport; import org.gcube.application.cms.plugins.requests.StepExecutionRequest; import org.gcube.application.geoportal.common.model.document.*; import org.gcube.application.geoportal.common.model.legacy.Concessione; import org.gcube.application.geoportal.common.model.legacy.report.ValidationReport; +import org.gcube.application.geoportal.common.model.profile.HandlerDeclaration; import org.gcube.application.geoportal.common.model.profile.Profile; import org.gcube.application.geoportal.common.model.rest.QueryRequest; import org.gcube.application.geoportal.service.engine.ImplementationProvider; +import org.gcube.application.geoportal.service.engine.providers.PluginManager; import org.gcube.application.geoportal.service.model.internal.faults.ConfigurationException; import org.gcube.application.geoportal.service.model.internal.faults.DeletionException; import org.gcube.application.geoportal.service.utils.Serialization; @@ -25,6 +28,7 @@ import javax.ws.rs.WebApplicationException; import javax.ws.rs.core.Response; import java.io.IOException; import java.security.InvalidParameterException; +import java.util.List; import java.util.Map; import java.util.concurrent.LinkedBlockingQueue; import java.util.function.Consumer; @@ -58,6 +62,23 @@ public class ProfiledMongoManager extends MongoManager implements MongoManagerI< // TODO MAP OF DATABASES? db=client.getTheClient().getDatabase(toUseDB); + + //Getting Lifecycle Manager + List handlerDeclarations= profile.getHandlersMap().get(PluginDescriptor.BaseTypes.LIFECYCLE_MANAGER); + if(handlerDeclarations==null || handlerDeclarations.isEmpty()) throw new ConfigurationException("No Lifecycle Handler defined for profile ID "+profileId); + if(handlerDeclarations.size()>1) throw new ConfigurationException("Too many Lifecycle Handlers defined ("+handlerDeclarations+") in profile ID "+profileId); + + + HandlerDeclaration lcHandlerDeclaration=handlerDeclarations.get(0); + + log.debug("Looking for handler {} ",lcHandlerDeclaration); + try{ + lfManager=(LifecycleManager) ImplementationProvider.get().getPluginManager().getObject().get(lcHandlerDeclaration.getId()); + if(lfManager==null) throw new ConfigurationException("Unable to find Lifecycle Manager Plugin. ID "+lcHandlerDeclaration.getId()); + }catch(ClassCastException e){ + throw new ConfigurationException("Unable to use "+lcHandlerDeclaration.getId()+" as Lifecycle Manager"); + } + } diff --git a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/providers/PluginManager.java b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/providers/PluginManager.java index 741a179..bf2f9ad 100644 --- a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/providers/PluginManager.java +++ b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/providers/PluginManager.java @@ -1,25 +1,110 @@ package org.gcube.application.geoportal.service.engine.providers; +import lombok.extern.slf4j.Slf4j; +import org.gcube.application.cms.plugins.InitializablePlugin; import org.gcube.application.cms.plugins.Plugin; +import org.gcube.application.cms.plugins.faults.InitializationException; +import org.gcube.application.cms.plugins.faults.ShutDownException; +import org.gcube.application.cms.plugins.reports.InitializationReport; +import org.gcube.application.geoportal.common.utils.ContextUtils; import org.gcube.application.geoportal.service.model.internal.faults.ConfigurationException; +import org.reflections.Reflections; +import org.reflections.util.ConfigurationBuilder; +import org.reflections.util.FilterBuilder; + +import java.util.HashMap; import java.util.Map; +import java.util.ServiceLoader; -public class PluginManager implements Engine>{ +@Slf4j +public class PluginManager extends AbstractScopedMap>{ + Map implementations=new HashMap<>(); + + + public PluginManager(){ + super("Plugin Cache"); + // reflections + + Reflections reflections = new Reflections( + new ConfigurationBuilder() + .forPackage("org.gcube.application.cms") + .filterInputsBy(new FilterBuilder().includePackage("org.gcube.application.cms"))); + + reflections.getSubTypesOf(Plugin.class).iterator().forEachRemaining(pluginClass->{ + if(!pluginClass.isInterface()){ + try { + Plugin plugin = pluginClass.newInstance(); + log.debug("Loading {} descriptiorn : ", plugin, plugin.getDescriptor()); + implementations.put(plugin.getDescriptor().getId(), plugin); + }catch (Throwable t){ + log.warn("Unable to instantiate Plugin "+pluginClass,t); + } + } + + }); + + log.info("Loaded {} plugins",implementations.keySet().size()); + + // Init plugins + implementations.forEach((id,p)->{ + if(p instanceof InitializablePlugin){ + log.info("INIT Plugin {}",id); + try { + InitializablePlugin ip=(InitializablePlugin) p; + InitializationReport rep=ip.init(); + log.info("INIT REPORT : {}",rep); + }catch (InitializationException e){ + log.error("Failed to initialize "+id,e); + }catch(Throwable t){ + log.error("Unable to initialize "+id,t); + } + } + }); + } + + + @Override + protected Map retrieveObject() throws ConfigurationException { + // Init plugins + implementations.forEach((id,p)->{ + if(p instanceof InitializablePlugin){ + log.info("INIT Plugin {} in context {} ",id, ContextUtils.getCurrentScope()); + try { + InitializablePlugin ip=(InitializablePlugin) p; + InitializationReport rep=ip.initInContext(); + log.info("INIT REPORT : {}",rep); + }catch (InitializationException e){ + log.error("Failed to initialize "+id,e); + }catch(Throwable t){ + log.error("Unable to initialize "+id,t); + } + } + }); + return implementations; + } + + @Override + protected void dispose(Map toDispose) { + // ShutDown plugins + implementations.forEach((id,p)->{ + if(p instanceof InitializablePlugin){ + log.info("Shutting down Plugin {}",id); + try { + InitializablePlugin ip=(InitializablePlugin) p; + ip.shutdown(); + }catch (ShutDownException e){ + log.error("Failed to shutdown "+id,e); + }catch(Throwable t){ + log.error("Unable to shutdown "+id,t); + } + } + }); + } @Override public void init() { } - - @Override - public void shutdown() { - - } - - @Override - public Map getObject() throws ConfigurationException { - return null; - } } diff --git a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/providers/ProfileMapCache.java b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/providers/ProfileMapCache.java index 4848361..4545e6d 100644 --- a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/providers/ProfileMapCache.java +++ b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/engine/providers/ProfileMapCache.java @@ -9,7 +9,6 @@ import org.gcube.application.geoportal.service.utils.Serialization; import java.io.IOException; import java.nio.charset.Charset; -import java.util.Collections; import java.util.HashMap; import java.util.Map; @@ -40,7 +39,7 @@ public class ProfileMapCache extends AbstractScopedMap> { try { Profile p=Serialization.read(Files. - readFileAsString(Files.getFileFromResources("profiles/concessione.json").getAbsolutePath(), Charset.defaultCharset()), Profile.class); + readFileAsString(Files.getFileFromResources("profiles/profiledConcessioni.json").getAbsolutePath(), Charset.defaultCharset()), Profile.class); log.debug("Loaded "+p.getName()+" ID "+p.getId()); toReturn.put(p.getId(),p); diff --git a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/utils/UserUtils.java b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/utils/UserUtils.java index 35dbab4..f7f7d7f 100644 --- a/geoportal-service/src/main/java/org/gcube/application/geoportal/service/utils/UserUtils.java +++ b/geoportal-service/src/main/java/org/gcube/application/geoportal/service/utils/UserUtils.java @@ -66,7 +66,12 @@ public class UserUtils { public AccountingInfo asInfo(){ AccountingInfo info=new AccountingInfo(); User user = new User(); - user.setUsername(this.getUser().getId()); + try{ + user.setUsername(this.getUser().getId()); + }catch(Exception e){ + log.warn("Unable to determine user id, using FAKE"); + user.setUsername("FAKE"); + } info.setUser(user); info.setInstant(LocalDateTime.now()); diff --git a/geoportal-service/src/main/resources/profiles/concessione.json b/geoportal-service/src/main/resources/profiles/profiledConcessioni.json similarity index 79% rename from geoportal-service/src/main/resources/profiles/concessione.json rename to geoportal-service/src/main/resources/profiles/profiledConcessioni.json index 2ec2cea..b75605f 100644 --- a/geoportal-service/src/main/resources/profiles/concessione.json +++ b/geoportal-service/src/main/resources/profiles/profiledConcessioni.json @@ -1,5 +1,5 @@ { - "id" : "legacyConcessioni", + "id" : "profiledConcessioni", "version" : "1.0.0", "name" : "Concessione", "description" : "Embedded profile for concessioni [mibac] management", @@ -10,7 +10,7 @@ }, "handlers" : [ { - "id" : "concessioniLifecycle", + "id" : "GNA-CONCESSIONI-LC", "type" : "LifecycleManagement"} ] } \ No newline at end of file diff --git a/geoportal-service/src/test/java/org/gcube/application/geoportal/service/ProjectTests.java b/geoportal-service/src/test/java/org/gcube/application/geoportal/service/ProjectTests.java index c7caa71..8b7e51b 100644 --- a/geoportal-service/src/test/java/org/gcube/application/geoportal/service/ProjectTests.java +++ b/geoportal-service/src/test/java/org/gcube/application/geoportal/service/ProjectTests.java @@ -17,7 +17,7 @@ import static org.junit.Assert.assertEquals; public class ProjectTests extends BasicServiceTestUnit{ - String testProfileId="legacyConcessioni"; + String testProfileId="profiledConcessioni"; @Before public void setContext(){ @@ -36,7 +36,18 @@ public class ProjectTests extends BasicServiceTestUnit{ public void getAll() { System.out.println(target(InterfaceConstants.Methods.PROJECTS).path(testProfileId).request(MediaType.APPLICATION_JSON).get(List.class)); } - + + @Test + public void registerNew() { + WebTarget target=target(InterfaceConstants.Methods.PROJECTS); + + Document document =new Document(Collections.singletonMap("dumbKey","dumbValue")); + System.out.println(target.path(testProfileId).request(MediaType.APPLICATION_JSON). + post(Entity.entity(document, MediaType.APPLICATION_JSON))); + } + + + // @Test // public void getFilteredAll() { // WebTarget target=target(InterfaceConstants.Methods.PROJECTS); @@ -71,14 +82,6 @@ public class ProjectTests extends BasicServiceTestUnit{ // } // // -// @Test -// public void registerNew() { -// WebTarget target=target(InterfaceConstants.Methods.PROJECTS); -// Document document =new Document(Collections.singletonMap("key", "value")); -// -// System.out.println(target.path(testProfileId).request(MediaType.APPLICATION_JSON). -// put(Entity.entity(document, MediaType.APPLICATION_JSON))); -// } // // @Test // public void updateDocument() { diff --git a/pom.xml b/pom.xml index d2c300a..88bee6d 100644 --- a/pom.xml +++ b/pom.xml @@ -44,7 +44,9 @@ - concessioni-use-case + concessioni-lifecycle + concessioni-model + @@ -111,10 +113,23 @@ org.gcube.application.cms - concessioni-use-case + concessioni-model [1.0.0-SNAPSHOT,2.0.0) + + org.gcube.application.cms + concessioni-lifecycle + [1.0.0-SNAPSHOT,2.0.0) + + + + org.reflections + reflections + 0.10.2 + + + org.projectlombok lombok