From 201da009aedc1ec4b2847efc177a0b8fa67cbb15 Mon Sep 17 00:00:00 2001 From: Fabio Sinibaldi Date: Tue, 7 Dec 2021 12:16:29 +0100 Subject: [PATCH] Introduced LifecycleManager interface --- CHANGELOG.md | 5 +- cms-plugin-framework/CHANGELOG.md | 6 + cms-plugin-framework/FUNDING.md | 26 ++ cms-plugin-framework/LICENSE.md | 312 ++++++++++++++++++ cms-plugin-framework/README.md | 53 +++ cms-plugin-framework/pom.xml | 45 +++ .../cms/plugins/InitializablePlugin.java | 28 ++ .../cms/plugins/LifecycleManager.java | 12 + .../gcube/application/cms/plugins/Plugin.java | 8 + .../faults/InitializationException.java | 23 ++ .../cms/plugins/faults/ShutDownException.java | 23 ++ .../cms/plugins/faults/StepException.java | 23 ++ .../cms/plugins/model/PluginDescriptor.java | 20 ++ .../cms/plugins/reports/ExecutionReport.java | 9 + .../plugins/reports/InitializationReport.java | 6 + .../cms/plugins/reports/Report.java | 16 + .../requests/StepExecutionRequest.java | 15 + cms-test-commons/pom.xml | 2 +- geoportal-client/pom.xml | 2 +- geoportal-common/pom.xml | 2 +- .../geoportal/common/model/profile/Field.java | 3 +- .../common/model/profile/Profile.java | 3 +- geoportal-service/pom.xml | 2 +- .../engine/providers/ProfileMapCache.java | 19 +- pom.xml | 17 +- use-cases/pom.xml | 2 +- 26 files changed, 667 insertions(+), 15 deletions(-) create mode 100644 cms-plugin-framework/CHANGELOG.md create mode 100644 cms-plugin-framework/FUNDING.md create mode 100644 cms-plugin-framework/LICENSE.md create mode 100644 cms-plugin-framework/README.md create mode 100644 cms-plugin-framework/pom.xml create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/InitializablePlugin.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/LifecycleManager.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/Plugin.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/InitializationException.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/ShutDownException.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/StepException.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/model/PluginDescriptor.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/ExecutionReport.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/InitializationReport.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/Report.java create mode 100644 cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/StepExecutionRequest.java diff --git a/CHANGELOG.md b/CHANGELOG.md index 9ee37d4..eafafe4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,5 +2,8 @@ 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.1-SNAPSHOT] - 2021-12-07 +- Introduced cms-plugin-framework + ## [v1.0.0] - 2021-2-11 -- First release \ No newline at end of file +- First release diff --git a/cms-plugin-framework/CHANGELOG.md b/cms-plugin-framework/CHANGELOG.md new file mode 100644 index 0000000..b49a97b --- /dev/null +++ b/cms-plugin-framework/CHANGELOG.md @@ -0,0 +1,6 @@ +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +# Changelog for org.gcube.application.cms-plugin-framework + +## [v1.0.0-SNAPSHOT] 2021-09-20 +- First release \ No newline at end of file diff --git a/cms-plugin-framework/FUNDING.md b/cms-plugin-framework/FUNDING.md new file mode 100644 index 0000000..9e48b94 --- /dev/null +++ b/cms-plugin-framework/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/cms-plugin-framework/LICENSE.md b/cms-plugin-framework/LICENSE.md new file mode 100644 index 0000000..3af0507 --- /dev/null +++ b/cms-plugin-framework/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/cms-plugin-framework/README.md b/cms-plugin-framework/README.md new file mode 100644 index 0000000..1fd3533 --- /dev/null +++ b/cms-plugin-framework/README.md @@ -0,0 +1,53 @@ +CMS - Plugin Framework +-------------------------------------------------- + +CMS Plugin Framework is a library containing the definition of Java interfaces that plugins should implement + +## 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 +* [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). + +## 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/cms-plugin-framework/pom.xml b/cms-plugin-framework/pom.xml new file mode 100644 index 0000000..7e62959 --- /dev/null +++ b/cms-plugin-framework/pom.xml @@ -0,0 +1,45 @@ + + + 4.0.0 + + org.gcube.application + cms-plugin-framework + 1.0.0-SNAPSHOT + + + org.gcube.application.cms + gcube-cms-suite + 1.0.1-SNAPSHOT + + + + + https://code-repo.d4science.org/gCubeSystem + 1.0 + + + + + + + scm:git:${gitBaseUrl}/gcube-cms-suite + scm:git:${gitBaseUrl}/gcube-cms-suite + ${gitBaseUrl}/gcube-cms-suite + + + + + + org.gcube.application + geoportal-common + + + + org.projectlombok + lombok + + + + \ No newline at end of file diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/InitializablePlugin.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/InitializablePlugin.java new file mode 100644 index 0000000..dee80c0 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/InitializablePlugin.java @@ -0,0 +1,28 @@ +package org.gcube.application.cms.plugins; + +import org.gcube.application.cms.plugins.faults.InitializationException; +import org.gcube.application.cms.plugins.faults.ShutDownException; +import org.gcube.application.cms.plugins.reports.InitializationReport; + +public interface InitializablePlugin { + /** + * To be called once per context + * @return + * @throws InitializationException + */ + + public InitializationReport initInContext()throws InitializationException; + + /** + * To be called for static initialization + * @return + * @throws InitializationException + */ + public InitializationReport init()throws InitializationException; + + /** + * To be called at application shutdown + * @throws ShutDownException + */ + public void shutdown() throws ShutDownException; +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/LifecycleManager.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/LifecycleManager.java new file mode 100644 index 0000000..63cd40f --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/LifecycleManager.java @@ -0,0 +1,12 @@ +package org.gcube.application.cms.plugins; + +import org.gcube.application.cms.plugins.faults.StepException; +import org.gcube.application.cms.plugins.reports.ExecutionReport; +import org.gcube.application.cms.plugins.requests.StepExecutionRequest; + +public interface LifecycleManager extends InitializablePlugin{ + + // Lifecycle operations + + public ExecutionReport performStep(StepExecutionRequest request)throws StepException; +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/Plugin.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/Plugin.java new file mode 100644 index 0000000..cac99a9 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/Plugin.java @@ -0,0 +1,8 @@ +package org.gcube.application.cms.plugins; + +import org.gcube.application.cms.plugins.model.PluginDescriptor; + +public interface Plugin { + + public PluginDescriptor getDescriptor(); +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/InitializationException.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/InitializationException.java new file mode 100644 index 0000000..177e5d6 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/InitializationException.java @@ -0,0 +1,23 @@ +package org.gcube.application.cms.plugins.faults; + +public class InitializationException extends Exception{ + + public InitializationException() { + } + + public InitializationException(String message) { + super(message); + } + + public InitializationException(String message, Throwable cause) { + super(message, cause); + } + + public InitializationException(Throwable cause) { + super(cause); + } + + public InitializationException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) { + super(message, cause, enableSuppression, writableStackTrace); + } +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/ShutDownException.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/ShutDownException.java new file mode 100644 index 0000000..c3584b1 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/ShutDownException.java @@ -0,0 +1,23 @@ +package org.gcube.application.cms.plugins.faults; + +public class ShutDownException extends Exception { + + public ShutDownException() { + } + + public ShutDownException(String message) { + super(message); + } + + public ShutDownException(String message, Throwable cause) { + super(message, cause); + } + + public ShutDownException(Throwable cause) { + super(cause); + } + + public ShutDownException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) { + super(message, cause, enableSuppression, writableStackTrace); + } +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/StepException.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/StepException.java new file mode 100644 index 0000000..39e5302 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/faults/StepException.java @@ -0,0 +1,23 @@ +package org.gcube.application.cms.plugins.faults; + +public class StepException extends Exception { + + public StepException() { + } + + public StepException(String message) { + super(message); + } + + public StepException(String message, Throwable cause) { + super(message, cause); + } + + public StepException(Throwable cause) { + super(cause); + } + + public StepException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) { + super(message, cause, enableSuppression, writableStackTrace); + } +} 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 new file mode 100644 index 0000000..290fa19 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/model/PluginDescriptor.java @@ -0,0 +1,20 @@ +package org.gcube.application.cms.plugins.model; + +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NonNull; +import lombok.RequiredArgsConstructor; +import org.gcube.application.geoportal.common.model.document.ComparableVersion; + +@Data +@RequiredArgsConstructor +@AllArgsConstructor +public class PluginDescriptor { + + @NonNull + private String ID; + private String label; + private String description; + private ComparableVersion version; + +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/ExecutionReport.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/ExecutionReport.java new file mode 100644 index 0000000..191d0f0 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/ExecutionReport.java @@ -0,0 +1,9 @@ +package org.gcube.application.cms.plugins.reports; + +import org.gcube.application.cms.plugins.requests.StepExecutionRequest; + +public class ExecutionReport extends Report{ + + StepExecutionRequest request; + +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/InitializationReport.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/InitializationReport.java new file mode 100644 index 0000000..58638ae --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/InitializationReport.java @@ -0,0 +1,6 @@ +package org.gcube.application.cms.plugins.reports; + +public class InitializationReport { + + +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/Report.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/Report.java new file mode 100644 index 0000000..58b9755 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/reports/Report.java @@ -0,0 +1,16 @@ +package org.gcube.application.cms.plugins.reports; + +import lombok.Data; + +import java.util.List; + +@Data +public class Report { + + public static enum Status { + ERROR,WARNING,OK + } + + private Status status; + private List messages; +} diff --git a/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/StepExecutionRequest.java b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/StepExecutionRequest.java new file mode 100644 index 0000000..ba64f67 --- /dev/null +++ b/cms-plugin-framework/src/main/java/org/gcube/application/cms/plugins/requests/StepExecutionRequest.java @@ -0,0 +1,15 @@ +package org.gcube.application.cms.plugins.requests; + +import lombok.Data; +import org.bson.Document; +import org.gcube.application.geoportal.common.model.document.ProfiledDocument; +import org.gcube.application.geoportal.common.model.profile.Profile; + +@Data +public class StepExecutionRequest { + + Profile profile; + ProfiledDocument document; + String step; + Document callParameters; +} diff --git a/cms-test-commons/pom.xml b/cms-test-commons/pom.xml index 5e8a717..dd1ff3f 100644 --- a/cms-test-commons/pom.xml +++ b/cms-test-commons/pom.xml @@ -12,7 +12,7 @@ org.gcube.application.cms gcube-cms-suite - 1.0.0 + 1.0.1-SNAPSHOT diff --git a/geoportal-client/pom.xml b/geoportal-client/pom.xml index 82ca912..a7eb25c 100644 --- a/geoportal-client/pom.xml +++ b/geoportal-client/pom.xml @@ -11,7 +11,7 @@ org.gcube.application.cms gcube-cms-suite - 1.0.0 + 1.0.1-SNAPSHOT diff --git a/geoportal-common/pom.xml b/geoportal-common/pom.xml index 80e8b89..9d220b3 100644 --- a/geoportal-common/pom.xml +++ b/geoportal-common/pom.xml @@ -11,7 +11,7 @@ org.gcube.application.cms gcube-cms-suite - 1.0.0 + 1.0.1-SNAPSHOT diff --git a/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/profile/Field.java b/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/profile/Field.java index dd59a37..75bd604 100644 --- a/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/profile/Field.java +++ b/geoportal-common/src/main/java/org/gcube/application/geoportal/common/model/profile/Field.java @@ -1,8 +1,9 @@ package org.gcube.application.geoportal.common.model.profile; +import lombok.Data; import lombok.Getter; -@Getter +@Data public class Field { 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 258c5ab..8e7f3f4 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 @@ -4,10 +4,11 @@ import java.util.List; import javax.xml.bind.annotation.XmlRootElement; +import lombok.Data; import lombok.Getter; import lombok.NoArgsConstructor; -@Getter +@Data @NoArgsConstructor @XmlRootElement public class Profile{ diff --git a/geoportal-service/pom.xml b/geoportal-service/pom.xml index 83b8b38..4431742 100644 --- a/geoportal-service/pom.xml +++ b/geoportal-service/pom.xml @@ -11,7 +11,7 @@ org.gcube.application.cms gcube-cms-suite - 1.0.0 + 1.0.1-SNAPSHOT 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 d9a8eb4..e7e195d 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 @@ -3,31 +3,38 @@ package org.gcube.application.geoportal.service.engine.providers; import org.gcube.application.geoportal.common.model.profile.Profile; import org.gcube.application.geoportal.service.model.internal.faults.ConfigurationException; +import java.util.Collections; import java.util.Map; public class ProfileMapCache extends AbstractScopedMap> { - public ProfileMapCache(String name) { - super(name); - // TODO Auto-generated constructor stub + public ProfileMapCache() { + super("Profiles CACHE"); + } @Override public void init() { - // TODO Auto-generated method stub } @Override protected void dispose(Map toDispose) { - // TODO Auto-generated method stub - + } @Override protected Map retrieveObject() throws ConfigurationException { // TODO Auto-generated method stub + + Profile p=new Profile(); + p. + + + return Collections.singletonMap("") + + return null; } diff --git a/pom.xml b/pom.xml index bec41f5..68e27e7 100644 --- a/pom.xml +++ b/pom.xml @@ -9,7 +9,7 @@ org.gcube.application.cms gcube-cms-suite pom - 1.0.0 + 1.0.1-SNAPSHOT Gcube CMS Suite gCube CMS Suite is a set of components designed to manage complex space-temporal Documents defined by metadata Profiles. @@ -34,8 +34,16 @@ geoportal-service + + cms-plugin-framework + geoportal-client geoportal-common + + + + + cms-test-commons use-cases @@ -69,6 +77,13 @@ geoportal-service [1.0.6-SNAPSHOT,2.0.0) + + + org.gcube.application + cms-plugin-framework + [1.0.0-SNAPSHOT,2.0.0) + + org.gcube.application geoportal-client diff --git a/use-cases/pom.xml b/use-cases/pom.xml index 646bac3..5f1da74 100644 --- a/use-cases/pom.xml +++ b/use-cases/pom.xml @@ -9,7 +9,7 @@ gcube-cms-suite org.gcube.application.cms - 1.0.0 + 1.0.1-SNAPSHOT