Compare commits

...

19 Commits

Author SHA1 Message Date
Francesco Mangiacrapa 70731aa1a9 just to rebuild -SNAPSHOT 2022-02-01 14:37:08 +01:00
Francesco Mangiacrapa ad81920ab3 Updated the CHANGELOG as required at #19555 2020-07-01 14:36:31 +02:00
Francesco Mangiacrapa a0835a37e7 only added the 'v' in the tag 2020-06-25 17:52:51 +02:00
Francesco Mangiacrapa 328d62cb41 only added the include to CHANGELOG.md 2020-06-23 18:12:43 +02:00
Francesco Mangiacrapa 951c1761f3 fixed tag at [2.12.1] [r4.24.0] 2020-06-22 17:37:53 +02:00
Francesco Mangiacrapa b28e98969d ready to be released. Removed -SNAPSHOT 2020-06-18 15:12:26 +02:00
Francesco Mangiacrapa b7816983f1 resourceExists now checks if the URL is reachable and print the error 2020-06-16 18:02:11 +02:00
Francesco Mangiacrapa ec8c6182d4 only fixed a message 2020-06-16 16:47:28 +02:00
Francesco Mangiacrapa 4a342b2ec6 fixing Bug #19479 2020-06-16 15:31:54 +02:00
Francesco Mangiacrapa 82a1869316 Removed -SNAPSHOT 2019-11-13 12:38:28 +01:00
Francesco Mangiacrapa 3c48cb542e Merge branch 'feature/18039' 2019-11-13 12:37:24 +01:00
Francesco Mangiacrapa bacb92dc5a Added test/resources ignore 2019-11-13 12:21:39 +01:00
Francesco Mangiacrapa 6a11bcdd99 Changed two logs 2019-11-13 11:43:11 +01:00
Francesco Mangiacrapa b412e2718d Added test/resources ignore 2019-11-13 11:31:18 +01:00
Francesco Mangiacrapa e2a3a37065 added and cheched JUnit Test case 2019-11-13 11:12:44 +01:00
Francesco Mangiacrapa edc1d8910e Added the method 'getMapAccessURLToCatalogue' to DataCatalogueImpl 2019-11-12 17:42:01 +01:00
Francesco Mangiacrapa 33e299c7a1 Updated the getPortletUrlFromInfrastrucure to return a Map of Access to
different Catalogue URLs
2019-11-12 17:26:25 +01:00
Francesco Mangiacrapa db50719788 Updated changelog 2019-11-12 17:03:42 +01:00
Francesco Mangiacrapa 1194e02ec2 enhanced version to 2.12.0 2019-11-12 17:02:02 +01:00
17 changed files with 903 additions and 56 deletions

View File

@ -6,14 +6,19 @@
<attribute name="maven.pomderived" value="true"/>
</attributes>
</classpathentry>
<classpathentry kind="src" path="src/main/resources"/>
<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 kind="src" path="src/test/resources"/>
<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="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
<attributes>
<attribute name="maven.pomderived" value="true"/>

View File

@ -1,4 +1,5 @@
eclipse.preferences.version=1
encoding//src/main/java=UTF-8
encoding//src/test/java=UTF-8
encoding//src/test/resources=UTF-8
encoding/<project>=UTF-8

View File

@ -3,6 +3,9 @@ org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.8
org.eclipse.jdt.core.compiler.compliance=1.8
org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
org.eclipse.jdt.core.compiler.problem.enablePreviewFeatures=disabled
org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
org.eclipse.jdt.core.compiler.problem.forbiddenReference=warning
org.eclipse.jdt.core.compiler.problem.reportPreviewFeatures=ignore
org.eclipse.jdt.core.compiler.release=disabled
org.eclipse.jdt.core.compiler.source=1.8

View File

@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?><project-modules id="moduleCoreId" project-version="1.5.0">
<wb-module deploy-name="ckan-util-library">
<wb-resource deploy-path="/" source-path="/src/main/java"/>
<wb-resource deploy-path="/" source-path="/src/main/resources"/>
</wb-module>
</project-modules>

135
CHANGELOG.md Normal file
View File

@ -0,0 +1,135 @@
# Changelog
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [v2.12.1-SNAPSHOT] [r4.24.0] - 2020-06-18
**Bug fixes**
[#19479] Add Resource facility does not work
## [v2.12.0] - 2019-11-13
[Feature #18039] Ckan-Util-Library: read the vre-public-url into GR "CkanPortlet"
## [v2.10.0] - 2019-08-01
[Task #16895] Try to patch some methods of the jackan library
## [v2.9.0] - 2019-04-11
[Task #16471] Migrate to new Catalogue Resolver
## [v2.8.1] - ${buildDate}
Added title on updated of records refs #16395
## [v2.8.1] - 2019-02-26
Fixed Bug on social post publishing
## [v2.8.0] - 2018-11-20
Patched method DataCatalogueImpl#getPortletURL
## [v2.7.0] - 2018-10-10
Added the possibility to deny social post on catalogue-ws #12514
## [v2.6.0] - 2018-07-18
Enhance timeout in requests to CKAN in ckan-util-library #12050
## [v2.5.0] - 2018-02-28
Code cleanup
## [v2.4.2] - 2018-02-28
Portlet url is built on the fly (#11294)
## [v2.4.1] - 2018-01-10
Minor fix for delegates
Added support for statistics (requires solrj)
Added method for retrieving main landing pages
## [v2.4.0] - 2017-11-01
Added delegate roles method
Added search methods for datasets
## [v2.3.2] - 2017-08-01
Minor fixes
## [v2.3.1] - 2017-07-01
Mime type fix for resources
## [v2.3.0] - 2017-05-01
Pom fixes
Moved to java 8
Added method to add a dataset to a group and its parents (if any)
## [v2.2.1] - 2017-04-01
Some minor changes
## [v2.2.0] - 2017-02-01
Added method to delete/purge group
Project structure and so packages are changed (gwt-widget like structure)
## [v2.1.0] - 2016-12-01
Product creation methods improved
Added method to get the group list
Added methods to manage groups
Added method to patch product/resource
## [v2.0.0] - 2016-11-01
Added support for datasets's relationships (create, delete, retrieve methods)
Added Factory in order to reduce the number of created instances of the utils class(cache)
Added code to discover a new Application Profile (see ticket #4925)
Added methods to manage group creation, assing a user/product to a group
## [v1.0.0] - 2016-06-01
First Release

311
LICENSE.md Normal file
View File

@ -0,0 +1,311 @@
#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 Licensees 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

59
README.md Normal file
View File

@ -0,0 +1,59 @@
# CKAN util library
Utility library to retrieve users information, organizations information and so on from the D4Science Catalogue
powered by CKAN
## Built With
* [OpenJDK](https://openjdk.java.net/) - The JDK used
* [Maven](https://maven.apache.org/) - Dependency Management
## Documentation
You can find the D4Science Catalogue documentation at [GCat Background Wiki Page](https://wiki.gcube-system.org/GCat_Background)
## Change log
See the [Releases](https://code-repo.d4science.org/gCubeSystem/ckan-util-library/releases)
## Authors
* **Costantino Perciante**
* **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);
- EUBrazilOpenBio (grant no. 288754);
- iMarine(grant no. 283644).
- the H2020 research and innovation programme
- BlueBRIDGE (grant no. 675680);
- EGIEngage (grant no. 654142);
- ENVRIplus (grant no. 654182);
- PARTHENOS (grant no. 654119);
- SoBigData (grant no. 654024);
- DESIRA (grant no. 818194);
- ARIADNEplus (grant no. 823914);
- RISIS2 (grant no. 824091);
- PerformFish (grant no. 727610);
- AGINFRAplus (grant no. 731001).

137
changelog.xml Normal file
View File

@ -0,0 +1,137 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<ReleaseNotes>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-12-1"
date="2020-06-18">
<Change>[#19479] Add Resource facility does not work</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-12-0"
date="${buildDate}">
<Change>[Feature #18039] Ckan-Util-Library: read the vre-public-url
into GR "CkanPortlet"</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-10-0"
date="${buildDate}">
<Change>[Task #16895] Try to patch some methods of the jackan library</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-9-0"
date="${buildDate}">
<Change>[Task #16471] Migrate to new Catalogue Resolver</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-8-1"
date="${buildDate}">
<Change>Added title on updated of records refs #16395</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-8-1"
date="2019-02-26">
<Change>Fixed Bug on social post publishing</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-8-0"
date="2018-11-20">
<Change>Patched method DataCatalogueImpl#getPortletURL</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-7-0"
date="2018-10-10">
<Change>Added the possibility to deny social post on catalogue-ws
#12514</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-6-0"
date="2018-07-18">
<Change>Enhance timeout in requests to CKAN in ckan-util-library
#12050</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-5-0"
date="2018-02-28">
<Change>Code cleanup</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-4-2"
date="2018-02-28">
<Change>Portlet url is built on the fly (#11294)</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-4-1"
date="2018-01-10">
<Change>Minor fix for delegates</Change>
<Change>Added support for statistics (requires solrj)</Change>
<Change>Added method for retrieving main landing pages</Change>
</Changeset>
Added title on updated of records refs #16395
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-4-0"
date="2017-11-01">
<Change>Added delegate roles method</Change>
<Change>Added search methods for datasets</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-3-2"
date="2017-08-01">
<Change>Minor fixes</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-3-1"
date="2017-07-01">
<Change>Mime type fix for resources</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-3-0"
date="2017-05-01">
<Change>Pom fixes</Change>
<Change>Moved to java 8</Change>
<Change>Added method to add a dataset to a group and its parents (if
any)
</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-2-1"
date="2017-04-01">
<Change>Some minor changes</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-2-0"
date="2017-02-01">
<Change>Added method to delete/purge group</Change>
<Change>Project structure and so packages are changed (gwt-widget like
structure)
</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-1-0"
date="2016-12-01">
<Change>Product creation methods improved</Change>
<Change>Added method to get the group list</Change>
<Change>Added methods to manage groups</Change>
<Change>Added method to patch product/resource</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-0-0"
date="2016-11-01">
<Change>Added support for datasets's relationships (create, delete,
retrieve methods)
</Change>
<Change>Added Factory in order to reduce the number of created
instances of the utils class(cache)
</Change>
<Change>Added code to discover a new Application Profile (see ticket
#4925)
</Change>
<Change>Added methods to manage group creation, assing a user/product
to a group
</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.1-0-0"
date="2016-06-01">
<Change>First Release</Change>
</Changeset>
</ReleaseNotes>

30
descriptor.xml Normal file
View File

@ -0,0 +1,30 @@
<assembly
xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
<id>servicearchive</id>
<formats>
<format>tar.gz</format>
</formats>
<baseDirectory>/</baseDirectory>
<fileSets>
<fileSet>
<outputDirectory>/</outputDirectory>
<useDefaultExcludes>true</useDefaultExcludes>
<includes>
<include>README.md</include>
<include>LICENSE.md</include>
<include>profile.xml</include>
<include>CHANGELOG.md</include>
</includes>
<fileMode>755</fileMode>
<filtered>true</filtered>
</fileSet>
</fileSets>
<files>
<file>
<source>target/${build.finalName}.${project.packaging}</source>
<outputDirectory>/${artifactId}</outputDirectory>
</file>
</files>
</assembly>

View File

@ -1,6 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE xml>
<ReleaseNotes>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-12-0"
date="${buildDate}">
<Change>[Feature #18039] Ckan-Util-Library: read the vre-public-url into GR "CkanPortlet"</Change>
</Changeset>
<Changeset
component="org.gcube.data-catalogue.ckan-util-library.2-10-0"
date="${buildDate}">

View File

@ -11,7 +11,7 @@
</parent>
<groupId>org.gcube.data-catalogue</groupId>
<artifactId>ckan-util-library</artifactId>
<version>2.11.0</version>
<version>2.12.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>CKan utility library</name>

25
profile.xml Normal file
View File

@ -0,0 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?>
<Resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ID></ID>
<Type>Service</Type>
<Profile>
<Description>${project.description}</Description>
<Class>PortletWidget</Class>
<Name>${project.artifactId}</Name>
<Version>1.0.0</Version>
<Packages>
<Software>
<Name>${project.artifactId}</Name>
<Description>${project.description}</Description>
<MavenCoordinates>
<groupId>${project.groupId}</groupId>
<artifactId>${project.artifactId}</artifactId>
<version>${project.version}</version>
</MavenCoordinates>
<Files>
<File>${project.build.finalName}.${project.packaging}</File>
</Files>
</Software>
</Packages>
</Profile>
</Resource>

View File

@ -31,6 +31,7 @@ import org.apache.solr.client.solrj.response.FacetField.Count;
import org.apache.solr.client.solrj.response.QueryResponse;
import org.gcube.common.scope.impl.ScopeBean;
import org.gcube.common.scope.impl.ScopeBean.Type;
import org.gcube.datacatalogue.ckanutillibrary.server.DataCatalogueRunningCluster.ACCESS_LEVEL_TO_CATALOGUE_PORTLET;
import org.gcube.datacatalogue.ckanutillibrary.server.utils.CatalogueUtilMethods;
import org.gcube.datacatalogue.ckanutillibrary.server.utils.url.EntityContext;
import org.gcube.datacatalogue.ckanutillibrary.shared.CKanUserWrapper;
@ -103,6 +104,8 @@ public class DataCatalogueImpl implements DataCatalogue{
private final static String PATH_SET_PRIVATE_DATASET = "/api/3/action/bulk_update_private";
private final static String PATH_SET_PUBLIC_DATASET = "/api/3/action/bulk_update_public";
private static final String CATALOGUE_TAB_ENDING_URL = "/catalogue";
public Map<ACCESS_LEVEL_TO_CATALOGUE_PORTLET, String> mapAccessURLToCatalogue;
// ckan client
private SimpleExtendCkanClient client;
@ -142,6 +145,7 @@ public class DataCatalogueImpl implements DataCatalogue{
CKAN_DB_PORT = runningInstance.getDatabasePorts().get(0);
CKAN_CATALOGUE_URL = runningInstance.getDataCatalogueUrl().get(0).trim();
PORTLET_URL_FOR_SCOPE = runningInstance.getPortletUrl().trim();
mapAccessURLToCatalogue = runningInstance.getMapAccessURLToCatalogue();
MANAGE_PRODUCT_BUTTON = runningInstance.isManageProductEnabled();
URI_RESOLVER_URL = runningInstance.getUrlResolver();
SOCIAL_POST = runningInstance.isSocialPostEnabled();
@ -663,8 +667,16 @@ public class DataCatalogueImpl implements DataCatalogue{
checkNotNull(resourceBean);
checkNotNull(apiKey);
checkArgument(!apiKey.isEmpty());
boolean isReachableURL = true;
try {
isReachableURL = CatalogueUtilMethods.resourceExists(resourceBean.getUrl());
} catch (Exception e) {
throw new Exception("It seems the resource at this url " + resourceBean.getUrl()+" is not reachable. Error: "+e.getMessage());
}
if(CatalogueUtilMethods.resourceExists(resourceBean.getUrl())){
if(isReachableURL){
// in order to avoid errors, the username is always converted
String ckanUsername = CatalogueUtilMethods.fromUsernameToCKanUsername(resourceBean.getOwner());
@ -693,7 +705,8 @@ public class DataCatalogueImpl implements DataCatalogue{
}
}else
throw new Exception("It seems there is no is no resource at this url " + resourceBean.getUrl());
throw new Exception("It seems there is no resource at this url " + resourceBean.getUrl());
return null;
}
@ -3022,5 +3035,15 @@ public class DataCatalogueImpl implements DataCatalogue{
public boolean isSocialPostEnabled() {
return SOCIAL_POST;
}
/**
* Gets the map access URL to catalogue.
*
* @return the map access URL to catalogue. For each {@link ACCESS_LEVEL_TO_CATALOGUE_PORTLET} contains the URL to the Catalogue Portlet
*/
public Map<ACCESS_LEVEL_TO_CATALOGUE_PORTLET, String> getMapAccessURLToCatalogue() {
return mapAccessURLToCatalogue;
}
}

View File

@ -39,8 +39,10 @@ import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* Retrieve ckan running instance information in the infrastructure (for both its database and data catalogue url)
* Retrieve ckan running instance information in the infrastructure (for both its database and data catalogue url).
*
* @author Costantino Perciante at ISTI-CNR (costantino.perciante@isti.cnr.it)
* updated by Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it)
*/
public class DataCatalogueRunningCluster {
@ -97,12 +99,30 @@ public class DataCatalogueRunningCluster {
public static final String TUPLES_SEPARATOR = ",";
private static final String DEFAULT_CATALOGUE_EMAIL = "catalogue@d4science.org";
/**
* The Enum ACCESS_LEVEL_TO_CATALOGUE_PORTLET.
*
* @author Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it)
*
* Nov 12, 2019
*/
//Added by Francesco, see #18039
public static final String PUBLIC_VRE_CATALOGUE_URL = "public-vre-url";
public static enum ACCESS_LEVEL_TO_CATALOGUE_PORTLET {PUBLIC_GATEWAY, PUBLIC_VRE, PRIVATE_VRE};
public Map<ACCESS_LEVEL_TO_CATALOGUE_PORTLET, String> mapAccessURLToCatalogue;
// this token is needed in order to assign roles to user
private String sysAdminToken;
private String catalogueEmail;
/**
* Instantiates a new data catalogue running cluster.
*
* @param scope the scope
* @throws Exception the exception
*/
public DataCatalogueRunningCluster(String scope) throws Exception{
if(scope == null || scope.isEmpty())
@ -131,8 +151,10 @@ public class DataCatalogueRunningCluster {
logger.debug("Looking for portlet url in " + ScopeProvider.instance.get() + " scope" );
portletUrl = getPortletUrlFromInfrastrucure();
//portletUrl = getPortletUrlFromInfrastrucure();
mapAccessURLToCatalogue = getPortletUrlFromInfrastrucure();
portletUrl = mapAccessURLToCatalogue.get(ACCESS_LEVEL_TO_CATALOGUE_PORTLET.PRIVATE_VRE);
// and parse the CatalogueDelegateRole resource, if any, in this context
parseExtendingRoles();
@ -146,10 +168,11 @@ public class DataCatalogueRunningCluster {
/**
* Evaluate the right configuration about ckan
* @param resources
* @throws NoDataCatalogueRuntimeResourceException
* @throws ServiceEndPointException
* Evaluate the right configuration about ckan.
*
* @param resources the resources
* @throws NoDataCatalogueRuntimeResourceException the no data catalogue runtime resource exception
* @throws ServiceEndPointException the service end point exception
*/
private void evaluateRightConfigurationCatalogue(
List<ServiceEndpoint> resources) throws NoDataCatalogueRuntimeResourceException, ServiceEndPointException {
@ -272,10 +295,11 @@ public class DataCatalogueRunningCluster {
}
/**
* Retrieve the right DB information
* @param resources
* @throws ServiceEndPointException
* @throws NoDataCatalogueRuntimeResourceException
* Retrieve the right DB information.
*
* @param resources the resources
* @throws ServiceEndPointException the service end point exception
* @throws NoDataCatalogueRuntimeResourceException the no data catalogue runtime resource exception
*/
private void evaluateRightConfigurationDB(List<ServiceEndpoint> resources) throws ServiceEndPointException, NoDataCatalogueRuntimeResourceException {
@ -362,9 +386,10 @@ public class DataCatalogueRunningCluster {
}
/**
* Retrieve endpoints information from IS for DB
* Retrieve endpoints information from IS for DB.
*
* @return list of endpoints for ckan database
* @throws Exception
* @throws Exception the exception
*/
private static List<ServiceEndpoint> getConfigurationFromISFORDB() throws Exception{
@ -378,9 +403,10 @@ public class DataCatalogueRunningCluster {
}
/**
* Retrieve endpoints information from IS for DataCatalogue URL
* Retrieve endpoints information from IS for DataCatalogue URL.
*
* @return list of endpoints for ckan data catalogue
* @throws Exception
* @throws Exception the exception
*/
private static List<ServiceEndpoint> getConfigurationFromISFORCatalogueUrl() throws Exception{
@ -395,14 +421,17 @@ public class DataCatalogueRunningCluster {
/**
* Retrieve the url of the ckan portlet deployed into this scope
* @return
* updated by Francesco see Feature #18039.
*
* @return the portlet url from infrastrucure
*/
private static String getPortletUrlFromInfrastrucure() {
private static Map<ACCESS_LEVEL_TO_CATALOGUE_PORTLET,String> getPortletUrlFromInfrastrucure() {
String scope = ScopeProvider.instance.get();
logger.debug("Trying to fetch applicationProfile profile from the infrastructure for " + APPLICATION_PROFILE_NAME + " scope: " + scope);
Map<ACCESS_LEVEL_TO_CATALOGUE_PORTLET,String> mapAccess = new HashMap<ACCESS_LEVEL_TO_CATALOGUE_PORTLET,String>(3);
try {
Query q = new QueryBox("for $profile in collection('/db/Profiles/GenericResource')//Resource " +
"where $profile/Profile/SecondaryType/string() eq 'ApplicationProfile' and $profile/Profile/Name/string() " +
" eq '" + APPLICATION_PROFILE_NAME + "'" +
@ -422,8 +451,17 @@ public class DataCatalogueRunningCluster {
List<String> currValue = null;
currValue = helper.evaluate("/Resource/Profile/Body/url/text()");
if (currValue != null && currValue.size() > 0) {
logger.debug("Portlet url found is " + currValue.get(0));
return currValue.get(0);
logger.debug("Private portlet url found is " + currValue.get(0));
//return currValue.get(0);
mapAccess.put(ACCESS_LEVEL_TO_CATALOGUE_PORTLET.PRIVATE_VRE, currValue.get(0));
}
currValue = null;
currValue = helper.evaluate("/Resource/Profile/Body/"+PUBLIC_VRE_CATALOGUE_URL+"/text()");
if (currValue != null && currValue.size() > 0) {
logger.debug(PUBLIC_VRE_CATALOGUE_URL+" portlet url found is " + currValue.get(0));
//return currValue.get(0);
mapAccess.put(ACCESS_LEVEL_TO_CATALOGUE_PORTLET.PUBLIC_VRE, currValue.get(0));
}
}
@ -432,15 +470,16 @@ public class DataCatalogueRunningCluster {
logger.error("Error while trying to fetch applicationProfile profile from the infrastructure", e);
}
return null;
return mapAccess;
}
/**
* Parse the CatalogueDelegateRoles in this context
* @throws ParserConfigurationException
* @throws IOException
* @throws SAXException
* Parse the CatalogueDelegateRoles in this context.
*
* @throws ParserConfigurationException the parser configuration exception
* @throws SAXException the SAX exception
* @throws IOException Signals that an I/O exception has occurred.
*/
private void parseExtendingRoles() throws ParserConfigurationException, SAXException, IOException {
@ -500,7 +539,9 @@ public class DataCatalogueRunningCluster {
logger.debug("Extended role map in this scope is " + extendRoleInOrganization);
}
/** Retrieve the ckan portlet url
/**
* Retrieve the ckan portlet url.
*
* @return the portletUrl
*/
public String getPortletUrl() {
@ -508,7 +549,9 @@ public class DataCatalogueRunningCluster {
}
/**
* Retrieve data catalogue url
* Retrieve data catalogue url.
*
* @return the data catalogue url
*/
public List<String> getDataCatalogueUrl() {
return datacatalogueUrls;
@ -516,7 +559,8 @@ public class DataCatalogueRunningCluster {
/**
* Get the hosts for such resource.
* @return
*
* @return the database hosts
*/
public List<String> getDatabaseHosts() {
return hostsDB;
@ -524,7 +568,8 @@ public class DataCatalogueRunningCluster {
/**
* Get the ports for such resource.
* @return
*
* @return the database ports
*/
public List<Integer> getDatabasePorts() {
return portsDB;
@ -532,7 +577,8 @@ public class DataCatalogueRunningCluster {
/**
* Get the database name.
* @return
*
* @return the data base name
*/
public String getDataBaseName() {
return nameDB;
@ -540,7 +586,8 @@ public class DataCatalogueRunningCluster {
/**
* Get the database's user.
* @return
*
* @return the data base user
*/
public String getDataBaseUser() {
return userDB;
@ -548,13 +595,16 @@ public class DataCatalogueRunningCluster {
/**
* Get the database's password.
* @return
*
* @return the data base password
*/
public String getDataBasePassword() {
return passwordDB;
}
/**
* Gets the sys admin token.
*
* @return the sysAdminToken
*/
public String getSysAdminToken() {
@ -563,23 +613,26 @@ public class DataCatalogueRunningCluster {
/**
* Is manager product enabled (e.g., for GRSF records)
* @return
*
* @return true, if is manage product enabled
*/
public boolean isManageProductEnabled() {
return manageProductEnabled;
}
/**
* Get the url of the uri resolver for this instance/scope
* @return
* Get the url of the uri resolver for this instance/scope.
*
* @return the url resolver
*/
public String getUrlResolver() {
return urlResolver;
}
/**
* Check if alert user members is enabled
* @return
* Check if alert user members is enabled.
*
* @return true, if is alert enabled
*/
public boolean isAlertEnabled() {
return alertUsers;
@ -587,7 +640,8 @@ public class DataCatalogueRunningCluster {
/**
* Get roles to extend
* Get roles to extend.
*
* @return Map<String, String>
*/
public Map<String, String> getExtendRoleInOrganization() {
@ -595,23 +649,40 @@ public class DataCatalogueRunningCluster {
}
/**
* Get the solr index base url
* @return
* Get the solr index base url.
*
* @return the url solr
*/
public String getUrlSolr() {
return urlSolr;
}
/**
* Gets the map access URL to catalogue.
*
* @return the map access URL to catalogue
*/
public Map<ACCESS_LEVEL_TO_CATALOGUE_PORTLET, String> getMapAccessURLToCatalogue() {
return mapAccessURLToCatalogue;
}
/**
* Get the catalogue email. Default is "catalogue@d4science.org"
* @return
*
* @return the email catalogue
*/
public String getEmailCatalogue() {
logger.debug("Read email from resource is " + catalogueEmail);
return catalogueEmail == null? DEFAULT_CATALOGUE_EMAIL : catalogueEmail;
}
/**
* Checks if is social post enabled.
*
* @return true, if is social post enabled
*/
public boolean isSocialPostEnabled() {
return socialPost;
}

View File

@ -103,24 +103,30 @@ public class CatalogueUtilMethods {
* Utility method to check if a something at this url actually exists
* @param URLName
* @return
* @throws Exception
*/
public static boolean resourceExists(String URLName){
public static boolean resourceExists(String URLName) throws Exception{
if(URLName == null || URLName.isEmpty())
return false;
try {
//Commented by Francesco. Bug #19479. Why replacing https?
// replace https
String urlToTest = URLName.replace(HTTPS, HTTP);
HttpURLConnection.setFollowRedirects(true);
//String urlToTest = URLName.replace(HTTPS, HTTP);
String urlToTest = URLName;
logger.debug("Checking Http HEAD connection for " + urlToTest);
HttpURLConnection con = (HttpURLConnection) new URL(urlToTest).openConnection();
HttpURLConnection.setFollowRedirects(true);
con.setRequestMethod("HEAD");
logger.debug("Return code is " + con.getResponseCode());
return (con.getResponseCode() == HttpURLConnection.HTTP_OK);
//check if it is 2xx Success
return (200 <= con.getResponseCode() && con.getResponseCode()<300);
}
catch (Exception e) {
logger.error("Exception while checking url", e);
return false;
throw new Exception(e);
}
}

View File

@ -14,8 +14,8 @@ import org.gcube.datacatalogue.ckanutillibrary.server.utils.CatalogueUtilMethods
import org.gcube.datacatalogue.ckanutillibrary.shared.CKanUserWrapper;
import org.gcube.datacatalogue.ckanutillibrary.shared.CkanDatasetRelationship;
import org.gcube.datacatalogue.ckanutillibrary.shared.DatasetRelationships;
import org.gcube.datacatalogue.ckanutillibrary.shared.ResourceBean;
import org.gcube.datacatalogue.ckanutillibrary.shared.RolesCkanGroupOrOrg;
import org.junit.Before;
import org.junit.Test;
import org.slf4j.LoggerFactory;
@ -35,7 +35,7 @@ public class TestDataCatalogueLib {
private static final org.slf4j.Logger logger = LoggerFactory.getLogger(TestDataCatalogueLib.class);
private DataCatalogueFactory factory;
private String scope = "/gcube/devNext/NextNext";
private String scope = "/gcube/devsec/devVRE";
//private String testUser = "costantino_perciante";
private String testUser = "francesco_mangiacrapa";
String subjectId = "aa_father4";
@ -413,15 +413,15 @@ public class TestDataCatalogueLib {
public void testAddResource() throws Exception{
DataCatalogueImpl instance = factory.getUtilsPerScope(scope);
String datasetId = "test_publish_folder_15_44";
String datasetId = "another_test_to_fix_add_resource";
//instance.assignDatasetToGroup(groupName, datasetId, instance.getApiKeyFromUsername("costantino_perciante"));
String api = instance.getApiKeyFromUsername("costantino_perciante");
String api = instance.getApiKeyFromUsername(testUser);
CheckedCkanClient client = new CheckedCkanClient(instance.getCatalogueUrl(), api);
List<String> randomName = Arrays.asList("FIRMS", "RAM", "FishSource");
for (int i = 0; i < 100; i++) {
CkanResource resource = new CkanResource("https://goo.gl/FH5AQ5", datasetId);
CkanResource resource = new CkanResource("https://data-dev.d4science.net/YpCK", datasetId);
String name = randomName.get((int)Math.round(Math.ceil(Math.random() * 3)));
resource.setName(name);
@ -429,6 +429,20 @@ public class TestDataCatalogueLib {
}
}
//@Test
public void testAddResourceToDataset() throws Exception{
factory = DataCatalogueFactory.getFactory();
DataCatalogueImpl instance = factory.getUtilsPerScope(scope);
String datasetId = "another_test_to_fix_add_resource";
String apiKey = instance.getApiKeyFromUsername(testUser);
String resourceURL = "https://data-dev.d4science.net/YpCK";
String name = "Resouce "+resourceURL.subSequence(resourceURL.length()-4, resourceURL.length());
ResourceBean resourceBean = new ResourceBean(resourceURL, name, "", "",
testUser,datasetId,"");
instance.addResourceToDataset(resourceBean, apiKey);
}
//@Test
public void checkGroupRole() throws Exception{
@ -585,5 +599,12 @@ public class TestDataCatalogueLib {
String url = instance.getUrlFromDatasetIdOrName(datasetName);
logger.debug("url is " + url);
}
//@Test
public void getCatalogueURLs() throws Exception{
DataCatalogueImpl util = factory.getUtilsPerScope("/gcube/devNext/NextNext");
logger.debug("MAP ACCESS URL TO CATALOGUE:" +util.getMapAccessURLToCatalogue());
}
}

14
src/test/resources/.gitignore vendored Normal file
View File

@ -0,0 +1,14 @@
/CNR.it.gcubekey
/EUBrazilOpenBio.gcubekey
/Ecosystem.gcubekey
/FARM.gcubekey
/ISTI.gcubekey
/d4science.research-infrastructures.eu.gcubekey
/devNext.gcubekey
/devVRE.gcubekey
/devsec.gcubekey
/gCubeApps.gcubekey
/gcube.gcubekey
/log4j.properties
/preprod.gcubekey
/pred4s.gcubekey