Compare commits

...

18 Commits

Author SHA1 Message Date
Luca Frosini 95cdb46f00 Removed -SNAPSHOT to release the component 2024-05-14 15:42:27 +02:00
Luca Frosini 75104813dc Updated maven parent 2024-05-14 14:20:42 +02:00
Luca Frosini 77209f01cf Moved tests in catalogue-core 2024-05-13 18:10:53 +02:00
Luca Frosini 9c087550d2 Improved changelog 2024-05-02 11:36:33 +02:00
Luca Frosini 638823062a Fixed typos and grammar 2024-04-16 14:48:47 +02:00
Luca Frosini 322a9509fb Added new version of base class for tests 2024-03-27 14:54:41 +01:00
Luca Frosini 07fb1e4213 ServiceCatalogueConfiguration class provided as argument 2024-03-27 12:00:25 +01:00
Luca Frosini 3c8932cd1f Moving core code to dedicated library 2024-03-25 19:48:05 +01:00
Luca Frosini 7cebe2beb5 Improved profiles schemas 2024-01-23 17:15:20 +01:00
Luca Frosini 3c05b571c9 Removed -SNAPSHOT for release 2024-01-22 12:21:10 +01:00
Luca Frosini a13cb0ed8f Implementing feature #26142 2024-01-19 15:15:19 +01:00
Luca Frosini 51731bbd04 adding feature #26142 2024-01-19 14:52:18 +01:00
Luca Frosini c17bf6de9a Removed -SNAPSHOT to release the component 2024-01-18 16:40:10 +01:00
Luca Frosini e47b147301 Added -SNAPSHOT to allow jenkins to build it 2024-01-18 16:20:49 +01:00
Luca Frosini 173100f123 Removed -SNAPSHOT to release the component 2024-01-18 12:39:19 +01:00
Luca Frosini 75353a57d1 Fixed changelog 2024-01-18 12:28:54 +01:00
Luca Frosini 7915074947 Enforcing private item to avoid issue #26391 2024-01-18 12:27:36 +01:00
Luca Frosini 703b284b92 Fixed query to properly support IS model changes refs #24992 2024-01-17 14:53:10 +01:00
79 changed files with 461 additions and 9840 deletions

View File

@ -2,6 +2,19 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
# Changelog for gCube Catalogue (gCat) Service
## [v2.5.3]
- Improved profile schema #26471
- Catalogue core operation has been moved in a dedicated library #27118
## [v2.5.2]
- Enforce private to a rejected item to avoid issue #26391
- Added profile validation (i.e. regex validity and default value conformity) #26142
## [v2.5.1]
- Migrated code to reorganized E/R format [#24992]

View File

@ -1,9 +1,8 @@
***********************************************************
Welcome to gCube Catalogue Service (aka gCat) documentation
***********************************************************
gCat is a RESTful application which exposes operations via REST-API.
gCat is a RESTful application that exposes operations via REST-API.
See the available `REST-API docs <../api-docs/index.html>`_.
@ -25,23 +24,23 @@ Obtain your Bearer token here: https://dev.d4science.org/how-to-access-resources
Service
=======
You can call the methods of the Web Service by writing your own REST client application or using existing REST client plugins.
You can call the methods of the Web Service by writing your REST client application or using existing REST client plugins.
HTTP Statuses
-------------
Any successful operation returns *200 OK* HTTP status code.
Any successful operation returns a *200 OK* HTTP status code.
The create operation returns *201 Created*.
Any Background operation returns *202 Accepted*.
Any operation which does not provide any content return *204 No Content*.
Any operation that does not provide any content returns *204 No Content*.
The most common error status a client can obtain are:
The most common error statuses a client can obtain are:
* **400 Bad Request** used to indicate a clients error `<https://tools.ietf.org/html/rfc7231#section-6.5.1>`_;
* **401 Unauthorized** used to indicate that the client does not provide the authorization token in the HTTP Header or the client has not enough right to perform such request `<https://tools.ietf.org/html/rfc7235#section-3.1>`_;
* **401 Unauthorized** used to indicate that the client does not provide the authorization token in the HTTP Header or the client does not have enough right to perform such request `<https://tools.ietf.org/html/rfc7235#section-3.1>`_;
* **404 Not Found** used to indicate that the requested instance does not exist `<https://tools.ietf.org/html/rfc7231#section-6.5.4>`_;
* **405 Method Not Allowed** the used HTTP method is not supported for the requested URL `<https://tools.ietf.org/html/rfc7231#section-6.5.5>`_.
The response contains the *Allow* HTTP Header indicating the supported HTTP method for such URL `<https://tools.ietf.org/html/rfc7231#section-7.4.1>`_;
@ -55,7 +54,7 @@ If you get a *500 Internal Server Error*, please report it in the `gCube ticketi
Please use this checklist before reporting an error:
* Replicate the request;
* The failure could be temporal due to network error, server issue and many other temporal issues. For this reason, please retry the request after a certain amount of time before reporting the issue;
* The failure could be temporal due to a network error, a server issue, and many other temporal issues. For this reason, please retry the request after a certain amount of time before reporting the issue;
* indicate how to replicate the error;
* indicate the time when the error occurred (this simplifies identifying the issue).
@ -104,12 +103,12 @@ gCat is a pure RESTful service. It uses standard HTTP Methods to perform a listi
.. [#del] DELETE has been defined as idempotent.
*Allamaraju* [#Allamaraju]_ argues that DELETE idempotency should be accomplished client-side.
The server should inform the client if the delete operation succeeded because the resource was really deleted or it was not found, i.e., **404 Not Found** error is suggested instead of **204 No Content**.
The server should inform the client if the delete operation succeeded because the resource was deleted or it was not found, i.e., **404 Not Found** error is suggested instead of **204 No Content**.
The latter situation should be treated as idempotent by the client.
We share the same vision. For this reason, gCat does not provide server-side idempotency for DELETE and PURGE operations.
.. [#Allamaraju] Allamaraju S. RESTful Web Services Cookbook: Solutions for Improving Scalability and Simplicity . OReilly. first ed. 2010
.. [#Allamaraju] Allamaraju S. RESTful Web Services Cookbook: Solutions for Improving Scalability and Simplicity. OReilly. first ed. 2010
About URL
@ -128,7 +127,7 @@ About Safety and Idempotency properties
* A method is *Safe* if it does not produce any side effects.
"This does not prevent an implementation from including behaviour that is potentially harmful, that is not entirely read-only, or that causes side effects while invoking a safe method"
`<https://tools.ietf.org/html/rfc7231#section-4.2.1>`_;
* A method is *Idempotent* if the same operation repeated multiple times has the same side effect than using it one time.
* A method is *Idempotent* if the same operation repeated multiple times has the same side effect as using it one time.
"repeating the request will have the same intended effect, even if the original request succeeded, though the response might differ"
`<https://tools.ietf.org/html/rfc7231#section-4.2.2>`_.
@ -138,7 +137,7 @@ Uncommon HTTP Methods
^^^^^^^^^^^^^^^^^^^^^
* PATCH method allows to perform a differential update (i.e. an update which provides only the differences and not the whole new representation);
* PURGE method is not a standard but is widely used in service which requires this action
* PURGE method is not a standard but is widely used in services that require this action
(e.g. `Varnish <https://varnish-cache.org/docs/3.0/tutorial/purging.html>`_, `Squid <https://wiki.squid-cache.org/SquidFaq/OperatingSquid#How_can_I_purge_an_object_from_my_cache.3F>`_).
gCat provides support for this method, but to support a wider range of clients, it also provides the Purge action via *DELETE* with the additional get parameter ``purge=true``.
@ -225,12 +224,12 @@ Moderated Catalogues
Any catalogues can be declared as moderated.
This means that, a **Catalogue-Moderator** must approve any submitted items to make them available to the other users of the catalogue.
This means that a **Catalogue-Moderator** must approve any submitted items to make them available to the other users of the catalogue.
In a moderated catalogue, an item can be in the following states:
**pending**:
The item published by any allowed author (a Catalogue-Editor or above) but not available to the other users of the catalogue.
The item is published by any allowed author (a Catalogue-Editor or above) but not available to the other users of the catalogue.
A Catalogue-Moderator has to approve or reject it;
**approved**:
@ -250,7 +249,7 @@ To present the moderation operations, we use the following convention:
``initial_state`` can be ``none``, meaning the item does not exist.
The following are the allowed moderation operation on an item
The following are the allowed moderation operations on an item
``none`` ---**create** (*Author*)---> ``pending``
@ -263,14 +262,14 @@ The following are the allowed moderation operation on an item
``approved`` ---**update** (*Author*)---> ``pending``
Please check the table below whcih summarise the item collection operation and the allowed users/roles.
Please check the table below that summarises the item collection operation and the allowed users/roles.
In a moderated catalogue, both the Catalogue-Moderators and the item author can send messages to
discuss the approval process of the item. The messages are related to a specific item.
Any Catalogue-Moderators receive a message sent by an Author.
The author receives a message sent by a Catalogue-Moderator as well as the other Catalogue-Moderators (if any).
Messages can be sent both with an action which changes the status of the item or as explicit action which does not change the status of the item:
Messages can be sent both with an action which changes the status of the item or as an explicit action which does not change the status of the item:
``pending`` ---**message** (*Author OR Catalogue-Moderator*)---> ``pending``
@ -280,7 +279,7 @@ Messages can be sent both with an action which changes the status of the item or
The following table summarize the allowed/forbidden operations depending on: the role of the user and the state of the item.
The following table summarizes the allowed/forbidden operations depending on the role of the user and the state of the item.
.. table::
@ -478,7 +477,7 @@ The service can be discovered in the gCore IS as gCore Endpoint with the followi
<ServiceName>gcat</ServiceName>
The service can be discovered in the Facet Based IS as EService with the following json query:
The service can be discovered in the Facet-Based IS as EService with the following JSON query:
.. code:: json
@ -501,7 +500,7 @@ The service can be discovered in the Facet Based IS as EService with the followi
Service Maven Coordinates
=========================
The maven coordinates of gCat service are:
The maven coordinates of the gCat service are:
.. code:: xml

View File

@ -5,14 +5,14 @@
<parent>
<artifactId>maven-parent</artifactId>
<groupId>org.gcube.tools</groupId>
<version>1.1.0</version>
<version>1.2.0</version>
<relativePath />
</parent>
<groupId>org.gcube.data-catalogue</groupId>
<artifactId>gcat</artifactId>
<packaging>war</packaging>
<version>2.5.1</version>
<version>2.5.3</version>
<name>gCube Catalogue (gCat) Service</name>
<description>
This service allows any client to publish on the gCube Catalogue.
@ -59,6 +59,11 @@
<groupId>org.gcube.core</groupId>
<artifactId>common-smartgears-app</artifactId>
</dependency>
<dependency>
<groupId>org.gcube.data-catalogue</groupId>
<artifactId>catalogue-core</artifactId>
<version>[1.0.0-SNAPSHOT, 2.0.0-SNAPSHOT)</version>
</dependency>
<dependency>
<groupId>org.gcube.data-catalogue</groupId>
<artifactId>gcat-api</artifactId>

View File

@ -1,150 +0,0 @@
package org.gcube.gcat.configuration;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.gcat.configuration.isproxies.ISConfigurationProxy;
import org.gcube.gcat.configuration.isproxies.ISConfigurationProxyFactory;
import org.gcube.gcat.configuration.isproxies.impl.FacetBasedISConfigurationProxyFactory;
import org.gcube.gcat.configuration.isproxies.impl.GCoreISConfigurationProxyFactory;
import org.gcube.gcat.configuration.service.ServiceCatalogueConfiguration;
import org.gcube.gcat.persistence.ckan.cache.CKANUserCache;
import org.gcube.gcat.utils.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CatalogueConfigurationFactory {
private static final Logger logger = LoggerFactory.getLogger(CatalogueConfigurationFactory.class);
private static final Map<String, ServiceCatalogueConfiguration> catalogueConfigurations;
private static List<ISConfigurationProxyFactory<?>> factories;
static {
catalogueConfigurations = new HashMap<>();
factories = new ArrayList<>();
}
private static List<ISConfigurationProxyFactory<?>> getFactories(){
if(factories.size()==0) {
factories.add(new FacetBasedISConfigurationProxyFactory());
factories.add(new GCoreISConfigurationProxyFactory());
}
return factories;
}
public static void addISConfigurationProxyFactory(ISConfigurationProxyFactory<?> icpf) {
factories.add(icpf);
}
private static ServiceCatalogueConfiguration load(String context) {
ServiceCatalogueConfiguration serviceCatalogueConfiguration = null;
SecretManager secretManager = SecretManagerProvider.instance.get();
try {
Secret secret = Constants.getCatalogueSecret();
secretManager.startSession(secret);
for(ISConfigurationProxyFactory<?> icpf : getFactories()) {
try {
ISConfigurationProxy<?> icp = icpf.getInstance(context);
serviceCatalogueConfiguration = icp.getCatalogueConfiguration();
logger.trace("The configuration has been read using {}.", icp.getClass().getSimpleName());
}catch(Exception e){
logger.warn("{} cannot be used to read {}. Reason is {}", icpf.getClass().getSimpleName(), ServiceCatalogueConfiguration.class.getSimpleName(), e.getMessage());
}
}
} catch(Exception e) {
logger.error("Unable to start session. Reason is " + e.getMessage());
} finally {
secretManager.endSession();
}
if(serviceCatalogueConfiguration==null) {
throw new RuntimeException("Unable to load " + ServiceCatalogueConfiguration.class.getSimpleName() + " by using configured " + ISConfigurationProxyFactory.class.getSimpleName() + " i.e. " + getFactories());
}
return serviceCatalogueConfiguration;
}
private static void purgeFromIS(String context) {
SecretManager secretManager = SecretManagerProvider.instance.get();
try {
Secret secret = Constants.getCatalogueSecret();
secretManager.startSession(secret);
for(ISConfigurationProxyFactory<?> icpf : getFactories()) {
ISConfigurationProxy<?> icp = icpf.getInstance(context);
icp.delete();
}
} catch(Exception e) {
logger.error("Unable to start session. Reason is " + e.getMessage());
} finally {
secretManager.endSession();
}
}
private static void createOrUpdateOnIS(String context, ServiceCatalogueConfiguration catalogueConfiguration) throws Exception {
SecretManager secretManager = SecretManagerProvider.instance.get();
try {
Secret secret = Constants.getCatalogueSecret();
secretManager.startSession(secret);
for(ISConfigurationProxyFactory<?> icpf : getFactories()) {
ISConfigurationProxy<?> icp = icpf.getInstance(context);
icp.setCatalogueConfiguration(catalogueConfiguration);
icp.createOrUpdateOnIS();
}
} finally {
secretManager.endSession();
}
}
public synchronized static ServiceCatalogueConfiguration getInstance() {
String context = SecretManagerProvider.instance.get().getContext();
ServiceCatalogueConfiguration catalogueConfiguration = catalogueConfigurations.get(context);
if(catalogueConfiguration == null) {
catalogueConfiguration = load(context);
catalogueConfigurations.put(context, catalogueConfiguration);
}
return catalogueConfiguration;
}
public synchronized static void renew() {
String context = SecretManagerProvider.instance.get().getContext();
catalogueConfigurations.remove(context);
ServiceCatalogueConfiguration catalogueConfiguration = load(context);
catalogueConfigurations.put(context, catalogueConfiguration);
}
public synchronized static void purge() {
// Remove the resource from IS
String context = SecretManagerProvider.instance.get().getContext();
catalogueConfigurations.remove(context);
purgeFromIS(context);
}
public synchronized static ServiceCatalogueConfiguration createOrUpdate(ServiceCatalogueConfiguration catalogueConfiguration) throws Exception {
String context = SecretManagerProvider.instance.get().getContext();
catalogueConfigurations.remove(context);
createOrUpdateOnIS(context, catalogueConfiguration);
catalogueConfigurations.put(context, catalogueConfiguration);
// The supported organizations could be changed we need to empty the user cache for the context
// to avoid to miss to add an user in an organization which has been added.
CKANUserCache.emptyUserCache();
return catalogueConfiguration;
}
}

View File

@ -1,127 +0,0 @@
package org.gcube.gcat.configuration;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class Version implements Comparable<Version> {
/**
* Regex validating the version
*/
public final static String VERSION_REGEX = "^[1-9][0-9]{0,}\\.(0|([1-9][0-9]{0,}))\\.(0|([1-9][0-9]{0,}))";
private final static Pattern VERSION_PATTERN;
static {
VERSION_PATTERN = Pattern.compile(VERSION_REGEX);
}
protected int major;
protected int minor;
protected int revision;
protected Version(){}
public Version(String version) {
setVersion(version);
}
public Version(int major, int minor, int revision) {
this.major = major;
this.minor = minor;
this.revision = revision;
}
public void setVersion(String version) {
Matcher matcher = VERSION_PATTERN.matcher(version);
if(!matcher.find()) {
throw new RuntimeException("The provided version (i.e. " + version + ") MUST comply with the regex " + VERSION_REGEX);
}
String matched = matcher.group(0);
String[] parts = matched.split("\\.");
this.major = Integer.valueOf(parts[0]);
this.minor = Integer.valueOf(parts[1]);
this.revision = Integer.valueOf(parts[2]);
}
public int getMajor() {
return major;
}
protected void setMajor(int major) {
this.major = major;
}
public int getMinor() {
return minor;
}
protected void setMinor(int minor) {
this.minor = minor;
}
public int getRevision() {
return revision;
}
protected void setRevision(int revision) {
this.revision = revision;
}
@Override
public String toString() {
return major + "." + minor + "." + revision;
}
@Override
public int compareTo(Version other) {
if(other == null) {
return 1;
}
int compare = Integer.compare(major, other.major);
if(compare!=0) {
return compare;
}
compare = Integer.compare(minor, other.minor);
if(compare!=0) {
return compare;
}
compare = Integer.compare(revision, other.revision);
return compare;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + major;
result = prime * result + minor;
result = prime * result + revision;
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
Version other = (Version) obj;
if (major != other.major)
return false;
if (minor != other.minor)
return false;
if (revision != other.revision)
return false;
return true;
}
}

View File

@ -1,72 +0,0 @@
package org.gcube.gcat.configuration.isproxies;
import javax.ws.rs.WebApplicationException;
import org.gcube.gcat.configuration.Version;
import org.gcube.gcat.configuration.service.ServiceCatalogueConfiguration;
import org.gcube.smartgears.ContextProvider;
import org.gcube.smartgears.configuration.application.ApplicationConfiguration;
import org.gcube.smartgears.context.application.ApplicationContext;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public abstract class ISConfigurationProxy<ISResource extends Object> {
protected final String context;
protected ServiceCatalogueConfiguration catalogueConfiguration;
public ISConfigurationProxy(String context) {
this.context = context;
}
public ISConfigurationProxy(String context, ServiceCatalogueConfiguration catalogueConfiguration) {
this(context);
this.catalogueConfiguration = catalogueConfiguration;
}
public ServiceCatalogueConfiguration getCatalogueConfiguration() throws WebApplicationException {
if (catalogueConfiguration == null) {
catalogueConfiguration = readFromIS();
}
return catalogueConfiguration;
}
public void setCatalogueConfiguration(ServiceCatalogueConfiguration catalogueConfiguration) {
this.catalogueConfiguration = catalogueConfiguration;
}
public ServiceCatalogueConfiguration createOrUpdateOnIS() throws Exception {
ISResource isResource = getISResource();
if(isResource!=null) {
// It's an update
catalogueConfiguration = updateOnIS();
}else {
// It's a create
catalogueConfiguration = createOnIS();
}
return catalogueConfiguration;
}
protected Version getGcatVersion() {
try {
ApplicationContext applicationContext = ContextProvider.get();
ApplicationConfiguration applicationConfiguration = applicationContext.configuration();
Version version = new Version(applicationConfiguration.version());
return version;
}catch (Exception e) {
return new Version("2.4.2");
}
}
protected abstract ServiceCatalogueConfiguration createOnIS() throws Exception;
protected abstract ISResource getISResource();
protected abstract ServiceCatalogueConfiguration readFromIS();
protected abstract ServiceCatalogueConfiguration updateOnIS() throws Exception;
public abstract void delete();
}

View File

@ -1,36 +0,0 @@
package org.gcube.gcat.configuration.isproxies;
import java.util.HashMap;
import java.util.Map;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public abstract class ISConfigurationProxyFactory<ISCP extends ISConfigurationProxy<?>> {
protected final Map<String, ISCP> isConfigurationProxies;
public ISConfigurationProxyFactory() {
this.isConfigurationProxies = new HashMap<>();
}
protected abstract ISCP newInstance(String context);
public synchronized ISCP getInstance(String context) {
ISCP isConfigurationProxy = isConfigurationProxies.get(context);
if(isConfigurationProxy == null) {
isConfigurationProxy = newInstance(context);
isConfigurationProxies.put(context, isConfigurationProxy);
}
return isConfigurationProxy;
}
public ISCP getInstance() {
String context = SecretManagerProvider.instance.get().getContext();
return getInstance(context);
}
}

View File

@ -1,520 +0,0 @@
package org.gcube.gcat.configuration.isproxies.impl;
import java.io.File;
import java.io.FileReader;
import java.net.URL;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import javax.ws.rs.InternalServerErrorException;
import org.gcube.com.fasterxml.jackson.core.JsonProcessingException;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.configuration.isproxies.ISConfigurationProxy;
import org.gcube.gcat.configuration.service.FacetBasedISServiceCatalogueConfiguration;
import org.gcube.gcat.configuration.service.ServiceCKANDB;
import org.gcube.gcat.configuration.service.ServiceCatalogueConfiguration;
import org.gcube.informationsystem.model.impl.properties.PropagationConstraintImpl;
import org.gcube.informationsystem.model.impl.relations.ConsistsOfImpl;
import org.gcube.informationsystem.model.reference.entities.Entity;
import org.gcube.informationsystem.model.reference.properties.Encrypted;
import org.gcube.informationsystem.model.reference.properties.PropagationConstraint;
import org.gcube.informationsystem.model.reference.properties.PropagationConstraint.AddConstraint;
import org.gcube.informationsystem.model.reference.properties.PropagationConstraint.DeleteConstraint;
import org.gcube.informationsystem.model.reference.properties.PropagationConstraint.RemoveConstraint;
import org.gcube.informationsystem.model.reference.relations.ConsistsOf;
import org.gcube.informationsystem.queries.templates.reference.entities.QueryTemplate;
import org.gcube.informationsystem.resourceregistry.api.exceptions.NotFoundException;
import org.gcube.informationsystem.resourceregistry.api.exceptions.ResourceRegistryException;
import org.gcube.informationsystem.resourceregistry.api.exceptions.types.SchemaViolationException;
import org.gcube.informationsystem.resourceregistry.client.ResourceRegistryClient;
import org.gcube.informationsystem.resourceregistry.client.ResourceRegistryClientFactory;
import org.gcube.informationsystem.resourceregistry.publisher.ResourceRegistryPublisher;
import org.gcube.informationsystem.resourceregistry.publisher.ResourceRegistryPublisherFactory;
import org.gcube.informationsystem.resourceregistry.queries.templates.ResourceRegistryQueryTemplateClient;
import org.gcube.informationsystem.resourceregistry.queries.templates.ResourceRegistryQueryTemplateClientFactory;
import org.gcube.informationsystem.serialization.ElementMapper;
import org.gcube.resourcemanagement.model.impl.entities.facets.SimpleFacetImpl;
import org.gcube.resourcemanagement.model.impl.entities.resources.EServiceImpl;
import org.gcube.resourcemanagement.model.impl.relations.isrelatedto.CallsForImpl;
import org.gcube.resourcemanagement.model.reference.entities.facets.AccessPointFacet;
import org.gcube.resourcemanagement.model.reference.entities.facets.SimpleFacet;
import org.gcube.resourcemanagement.model.reference.entities.resources.Configuration;
import org.gcube.resourcemanagement.model.reference.entities.resources.EService;
import org.gcube.resourcemanagement.model.reference.entities.resources.VirtualService;
import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.CallsFor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class FacetBasedISConfigurationProxy extends ISConfigurationProxy<SimpleFacet> {
private static Logger logger = LoggerFactory.getLogger(FacetBasedISConfigurationProxy.class);
public final String QUERY_TEMPLATE_DIRECTORY_NAME = "query-template";
public final String SERVICE_ESERVICE_UUID_VARNAME = "$uuid";
public final String GET_CALLS_FOR_QUERY_TEMPLATE_FILENAME = "01-get-calls-for-query-template.json";
public final String QUERY_DIRECTORY_NAME = "query";
public final String GET_CATALOGUE_VIRTUAL_SERVICE_FILENAME = "01-get-catalogue-virtual-service.json";
public final String GET_CATALOGUE_CONFIGURATION_FILENAME = "02-get-catalogue-configuration.json";
public final String GET_SIMPLE_FACET_OF_CATALOGUE_CONFIGURATION_FILENAME = "03-get-simple-facet-of-catalogue-configuration.json";
public final String GET_ACCESS_POINT_FACET_OF_CKAN_SERVICE_FILENAME = "05-get-access-point-facet-of-ckan-service.json";
public final String GET_ACCESS_POINT_FACET_OF_POSTGRES_CKAN_DB_FILENAME = "07-get-access-point-facet-of-postgres-ckan-db.json";
public final String GET_ACCESS_POINT_FACET_OF_SOLR_SERVICE_FILENAME = "09-get-access-point-facet-of-solr-service.json";
protected QueryTemplate queryTemplate;
protected String serviceName;
public QueryTemplate getQueryTemplateFromFile(String queryTemplateFilename) throws Exception {
File queryTemplateFile = getJsonQueryTemplateFromFile(queryTemplateFilename);
FileReader fileReader = new FileReader(queryTemplateFile);
QueryTemplate queryTemplate = ElementMapper.unmarshal(QueryTemplate.class, fileReader);
return queryTemplate;
}
public QueryTemplate installQueryTemplate() throws Exception {
/*
* Going to create/update the query template.
* No need to test if exists and/or if is the last version.
*/
queryTemplate = rrqtc.update(queryTemplate);
return queryTemplate;
}
protected File getBaseDirectory(String directoryName) {
URL directoryURL = this.getClass().getClassLoader().getResource(directoryName);
File directory = new File(directoryURL.getPath());
return directory;
}
protected File getFile(String directoryName, String filename) throws Exception {
File directory = getBaseDirectory(directoryName);
return new File(directory, filename);
}
protected File getJsonQueryTemplateFromFile(String filename) throws Exception {
return getFile(QUERY_TEMPLATE_DIRECTORY_NAME, filename);
}
protected File getJsonQueryFromFile(String filename) throws Exception {
return getFile(QUERY_DIRECTORY_NAME, filename);
}
//
// Configuration
// ---------------------------
// IsCustomizedBy | |
// -----------------> | catalogue-configuration |
// / | |
// / ---------------------------
// EService VirtualService /
// ------------ -----------------------------
// | | CallsFor | |
// | gcat | ------------> | catalogue-virtual-service |
// | | | |
// ------------ -----------------------------
// \ EService
// \ --------------------
// \ Uses | |
// \ ------------------> | postgres-ckan-db |
// \ / | |
// \ EService / --------------------
// \ -----------------
// \ CallsFor | |
// -------------> | ckan |
// | |
// ----------------- EService
// \ --------------------
// \ Uses | |
// ------------------> | solr |
// | |
// --------------------
/*
* Some resources are not needed to be queried and maintained.
* Leaving comment to remember that is not an error
* protected Configuration configuration;
*
* public static final String GET_CKAN_SERVICE_FILENAME = "04-get-ckan-service.json";
* protected EService ckanService;
*
* public static final String GET_POSTGRES_CKAN_DB_FILENAME = "06-get-postgres-ckan-db.json";
* protected EService solrService;
*
* public static final String GET_SOLR_SERVICE_FILENAME = "08-get-solr-service.json";
* protected EService ckanDB;
*
*/
protected final ObjectMapper objectMapper;
protected final ResourceRegistryClient resourceRegistryClient;
protected final ResourceRegistryPublisher resourceRegistryPublisher;
protected final ResourceRegistryQueryTemplateClient rrqtc;
/*
* We need to keep this resource because we want to create
* an IsRelatedTo relation
* i.e. EService(gcat) --CallsFor--> VirtualService(catalogue-virtual-service)
*/
protected VirtualService virtualService;
protected SimpleFacet configurationSimpleFacet;
protected String serviceEServiceID;
public FacetBasedISConfigurationProxy(String context) {
super(context);
serviceName = "gcat";
resourceRegistryClient = ResourceRegistryClientFactory.create();
resourceRegistryPublisher = ResourceRegistryPublisherFactory.create();
rrqtc = ResourceRegistryQueryTemplateClientFactory.create();
try {
queryTemplate = getQueryTemplateFromFile(GET_CALLS_FOR_QUERY_TEMPLATE_FILENAME);
}catch(Exception e) {
throw new RuntimeException(this.getClass().getSimpleName() + " cannot be used", e);
}
objectMapper = new ObjectMapper();
}
public VirtualService getVirtualService() {
if(virtualService==null) {
virtualService = queryVirtualService();
}
return virtualService;
}
public void setServiceEServiceID(String serviceEServiceID) {
this.serviceEServiceID = serviceEServiceID;
}
public List<CallsFor<EService, VirtualService>> getCallsForToVirtualService() throws Exception {
ResourceRegistryQueryTemplateClient rrqtc = ResourceRegistryQueryTemplateClientFactory.create();
ObjectNode objectNode = objectMapper.createObjectNode();
objectNode.put(SERVICE_ESERVICE_UUID_VARNAME, serviceEServiceID);
List<CallsFor<EService, VirtualService>> callsForList = rrqtc.run(queryTemplate.getName(), objectNode);
return callsForList;
}
public List<CallsFor<EService, VirtualService>> deleteCallsForToVirtualService(List<CallsFor<EService, VirtualService>> callsForList) throws SchemaViolationException, NotFoundException, ResourceRegistryException {
for(CallsFor<EService, VirtualService> cf : callsForList) {
resourceRegistryPublisher.delete(cf);
}
return callsForList;
}
public List<CallsFor<EService, VirtualService>> deleteCallsForToVirtualService() throws Exception {
List<CallsFor<EService, VirtualService>> callsForList = getCallsForToVirtualService();
return deleteCallsForToVirtualService(callsForList);
}
public CallsFor<EService, VirtualService> createCallsForToVirtualService() throws Exception {
List<CallsFor<EService, VirtualService>> callsForList = getCallsForToVirtualService();
CallsFor<EService, VirtualService> callsFor = null;
int size = callsForList.size();
UUID serviceEServiceUUID = UUID.fromString(serviceEServiceID);
if(size>1) {
logger.warn("There are {} instances of {} relation beetween {} Eservice with UUID {} and the {} (catalogue-virtual-service). This is very strange because there should be only one. We are going to delete them and recreated a new one.",
callsForList.size(), CallsFor.NAME, serviceName, serviceEServiceID, VirtualService.NAME);
logger.trace("{} relation instances that are going to be deleted are {}",
CallsFor.NAME, ElementMapper.marshal(callsForList));
deleteCallsForToVirtualService(callsForList);
size = 0;
}
if(size==0) {
logger.info("Going to create {} between {} ({} with UUID={}) and the {}",
CallsFor.NAME, EService.NAME, serviceName, serviceEServiceID, VirtualService.NAME);
PropagationConstraint propagationConstraint = new PropagationConstraintImpl();
propagationConstraint.setAddConstraint(AddConstraint.unpropagate);
propagationConstraint.setRemoveConstraint(RemoveConstraint.keep);
propagationConstraint.setDeleteConstraint(DeleteConstraint.keep);
EService serviceEService = new EServiceImpl();
serviceEService.setID(serviceEServiceUUID);
VirtualService virtualService = queryVirtualService();
callsFor = new CallsForImpl<EService, VirtualService>(serviceEService, virtualService, propagationConstraint);
callsFor = resourceRegistryPublisher.create(callsFor);
}else if(size==1){
callsFor = callsForList.get(0);
logger.info("{} between {} ({} with UUID={}) and the {} exists.\n{}",
CallsFor.NAME, EService.NAME, serviceName, serviceEServiceID, VirtualService.NAME, ElementMapper.marshal(callsFor));
}
return callsFor;
}
protected List<Entity> queryListOfEntities(String query) throws Exception {
logger.trace("Going to request the following query:\n{}", query);
String result = resourceRegistryClient.jsonQuery(query);
logger.trace("The query:\n{}\nproduced the following result:\n{}", query, result);
List<Entity> entities = ElementMapper.unmarshalList(Entity.class, result);
return entities;
}
protected JsonNode getQuery(File jsonQueryFile) throws Exception {
JsonNode query = objectMapper.readTree(jsonQueryFile);
return query;
}
protected <E extends Entity> E getUniqueEntity(List<E> entities, String originalQuery) throws JsonProcessingException {
int size = entities.size();
if(entities==null || size==0) {
String message = String.format("No instance found with query:\n%s", originalQuery);
logger.error(message);
throw new InternalServerErrorException(message);
}
if(size>1) {
String message = String.format(
"Too many instances found (i.e. expected 1, found %d) with query:\n%s\nthe obtained result is:\n%s",
size, originalQuery, ElementMapper.marshal(entities));
logger.error(message);
throw new InternalServerErrorException(message);
}
return entities.get(0);
}
protected Entity queryEntity(String filename) throws Exception{
File jsonQueryFile = getJsonQueryFromFile(filename);
JsonNode query = getQuery(jsonQueryFile);
String jsonQueryAsString = objectMapper.writeValueAsString(query);
List<Entity> entities = queryListOfEntities(jsonQueryAsString);
return getUniqueEntity(entities, jsonQueryAsString);
}
protected VirtualService queryVirtualService() throws InternalServerErrorException {
try {
VirtualService virtualService = (VirtualService) queryEntity(GET_CATALOGUE_VIRTUAL_SERVICE_FILENAME);
return virtualService;
}catch (Exception e) {
throw new InternalServerErrorException(e);
}
}
protected Configuration queryServiceConfiguration() throws Exception {
Configuration configuration = (Configuration) queryEntity(GET_CATALOGUE_CONFIGURATION_FILENAME);
return configuration;
}
protected SimpleFacet queryConfigurationSimpleFacet() throws Exception {
SimpleFacet configurationSimpleFacet = (SimpleFacet) queryEntity(GET_SIMPLE_FACET_OF_CATALOGUE_CONFIGURATION_FILENAME);
return configurationSimpleFacet;
}
protected AccessPointFacet queryCkanServiceAccessPointFacet() throws Exception {
AccessPointFacet accessPointFacet = (AccessPointFacet) queryEntity(GET_ACCESS_POINT_FACET_OF_CKAN_SERVICE_FILENAME);
return accessPointFacet;
}
protected AccessPointFacet queryPostgresCkanDBAccessPointFacet() throws Exception {
AccessPointFacet accessPointFacet = (AccessPointFacet) queryEntity(GET_ACCESS_POINT_FACET_OF_POSTGRES_CKAN_DB_FILENAME);
return accessPointFacet;
}
public AccessPointFacet querySolrServiceAccessPointFacet() throws Exception {
AccessPointFacet accessPointFacet = (AccessPointFacet) queryEntity(GET_ACCESS_POINT_FACET_OF_SOLR_SERVICE_FILENAME);
return accessPointFacet;
}
protected ServiceCatalogueConfiguration setConfigurationInfoFromSimpleFacet(SimpleFacet configurationSimpleFacet, ServiceCatalogueConfiguration catalogueConfiguration) throws Exception {
if(configurationSimpleFacet.getID()!=null) {
catalogueConfiguration.setID(configurationSimpleFacet.getID().toString());
}
catalogueConfiguration.setModerationEnabled((boolean) configurationSimpleFacet.getAdditionalProperty(CatalogueConfiguration.MODERATION_ENABLED_KEY));
catalogueConfiguration.setNotificationToUsersEnabled((boolean) configurationSimpleFacet.getAdditionalProperty(CatalogueConfiguration.NOTIFICATION_TO_USER_ENABLED_KEY));
catalogueConfiguration.setSocialPostEnabled((boolean) configurationSimpleFacet.getAdditionalProperty(CatalogueConfiguration.SOCIAL_POST_ENABLED_KEY));
catalogueConfiguration.setDefaultOrganization((String) configurationSimpleFacet.getAdditionalProperty(CatalogueConfiguration.DEFAULT_ORGANIZATION_KEY));
Object supportedOrganizationsObj = configurationSimpleFacet.getAdditionalProperty(CatalogueConfiguration.SUPPORTED_ORGANIZATIONS_KEY);
boolean forceUpdate = false;
if(supportedOrganizationsObj!=null && supportedOrganizationsObj instanceof Collection) {
@SuppressWarnings("unchecked")
Set<String> supportedOrganizations = new HashSet<String>((Collection<String>) supportedOrganizationsObj);
catalogueConfiguration.setSupportedOrganizations(supportedOrganizations);
}else {
Set<String> supportedOrganizations = new HashSet<>();
supportedOrganizations.add(catalogueConfiguration.getDefaultOrganization());
configurationSimpleFacet.setAdditionalProperty(CatalogueConfiguration.SUPPORTED_ORGANIZATIONS_KEY, supportedOrganizations);
forceUpdate = true;
catalogueConfiguration.setSupportedOrganizations(supportedOrganizations);
}
Map<String,Object> additionalProperties = new HashMap<>(configurationSimpleFacet.getAdditionalProperties());
for(String key : additionalProperties.keySet()) {
if(!CatalogueConfiguration.KNOWN_PROPERTIES.contains(key)) {
if(key.startsWith("@")) {
continue;
}
Object value = additionalProperties.get(key);
catalogueConfiguration.setAdditionalProperty(key, value);
}
}
if(forceUpdate) {
updateOnIS();
}
return catalogueConfiguration;
}
public ServiceCatalogueConfiguration setCkanServiceInfo(ServiceCatalogueConfiguration catalogueConfiguration) throws Exception {
AccessPointFacet ckanServiceAccessPointFacet = queryCkanServiceAccessPointFacet();
catalogueConfiguration.setCkanURL(ckanServiceAccessPointFacet.getEndpoint().toString());
Encrypted encrypted = (Encrypted) ckanServiceAccessPointFacet.getAdditionalProperty(CatalogueConfiguration.SYS_ADMIN_TOKEN_KEY);
String encryptedPassword = encrypted.getValue();
catalogueConfiguration.setSysAdminToken(encryptedPassword);
return catalogueConfiguration;
}
public ServiceCatalogueConfiguration setCkanDBInfo(ServiceCatalogueConfiguration catalogueConfiguration) throws Exception {
AccessPointFacet postgresCkanDBAccessPointFacet = queryPostgresCkanDBAccessPointFacet();
ServiceCKANDB ckanDB = new ServiceCKANDB();
String ckanDbURL = postgresCkanDBAccessPointFacet.getEndpoint().toString();
ckanDB.setUrl(ckanDbURL);
Encrypted encrypted = (Encrypted) postgresCkanDBAccessPointFacet.getAdditionalProperty(ServiceCKANDB.PASSWORD_KEY);
String encryptedPassword = encrypted.getValue();
ckanDB.setEncryptedPassword(encryptedPassword);
String username = (String) postgresCkanDBAccessPointFacet.getAdditionalProperty(ServiceCKANDB.USERNAME_KEY);
ckanDB.setUsername(username);
catalogueConfiguration.setCkanDB(ckanDB);
return catalogueConfiguration;
}
public ServiceCatalogueConfiguration setSolrServiceInfo(ServiceCatalogueConfiguration catalogueConfiguration) throws Exception {
AccessPointFacet solrServiceAccessPointFacet = querySolrServiceAccessPointFacet();
String solrURL = solrServiceAccessPointFacet.getEndpoint().toString();
catalogueConfiguration.setSolrURL(solrURL);
return catalogueConfiguration;
}
protected SimpleFacet getSimpleFacetFromConfiguration(ServiceCatalogueConfiguration catalogueConfiguration) {
SimpleFacet simpleFacet = new SimpleFacetImpl();
if(catalogueConfiguration.getID()!=null) {
UUID uuid = null;
try {
uuid = UUID.fromString(catalogueConfiguration.getID());
simpleFacet.setID(uuid);
}catch (Exception e) {
}
}
simpleFacet.setAdditionalProperty(CatalogueConfiguration.MODERATION_ENABLED_KEY, catalogueConfiguration.isModerationEnabled());
simpleFacet.setAdditionalProperty(CatalogueConfiguration.NOTIFICATION_TO_USER_ENABLED_KEY, catalogueConfiguration.isNotificationToUsersEnabled());
simpleFacet.setAdditionalProperty(CatalogueConfiguration.SOCIAL_POST_ENABLED_KEY, catalogueConfiguration.isSocialPostEnabled());
simpleFacet.setAdditionalProperty(CatalogueConfiguration.DEFAULT_ORGANIZATION_KEY, catalogueConfiguration.getDefaultOrganization());
simpleFacet.setAdditionalProperty(CatalogueConfiguration.SUPPORTED_ORGANIZATIONS_KEY, catalogueConfiguration.getSupportedOrganizations());
Map<String,Object> additionalProperties = new HashMap<>(catalogueConfiguration.getAdditionalProperties());
for(String key : additionalProperties.keySet()) {
if(!CatalogueConfiguration.KNOWN_PROPERTIES.contains(key)) {
Object value = additionalProperties.get(key);
simpleFacet.setAdditionalProperty(key, value);
}
}
return simpleFacet;
}
@Override
protected ServiceCatalogueConfiguration readFromIS() {
try {
catalogueConfiguration = new FacetBasedISServiceCatalogueConfiguration(context, this);
configurationSimpleFacet = getISResource();
if(configurationSimpleFacet==null) {
configurationSimpleFacet = getSimpleFacetFromConfiguration(catalogueConfiguration);
}else {
catalogueConfiguration = setConfigurationInfoFromSimpleFacet(configurationSimpleFacet, catalogueConfiguration);
}
catalogueConfiguration = setCkanServiceInfo(catalogueConfiguration);
catalogueConfiguration = setCkanDBInfo(catalogueConfiguration);
catalogueConfiguration = setSolrServiceInfo(catalogueConfiguration);
}catch (InternalServerErrorException e) {
throw e;
}catch (Exception e) {
throw new InternalServerErrorException(e);
}
return catalogueConfiguration;
}
@Override
public void delete() {
SimpleFacet simpleFacet = getISResource();
if(simpleFacet!=null) {
try {
resourceRegistryPublisher.delete(simpleFacet);
} catch (Exception e) {
throw new InternalServerErrorException("Unable to delete SimpleFacet with UUID " + simpleFacet.getID().toString(), e);
}
}
}
@Override
protected ServiceCatalogueConfiguration createOnIS() throws Exception {
UUID uuid = configurationSimpleFacet.getID();
if(uuid==null) {
Configuration configuration = queryServiceConfiguration();
ConsistsOf<Configuration, SimpleFacet> co = new ConsistsOfImpl<>(configuration, configurationSimpleFacet);
co = resourceRegistryPublisher.create(co);
configurationSimpleFacet = co.getTarget();
setConfigurationInfoFromSimpleFacet(configurationSimpleFacet, catalogueConfiguration);
}
return catalogueConfiguration;
}
@Override
protected SimpleFacet getISResource() {
if(configurationSimpleFacet==null) {
try {
configurationSimpleFacet = queryConfigurationSimpleFacet();
}catch (Exception e) {
return null;
}
}
return configurationSimpleFacet;
}
@Override
protected ServiceCatalogueConfiguration updateOnIS() throws Exception {
if(configurationSimpleFacet.getID()!=null) {
configurationSimpleFacet = getSimpleFacetFromConfiguration(catalogueConfiguration);
configurationSimpleFacet = resourceRegistryPublisher.update(configurationSimpleFacet);
setConfigurationInfoFromSimpleFacet(configurationSimpleFacet, catalogueConfiguration);
}
return catalogueConfiguration;
}
}

View File

@ -1,20 +0,0 @@
package org.gcube.gcat.configuration.isproxies.impl;
import org.gcube.gcat.configuration.isproxies.ISConfigurationProxyFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class FacetBasedISConfigurationProxyFactory extends ISConfigurationProxyFactory<FacetBasedISConfigurationProxy> {
public FacetBasedISConfigurationProxyFactory() {
super();
}
@Override
protected FacetBasedISConfigurationProxy newInstance(String context) {
return new FacetBasedISConfigurationProxy(context);
}
}

View File

@ -1,676 +0,0 @@
package org.gcube.gcat.configuration.isproxies.impl;
import static org.gcube.resources.discovery.icclient.ICFactory.clientFor;
import static org.gcube.resources.discovery.icclient.ICFactory.queryFor;
import java.io.IOException;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.WebApplicationException;
import org.gcube.com.fasterxml.jackson.core.JsonProcessingException;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.resources.gcore.GenericResource;
import org.gcube.common.resources.gcore.ServiceEndpoint;
import org.gcube.common.resources.gcore.ServiceEndpoint.AccessPoint;
import org.gcube.common.resources.gcore.ServiceEndpoint.Profile;
import org.gcube.common.resources.gcore.ServiceEndpoint.Property;
import org.gcube.common.resources.gcore.ServiceEndpoint.Runtime;
import org.gcube.common.resources.gcore.common.Platform;
import org.gcube.common.resources.gcore.utils.Group;
import org.gcube.gcat.api.GCatConstants;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.configuration.Version;
import org.gcube.gcat.configuration.isproxies.ISConfigurationProxy;
import org.gcube.gcat.configuration.service.ServiceCKANDB;
import org.gcube.gcat.configuration.service.ServiceCatalogueConfiguration;
import org.gcube.informationsystem.publisher.RegistryPublisher;
import org.gcube.informationsystem.publisher.RegistryPublisherFactory;
import org.gcube.resources.discovery.client.api.DiscoveryClient;
import org.gcube.resources.discovery.client.queries.api.SimpleQuery;
import org.gcube.resources.discovery.icclient.ICFactory;
import org.gcube.smartgears.ContextProvider;
import org.gcube.smartgears.configuration.container.ContainerConfiguration;
import org.gcube.smartgears.context.application.ApplicationContext;
import org.gcube.smartgears.context.container.ContainerContext;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class GCoreISConfigurationProxy extends ISConfigurationProxy<ServiceEndpoint> {
private static final Logger logger = LoggerFactory.getLogger(GCoreISConfigurationProxy.class);
// property to retrieve the master service endpoint into the /root scope
public final static String IS_ROOT_MASTER_PROPERTY_KEY = "IS_ROOT_MASTER"; // true, false.. missing means false as
public final static String DEFAULT_ORGANIZATION_PROPERTY_KEY = "DEFAULT_ORGANIZATION";
public final static String SUPPORTED_ORGANIZATION_PROPERTY_KEY = "SUPPORTED_ORGANIZATION";
public final static String API_KEY_PROPERTY_KEY = "API_KEY";
public final static String SOLR_INDEX_ADDRESS_PROPERTY_KEY = "SOLR_INDEX_ADDRESS";
public final static String SOCIAL_POST_PROPERTY_KEY = "SOCIAL_POST";
public final static String ALERT_USERS_ON_POST_CREATION_PROPERTY_KEY = "ALERT_USERS_ON_POST_CREATION";
public final static String MODERATION_ENABLED_KEY_PROPERTY_KEY = "MODERATION_ENABLED";
public static final Map<String, String> gCoreToConfigurationMapping;
public static final Map<String, String> configurationToGCoreMapping;
static {
gCoreToConfigurationMapping = new HashMap<>();
configurationToGCoreMapping = new HashMap<>();
gCoreToConfigurationMapping.put(API_KEY_PROPERTY_KEY, CatalogueConfiguration.SYS_ADMIN_TOKEN_KEY);
gCoreToConfigurationMapping.put(SOLR_INDEX_ADDRESS_PROPERTY_KEY, CatalogueConfiguration.SOLR_URL_KEY);
gCoreToConfigurationMapping.put(SOCIAL_POST_PROPERTY_KEY, CatalogueConfiguration.SOCIAL_POST_ENABLED_KEY);
gCoreToConfigurationMapping.put(ALERT_USERS_ON_POST_CREATION_PROPERTY_KEY, CatalogueConfiguration.NOTIFICATION_TO_USER_ENABLED_KEY);
gCoreToConfigurationMapping.put(MODERATION_ENABLED_KEY_PROPERTY_KEY, CatalogueConfiguration.MODERATION_ENABLED_KEY);
for(String key : gCoreToConfigurationMapping.keySet()) {
configurationToGCoreMapping.put(gCoreToConfigurationMapping.get(key), key);
}
}
// CKAN Instance info
private final static String OLD_CATEGORY = "Application";
private final static String OLD_NAME = "CKanDataCatalogue";
protected ObjectMapper mapper;
protected ServiceEndpoint serviceEndpoint;
public GCoreISConfigurationProxy(String context) {
super(context);
this.mapper = new ObjectMapper();
}
protected AccessPoint getAccessPoint(Profile profile) {
Group<AccessPoint> accessPoints = profile.accessPoints();
Iterator<AccessPoint> accessPointIterator = accessPoints.iterator();
AccessPoint accessPoint = accessPointIterator.next();
return accessPoint;
}
protected String getDefaultSolrURL(String ckanURL) {
StringBuffer stringBuffer = new StringBuffer();
stringBuffer.append(ckanURL);
stringBuffer.append(ckanURL.endsWith("/")?"":"/");
stringBuffer.append("solr/");
return stringBuffer.toString();
}
protected ObjectNode setValue(ObjectNode node, String key, String value) throws IOException {
if(value.toLowerCase().compareTo("true")==0 || value.toLowerCase().compareTo("false")==0) {
node.put(key, Boolean.parseBoolean(value));
return node;
}
if(value.startsWith("{") || value.startsWith("[")){
JsonNode n = mapper.readTree(value);
node.set(key, n);
return node;
}
node.put(key, value);
return node;
}
protected ServiceCatalogueConfiguration getConfiguration(ServiceEndpoint serviceEndpoint) throws IOException {
Profile profile = serviceEndpoint.profile();
AccessPoint accessPoint = getAccessPoint(profile);
Map<String, Property> propertyMap = accessPoint.propertyMap();
ObjectNode node = mapper.createObjectNode();
node.put(CatalogueConfiguration.ID_KEY, serviceEndpoint.id());
for(String key : propertyMap.keySet()) {
String value = propertyMap.get(key).value().trim();
setValue(node, key, value);
}
return mapper.treeToValue(node, ServiceCatalogueConfiguration.class);
}
private List<ServiceEndpoint> getServiceEndpoints(String category, String name) {
SimpleQuery query = queryFor(ServiceEndpoint.class);
query.addCondition("$resource/Scopes/Scope/text() eq '" + SecretManagerProvider.instance.get().getContext() + "'");
query.addCondition("$resource/Profile/Category/text() eq '" + category + "'");
query.addCondition("$resource/Profile/Name/text() eq '" + name + "'");
DiscoveryClient<ServiceEndpoint> client = clientFor(ServiceEndpoint.class);
List<ServiceEndpoint> serviceEndpoints = client.submit(query);
return serviceEndpoints;
}
@Override
protected ServiceEndpoint getISResource() {
if(serviceEndpoint==null) {
List<ServiceEndpoint> serviceEndpoints = getServiceEndpoints(GCatConstants.CONFIGURATION_CATEGORY, GCatConstants.CONFIGURATION_NAME);
if (serviceEndpoints==null || serviceEndpoints.size() == 0) {
logger.error("There is no {} having Category {} and Name {} in this context.",
ServiceEndpoint.class.getSimpleName(), GCatConstants.CONFIGURATION_CATEGORY, GCatConstants.CONFIGURATION_NAME);
return null;
}
serviceEndpoint = serviceEndpoints.get(0);
}
return serviceEndpoint;
}
@Override
protected ServiceCatalogueConfiguration readFromIS() throws WebApplicationException {
ServiceEndpoint serviceEndpoint = getISResource();
if(serviceEndpoint==null) {
return getOLDCatalogueConfigurationFromGCoreIS();
}
try {
return getConfiguration(serviceEndpoint);
}catch (Exception e) {
throw new InternalServerErrorException();
}
}
@Deprecated
private ServiceEndpoint getOldServiceEndpoint() {
List<ServiceEndpoint> serviceEndpoints = getServiceEndpoints(OLD_CATEGORY, OLD_NAME);
if (serviceEndpoints.size() == 0) {
logger.error("There is no {} having Category {} and Name {} in this context.",
ServiceEndpoint.class.getSimpleName(), OLD_CATEGORY, OLD_NAME);
return null;
}
ServiceEndpoint serviceEndpoint = null;
if (serviceEndpoints.size() > 1) {
logger.info("Too many {} having Category {} and Name {} in this context. Looking for the one that has the property {}",
ServiceEndpoint.class.getSimpleName(), OLD_CATEGORY, OLD_NAME, IS_ROOT_MASTER_PROPERTY_KEY);
for (ServiceEndpoint se : serviceEndpoints) {
Iterator<AccessPoint> accessPointIterator = se.profile().accessPoints().iterator();
while (accessPointIterator.hasNext()) {
ServiceEndpoint.AccessPoint accessPoint = accessPointIterator.next();
// get the is master property
Property entry = accessPoint.propertyMap().get(IS_ROOT_MASTER_PROPERTY_KEY);
String isMaster = entry != null ? entry.value() : null;
if (isMaster == null || !isMaster.equals("true")) {
continue;
}
// set this variable
serviceEndpoint = se;
return serviceEndpoint;
}
}
// if none of them was master, throw an exception
if (serviceEndpoint == null) {
throw new InternalServerErrorException(
"Too many catalogue configuration on IS and no one with MASTER property");
}
} else {
serviceEndpoint = serviceEndpoints.get(0);
}
return serviceEndpoint;
}
@Deprecated
protected ServiceCatalogueConfiguration getOLDCatalogueConfigurationFromGCoreIS() {
ServiceCatalogueConfiguration catalogueConfiguration = new ServiceCatalogueConfiguration(context);
try {
// boolean mustBeUpdated = false;
ServiceEndpoint serviceEndpoint = getOldServiceEndpoint();
if (serviceEndpoint == null) {
throw new NotFoundException("No configuration found in this context");
}
// catalogueConfiguration.setID(serviceEndpoint.id());
Profile profile = serviceEndpoint.profile();
AccessPoint accessPoint = getAccessPoint(profile);
// add this host
String ckanURL = accessPoint.address();
catalogueConfiguration.setCkanURL(ckanURL);
Map<String, Property> propertyMap = accessPoint.propertyMap();
// retrieve sys admin token
String encryptedSysAdminToken = propertyMap.get(API_KEY_PROPERTY_KEY).value();
catalogueConfiguration.setEncryptedSysAdminToken(encryptedSysAdminToken);
String defaultOrganization = CatalogueConfiguration.getOrganizationName(context);
String solrURL = null;
if (propertyMap.containsKey(SOLR_INDEX_ADDRESS_PROPERTY_KEY)) {
solrURL = propertyMap.get(SOLR_INDEX_ADDRESS_PROPERTY_KEY).value();
}else {
solrURL = getDefaultSolrURL(ckanURL);
}
catalogueConfiguration.setSolrURL(solrURL);
// retrieve option to check if the social post has to be made
Boolean socialPostEnabled = true;
if (propertyMap.containsKey(SOCIAL_POST_PROPERTY_KEY)) {
if (propertyMap.get(SOCIAL_POST_PROPERTY_KEY).value().trim().equalsIgnoreCase("false")) {
socialPostEnabled = false;
}
}
catalogueConfiguration.setSocialPostEnabled(socialPostEnabled);
// retrieve option for user alert
boolean notificationToUsersEnabled = false; // default is false
if (propertyMap.containsKey(ALERT_USERS_ON_POST_CREATION_PROPERTY_KEY)) {
if (propertyMap.get(ALERT_USERS_ON_POST_CREATION_PROPERTY_KEY).value().trim()
.equalsIgnoreCase("true")) {
notificationToUsersEnabled = true;
}
}
catalogueConfiguration.setNotificationToUsersEnabled(notificationToUsersEnabled);
boolean moderationEnabled = false; // default is false
if (propertyMap.containsKey(MODERATION_ENABLED_KEY_PROPERTY_KEY)) {
if (propertyMap.get(MODERATION_ENABLED_KEY_PROPERTY_KEY).value().trim().equalsIgnoreCase("true")) {
moderationEnabled = true;
}
}
catalogueConfiguration.setModerationEnabled(moderationEnabled);
Set<String> supportedOrganizations = getSupportedOrganizationsFromGenericResource();
if (supportedOrganizations != null) {
catalogueConfiguration.setSupportedOrganizations(supportedOrganizations);
if(defaultOrganization==null) {
defaultOrganization = supportedOrganizations.toArray(new String[supportedOrganizations.size()])[0];
catalogueConfiguration.setDefaultOrganization(defaultOrganization);
}
}
ServiceCKANDB ckanDB = getCKANDBFromIS();
catalogueConfiguration.setCkanDB(ckanDB);
} catch (WebApplicationException e) {
throw e;
} catch (Exception e) {
throw new InternalServerErrorException("Error while getting configuration on IS", e);
}
return catalogueConfiguration;
}
// CKAN Instance info
@Deprecated
private final static String CKAN_DB_SERVICE_ENDPOINT_CATEGORY= "Database";
@Deprecated
private final static String CKAN_DB_SERVICE_ENDPOINT_NAME = "CKanDatabase";
@Deprecated
protected ServiceCKANDB getCKANDBFromIS() {
try {
List<ServiceEndpoint> serviceEndpoints = getServiceEndpoints(CKAN_DB_SERVICE_ENDPOINT_CATEGORY, CKAN_DB_SERVICE_ENDPOINT_NAME);
if(serviceEndpoints.size() == 0) {
String error = String.format("There is no %s having category '%s' and name '%s' in this context.",
ServiceEndpoint.class.getSimpleName(), CKAN_DB_SERVICE_ENDPOINT_CATEGORY, CKAN_DB_SERVICE_ENDPOINT_NAME);
logger.error(error);
throw new InternalServerErrorException(error);
}
ServiceEndpoint serviceEndpoint = null;
if(serviceEndpoints.size() > 1) {
logger.info("Too many {} having category {} and name {} in this context. Looking for the one that has the property {}",
ServiceEndpoint.class.getSimpleName(), CKAN_DB_SERVICE_ENDPOINT_CATEGORY,
CKAN_DB_SERVICE_ENDPOINT_NAME);
for(ServiceEndpoint se : serviceEndpoints) {
Iterator<AccessPoint> accessPointIterator = se.profile().accessPoints().iterator();
while(accessPointIterator.hasNext()) {
ServiceEndpoint.AccessPoint accessPoint = accessPointIterator.next();
// get the is master property
Property entry = accessPoint.propertyMap().get(IS_ROOT_MASTER_PROPERTY_KEY);
String isMaster = entry != null ? entry.value() : null;
if(isMaster == null || !isMaster.equals("true")) {
continue;
}
// set this variable
serviceEndpoint = se;
break;
}
}
// if none of them was master, throw an exception
if(serviceEndpoint == null) {
throw new InternalServerErrorException(
"Too many CKAN configuration on IS and no one with MASTER property");
}
} else {
serviceEndpoint = serviceEndpoints.get(0);
}
Iterator<AccessPoint> accessPointIterator = serviceEndpoint.profile().accessPoints().iterator();
while(accessPointIterator.hasNext()) {
AccessPoint accessPoint = accessPointIterator.next();
String host = accessPoint.address();
String db = accessPoint.name();
ServiceCKANDB ckanDB = new ServiceCKANDB();
String url = String.format("jdbc:postgresql://%s/%s", host, db);
ckanDB.setUrl(url);
ckanDB.setUsername(accessPoint.username());
ckanDB.setEncryptedPassword(accessPoint.password());
return ckanDB;
}
return null;
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new InternalServerErrorException("Error while getting configuration on IS", e);
}
}
@Deprecated
public static final String GENERIC_RESOURCE_SECONDARY_TYPE_FOR_ORGANIZATIONS = "ApplicationProfile";
@Deprecated
public static final String GENERIC_RESOURCE_NAME_FOR_ORGANIZATIONS = "Supported CKAN Organizations";
@Deprecated
public static final String GENERIC_RESOURCE_CKAN_ORGANIZATIONS = "CKANOrganizations";
@Deprecated
private List<GenericResource> getGenericResources() {
SimpleQuery query = ICFactory.queryFor(GenericResource.class);
query.addCondition(String.format("$resource/Profile/SecondaryType/text() eq '%s'",
GENERIC_RESOURCE_SECONDARY_TYPE_FOR_ORGANIZATIONS));
query.addCondition(
String.format("$resource/Profile/Name/text() eq '%s'", GENERIC_RESOURCE_NAME_FOR_ORGANIZATIONS));
DiscoveryClient<GenericResource> client = ICFactory.clientFor(GenericResource.class);
List<GenericResource> genericResources = client.submit(query);
return genericResources;
}
protected String marshallSupportedOrganizations() throws JsonProcessingException {
Set<String> supportedOrganizations = catalogueConfiguration.getSupportedOrganizations();
return marshallSupportedOrganizations(supportedOrganizations);
}
protected String marshallSupportedOrganizations(Set<String> supportedOrganizations) throws JsonProcessingException {
ObjectMapper objectMapper = new ObjectMapper();
ArrayNode arrayNode = objectMapper.createArrayNode();
for(String org : supportedOrganizations) {
arrayNode.add(org);
}
return objectMapper.writeValueAsString(arrayNode);
}
@Deprecated
protected Set<String> unmarshallSupportedOrganizations(String supportedOrganizationsJsonArray){
try {
ObjectMapper objectMapper = new ObjectMapper();
JsonNode jsonNode = objectMapper.readTree(supportedOrganizationsJsonArray);
ArrayNode array = (ArrayNode) jsonNode.get(GENERIC_RESOURCE_CKAN_ORGANIZATIONS);
Set<String> supportedOrganizations = new HashSet<>(array.size());
for (int i = 0; i < array.size(); i++) {
String o = array.get(i).asText();
supportedOrganizations.add(o);
}
logger.debug("Supported CKAN Organization for current Context ({}) are {}", context,
supportedOrganizations);
return supportedOrganizations;
} catch (Exception e) {
return null;
}
}
@Deprecated
protected Set<String> getSupportedOrganizationsFromGenericResource() {
List<GenericResource> genericResources = getGenericResources();
if (genericResources == null || genericResources.size() == 0) {
logger.trace(
"{} with SecondaryType {} and Name %s not found. Item will be only be created in {} CKAN organization",
GenericResource.class.getSimpleName(), GENERIC_RESOURCE_SECONDARY_TYPE_FOR_ORGANIZATIONS,
GENERIC_RESOURCE_NAME_FOR_ORGANIZATIONS, ServiceCatalogueConfiguration.getOrganizationName(context));
return null;
}
GenericResource genericResource = genericResources.get(0);
String supportedOrganizationsJsonArray = genericResource.profile().body().getTextContent();
Set<String> supportedOrganizatins = unmarshallSupportedOrganizations(supportedOrganizationsJsonArray);
return supportedOrganizatins;
}
@Deprecated
public void deleteOldConfiguration() {
RegistryPublisher registryPublisher = RegistryPublisherFactory.create();
deleteOldConfiguration(registryPublisher);
}
@Deprecated
protected void deleteOldConfiguration(RegistryPublisher registryPublisher) {
ServiceEndpoint serviceEndpoint = getOldServiceEndpoint();
if(serviceEndpoint!=null) {
registryPublisher.remove(serviceEndpoint);
}
List<GenericResource> genericResources = getGenericResources();
if(genericResources!=null) {
for(GenericResource genericResource : genericResources) {
registryPublisher.remove(genericResource);
}
}
}
@Override
public void delete() {
RegistryPublisher registryPublisher = RegistryPublisherFactory.create();
ServiceEndpoint serviceEndpoint = getISResource();
if(serviceEndpoint!=null) {
registryPublisher.remove(serviceEndpoint);
}
}
protected Property addProperty(Group<Property> properties, String name, String value) {
return addProperty(properties, name, value, false);
}
protected Property addProperty(Group<Property> properties, String name, String value, boolean encrypted) {
Property property = new Property();
property.nameAndValue(name, value);
property.encrypted(encrypted);
properties.add(property);
return property;
}
protected Group<Property> setAccessPointProperties(AccessPoint accessPoint, String address, boolean update) throws JsonProcessingException {
accessPoint.description(String.format("Access Point %s by gcat %s", update ? "updated" : "created", getGcatVersion().toString()));
accessPoint.address(address);
accessPoint.name(GCatConstants.CONFIGURATION_NAME);
Group<Property> properties = accessPoint.properties();
JsonNode jsonNode = mapper.valueToTree(catalogueConfiguration);
Iterator<String> iterator = jsonNode.fieldNames();
while (iterator.hasNext()) {
String key = iterator.next();
if(key.compareTo(CatalogueConfiguration.ID_KEY)==0) {
continue;
}
if(key.compareTo(CatalogueConfiguration.SYS_ADMIN_TOKEN_KEY)==0) {
addProperty(properties, key, catalogueConfiguration.getEncryptedSysAdminToken(), true);
continue;
}
JsonNode valueJsonNode = jsonNode.get(key);
String value = valueJsonNode.toString();
if(valueJsonNode.isTextual()) {
value = valueJsonNode.asText();
}
addProperty(properties, key, value);
}
return properties;
}
/**
* Set the version of gcat so that in future implementation
* we can understand if the configuration must be updated.
* @param platform
* @return the platform
*/
protected Platform setVersion(Platform platform) {
Version version = getGcatVersion();
platform.version((short) version.getMajor());
platform.minorVersion((short) version.getMinor());
platform.revisionVersion((short) version.getRevision());
platform.buildVersion((short) 0);
return platform;
}
protected Platform setPlatformProperty(Platform platform) {
/*
* <Platform>
* <Name>gcat</Name>
* <!-- The version of gcat -->
* <Version>2</Version>
* <MinorVersion>2</MinorVersion>
* <RevisionVersion>0</RevisionVersion>
* <BuildVersion>0</BuildVersion>
* </Platform>
*/
platform.name(GCatConstants.SERVICE_NAME);
platform = setVersion(platform);
return platform;
}
private String getRunningOn(ContainerConfiguration containerConfiguration) {
return String.format("%s:%s", containerConfiguration.hostname(), containerConfiguration.port());
}
protected Runtime setRuntimeProperties(Runtime runtime) {
try {
ApplicationContext applicationContext = ContextProvider.get();
ContainerContext containerContext = applicationContext.container();
ContainerConfiguration containerConfiguration = containerContext.configuration();
String runningOn = getRunningOn(containerConfiguration);
runtime.hostedOn(runningOn);
runtime.ghnId(containerContext.id());
runtime.status(applicationContext.configuration().mode().toString());
}catch (Exception e) {
runtime.hostedOn("localhost");
runtime.ghnId("");
runtime.status("READY");
}
return runtime;
}
protected Profile setProfileProperties(Profile profile, boolean update) {
/*
* <Profile>
* <Category>Application</Category>
* <Name>CKanDataCatalogue</Name>
* <Description>gCat Configuration created/updated by the service via REST</Description>
*/
profile.category(GCatConstants.CONFIGURATION_CATEGORY);
profile.name(GCatConstants.CONFIGURATION_NAME);
profile.description(String.format("gCat configuration %s by the service via REST", update ? "updated" : "created"));
return profile;
}
// @Deprecated
// protected boolean isRootMaster(ServiceEndpoint serviceEndpoint) {
// Profile profile = serviceEndpoint.profile();
// AccessPoint accessPoint = getAccessPoint(profile);
// Map<String, Property> propertyMap = accessPoint.propertyMap();
// if (propertyMap.containsKey(IS_ROOT_MASTER_PROPERTY_KEY)) {
// if (propertyMap.get(IS_ROOT_MASTER_PROPERTY_KEY).value().trim().equalsIgnoreCase("true")) {
// return true;
// }
// }
// return false;
// }
protected ServiceEndpoint createServiceEndpoint(ServiceEndpoint serviceEndpoint) throws Exception {
boolean update = true;
if(serviceEndpoint==null) {
serviceEndpoint = new ServiceEndpoint();
serviceEndpoint.setId(catalogueConfiguration.getID());
update = false;
}
Profile profile = serviceEndpoint.newProfile();
profile = setProfileProperties(profile, update);
Platform platform = profile.newPlatform();
setPlatformProperty(platform);
Runtime runtime = profile.newRuntime();
runtime = setRuntimeProperties(runtime);
Group<AccessPoint> accessPoints = profile.accessPoints();
AccessPoint accessPoint = accessPoints.add();
setAccessPointProperties(accessPoint, runtime.hostedOn(), update);
return serviceEndpoint;
}
@Override
protected ServiceCatalogueConfiguration createOnIS() throws Exception {
RegistryPublisher registryPublisher = RegistryPublisherFactory.create();
String id = catalogueConfiguration.getID();
if(id==null || id.compareTo("")==0) {
id = UUID.randomUUID().toString();
catalogueConfiguration.setID(id);
}
ServiceEndpoint serviceEndpoint = createServiceEndpoint(null);
registryPublisher.create(serviceEndpoint);
return catalogueConfiguration;
}
@Override
protected ServiceCatalogueConfiguration updateOnIS() throws Exception {
RegistryPublisher registryPublisher = RegistryPublisherFactory.create();
ServiceEndpoint serviceEndpoint = getISResource();
String id = serviceEndpoint.id();
catalogueConfiguration.setID(id);
serviceEndpoint = createServiceEndpoint(serviceEndpoint);
registryPublisher.update(serviceEndpoint);
return catalogueConfiguration;
}
}

View File

@ -1,23 +0,0 @@
package org.gcube.gcat.configuration.isproxies.impl;
import org.gcube.gcat.configuration.isproxies.ISConfigurationProxyFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class GCoreISConfigurationProxyFactory extends ISConfigurationProxyFactory<GCoreISConfigurationProxy> {
public GCoreISConfigurationProxyFactory() {
super();
}
@Override
protected GCoreISConfigurationProxy newInstance(String context) {
GCoreISConfigurationProxy isConfigurationProxy = new GCoreISConfigurationProxy(context);
return isConfigurationProxy;
}
}

View File

@ -1,86 +0,0 @@
package org.gcube.gcat.configuration.service;
import javax.ws.rs.InternalServerErrorException;
import org.gcube.com.fasterxml.jackson.annotation.JsonGetter;
import org.gcube.com.fasterxml.jackson.annotation.JsonIgnore;
import org.gcube.com.fasterxml.jackson.annotation.JsonProperty;
import org.gcube.gcat.configuration.isproxies.impl.FacetBasedISConfigurationProxy;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class FacetBasedISServiceCatalogueConfiguration extends ServiceCatalogueConfiguration {
private static Logger logger = LoggerFactory.getLogger(FacetBasedISServiceCatalogueConfiguration.class);
protected final FacetBasedISConfigurationProxy facetBasedISConfigurationProxy;
public FacetBasedISServiceCatalogueConfiguration(String context, FacetBasedISConfigurationProxy facetBasedISConfigurationProxy) {
super(context);
this.facetBasedISConfigurationProxy = facetBasedISConfigurationProxy;
}
@JsonProperty(value = CKAN_URL_KEY)
public String getCkanURL() {
if(ckanURL==null) {
try {
facetBasedISConfigurationProxy.setCkanServiceInfo(this);
} catch (Exception e) {
throw new InternalServerErrorException(e);
}
}
return ckanURL;
}
@JsonIgnore
public String getSysAdminToken() {
if(sysAdminToken==null) {
try {
facetBasedISConfigurationProxy.setCkanServiceInfo(this);
} catch (Exception e) {
throw new InternalServerErrorException(e);
}
}
return sysAdminToken;
}
@JsonGetter(value=SYS_ADMIN_TOKEN_KEY)
public String getEncryptedSysAdminToken() {
if(encryptedSysAdminToken==null) {
try {
facetBasedISConfigurationProxy.setCkanServiceInfo(this);
} catch (Exception e) {
throw new InternalServerErrorException(e);
}
}
return encryptedSysAdminToken;
}
@JsonGetter(value = CKAN_DB_KEY)
public ServiceCKANDB getCkanDB() {
if(ckanDB==null) {
try {
facetBasedISConfigurationProxy.setCkanDBInfo(this);
} catch (Exception e) {
throw new InternalServerErrorException(e);
}
}
return (ServiceCKANDB) ckanDB;
}
@JsonProperty(value = SOLR_URL_KEY)
public String getSolrURL() {
if(solrURL==null) {
try {
facetBasedISConfigurationProxy.setSolrServiceInfo(this);
} catch (Exception e) {
throw new InternalServerErrorException(e);
}
}
return solrURL;
}
}

View File

@ -1,63 +0,0 @@
package org.gcube.gcat.configuration.service;
import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import org.gcube.com.fasterxml.jackson.annotation.JsonGetter;
import org.gcube.com.fasterxml.jackson.annotation.JsonIgnore;
import org.gcube.com.fasterxml.jackson.annotation.JsonSetter;
import org.gcube.common.encryption.encrypter.StringEncrypter;
import org.gcube.gcat.api.configuration.CKANDB;
/**
* @author Luca Frosini (ISTI-CNR)
*/
public class ServiceCKANDB extends CKANDB {
public static final String USERNAME_KEY = "username";
public static final String PASSWORD_KEY = "password";
protected String encryptedPassword;
@JsonIgnore
public String getPassword() {
return password;
}
@JsonIgnore
public String getPlainPassword() {
return password;
}
@JsonGetter(value=PASSWORD_KEY)
public String getEncryptedPassword() {
return encryptedPassword;
}
public void setEncryptedPassword(String encryptedPassword) throws Exception {
this.encryptedPassword = encryptedPassword;
this.password = StringEncrypter.getEncrypter().decrypt(encryptedPassword);
}
public void setPlainPassword(String plainPassword) throws Exception {
this.password = plainPassword;
this.encryptedPassword = StringEncrypter.getEncrypter().encrypt(plainPassword);
}
@Override
@JsonSetter(value = PASSWORD_KEY)
public void setPassword(String password) {
try {
try {
this.password = StringEncrypter.getEncrypter().decrypt(password);
this.encryptedPassword = password;
}catch (IllegalBlockSizeException | BadPaddingException e) {
this.password = password;
this.encryptedPassword = StringEncrypter.getEncrypter().encrypt(password);
}
}catch (Exception e) {
throw new RuntimeException(e);
}
}
}

View File

@ -1,142 +0,0 @@
package org.gcube.gcat.configuration.service;
import javax.crypto.BadPaddingException;
import javax.crypto.IllegalBlockSizeException;
import org.gcube.com.fasterxml.jackson.annotation.JsonGetter;
import org.gcube.com.fasterxml.jackson.annotation.JsonIgnore;
import org.gcube.com.fasterxml.jackson.annotation.JsonSetter;
import org.gcube.com.fasterxml.jackson.core.JsonProcessingException;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.common.encryption.encrypter.StringEncrypter;
import org.gcube.gcat.api.configuration.CKANDB;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.api.roles.Role;
import org.gcube.gcat.persistence.ckan.CKANUser;
import org.gcube.gcat.persistence.ckan.cache.CKANUserCache;
/**
* @author Luca Frosini (ISTI-CNR)
*/
public class ServiceCatalogueConfiguration extends CatalogueConfiguration {
protected ObjectMapper mapper;
public ServiceCatalogueConfiguration() {
super();
mapper = new ObjectMapper();
}
public ServiceCatalogueConfiguration(String context) {
super(context);
mapper = new ObjectMapper();
}
@JsonIgnore
protected String encryptedSysAdminToken;
@JsonIgnore
public String getSysAdminToken() {
return sysAdminToken;
}
@JsonIgnore
public String getPlainSysAdminToken() {
return getSysAdminToken();
}
@JsonGetter(value=SYS_ADMIN_TOKEN_KEY)
public String getEncryptedSysAdminToken() {
return encryptedSysAdminToken;
}
public void setEncryptedSysAdminToken(String encryptedSysAdminToken) throws Exception {
this.encryptedSysAdminToken = encryptedSysAdminToken;
this.sysAdminToken = StringEncrypter.getEncrypter().decrypt(encryptedSysAdminToken);
}
public void setPlainSysAdminToken(String plainSysAdminToken) throws Exception {
this.sysAdminToken = plainSysAdminToken;
this.encryptedSysAdminToken = StringEncrypter.getEncrypter().encrypt(plainSysAdminToken);
}
@Override
@JsonSetter(value = SYS_ADMIN_TOKEN_KEY)
public void setSysAdminToken(String sysAdminToken) {
try {
try {
this.sysAdminToken = StringEncrypter.getEncrypter().decrypt(sysAdminToken);
this.encryptedSysAdminToken = sysAdminToken;
}catch (IllegalBlockSizeException | BadPaddingException e) {
this.sysAdminToken = sysAdminToken;
this.encryptedSysAdminToken = StringEncrypter.getEncrypter().encrypt(sysAdminToken);
}
}catch (Exception e) {
throw new RuntimeException(e);
}
}
@Override
@JsonGetter(value = CKAN_DB_KEY)
public ServiceCKANDB getCkanDB() {
return (ServiceCKANDB) ckanDB;
}
@Override
public void setCkanDB(CKANDB ckanDB) {
this.ckanDB = new ServiceCKANDB();
this.ckanDB.setUrl(ckanDB.getUrl());
this.ckanDB.setUsername(ckanDB.getUsername());
this.ckanDB.setPassword(ckanDB.getPassword());
}
@JsonSetter(value=CKAN_DB_KEY)
public void setCkanDB(ServiceCKANDB ckanDB) {
this.ckanDB = ckanDB;
}
public ObjectNode toObjetcNode() throws JsonProcessingException {
return toObjetcNode(false);
}
public ObjectNode toObjetcNode(boolean decryptedValues) throws JsonProcessingException {
ObjectNode configuration = mapper.valueToTree(this);
CKANUser ckanUser = CKANUserCache.getCurrrentCKANUser();
if(ckanUser.getRole().ordinal() < Role.MANAGER.ordinal()) {
configuration.remove(ServiceCatalogueConfiguration.SYS_ADMIN_TOKEN_KEY);
configuration.remove(ServiceCatalogueConfiguration.CKAN_DB_KEY);
}else {
if(decryptedValues) {
configuration.put(ServiceCatalogueConfiguration.SYS_ADMIN_TOKEN_KEY, getPlainSysAdminToken());
ObjectNode node = (ObjectNode) configuration.get(ServiceCatalogueConfiguration.CKAN_DB_KEY);
node.put(ServiceCKANDB.PASSWORD_KEY, ((ServiceCKANDB) ckanDB).getPlainPassword());
}
}
return configuration;
}
public String toJsonString() throws Exception {
return toJsonString(false);
}
public String toJsonString(boolean decryptedValues) throws Exception {
ObjectNode objectNode = toObjetcNode(decryptedValues);
return mapper.writeValueAsString(objectNode);
}
public static ServiceCatalogueConfiguration getServiceCatalogueConfiguration(String json) throws Exception {
ObjectMapper mapper = new ObjectMapper();
ServiceCatalogueConfiguration catalogueConfiguration = mapper.readValue(json, ServiceCatalogueConfiguration.class);
return catalogueConfiguration;
}
public static ServiceCatalogueConfiguration getServiceCatalogueConfiguration(ObjectNode objectNode) throws Exception {
ObjectMapper mapper = new ObjectMapper();
ServiceCatalogueConfiguration catalogueConfiguration = mapper.treeToValue(objectNode, ServiceCatalogueConfiguration.class);
return catalogueConfiguration;
}
}

View File

@ -1,34 +0,0 @@
package org.gcube.gcat.moderation.thread;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.gcat.api.moderation.CMItemStatus;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class FakeModerationThread extends ModerationThread {
private static final Logger logger = LoggerFactory.getLogger(FakeModerationThread.class);
@Override
protected void postMessage(String message) throws Exception {
logger.info("gCat is sending a message to the {} for item '{}' (id={}). ItemStatus={}, Message=\"{}\"",
ModerationThread.class.getSimpleName(), itemName, itemID, cmItemStatus, message);
}
@Override
public void postUserMessage(CMItemStatus cmItemStatus, String userMessage) throws Exception {
logger.info("{} is sending a message to the {} for item '{}' (id={}). ItemStatus={}, Message=\"{}\"",
SecretManagerProvider.instance.get().getUser().getUsername(),
ModerationThread.class.getSimpleName(), itemName, itemID, cmItemStatus, userMessage);
}
@Override
protected void createModerationThread() throws Exception {
logger.info("Creating {} for item '{}' (id={})", ModerationThread.class.getSimpleName(), itemName, itemID);
}
}

View File

@ -1,174 +0,0 @@
package org.gcube.gcat.moderation.thread;
import java.util.HashMap;
import java.util.Map;
//import java.util.HashMap;
//import java.util.Map;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
//import org.gcube.common.authorization.utils.manager.SecretManager;
//import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
//import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.api.moderation.CMItemStatus;
import org.gcube.gcat.moderation.thread.social.notifications.SocialNotificationModerationThread;
import org.gcube.gcat.persistence.ckan.CKANUser;
//import org.gcube.portlets.user.uriresolvermanager.UriResolverManager;
//import org.gcube.portlets.user.uriresolvermanager.resolvers.query.CatalogueResolverQueryString.MODERATION_OP;
//import org.gcube.portlets.user.uriresolvermanager.resolvers.query.CatalogueResolverQueryStringBuilder;
import org.gcube.portlets.user.uriresolvermanager.UriResolverManager;
import org.gcube.portlets.user.uriresolvermanager.resolvers.query.CatalogueResolverQueryString.MODERATION_OP;
import org.gcube.portlets.user.uriresolvermanager.resolvers.query.CatalogueResolverQueryStringBuilder;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public abstract class ModerationThread {
protected String itemID;
protected String itemName;
protected String itemTitle;
protected String itemURL;
protected String itemAuthorCkanUsername;
protected String moderationURL;
protected boolean create;
protected CMItemStatus cmItemStatus;
protected boolean itemAuthor;
protected CKANUser ckanUser;
protected ObjectMapper objectMapper;
public static ModerationThread getDefaultInstance() {
// return new FakeModerationThread();
// return new SocialMessageModerationThread();
return new SocialNotificationModerationThread();
}
public ModerationThread() {
this.objectMapper = new ObjectMapper();
this.itemAuthor = false;
this.create = false;
this.cmItemStatus = CMItemStatus.PENDING;
}
public void setItemCoordinates(String itemID, String itemName, String itemTitle, String itemURL) {
this.itemID = itemID;
this.itemName = itemName;
this.itemTitle = itemTitle;
this.itemURL = itemURL;
}
public void setItemAuthor(boolean itemAuthor) {
this.itemAuthor = itemAuthor;
}
public String getItemAuthorCkanUsername() {
return itemAuthorCkanUsername;
}
public void setItemAuthorCkanUsername(String itemAuthorCkanUsername) {
this.itemAuthorCkanUsername = itemAuthorCkanUsername;
}
public void setCKANUser(CKANUser ckanUser) {
this.ckanUser = ckanUser;
}
public String getModerationURL() {
if(moderationURL==null) {
try {
SecretManager secretManager = SecretManagerProvider.instance.get();
String context = secretManager.getContext();
UriResolverManager resolver = new UriResolverManager("CTLG");
Map<String, String> params = new HashMap<String, String>();
params.put("gcube_scope", context); //e.g. /gcube/devsec/devVRE
params.put("entity_context", "organization");
params.put("entity_name", CatalogueConfiguration.getOrganizationName(context)); //e.g. devvre
CatalogueResolverQueryStringBuilder builder = new CatalogueResolverQueryStringBuilder(itemName); //item name under moderation
builder.itemStatus(cmItemStatus.name()). //e.g. pending, approved, rejected
moderation(MODERATION_OP.show);
String queryString = builder.buildQueryParametersToQueryString();
params.put(CatalogueResolverQueryStringBuilder.QUERY_STRING_PARAMETER, queryString);
moderationURL = resolver.getLink(params, true);
}catch (Exception e) {
return itemURL;
}
}
return moderationURL;
}
/**
* The message is sent as gCat
* @param message
* @throws Exception
*/
protected abstract void postMessage(String message) throws Exception;
/**
* The message is sent as User
*
* @param cmItemStatus
* @param userMessage
* @throws Exception
*/
public abstract void postUserMessage(CMItemStatus cmItemStatus, String userMessage) throws Exception;
protected abstract void createModerationThread() throws Exception;
public void postItemCreated() throws Exception {
createModerationThread();
this.create = true;
this.cmItemStatus = CMItemStatus.PENDING;
String fullName = ckanUser.getNameSurname();
String message = String.format(
"@**%s** created the item with name '%s' (id='%s'). The item is now in **%s** state and must be moderated.",
fullName, itemName, itemID, cmItemStatus.getFancyValue());
postMessage(message);
}
public void postItemUpdated() throws Exception {
this.cmItemStatus = CMItemStatus.PENDING;
String fullName = ckanUser.getNameSurname();
String message = String.format(
"@**%s** updated the item with name '%s' (id='%s'). The item is now in **%s** state and must be moderated.",
fullName, itemName, itemID, cmItemStatus.getFancyValue());
postMessage(message);
}
public void postItemRejected(String userMessage) throws Exception {
this.cmItemStatus = CMItemStatus.REJECTED;
String fullName = ckanUser.getNameSurname();
String message = String.format(
"@**%s** **%s** the item with name '%s' (id='%s'). The author can delete the item or update it to try to meet moderators requests if any.",
fullName, cmItemStatus.getFancyValue(), itemName, itemID);
postMessage(message);
postUserMessage(cmItemStatus, userMessage);
}
public void postItemApproved(String userMessage) throws Exception {
this.cmItemStatus = CMItemStatus.APPROVED;
String fullName = ckanUser.getNameSurname();
String message = String.format(
"@**%s** **%s** the item with name '%s' (id='%s'). The item is now available in the catalogue. The item is available at %s",
fullName, cmItemStatus.getFancyValue(), itemName, itemID, itemURL);
postMessage(message);
postUserMessage(cmItemStatus, userMessage);
}
public void postItemDeleted() throws Exception {
this.cmItemStatus = null;
String fullName = ckanUser.getNameSurname();
String message = String.format(
"@**%s** deleted the item with name '%s' (id='%s')",
fullName, itemName, itemID, itemURL);
postMessage(message);
}
}

View File

@ -1,335 +0,0 @@
package org.gcube.gcat.moderation.thread.social.notifications;
import java.net.URL;
import java.util.HashSet;
import java.util.Set;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.gcat.api.moderation.CMItemStatus;
import org.gcube.gcat.api.moderation.Moderated;
import org.gcube.gcat.moderation.thread.ModerationThread;
import org.gcube.gcat.persistence.ckan.CKANUser;
import org.gcube.gcat.social.SocialUsers;
import org.gcube.gcat.utils.Constants;
import org.gcube.social_networking.social_networking_client_library.NotificationClient;
import org.gcube.social_networking.socialnetworking.model.beans.catalogue.CatalogueEvent;
import org.gcube.social_networking.socialnetworking.model.beans.catalogue.CatalogueEventType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class SocialNotificationModerationThread extends ModerationThread {
private static final Logger logger = LoggerFactory.getLogger(SocialNotificationModerationThread.class);
public static final String AUTHOR = "Author";
protected CatalogueEventType catalogueEventType;
protected boolean comment;
protected boolean notificationSentByGCat;
protected boolean notificationToSelfOnly;
public SocialNotificationModerationThread() {
super();
this.comment = false;
this.notificationSentByGCat = false;
this.notificationToSelfOnly = false;
}
/**
* Create the message for an item that is created/updated
*/
protected void notifyItemToBeManaged() throws Exception {
/*
* An example of created message is:
*
* [mister x] created/updated the item "[TITLE]". You are kindly requested to review it and decide either to APPROVE or REJECT it. [Go to catalogue]
*
*/
String fullName = ckanUser.getNameSurname();
StringBuffer stringBuffer = new StringBuffer();
if(notificationSentByGCat) {
stringBuffer.append(fullName);
}
stringBuffer.append(create ? " created " : " updated ");
stringBuffer.append("the item ");
stringBuffer = addQuotedTitle(stringBuffer);
stringBuffer.append(". You are kindly requested to review it and decide either to APPROVE or REJECT it. ");
postMessage(stringBuffer.toString());
notificationToSelfOnly = true;
notificationSentByGCat = true;
stringBuffer = new StringBuffer();
stringBuffer.append("Thank you for submitting your item ");
stringBuffer = addQuotedTitle(stringBuffer);
stringBuffer.append(" to the catalogue. This item has been successfully received and will be managed by the catalogue moderators.");
postMessage(stringBuffer.toString());
notificationToSelfOnly = false;
notificationSentByGCat = false;
}
protected void notifyItemDeleted() throws Exception {
String fullName = ckanUser.getNameSurname();
StringBuffer stringBuffer = new StringBuffer();
if(notificationSentByGCat) {
stringBuffer.append(fullName);
}
stringBuffer.append(" permanently deleted ");
stringBuffer.append("the item ");
stringBuffer = addQuotedTitle(stringBuffer);
stringBuffer.append(".");
postMessage(stringBuffer.toString());
}
@Override
public void postItemCreated() throws Exception {
create = true;
cmItemStatus = CMItemStatus.PENDING;
catalogueEventType = CatalogueEventType.ITEM_SUBMITTED;
notifyItemToBeManaged();
}
@Override
public void postItemUpdated() throws Exception {
create = false;
cmItemStatus = CMItemStatus.PENDING;
catalogueEventType = CatalogueEventType.ITEM_UPDATED;
notifyItemToBeManaged();
}
protected StringBuffer addUserWithRole(String fullName, String role, StringBuffer stringBuffer, boolean addUserFullName) {
if(addUserFullName) {
stringBuffer.append(fullName);
}
if(role!=null) {
stringBuffer.append(" [");
stringBuffer.append(role);
stringBuffer.append("] ");
}
return stringBuffer;
}
protected StringBuffer addUserWithRole(String fullName, String role, StringBuffer stringBuffer) {
return addUserWithRole(fullName, role, stringBuffer, notificationSentByGCat);
}
public void postItemManaged(String userMessage) throws Exception {
/*
* [mister x] rejected the item "[TITLE]" with this accompanying message "[MESSAGE]". To resubmit it [Go to catalogue]
*
* [mister x] approved the item "[TITLE]" with this accompanying message "[MESSAGE]". [Go to catalogue]
*/
this.create = false;
String fullName = ckanUser.getNameSurname();
StringBuffer stringBuffer = new StringBuffer();
stringBuffer = addUserWithRole(fullName, Moderated.CATALOGUE_MODERATOR, stringBuffer);
stringBuffer.append(cmItemStatus.getValue());
stringBuffer.append(" the item ");
stringBuffer = addQuotedTitle(stringBuffer);
if(userMessage!=null && userMessage.length()>0) {
stringBuffer.append(" with this accompanying message \"");
stringBuffer.append(userMessage);
stringBuffer.append("\"");
}
stringBuffer.append(".");
if(cmItemStatus == CMItemStatus.REJECTED) {
stringBuffer.append(" To resubmit it ");
}
postMessage(stringBuffer.toString());
}
@Override
public void postItemRejected(String userMessage) throws Exception {
this.create = false;
this.cmItemStatus = CMItemStatus.REJECTED;
this.catalogueEventType = CatalogueEventType.ITEM_REJECTED;
postItemManaged(userMessage);
}
@Override
public void postItemApproved(String userMessage) throws Exception {
this.create = false;
this.cmItemStatus = CMItemStatus.APPROVED;
this.catalogueEventType = CatalogueEventType.ITEM_PUBLISHED;
postItemManaged(userMessage);
}
@Override
public void postItemDeleted() throws Exception {
this.create = false;
this.cmItemStatus = null;
this.catalogueEventType = CatalogueEventType.ITEM_REMOVED;
notifyItemDeleted();
}
protected StringBuffer addQuotedTitle(StringBuffer stringBuffer, String quotingCharacter) {
stringBuffer.append(quotingCharacter);
stringBuffer.append(itemTitle);
stringBuffer.append(quotingCharacter);
return stringBuffer;
}
protected StringBuffer addQuotedTitle(StringBuffer stringBuffer) {
return addQuotedTitle(stringBuffer, "\"");
}
protected String getSubject() {
StringBuffer stringBuffer = new StringBuffer();
String fullName = ckanUser.getNameSurname();
if(!comment) {
switch (catalogueEventType) {
case ITEM_SUBMITTED:
stringBuffer.append(fullName);
stringBuffer.append(" created the item ");
break;
case ITEM_UPDATED:
stringBuffer.append(fullName);
stringBuffer.append(" updated the item ");
break;
case ITEM_REJECTED:
case ITEM_PUBLISHED:
addUserWithRole(fullName, Moderated.CATALOGUE_MODERATOR, stringBuffer, true);
stringBuffer.append(cmItemStatus.getValue());
stringBuffer.append(" the item ");
break;
default:
break;
}
}else {
addUserWithRole(fullName, itemAuthor ? SocialNotificationModerationThread.AUTHOR : Moderated.CATALOGUE_MODERATOR, stringBuffer, true);
stringBuffer.append("commented on the item ");
}
stringBuffer = addQuotedTitle(stringBuffer);
return stringBuffer.toString();
}
protected CatalogueEvent getCatalogueEvent(String messageString) throws Exception {
CatalogueEvent catalogueEvent = new CatalogueEvent();
catalogueEvent.setType(catalogueEventType);
catalogueEvent.setNotifyText(messageString);
catalogueEvent.setItemId(getSubject());
if(cmItemStatus!=null && cmItemStatus == CMItemStatus.APPROVED) {
catalogueEvent.setItemURL(new URL(itemURL));
}else {
catalogueEvent.setItemURL(new URL(getModerationURL()));
}
Set<String> users = new HashSet<>();
if(!notificationToSelfOnly) {
users.addAll(SocialUsers.getUsernamesByRole(Moderated.CATALOGUE_MODERATOR));
if(itemAuthorCkanUsername!=null) {
// Adding item author
users.add(CKANUser.getUsernameFromCKANUsername(itemAuthorCkanUsername));
}
}
// Adding current user
users.add(CKANUser.getUsernameFromCKANUsername(ckanUser.getName()));
catalogueEvent.setIdsToNotify(users.toArray(new String[users.size()]));
catalogueEvent.setIdsAsGroup(false);
return catalogueEvent;
}
@Override
protected void postMessage(String messageString) throws Exception {
CatalogueEvent catalogueEvent = getCatalogueEvent(messageString);
SecretManager secretManager = SecretManagerProvider.instance.get();
Secret secret = Constants.getCatalogueSecret();
if(notificationSentByGCat) {
secretManager.startSession(secret);
}
try {
sendNotification(catalogueEvent);
}finally {
if(notificationSentByGCat) {
secretManager.endSession();
}
}
}
@Override
public void postUserMessage(CMItemStatus cmItemStatus, String userMessage) throws Exception {
/*
* [mister x] ([Role]) commented on the item "[TITLE]" as follows "[MESSAGE]". [Go to catalogue]
*/
this.create = false;
this.cmItemStatus = cmItemStatus;
this.comment = true;
switch (cmItemStatus) {
case PENDING:
catalogueEventType = CatalogueEventType.ITEM_UPDATED;
break;
case APPROVED:
catalogueEventType = CatalogueEventType.ITEM_PUBLISHED;
break;
case REJECTED:
catalogueEventType = CatalogueEventType.ITEM_REJECTED;
break;
default:
break;
}
String fullName = ckanUser.getNameSurname();
StringBuffer stringBuffer = new StringBuffer();
stringBuffer = addUserWithRole(fullName, itemAuthor ? SocialNotificationModerationThread.AUTHOR : Moderated.CATALOGUE_MODERATOR, stringBuffer);
stringBuffer.append("commented on the item ");
stringBuffer = addQuotedTitle(stringBuffer);
stringBuffer.append(" as follows \"");
stringBuffer.append(userMessage);
stringBuffer.append("\".");
CatalogueEvent catalogueEvent = getCatalogueEvent(stringBuffer.toString());
SecretManager secretManager = SecretManagerProvider.instance.get();
Secret secret = Constants.getCatalogueSecret();
if(notificationSentByGCat) {
secretManager.startSession(secret);
}
try {
sendNotification(catalogueEvent);
}finally {
if(notificationSentByGCat) {
secretManager.endSession();
}
}
}
protected void sendNotification(CatalogueEvent catalogueEvent) throws Exception {
Thread thread = new Thread() {
public void run() {
try {
logger.trace("{} is going to send the following notification {}", SecretManagerProvider.instance.get().getUser().getUsername(), catalogueEvent);
NotificationClient nc = new NotificationClient();
nc.sendCatalogueEvent(catalogueEvent);
} catch(Exception e) {
logger.error("Error while sending notification.", e);
}
}
};
// thread.run();
thread.start();
}
@Override
protected void createModerationThread() throws Exception {
create = true;
cmItemStatus = CMItemStatus.PENDING;
}
}

View File

@ -1,43 +0,0 @@
package org.gcube.gcat.moderation.thread.zulip;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class ZulipAuth {
public static final String ZULIP_RC_FILENAME = "zuliprc";
public static final String EMAIL_KEY = "email";
public static final String KEY_KEY = "key";
public static final String SITE_KEY = "site";
protected final Properties properties;
public ZulipAuth(String username) {
properties = new Properties();
InputStream input = ZulipAuth.class.getClassLoader().getResourceAsStream(username+"_"+ZULIP_RC_FILENAME);
try {
// load the properties file
properties.load(input);
} catch(IOException e) {
throw new RuntimeException(e);
}
}
public String getEmail() {
return properties.getProperty(EMAIL_KEY);
}
public String getAPIKey() {
return properties.getProperty(KEY_KEY);
}
public String getSite() {
return properties.getProperty(SITE_KEY);
}
}

View File

@ -1,57 +0,0 @@
package org.gcube.gcat.moderation.thread.zulip;
import java.io.IOException;
import org.gcube.com.fasterxml.jackson.core.JsonProcessingException;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class ZulipResponse {
public static final String RESULT_KEY = "result";
public static final String MSG_KEY = "msg";
public enum Result {
success,
error
}
protected ObjectMapper objectMapper;
protected String responseString;
protected JsonNode response;
protected Result result;
protected String message;
public ZulipResponse(String responseString) {
this.responseString = responseString;
this.objectMapper = new ObjectMapper();
}
public Result getResponseResult() throws JsonProcessingException, IOException {
if(result==null) {
String resultString = getResponse().get(RESULT_KEY).asText();
result = Result.valueOf(resultString);
}
return result;
}
public String getResponseMessage() throws JsonProcessingException, IOException {
if(message==null) {
message = getResponse().get(MSG_KEY).asText();
}
return message;
}
public JsonNode getResponse() throws JsonProcessingException, IOException {
if(response == null) {
response = objectMapper.readTree(responseString);
}
return response;
}
}

View File

@ -1,171 +0,0 @@
package org.gcube.gcat.moderation.thread.zulip;
//import java.util.Set;
//
//import javax.ws.rs.InternalServerErrorException;
//
//import org.gcube.com.fasterxml.jackson.databind.JsonNode;
//import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
//import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
//import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
//import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.gcat.api.moderation.CMItemStatus;
//import org.gcube.gcat.api.moderation.Moderated;
import org.gcube.gcat.moderation.thread.ModerationThread;
//import org.gcube.gcat.moderation.thread.zulip.ZulipResponse.Result;
//import org.gcube.gcat.social.SocialUsers;
//import org.gcube.gcat.utils.Constants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
//import io.taliox.zulip.ZulipRestExecutor;
//import io.taliox.zulip.calls.ZulipRestAPICall;
//import io.taliox.zulip.calls.messages.PostMessage;
//import io.taliox.zulip.calls.streams.GetStreamID;
//import io.taliox.zulip.calls.streams.PostCreateStream;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class ZulipStream extends ModerationThread {
private static final Logger logger = LoggerFactory.getLogger(ZulipStream.class);
@Override
protected void postMessage(String message) throws Exception {
logger.info("gCat is sending a message to the {} for item '{}' (id={}). ItemStatus={}, Message=\"{}\"",
ZulipStream.class.getSimpleName(), itemName, itemID, cmItemStatus, message);
}
@Override
public void postUserMessage(CMItemStatus cmItemStatus, String userMessage) throws Exception {
logger.info("{} is sending a message to the {} for item '{}' (id={}). ItemStatus={}, Message=\"{}\"",
SecretManagerProvider.instance.get().getUser().getUsername(),
ZulipStream.class.getSimpleName(), itemName, itemID, cmItemStatus, userMessage);
}
@Override
protected void createModerationThread() throws Exception {
logger.info("Creating {} for item '{}' (id={})", ZulipStream.class.getSimpleName(), itemName, itemID);
}
// public static final String TOPICS_KEY = "topics";
// public static final String NAME_KEY = "name";
// public static final String MAX_ID_KEY = "max_id";
// public static final String INITIAL_TOPIC_NAME = "hello";
//
// protected ZulipRestExecutor gCatZulipRestExecutor;
// protected ZulipRestExecutor userZulipRestExecutor;
//
// protected String streamName;
// protected String streamDescription;
//
// public ZulipStream() {
// super();
// }
//
// protected ZulipRestExecutor getZulipRestExecutor() {
// ZulipAuth zulipAuth = new ZulipAuth(SecretManagerProvider.instance.get().getUser().getUsername());
// return new ZulipRestExecutor(zulipAuth.getEmail(), zulipAuth.getAPIKey(), zulipAuth.getSite());
// }
//
// public ZulipRestExecutor getGCatZulipRestExecutor() throws Exception {
// if(gCatZulipRestExecutor==null) {
// SecretManager secretManager = SecretManagerProvider.instance.get();
// Secret secret = Constants.getCatalogueSecret();
// secretManager.startSession(secret);
// gCatZulipRestExecutor = getZulipRestExecutor();
// secretManager.endSession();
// }
// return gCatZulipRestExecutor;
// }
//
// public ZulipRestExecutor getUserZulipRestExecutor() {
// if(userZulipRestExecutor==null) {
// userZulipRestExecutor = getZulipRestExecutor();
// }
// return userZulipRestExecutor;
// }
//
// protected String getStreamName() {
// if(streamName==null) {
// streamName = String.format("Item '%s' moderation", itemID);
// }
// return streamName;
// }
//
// protected Integer getStreamID() throws Exception {
// GetStreamID getStreamID = new GetStreamID(getStreamName());
// ZulipResponse zulipResponse = executeZulipCall(gCatZulipRestExecutor, getStreamID);
// JsonNode response = zulipResponse.getResponse();
// return response.get("stream_id").asInt();
// }
//
// protected String getStreamDescription() {
// if(streamDescription==null) {
// streamDescription = String.format("This stream is used to discuss about the moderation of the item '%s' with id '%s'", itemName, itemID);
// }
// return streamDescription;
// }
//
// protected ZulipResponse executeZulipCall(ZulipRestExecutor zulipRestExecutor, ZulipRestAPICall call) throws Exception {
// logger.trace("Going to execute {}", call);
// String responseString = zulipRestExecutor.executeCall(call);
// logger.trace("Response from {} is {}", call.getClass().getSimpleName(), responseString);
// ZulipResponse zulipResponse = new ZulipResponse(responseString);
// if(zulipResponse.getResponseResult()==Result.error) {
// throw new InternalServerErrorException(zulipResponse.getResponseMessage());
// }
// return zulipResponse;
// }
//
// @Override
// protected void createModerationThread() throws Exception {
// ArrayNode streamsArrayNode = objectMapper.createArrayNode();
// ObjectNode streamobjectNode = objectMapper.createObjectNode();
// streamobjectNode.put("name", getStreamName());
// streamobjectNode.put("description", getStreamDescription());
// streamsArrayNode.add(streamobjectNode);
//
// ArrayNode principalsArrayNode = objectMapper.createArrayNode();
// // Going to add the item creator
// String itemCreatorEmail = ckanUser.getEMail();
// principalsArrayNode.add(itemCreatorEmail);
//
// getGCatZulipRestExecutor();
//
// principalsArrayNode.add(gCatZulipRestExecutor.httpController.getUserName());
//
// // Going to add the catalogue moderators
// Set<String> moderators = SocialUsers.getUsernamesByRole(Moderated.CATALOGUE_MODERATOR);
// for(String moderator : moderators) {
// principalsArrayNode.add(moderator);
// }
//
// PostCreateStream postCreateStream = new PostCreateStream(streamsArrayNode.toString());
// postCreateStream.setPrincipals(principalsArrayNode.toString());
// postCreateStream.setInvite_only(true);
// postCreateStream.setAnnounce(false);
//
// executeZulipCall(gCatZulipRestExecutor, postCreateStream);
// }
//
// protected void postMessageToStream(ZulipRestExecutor zulipRestExecutor, String message) throws Exception {
// PostMessage postMessage = new PostMessage(getStreamName(), cmItemStatus.getFancyValue(), message);
// logger.debug("Going to send the following message: {}", message);
// executeZulipCall(zulipRestExecutor, postMessage);
// }
//
// @Override
// protected void postMessage(String message) throws Exception {
// postMessageToStream(getGCatZulipRestExecutor(), message);
// }
//
// @Override
// public void postUserMessage(CMItemStatus cmItemStatus, String message) throws Exception {
// this.cmItemStatus = cmItemStatus;
// postMessageToStream(getUserZulipRestExecutor(), message);
// }
}

View File

@ -1,131 +0,0 @@
package org.gcube.gcat.oldutils;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
/**
* A custom field bean. It also stores index of the category and of the metadata field associated.
* These are used to sort them before pushing the content to CKAN.
* If they are missing, indexes are set to Integer.MAX_VALUE.
* @author Costantino Perciante (ISTI - CNR)
* @author Luca Frosini (ISTI - CNR)
*/
public class CustomField implements Comparable<CustomField> {
private String key;
private String qualifiedKey;
private String value;
private int indexCategory = Integer.MAX_VALUE;
private int indexMetadataField = Integer.MAX_VALUE;
private void init(String key, String value, int indexCategory, int indexMetadataField) {
if(key == null || value == null || key.isEmpty()) {
throw new IllegalArgumentException(
"A custom field must have a key and a value! Provided values are " + key + "=" + value);
}
this.key = key;
this.qualifiedKey = key;
this.value = value;
this.indexMetadataField = indexMetadataField;
this.indexCategory = indexCategory;
if(this.indexCategory < 0) {
this.indexCategory = Integer.MAX_VALUE;
}
if(this.indexMetadataField < 0) {
this.indexMetadataField = Integer.MAX_VALUE;
}
}
public CustomField(JsonNode object) {
super();
init(object.get("key").asText(), object.get("value").asText(), -1, -1);
}
/**
* @param key
* @param value
*/
public CustomField(String key, String value) {
super();
init(key, value, -1, -1);
}
/**
* @param key
* @param value
* @param indexMetadataField
* @param indexCategory
*/
public CustomField(String key, String value, int indexCategory, int indexMetadataField) {
super();
init(key, value, indexCategory, indexMetadataField);
}
public String getKey() {
return key;
}
public void setKey(String key) {
this.key = key;
}
public String getValue() {
return value;
}
public void setValue(String value) {
this.value = value;
}
public String getQualifiedKey() {
return qualifiedKey;
}
public void setQualifiedKey(String qualifiedKey) {
this.qualifiedKey = qualifiedKey;
}
public int getIndexCategory() {
return indexCategory;
}
public void setIndexCategory(int indexCategory) {
this.indexCategory = indexCategory;
if(this.indexCategory < 0)
this.indexCategory = Integer.MAX_VALUE;
}
public int getIndexMetadataField() {
return indexMetadataField;
}
public void setIndexMetadataField(int indexMetadataField) {
this.indexMetadataField = indexMetadataField;
if(this.indexMetadataField < 0) {
this.indexMetadataField = Integer.MAX_VALUE;
}
}
@Override
public String toString() {
return "CustomField [key=" + key + ", qualifiedKey=" + qualifiedKey + ", value=" + value
+ ", indexMetadataField=" + indexMetadataField + ", indexCategory=" + indexCategory + "]";
}
@Override
public int compareTo(CustomField o) {
if(this.indexCategory == o.indexCategory) {
if(this.indexMetadataField == o.indexMetadataField) {
return 0;
} else {
return this.indexMetadataField > o.indexMetadataField ? 1 : -1;
}
} else {
return this.indexCategory > o.indexCategory ? 1 : -1;
}
}
}

View File

@ -1,645 +0,0 @@
package org.gcube.gcat.oldutils;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import javax.ws.rs.BadRequestException;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response.Status;
import org.apache.commons.lang.math.NumberUtils;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.common.scope.api.ScopeProvider;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.DataType;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataField;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataFormat;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataGrouping;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataTagging;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataVocabulary;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.NamespaceCategory;
import org.gcube.gcat.persistence.ckan.CKANGroup;
import org.gcube.gcat.persistence.ckan.CKANPackage;
import org.gcube.gcat.persistence.ckan.CKANUser;
import org.gcube.gcat.persistence.ckan.CKANUtility;
import org.gcube.gcat.profile.MetadataUtility;
import org.geojson.GeoJsonObject;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Validate creation item requests utilities.
* @author Costantino Perciante (ISTI - CNR)
* @author Luca Frosini (ISTI - CNR)
*/
public class Validator {
private static final Logger logger = LoggerFactory.getLogger(Validator.class);
private static final SimpleDateFormat DATE_SIMPLE = new SimpleDateFormat("yyyy-MM-dd");
private static final SimpleDateFormat DATE_HOUR_MINUTES = new SimpleDateFormat("yyyy-MM-dd HH:mm");
public static final int MAX_TAG_CHARS = 100;
public static final String ITEM_URL = "Item URL";
protected ObjectMapper mapper;
public Validator() {
this.mapper = new ObjectMapper();
}
public Validator(ObjectMapper mapper) {
this.mapper = mapper;
}
public ObjectNode validateAgainstProfile(ObjectNode objectNode, MetadataUtility metadataUtility) throws Exception {
ArrayNode extrasArrayOriginal = (ArrayNode) objectNode.get(CKANPackage.EXTRAS_KEY);
if(extrasArrayOriginal == null || extrasArrayOriginal.size() == 0) {
throw new BadRequestException(
"'extras' field is missing in context where metadata profile(s) are defined!");
}
ArrayNode groupsArrayOriginal = (ArrayNode) objectNode.get(CKANPackage.GROUPS_KEY);
if(groupsArrayOriginal == null) {
groupsArrayOriginal = mapper.createArrayNode();
}
ArrayNode tagsArrayOriginal = (ArrayNode) objectNode.get(CKANPackage.TAGS_KEY);
if(tagsArrayOriginal == null) {
tagsArrayOriginal = mapper.createArrayNode();
}
// get the metadata profile specifying the type
CustomField metadataTypeCF = null;
List<CustomField> customFields = new ArrayList<CustomField>(extrasArrayOriginal.size());
Iterator<JsonNode> iterator = extrasArrayOriginal.iterator();
while(iterator.hasNext()) {
JsonNode object = iterator.next();
CustomField cf = new CustomField(object);
if(cf.getKey().equals(CKANPackage.EXTRAS_KEY_VALUE_SYSTEM_TYPE)) {
metadataTypeCF = cf;
} else if(cf.getKey().equals(ITEM_URL)) {
continue;
} else {
customFields.add(cf);
}
}
if(metadataTypeCF == null) {
throw new BadRequestException("'" + CKANPackage.EXTRAS_KEY_VALUE_SYSTEM_TYPE
+ "' extra field is missing in context where metadata profile(s) are defined!");
}
String profileName = metadataTypeCF.getValue();
// fetch the profile by metadata type specified above
if(metadataUtility == null) {
metadataUtility = new MetadataUtility();
}
MetadataFormat profile = metadataUtility.getMetadataFormat(profileName);
if(profile == null) {
throw new BadRequestException("'" + CKANPackage.EXTRAS_KEY_VALUE_SYSTEM_TYPE + "' extra field's value ('"
+ profileName
+ "') specified as custom field doesn't match any of the profiles defined in this context!");
} else {
ArrayNode extrasArrayUpdated = null;
List<MetadataField> metadataFields = profile.getMetadataFields();
if(metadataFields == null || metadataFields.isEmpty()) {
extrasArrayUpdated = extrasArrayOriginal;
} else {
extrasArrayUpdated = mapper.createArrayNode();
List<NamespaceCategory> categories = metadataUtility.getNamespaceCategories();
logger.debug("Retrieved namespaces are {}", categories);
List<String> categoriesIds = new ArrayList<String>(categories == null ? 0 : categories.size());
if(categories == null || categories.isEmpty()) {
logger.warn("No category defined in context {}", ScopeProvider.instance.get());
} else {
for(NamespaceCategory metadataCategory : categories) {
categoriesIds.add(metadataCategory.getId()); // save them later for matching with custom fields
}
}
// the list of already validated customFields
List<CustomField> validatedCustomFields = new ArrayList<CustomField>(customFields.size());
// keep track of mandatory fields and their cardinality
Map<String,Integer> fieldsMandatoryLowerBoundMap = new HashMap<String,Integer>(metadataFields.size());
Map<String,Integer> fieldsMandatoryUpperBoundMap = new HashMap<String,Integer>(metadataFields.size());
Map<String,Integer> numberFieldsMandatorySameKeyMap = new HashMap<String,Integer>(
metadataFields.size());
// keep track of the groups that must be created AFTER validation but BEFORE item creation
List<String> groupsToCreateAfterValidation = new ArrayList<String>();
// now validate fields
int metadataIndex = 0;
Map<String, MetadataField> metadataFieldMap = new HashMap<>();
for(MetadataField metadataField : metadataFields) {
metadataFieldMap.put(metadataField.getFieldName(), metadataField);
int categoryIdIndex = categoriesIds.indexOf(metadataField.getCategoryRef());
logger.debug("Found index for category " + metadataField.getCategoryRef() + " " + categoryIdIndex);
List<CustomField> validCFs = validateAgainstMetadataField(metadataIndex, categoryIdIndex,
customFields, tagsArrayOriginal, groupsArrayOriginal, metadataField, categories,
fieldsMandatoryLowerBoundMap, fieldsMandatoryUpperBoundMap, numberFieldsMandatorySameKeyMap,
groupsToCreateAfterValidation);
validatedCustomFields.addAll(validCFs);
metadataIndex++;
}
// check mandatory fields
Iterator<Entry<String,Integer>> iteratorLowerBounds = fieldsMandatoryLowerBoundMap.entrySet()
.iterator();
while(iteratorLowerBounds.hasNext()) {
Map.Entry<java.lang.String,java.lang.Integer> entry = (Map.Entry<java.lang.String,java.lang.Integer>) iteratorLowerBounds
.next();
int lowerBound = entry.getValue();
// int upperBound = fieldsMandatoryUpperBoundMap.get(entry.getKey());
int upperBound = Integer.MAX_VALUE;
try {
String maxOccurs = metadataFieldMap.get(entry.getKey()).getMaxOccurs();
if(maxOccurs==null || maxOccurs.compareTo("*")==0) {
upperBound = Integer.MAX_VALUE;
}else {
try {
upperBound = Integer.valueOf(maxOccurs);
}catch (Exception e) {
}
}
}catch (Exception e) {
upperBound = Integer.MAX_VALUE;
}
int inserted = numberFieldsMandatorySameKeyMap.get(entry.getKey());
logger.info("Field with key '" + entry.getKey() + "' has been found " + inserted
+ " times and its lower bound is " + lowerBound + " and upper bound " + upperBound);
if(inserted < lowerBound || inserted > upperBound) {
throw new BadRequestException("Field with key '" + entry.getKey()
+ "' is mandatory, but it's not present among the provided fields or its cardinality is not respected ([min = "
+ lowerBound + ", max=" + upperBound + "]).");
}
}
// if there are no tags, throw an exception
if(tagsArrayOriginal.size() == 0) {
throw new BadRequestException("Please define at least one tag for this item!");
}
// sort validated custom fields and add to the extrasArrayUpdated json array
Collections.sort(validatedCustomFields);
logger.debug("Sorted list of custom fields is " + validatedCustomFields);
// add missing fields with no match (append them at the end, since no metadataIndex or categoryIndex was defined for them)
for(CustomField cf : customFields)
validatedCustomFields.add(cf);
// convert back to json
for(CustomField customField : validatedCustomFields) {
ObjectNode jsonObj = mapper.createObjectNode();
jsonObj.put(CKANPackage.EXTRAS_KEY_KEY, customField.getQualifiedKey());
jsonObj.put(CKANPackage.EXTRAS_VALUE_KEY, customField.getValue());
extrasArrayUpdated.add(jsonObj);
}
// add metadata type field as last element
ObjectNode metadataTypeJSON = mapper.createObjectNode();
metadataTypeJSON.put(CKANPackage.EXTRAS_KEY_KEY, metadataTypeCF.getKey());
metadataTypeJSON.put(CKANPackage.EXTRAS_VALUE_KEY, metadataTypeCF.getValue());
extrasArrayUpdated.add(metadataTypeJSON);
// create groups
for(String title : groupsToCreateAfterValidation) {
try {
createGroupAsSysAdmin(title);
} catch(Exception e) {
logger.trace("Failed to create group with title " + title, e);
}
}
}
objectNode.replace(CKANPackage.TAGS_KEY, tagsArrayOriginal);
objectNode.replace(CKANPackage.GROUPS_KEY, groupsArrayOriginal);
objectNode.replace(CKANPackage.EXTRAS_KEY, extrasArrayUpdated);
return objectNode;
}
}
/**
* Retrieve an instance of the library for the scope
*/
public void createGroupAsSysAdmin(String title) throws Exception {
String sysAdminAPI = CKANUtility.getSysAdminAPI();
CKANGroup ckanGroup = new CKANGroup();
ckanGroup.setApiKey(sysAdminAPI);
ckanGroup.setName(CKANGroup.getCKANGroupName(title));
try {
ckanGroup.read();
} catch(WebApplicationException e) {
if(e.getResponse().getStatus() == Status.NOT_FOUND.getStatusCode()) {
ckanGroup.create();
} else {
throw e;
}
} catch(Exception e) {
throw new InternalServerErrorException(e);
} finally {
try {
addUserToGroupAsSysAdmin(title);
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
}
public void addUserToGroupAsSysAdmin(String groupName) throws Exception {
String username = CKANUser.getCKANUsername();
addUserToGroupAsSysAdmin(groupName, username);
}
public void addUserToGroupAsSysAdmin(String groupName, String username) throws Exception {
String sysAdminAPI = CKANUtility.getSysAdminAPI();
CKANUser ckanUser = new CKANUser();
ckanUser.setApiKey(sysAdminAPI);
ckanUser.setName(username);
ckanUser.addToGroup(CKANGroup.getCKANGroupName(groupName));
}
/**
* Validate this field and generate a new value (or returns the same if there is nothing to update)
* @param metadataIndex
* @param categoryIndex
* @param customFields
* @param tagsArrayOriginal
* @param groupsArrayOriginal
* @param metadataField
* @param categories
* @param numberFieldsSameKeyMap
* @param fieldsMandatoryLowerBoundMap
* @param isApplication
* @return
* @throws Exception
*/
private List<CustomField> validateAgainstMetadataField(int metadataIndex, int categoryIndex,
List<CustomField> customFields, ArrayNode tagsArrayOriginal, ArrayNode groupsArrayOriginal,
MetadataField metadataField, List<NamespaceCategory> categories,
Map<String,Integer> fieldsMandatoryLowerBoundMap, Map<String,Integer> fieldsMandatoryUpperBoundMap,
Map<String,Integer> numberFieldsMandatorySameKeyMap, List<String> groupToCreate) throws Exception {
List<CustomField> toReturn = new ArrayList<CustomField>();
String metadataFieldName = metadataField.getCategoryFieldQName(); // get the qualified one, if any
int fieldsFoundWithThisKey = 0;
Iterator<CustomField> iterator = customFields.iterator();
while(iterator.hasNext()) {
CustomField cf = (CustomField) iterator.next();
if(cf.getKey().equals(metadataFieldName)) {
validate(cf, metadataField);
fieldsFoundWithThisKey++;
cf.setIndexCategory(categoryIndex);
cf.setIndexMetadataField(metadataIndex);
checkAsGroup(cf, metadataField, groupsArrayOriginal, groupToCreate);
checkAsTag(cf, metadataField, tagsArrayOriginal);
toReturn.add(cf);
iterator.remove();
}
}
// in case of mandatory fields, keep track of the number of times they appear
if(metadataField.getMandatory()) {
// lower bound
int lowerBound = 1;
if(fieldsMandatoryLowerBoundMap.containsKey(metadataFieldName))
lowerBound = fieldsMandatoryLowerBoundMap.get(metadataFieldName) + 1;
fieldsMandatoryLowerBoundMap.put(metadataFieldName, lowerBound);
// upper bound
boolean hasVocabulary = metadataField.getVocabulary() != null;
int upperBound = hasVocabulary ? (metadataField.getVocabulary().isMultiSelection()
? metadataField.getVocabulary().getVocabularyFields().size()
: 1) : 1;
if(fieldsMandatoryUpperBoundMap.containsKey(metadataFieldName))
upperBound += fieldsMandatoryUpperBoundMap.get(metadataFieldName);
fieldsMandatoryUpperBoundMap.put(metadataFieldName, upperBound);
// fields with this same key
int countPerFields = fieldsFoundWithThisKey;
if(numberFieldsMandatorySameKeyMap.containsKey(metadataFieldName))
countPerFields += numberFieldsMandatorySameKeyMap.get(metadataFieldName);
numberFieldsMandatorySameKeyMap.put(metadataFieldName, countPerFields);
}
// if there was no field with this key and it was not mandatory, just add an entry of the kind {"key": "key-value", "value" : ""}.
// Sometimes it is important to view the field as empty.
/*
if(fieldsFoundWithThisKey == 0 && !metadataField.getMandatory()) {
toReturn.add(new CustomField(metadataFieldName, "", -1, -1));
}
*/
return toReturn;
}
/**
* Check if a tag must be generated
* @param fieldToValidate
* @param metadataField
* @param tagsArrayOriginal
*/
private void checkAsTag(CustomField fieldToValidate, MetadataField metadataField, ArrayNode tagsArrayOriginal) {
MetadataTagging tagging = metadataField.getTagging();
if(tagging != null) {
String tag = "";
switch(tagging.getTaggingValue()) {
case onFieldName:
tag = metadataField.getFieldName();
break;
case onValue:
tag = fieldToValidate.getValue();
break;
case onFieldName_onValue:
tag = metadataField.getFieldName() + tagging.getSeparator() + fieldToValidate.getValue();
break;
case onValue_onFieldName:
tag = fieldToValidate.getValue() + tagging.getSeparator() + metadataField.getFieldName();
break;
default:
return;
}
tag = tag.substring(0, MAX_TAG_CHARS > tag.length() ? tag.length() : MAX_TAG_CHARS);
logger.debug("Tag is " + tag);
ObjectNode tagJSON = mapper.createObjectNode();
tagJSON.put("name", tag);
tagJSON.put("display_name", tag);
tagsArrayOriginal.add(tagJSON);
}
}
/**
* Check if a group must be generated
* @param fieldToValidate
* @param metadataField
* @param groupsArrayOriginal
* @param isApplication
* @throws Exception
*/
private void checkAsGroup(CustomField fieldToValidate, MetadataField metadataField, ArrayNode groupsArrayOriginal,
List<String> groupToCreate) throws Exception {
logger.debug("Custom field is " + fieldToValidate);
logger.debug("MetadataField field is " + metadataField);
logger.debug("JSONArray field is " + groupsArrayOriginal);
MetadataGrouping grouping = metadataField.getGrouping();
if(grouping != null) {
boolean propagateUp = grouping.getPropagateUp();
final Set<String> groupNames = new HashSet<String>();
switch(grouping.getGroupingValue()) {
case onFieldName:
groupNames.add(metadataField.getFieldName());
break;
case onValue:
if(fieldToValidate.getValue() != null && !fieldToValidate.getValue().isEmpty())
groupNames.add(fieldToValidate.getValue());
break;
case onFieldName_onValue:
case onValue_onFieldName:
groupNames.add(metadataField.getFieldName());
if(fieldToValidate.getValue() != null && !fieldToValidate.getValue().isEmpty())
groupNames.add(fieldToValidate.getValue());
break;
default:
return;
}
for(String title : groupNames) {
String groupName = CKANGroup.getCKANGroupName(title);
logger.debug("Adding group to which add this item {}", groupName);
ObjectNode group = mapper.createObjectNode();
group.put("name", groupName);
if(propagateUp) {
List<String> parents = Validator.getGroupHierarchyNames(groupName);
for(String parent : parents) {
ObjectNode groupP = mapper.createObjectNode();
groupP.put("name", parent);
groupsArrayOriginal.add(groupP);
}
}
groupsArrayOriginal.add(group);
}
// force group creation if needed
if(grouping.getCreate()) {
for(String title : groupNames)
groupToCreate.add(title);
}
}
}
/**
* Validate the single field
* @param fieldToValidate
* @param metadataField
* @param isFirst
* @return
* @throws Exception
*/
private void validate(CustomField fieldToValidate, MetadataField metadataField) throws Exception {
DataType dataType = metadataField.getDataType();
String regex = metadataField.getValidator() != null ? metadataField.getValidator().getRegularExpression()
: null;
boolean hasControlledVocabulary = false;
MetadataVocabulary metadataVocabulary = metadataField.getVocabulary();
if(metadataVocabulary!=null) {
List<String> vocabularyFields = metadataVocabulary.getVocabularyFields();
if(vocabularyFields!=null && vocabularyFields.size()>0) {
hasControlledVocabulary = true;
}
}
String value = fieldToValidate.getValue();
String key = fieldToValidate.getKey();
String defaultValue = metadataField.getDefaultValue();
// replace key by prepending the qualified name of the category, if needed
fieldToValidate.setQualifiedKey(metadataField.getCategoryFieldQName());
if((value == null || value.isEmpty()))
if(metadataField.getMandatory() || hasControlledVocabulary)
throw new BadRequestException("Mandatory field with name '" + key
+ "' doesn't have a value but it is mandatory or has a controlled vocabulary!");
else {
if(defaultValue != null && !defaultValue.isEmpty()) {
value = defaultValue;
fieldToValidate.setValue(defaultValue);
}
return; // there is no need to check other stuff
}
switch(dataType) {
case String:
case Text:
if(regex != null && !value.matches(regex))
throw new BadRequestException("Field with key '" + key
+ "' doesn't match the provided regular expression (" + regex + ")!");
if(hasControlledVocabulary) {
List<String> valuesVocabulary = metadataField.getVocabulary().getVocabularyFields();
if(valuesVocabulary == null || valuesVocabulary.isEmpty())
return;
boolean match = false;
for(String valueVocabulary : valuesVocabulary) {
match = value.equals(valueVocabulary);
if(match)
break;
}
if(!match)
throw new BadRequestException("Field with key '" + key + "' has a value '" + value
+ "' but it doesn't match any of the vocabulary's values (" + valuesVocabulary + ")!");
}
break;
case Time:
if(!isValidDate(value))
throw new BadRequestException("Field with key '" + key + "' doesn't seem a valid time!");
break;
case Time_Interval:
String[] timeValues = value.split("/");
for(int i = 0; i < timeValues.length; i++) {
String time = timeValues[i];
if(!isValidDate(time))
throw new BadRequestException(
"Field with key '" + key + "' doesn't seem a valid time interval!");
}
break;
case Times_ListOf:
String[] timeIntervals = value.split(",");
for(int i = 0; i < timeIntervals.length; i++) {
String[] timeIntervalValues = timeIntervals[i].split("/");
if(timeIntervalValues.length > 2)
throw new BadRequestException(
"Field with key '" + key + "' doesn't seem a valid list of times!");
for(i = 0; i < timeIntervalValues.length; i++) {
String time = timeIntervalValues[i];
if(!isValidDate(time))
throw new BadRequestException(
"Field with key '" + key + "' doesn't seem a valid list of times!");
}
}
break;
case Boolean:
if(value.equalsIgnoreCase("true") || value.equalsIgnoreCase("false")) {
} else
throw new BadRequestException("Field with key '" + key + "' doesn't seem a valid boolean value!");
break;
case Number:
if(!NumberUtils.isNumber(value))
throw new BadRequestException("Field's value with key '" + key + "' is not a valid number!");
break;
case GeoJSON:
try {
new com.fasterxml.jackson.databind.ObjectMapper().readValue(fieldToValidate.getValue(), GeoJsonObject.class);
} catch(Exception e) {
throw new BadRequestException("GeoJSON field with key '" + key + "' seems not valid!");
}
break;
default:
break;
}
}
/**
* Validate a time date against a formatter
* @param value
* @param formatter
* @return
*/
private static boolean isValidDate(String value) {
try {
DATE_HOUR_MINUTES.parse(value);
return true;
} catch(Exception e) {
logger.debug("failed to parse date with hours and minutes, trying the other one");
try {
DATE_SIMPLE.parse(value);
return true;
} catch(Exception e2) {
logger.warn("failed to parse date with simple format, returning false");
return false;
}
}
}
/**
* Get the group hierarchy
* @param groupName
* @throws Exception
*/
public static List<String> getGroupHierarchyNames(String groupName) throws Exception {
CKANGroup ckanGroup = new CKANGroup();
ckanGroup.setName(groupName);
return ckanGroup.getGroups();
}
}

View File

@ -1,366 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import java.io.IOException;
import java.io.InputStream;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import java.util.HashMap;
import java.util.Map;
import javax.ws.rs.BadRequestException;
import javax.ws.rs.ForbiddenException;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.Response.Status;
import javax.ws.rs.core.UriInfo;
import org.gcube.com.fasterxml.jackson.core.JsonProcessingException;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.NullNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.common.gxhttp.request.GXHTTPStringRequest;
import org.gcube.gcat.utils.HTTPUtility;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public abstract class CKAN {
private static final Logger logger = LoggerFactory.getLogger(CKAN.class);
protected static final String ID_KEY = "id";
protected static final String TITLE_KEY = "title";
protected static final String NAME_KEY = "name";
protected static final String ERROR_KEY = "error";
protected static final String ERROR_TYPE_KEY = "__type";
protected static final String MESSAGE_KEY = "message";
protected static final String OWNER_ORG_KEY = "owner_org";
protected static final String RESULT_KEY = "result";
protected static final String SUCCESS_KEY = "success";
public static final String LIMIT_KEY = "limit";
public static final String OFFSET_KEY = "offset";
protected static final String NOT_FOUND_ERROR = "Not Found Error";
protected static final String AUTHORIZATION_ERROR = "Authorization Error";
protected static final String VALIDATION_ERROR = "Validation Error";
// api rest path CKAN
public final static String CKAN_API_PATH = "/api/3/action/";
// ckan header authorization
public final static String AUTH_CKAN_HEADER = HttpHeaders.AUTHORIZATION;
public final static String NAME_REGEX = "^[a-z0-9_\\\\-]{2,100}$";
protected String LIST;
protected String CREATE;
protected String READ;
protected String UPDATE;
protected String PATCH;
protected String DELETE;
protected String PURGE;
protected final ObjectMapper mapper;
protected String name;
protected String apiKey;
protected JsonNode result;
protected String nameRegex;
protected UriInfo uriInfo;
public void setUriInfo(UriInfo uriInfo) {
this.uriInfo = uriInfo;
}
public String getApiKey() {
if(apiKey == null) {
try {
return CKANUtility.getApiKey();
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
return apiKey;
}
public void setApiKey(String apiKey) {
this.apiKey = apiKey;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public ObjectMapper getMapper() {
return mapper;
}
public JsonNode getJsonNodeResult() {
return result;
}
protected CKAN() {
try {
this.mapper = new ObjectMapper();
this.nameRegex = CKAN.NAME_REGEX;
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
protected JsonNode getAsJsonNode(String json) {
try {
return mapper.readTree(json);
} catch(IOException e) {
throw new BadRequestException(e);
}
}
/**
* Validate the CKAN response and return the
* @param json
* @return the validated response as JsonNode
*/
protected JsonNode validateCKANResponse(String json) {
JsonNode jsonNode = getAsJsonNode(json);
if(jsonNode.get(SUCCESS_KEY).asBoolean()) {
return jsonNode.get(RESULT_KEY);
} else {
try {
JsonNode error = jsonNode.get(ERROR_KEY);
String errorType = error.get(ERROR_TYPE_KEY).asText();
if(errorType.compareTo(VALIDATION_ERROR) == 0) {
throw new BadRequestException(getAsString(error));
}
String message = error.get(MESSAGE_KEY).asText();
if(errorType.compareTo(NOT_FOUND_ERROR) == 0) {
throw new NotFoundException(message);
}
if(errorType.compareTo(AUTHORIZATION_ERROR) == 0) {
throw new ForbiddenException(message);
}
// TODO parse more cases
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new BadRequestException(json);
}
throw new BadRequestException(json);
}
}
protected String getAsString(JsonNode node) {
try {
String json = mapper.writeValueAsString(node);
return json;
} catch(JsonProcessingException e) {
throw new InternalServerErrorException(e);
}
}
protected JsonNode checkName(JsonNode jsonNode) {
try {
String gotName = jsonNode.get(NAME_KEY).asText();
if(!gotName.matches(nameRegex)) {
throw new BadRequestException(
"The 'name' must be between 2 and 100 characters long and contain only lowercase alphanumeric characters, '-' and '_'. You can validate your name using the regular expression : "
+ NAME_REGEX);
}
if(name == null) {
name = gotName;
}
if(gotName != null && gotName.compareTo(name) != 0) {
String error = String.format(
"The name (%s) does not match with the '%s' contained in the provided content (%s).", name,
NAME_KEY, gotName);
throw new BadRequestException(error);
}
return jsonNode;
} catch(BadRequestException e) {
throw e;
} catch(Exception e) {
throw new BadRequestException("Unable to obtain a correct 'name' from the provided content");
}
}
protected JsonNode checkName(String json) {
JsonNode jsonNode = getAsJsonNode(json);
checkName(jsonNode);
return jsonNode;
}
protected JsonNode createJsonNodeWithID(String id) {
ObjectNode objectNode = mapper.createObjectNode();
objectNode.put(ID_KEY, id);
return objectNode;
}
protected JsonNode createJsonNodeWithNameAsID() {
return createJsonNodeWithID(name);
}
protected Map<String,String> getMapWithNameAsID() {
return getMapWithID(name);
}
protected Map<String,String> getMapWithID(String id) {
Map<String,String> map = new HashMap<>();
map.put(ID_KEY, id);
return map;
}
protected GXHTTPStringRequest getGXHTTPStringRequest(String path, boolean post)
throws UnsupportedEncodingException {
String catalogueURL = CKANUtility.getCkanURL();
GXHTTPStringRequest gxhttpStringRequest = HTTPUtility.createGXHTTPStringRequest(catalogueURL, path, post);
gxhttpStringRequest.isExternalCall(true);
gxhttpStringRequest.header(AUTH_CKAN_HEADER, getApiKey());
return gxhttpStringRequest;
}
protected String getResultAsString(HttpURLConnection httpURLConnection) throws IOException {
int responseCode = httpURLConnection.getResponseCode();
if(responseCode >= Status.BAD_REQUEST.getStatusCode()) {
Status status = Status.fromStatusCode(responseCode);
switch (status) {
case NOT_FOUND:
throw new NotFoundException();
default:
break;
}
InputStream inputStream = httpURLConnection.getErrorStream();
StringBuilder result = HTTPUtility.getStringBuilder(inputStream);
logger.trace(result.toString());
try {
JsonNode jsonNode = getAsJsonNode(result.toString());
JsonNode error = jsonNode.get(ERROR_KEY);
throw new WebApplicationException(getAsString(error), status);
}catch (WebApplicationException e) {
throw e;
}catch (Exception e) {
throw new WebApplicationException(result.toString(), status);
}
}
InputStream inputStream = httpURLConnection.getInputStream();
String ret = HTTPUtility.getStringBuilder(inputStream).toString();
logger.trace("Got Respose is {}", ret);
return ret;
}
protected String getResultAndValidate(HttpURLConnection httpURLConnection) throws IOException {
String ret = getResultAsString(httpURLConnection);
logger.trace("Got Respose is {}", ret);
result = validateCKANResponse(ret);
if(result instanceof NullNode) {
result = mapper.createObjectNode();
}
return getAsString(result);
}
protected String sendGetRequest(String path, Map<String,String> parameters) {
try {
logger.debug("Going to send GET request with parameters {}", parameters);
GXHTTPStringRequest gxhttpStringRequest = getGXHTTPStringRequest(path, false);
gxhttpStringRequest.queryParams(parameters);
HttpURLConnection httpURLConnection = gxhttpStringRequest.get();
return getResultAndValidate(httpURLConnection);
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
protected String sendPostRequest(String path, String body) {
try {
logger.debug("Going to send POST request with body {}", body);
GXHTTPStringRequest gxhttpStringRequest = getGXHTTPStringRequest(path, true);
HttpURLConnection httpURLConnection = gxhttpStringRequest.post(body);
return getResultAndValidate(httpURLConnection);
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
protected String sendPostRequest(String path, JsonNode jsonNode) {
return sendPostRequest(path, getAsString(jsonNode));
}
public String list(int limit, int offset) {
Map<String,String> parameters = new HashMap<>();
if(limit > 0) {
parameters.put(LIMIT_KEY, String.valueOf(limit));
}
if(offset >= 0) {
parameters.put(OFFSET_KEY, String.valueOf(offset));
}
return sendGetRequest(LIST, parameters);
}
public String create(String json) {
return sendPostRequest(CREATE, json);
}
public String read() {
return sendGetRequest(READ, getMapWithNameAsID());
}
public String update(String json) {
checkName(json);
return sendPostRequest(UPDATE, json);
}
public String patch(String json) {
JsonNode jsonNode = checkName(json);
ObjectNode objectNode = ((ObjectNode) jsonNode);
objectNode.put(ID_KEY, name);
objectNode.remove(NAME_KEY);
return sendPostRequest(PATCH, objectNode);
}
protected void delete() {
sendPostRequest(DELETE, createJsonNodeWithNameAsID());
}
public void delete(boolean purge) {
if(purge) {
purge();
} else {
delete();
}
}
public void purge() {
sendPostRequest(PURGE, createJsonNodeWithNameAsID());
}
}

View File

@ -1,108 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.WebApplicationException;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANGroup extends CKAN {
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.get.group_list
public static final String GROUP_LIST = CKAN.CKAN_API_PATH + "group_list";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.create.group_create
public static final String GROUP_CREATE = CKAN.CKAN_API_PATH + "group_create";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.get.group_show
public static final String GROUP_SHOW = CKAN.CKAN_API_PATH + "group_show";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.update.group_update
public static final String GROUP_UPDATE = CKAN.CKAN_API_PATH + "group_update";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.patch.group_patch
public static final String GROUP_PATCH = CKAN.CKAN_API_PATH + "group_patch";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.delete.group_delete
public static final String GROUP_DELETE = CKAN.CKAN_API_PATH + "group_delete";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.delete.group_purge
public static final String GROUP_PURGE = CKAN.CKAN_API_PATH + "group_purge";
public static final String GROUPS_KEY = "groups";
public CKANGroup() {
super();
LIST = GROUP_LIST;
CREATE = GROUP_CREATE;
READ = GROUP_SHOW;
UPDATE = GROUP_UPDATE;
PATCH = GROUP_PATCH;
DELETE = GROUP_DELETE;
PURGE = GROUP_PURGE;
}
public static String fromGroupTitleToName(String groupTitle) {
if(groupTitle == null)
return null;
String regexGroupTitleTransform = "[^A-Za-z0-9-]";
String modified = groupTitle.trim().replaceAll(regexGroupTitleTransform, "-").replaceAll("-+", "-").toLowerCase();
if(modified.startsWith("-"))
modified = modified.substring(1);
if(modified.endsWith("-"))
modified = modified.substring(0, modified.length() - 1);
return modified;
}
public static String getCKANGroupName(String name) {
return CKANGroup.fromGroupTitleToName(name);
}
public String create() throws WebApplicationException {
try {
ObjectNode objectNode = mapper.createObjectNode();
objectNode.put(NAME_KEY, CKANGroup.getCKANGroupName(name));
objectNode.put("title", name);
objectNode.put("display_name", name);
objectNode.put("description", "");
return super.create(mapper.writeValueAsString(objectNode));
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
public List<String> getGroups() {
if(result == null) {
read();
}
List<String> groups = new ArrayList<String>();
if(result.has(GROUPS_KEY)) {
JsonNode jsonNode = result.get(GROUPS_KEY);
if(jsonNode.isArray()) {
ArrayNode arrayNode = (ArrayNode) jsonNode;
if(arrayNode.size() > 0) {
Iterator<JsonNode> iterator = arrayNode.iterator();
while(iterator.hasNext()) {
groups.add(iterator.next().asText());
}
}
}
}
return groups;
}
public int count() {
list(100000, 0);
ArrayNode arrayNode = (ArrayNode) result;
return arrayNode.size();
}
}

View File

@ -1,49 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANLicense extends CKAN {
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.get.license_list
public static final String LICENSES_LIST = CKAN.CKAN_API_PATH + "license_list";
public CKANLicense() {
super();
LIST = LICENSES_LIST;
}
protected static ArrayNode getLicenses() {
CKANLicense ckanLicense = new CKANLicense();
ckanLicense.list(-1, -1);
ArrayNode arrayNode = (ArrayNode) ckanLicense.getJsonNodeResult();
return arrayNode;
}
public static boolean checkLicenseId(String licenseId) throws Exception {
return checkLicenseId(getLicenses(), licenseId);
}
// TODO Use a Cache
protected static boolean checkLicenseId(ArrayNode arrayNode, String licenseId) throws Exception {
try {
for(JsonNode jsonNode : arrayNode) {
try {
String id = jsonNode.get(ID_KEY).asText();
if(id.compareTo(licenseId) == 0) {
return true;
}
} catch(Exception e) {
}
}
return false;
} catch(Exception e) {
throw e;
}
}
}

View File

@ -1,86 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.scope.impl.ScopeBean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANOrganization extends CKAN {
private static Logger logger = LoggerFactory.getLogger(CKANOrganization.class);
// CKAN Connector sanitize the Organization name as following
//organizationName.replaceAll(" ", "_").replace(".", "_").toLowerCase()
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.get.organization_list
public static final String ORGANIZATION_LIST = CKAN.CKAN_API_PATH + "organization_list";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.create.organization_create
public static final String ORGANIZATION_CREATE = CKAN.CKAN_API_PATH + "organization_create";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.get.organization_show
public static final String ORGANIZATION_SHOW = CKAN.CKAN_API_PATH + "organization_show";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.update.organization_update
public static final String ORGANIZATION_UPDATE = CKAN.CKAN_API_PATH + "organization_update";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.patch.organization_patch
public static final String ORGANIZATION_PATCH = CKAN.CKAN_API_PATH + "organization_patch";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.delete.organization_delete
public static final String ORGANIZATION_DELETE = CKAN.CKAN_API_PATH + "organization_delete";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.delete.organization_purge
public static final String ORGANIZATION_PURGE = CKAN.CKAN_API_PATH + "organization_purge";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.create.organization_member_create
public static final String ORGANIZATION_MEMBER_CREATE = CKAN.CKAN_API_PATH + "organization_member_create";
// https://docs.ckan.org/en/latest/api/index.html#ckan.logic.action.get.organization_list_for_user
public static final String ORGANIZATION_LIST_FOR_USER = CKAN.CKAN_API_PATH + "organization_list_for_user";
protected static final String USERNAME_KEY = "username";
protected static final String ROLE_KEY = "role";
public CKANOrganization() {
super();
LIST = ORGANIZATION_LIST;
CREATE = ORGANIZATION_CREATE;
READ = ORGANIZATION_SHOW;
UPDATE = ORGANIZATION_UPDATE;
PATCH = ORGANIZATION_PATCH;
DELETE = ORGANIZATION_DELETE;
PURGE = ORGANIZATION_PURGE;
}
protected static final String ORGANIZATION_PERMISSION_KEY = "permission";
protected static final String ORGANIZATION_PERMISSION_VALUE_READ = "read";
public void addUserToOrganisation(String gCubeUsername, String role) {
String ckanUsername = CKANUser.getCKANUsername(gCubeUsername);
ObjectNode objectNode = mapper.createObjectNode();
objectNode.put(ID_KEY, name);
objectNode.put(USERNAME_KEY, ckanUsername);
objectNode.put(ROLE_KEY, role);
sendPostRequest(ORGANIZATION_MEMBER_CREATE, getAsString(objectNode));
logger.debug("User {} successfully added to Organisation {} with role {}", ckanUsername, name, role);
}
public static String getCKANOrganizationName() {
String context = SecretManagerProvider.instance.get().getContext();
return getCKANOrganizationName(context);
}
public static String getCKANOrganizationName(String context) {
ScopeBean scopeBean = new ScopeBean(context);
return scopeBean.name().toLowerCase();
}
public int count() {
list(100000, 0);
ArrayNode arrayNode = (ArrayNode) result;
return arrayNode.size();
}
}

File diff suppressed because it is too large Load Diff

View File

@ -1,223 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import javax.ws.rs.WebApplicationException;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.gcat.api.configuration.CKANDB;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.api.roles.Role;
import org.gcube.gcat.configuration.CatalogueConfigurationFactory;
import org.gcube.gcat.persistence.ckan.cache.CKANUserCache;
import org.postgresql.core.Utils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANPackageTrash {
protected static final Logger logger = LoggerFactory.getLogger(CKANPackageTrash.class);
private static final String GROUP_TABLE_KEY = "group";
private static final String GROUP_ID_KEY = "id";
private static final String GROUP_NAME_KEY = "name";
private static final String PACKAGE_TABLE_KEY = "package";
private static final String PACKAGE_NAME_KEY = "name";
private static final String PACKAGE_TYPE_KEY = "type";
private static final String PACKAGE_TYPE_VALUE = "dataset";
private static final String PACKAGE_STATE_KEY = "state";
private static final String PACKAGE_STATE_VALUE = "deleted";
private static final String PACKAGE_OWNER_ORG_KEY = "owner_org";
protected ObjectMapper mapper;
protected final CKANUser ckanUser;
protected final CatalogueConfiguration configuration;
protected final Set<String> supportedOrganizations;
protected boolean ownOnly;
public CKANPackageTrash() {
this(CatalogueConfigurationFactory.getInstance());
}
protected CKANPackageTrash(CatalogueConfiguration configuration) {
this.mapper = new ObjectMapper();
this.ckanUser = CKANUserCache.getCurrrentCKANUser();
this.configuration = configuration;
this.supportedOrganizations = configuration.getSupportedOrganizations();
this.ownOnly = true;
}
public void setOwnOnly(boolean ownOnly) {
this.ownOnly = ownOnly;
}
protected Connection getConnection() throws Exception {
Class.forName("org.postgresql.Driver");
CKANDB ckanDB = configuration.getCkanDB();
String url = ckanDB.getUrl();
String username = ckanDB.getUsername();
String password = ckanDB.getPassword();
Connection connection = DriverManager.getConnection(url, username, password);
logger.trace("Database {} opened successfully", url);
connection.setAutoCommit(false);
return connection;
}
protected String getQuotedString(String string) throws SQLException {
StringBuilder builder = new StringBuilder();
builder.append("'");
Utils.escapeLiteral(builder, string, false);
builder.append("'");
return builder.toString();
}
protected ArrayNode getItems() throws WebApplicationException {
Connection connection = null;
try {
StringBuffer stringBufferOrg = new StringBuffer();
stringBufferOrg.append("SELECT ");
stringBufferOrg.append(GROUP_ID_KEY);
stringBufferOrg.append(" FROM \"");
stringBufferOrg.append(GROUP_TABLE_KEY);
stringBufferOrg.append("\" WHERE ");
stringBufferOrg.append(GROUP_NAME_KEY);
stringBufferOrg.append(" IN ");
stringBufferOrg.append("(");
boolean first = true;
for(String organizationName : supportedOrganizations) {
if(first) {
first = false;
}else {
stringBufferOrg.append(",");
}
stringBufferOrg.append(getQuotedString(organizationName));
}
stringBufferOrg.append(")");
StringBuffer stringBuffer = new StringBuffer();
stringBuffer.append("SELECT ");
stringBuffer.append(PACKAGE_NAME_KEY);
stringBuffer.append(" FROM ");
stringBuffer.append(PACKAGE_TABLE_KEY);
stringBuffer.append(" WHERE ");
stringBuffer.append(PACKAGE_TYPE_KEY);
stringBuffer.append("=");
stringBuffer.append(getQuotedString(PACKAGE_TYPE_VALUE));
stringBuffer.append(" AND ");
stringBuffer.append(PACKAGE_STATE_KEY);
stringBuffer.append("=");
stringBuffer.append(getQuotedString(PACKAGE_STATE_VALUE));
if(ownOnly || ckanUser.getRole().ordinal()<Role.ADMIN.ordinal()) {
// add only own items
stringBuffer.append(" AND ");
stringBuffer.append(CKANPackage.AUTHOR_EMAIL_KEY);
stringBuffer.append("=");
stringBuffer.append(getQuotedString(ckanUser.getEMail()));
}
stringBuffer.append(" AND ");
stringBuffer.append(PACKAGE_OWNER_ORG_KEY);
stringBuffer.append(" IN (");
stringBuffer.append(stringBufferOrg);
stringBuffer.append(")");
ArrayNode items = mapper.createArrayNode();
connection = getConnection();
Statement statement = connection.createStatement();
String sql = stringBuffer.toString();
logger.trace("Going to request the following query: {}", sql);
ResultSet resultSet = statement.executeQuery(sql);
while (resultSet.next()) {
String id = resultSet.getString(PACKAGE_NAME_KEY);
items.add(id);
}
return items;
} catch (WebApplicationException e) {
throw e;
} catch (Exception e) {
throw new WebApplicationException(e);
}finally {
if(connection!=null) {
try {
connection.close();
} catch (SQLException e) {
}
}
}
}
public String list() throws WebApplicationException {
try {
return mapper.writeValueAsString(getItems());
} catch (WebApplicationException e) {
throw e;
} catch (Exception e) {
throw new WebApplicationException(e);
}
}
public ObjectNode removeAll() throws WebApplicationException {
ObjectNode objectNode = mapper.createObjectNode();
ArrayNode deleted = mapper.createArrayNode();
ArrayNode notDeleted = mapper.createArrayNode();
ArrayNode itemNames = getItems();
CKANPackage ckanPackage = new CKANPackage();
for(int i=0; i<itemNames.size(); i++) {
String name = itemNames.get(i).asText();
try {
ckanPackage.reuseInstance();
ckanPackage.setName(name);
ckanPackage.purge();
deleted.add(name);
}catch (Exception e) {
notDeleted.add(name);
}
try {
Thread.sleep(TimeUnit.MILLISECONDS.toMillis(300));
} catch (InterruptedException e) {
}
}
objectNode.set("deleted", deleted);
objectNode.set("failed", notDeleted);
return objectNode;
}
public String empty() throws WebApplicationException {
try {
return mapper.writeValueAsString(removeAll());
} catch (WebApplicationException e) {
throw e;
} catch (Exception e) {
throw new WebApplicationException(e);
}
}
}

View File

@ -1,521 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.UUID;
import javax.ws.rs.BadRequestException;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.HEAD;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.NotAllowedException;
import javax.ws.rs.OPTIONS;
import javax.ws.rs.PUT;
import javax.ws.rs.WebApplicationException;
import org.apache.commons.io.FilenameUtils;
import org.apache.tika.mime.MimeType;
import org.apache.tika.mime.MimeTypes;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.gxhttp.request.GXHTTPStringRequest;
import org.gcube.gcat.utils.Constants;
import org.gcube.gcat.utils.HTTPCall;
import org.gcube.gcat.workspace.GcatStorageHubManagement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANResource extends CKAN {
private static final Logger logger = LoggerFactory.getLogger(CKANResource.class);
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.create.resource_create
public static final String RESOURCE_CREATE = CKAN.CKAN_API_PATH + "resource_create";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.get.resource_show
public static final String RESOURCE_SHOW = CKAN.CKAN_API_PATH + "resource_show";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.update.resource_update
public static final String RESOURCE_UPDATE = CKAN.CKAN_API_PATH + "resource_update";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.patch.resource_patch
public static final String RESOURCE_PATCH = CKAN.CKAN_API_PATH + "resource_patch";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.delete.resource_delete
public static final String RESOURCE_DELETE = CKAN.CKAN_API_PATH + "resource_delete";
protected static final String URL_KEY = "url";
public static final String RESOURCES_KEY = "resources";
public static final String PACKAGE_ID_KEY = "package_id";
public static final String FORMAT_KEY = "format";
public static final String MIME_TYPE_KEY = "mimetype";
public static final String REVISION_ID_KEY = "revision_id";
private static final String TEMP = "TEMP_";
public final static String RESOURCE_NAME_REGEX = "^[\\s\\S]*$";
public static final MimeTypes ALL_MIME_TYPES;
/* TODO Remove this code ASAP. It requires a function from Storage HUB */
private static final String URI_RESOLVER_STORAGE_HUB_HOST_PROD = "data.d4science.org";
private static final String URI_RESOLVER_STORAGE_HUB_HOST_PRE = "data-pre.d4science.org";
private static final String URI_RESOLVER_STORAGE_HUB_HOST_DEV = "data.dev.d4science.org";
public static final String URI_RESOLVER_STORAGE_HUB_HOST;
public static final String URI_RESOLVER_STORAGE_HUB_PATH = "/shub/";
static {
String context = SecretManagerProvider.instance.get().getContext();
if(context.startsWith("/gcube")) {
URI_RESOLVER_STORAGE_HUB_HOST = URI_RESOLVER_STORAGE_HUB_HOST_DEV;
} else if(context.startsWith("/pred4s")){
URI_RESOLVER_STORAGE_HUB_HOST = URI_RESOLVER_STORAGE_HUB_HOST_PRE;
} else {
URI_RESOLVER_STORAGE_HUB_HOST = URI_RESOLVER_STORAGE_HUB_HOST_PROD;
}
// If you might be dealing with custom mimetypes too, then Tika supports those, and change line one to be:
// TikaConfig config = TikaConfig.getDefaultConfig();
// MimeTypes ALL_MIME_TYPES = config.getMimeRepository();
ALL_MIME_TYPES = MimeTypes.getDefaultMimeTypes();
}
/* TODO END Code to be Removed */
protected String itemID;
public String getItemID() {
return itemID;
}
protected String resourceID;
protected boolean persisted;
protected URL persistedURL;
protected String mimeType;
protected String originalFileExtension;
protected JsonNode previousRepresentation;
protected GcatStorageHubManagement storageHubManagement;
public URL getPersistedURL() {
return persistedURL;
}
public static String extractResourceID(JsonNode jsonNode) {
String resourceID = null;
if(jsonNode.has(ID_KEY)) {
resourceID = jsonNode.get(ID_KEY).asText();
}
return resourceID;
}
public String getResourceID() {
if(resourceID == null && previousRepresentation != null) {
resourceID = CKANResource.extractResourceID(previousRepresentation);
}
return resourceID;
}
public void setResourceID(String resourceID) {
this.resourceID = resourceID;
}
public void setPreviousRepresentation(JsonNode jsonNode) {
validate(jsonNode);
previousRepresentation = jsonNode;
}
public JsonNode getPreviousRepresentation() {
if(previousRepresentation == null && resourceID != null) {
sendGetRequest(READ, getMapWithID(resourceID));
validate(result);
previousRepresentation = result;
}
return previousRepresentation;
}
public CKANResource(String itemID) {
super();
this.nameRegex = RESOURCE_NAME_REGEX;
this.itemID = itemID;
CREATE = RESOURCE_CREATE;
READ = RESOURCE_SHOW;
UPDATE = RESOURCE_UPDATE;
PATCH = RESOURCE_PATCH;
DELETE = RESOURCE_DELETE;
PURGE = null;
persisted = false;
previousRepresentation = null;
storageHubManagement = new GcatStorageHubManagement();
}
@Override
public String list(int limit, int offeset) {
return list();
}
public String list() {
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName(itemID);
String itemJson = ckanPackage.read();
JsonNode item = getAsJsonNode(itemJson);
JsonNode resources = item.get(RESOURCES_KEY);
return getAsString(resources);
}
protected String getFormat() {
String format = null;
if(originalFileExtension != null) {
format = originalFileExtension;
} else {
try {
MimeType mimeTypeClzInstance = ALL_MIME_TYPES.forName(mimeType);
format = mimeTypeClzInstance.getExtension();
// List<String> extensions = mimeTypeClzInstance.getExtensions();
if(format == null || format.compareTo("") == 0) {
format = mimeType.split("/")[1].split(";")[0];
}
} catch(Exception e) {
try {
format = mimeType.split("/")[1].split(";")[0];
} catch(Exception ex) {
format = null;
}
}
}
if(format != null && format.startsWith(".")) {
format = format.substring(1);
}
return format;
}
protected ObjectNode persistStorageFile(ObjectNode objectNode) {
if(objectNode.has(URL_KEY)) {
String urlString = objectNode.get(URL_KEY).asText();
URL url;
try {
url = new URL(urlString);
} catch(MalformedURLException e) {
throw new BadRequestException(e);
}
url = copyStorageResource(url);
if(name != null) {
objectNode.put(NAME_KEY, name);
}
if(mimeType != null) {
objectNode.put(MIME_TYPE_KEY, mimeType);
if(!objectNode.has(FORMAT_KEY)) {
String format = getFormat();
if(format != null) {
objectNode.put(FORMAT_KEY, format);
}
}
}
objectNode.put(URL_KEY, url.toString());
return objectNode;
}
String error = String.format("The content must contains the %s property", URL_KEY);
throw new BadRequestException(error);
}
protected ObjectNode validate(String json) throws MalformedURLException {
JsonNode jsonNode = getAsJsonNode(json);
return validate(jsonNode);
}
protected ObjectNode validate(JsonNode jsonNode) {
ObjectNode objectNode = (ObjectNode) jsonNode;
if(objectNode.has(PACKAGE_ID_KEY)) {
String packageId = objectNode.get(PACKAGE_ID_KEY).asText();
if(packageId.compareTo(itemID) != 0) {
String error = String.format(
"Item ID %s does not match %s which is the value of %s contained in the representation.",
itemID, packageId, PACKAGE_ID_KEY);
throw new BadRequestException(error);
}
} else {
objectNode.put(PACKAGE_ID_KEY, itemID);
}
if(objectNode.has(ID_KEY)) {
String gotId = objectNode.get(ID_KEY).asText();
if(resourceID == null) {
resourceID = gotId;
} else {
if(resourceID.compareTo(gotId) != 0) {
String error = String.format(
"Resource ID %s does not match %s which is the value of %s contained in the representation.",
resourceID, gotId, ID_KEY);
throw new BadRequestException(error);
}
}
} else {
resourceID = TEMP + UUID.randomUUID().toString();
logger.trace(
"The id of the resource with name {} for package {} has not been provided. It has been generated : {}",
name, itemID, resourceID);
}
return objectNode;
}
protected URL getFinalURL(String url) {
try {
URL urlURL = new URL(url);
return CKANResource.getFinalURL(urlURL);
} catch(MalformedURLException e) {
throw new BadRequestException(e);
}
}
public static URL getFinalURL(URL url) {
HTTPCall httpCall = new HTTPCall(url.toString());
httpCall.setgCubeTargetService(false);
URL finalURL = httpCall.getFinalURL(url);
return finalURL;
}
protected boolean isStorageFile(URL url) {
URL urlToCheck = url;
try {
urlToCheck = getFinalURL(url);
} catch(Exception e) {
// TODO Evaluate if we want to validate the URL. If the URL does not exists the service
// could decide to refuse the Resource Creation
}
if(urlToCheck.getHost().compareTo(URI_RESOLVER_STORAGE_HUB_HOST) == 0) {
if(urlToCheck.getPath().startsWith(URI_RESOLVER_STORAGE_HUB_PATH)) {
persistedURL = urlToCheck;
return true;
}
}
return false;
}
/**
* Check if the URl is a workspace URL so that is has to copy the resource to guarantee
* the resource remain persistent
* @param url the URL to check
* @return the public URL of the copied resource if any. It return the original URL otherwise
*/
protected URL copyStorageResource(URL url) {
persistedURL = url;
if(isStorageFile(persistedURL)) {
try {
persistedURL = storageHubManagement.ensureResourcePersistence(persistedURL, itemID, resourceID);
String originalFilename = storageHubManagement.getOriginalFilename();
name = FilenameUtils.removeExtension(originalFilename);
originalFileExtension = FilenameUtils.getExtension(originalFilename);
mimeType = storageHubManagement.getMimeType();
persisted = true;
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
return persistedURL;
}
protected void deleteStorageResource(URL url, String filename, String mimetype) {
persistedURL = url;
if(isStorageFile(persistedURL)) {
try {
GXHTTPStringRequest gxhttpStringRequest = GXHTTPStringRequest.newRequest(persistedURL.toString());
HttpURLConnection httpURLConnection = gxhttpStringRequest.from(Constants.CATALOGUE_NAME).head();
String storageHubContentType = httpURLConnection.getContentType().split(";")[0];
if(mimetype.compareTo(storageHubContentType) != 0) {
mimetype = storageHubContentType;
// Using storage hub mimetype
}
} catch(Exception e) {
// using provided mimetype
}
try {
storageHubManagement.deleteResourcePersistence(itemID, filename, mimetype);
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
}
protected String create(JsonNode jsonNode) {
try {
ObjectNode objectNode = validate(jsonNode);
objectNode = persistStorageFile(objectNode);
String ret = super.create(getAsString(objectNode));
if(persisted) {
String gotResourceID = result.get(ID_KEY).asText();
if(gotResourceID != null && gotResourceID.compareTo(resourceID) != 0) {
resourceID = gotResourceID;
// String revisionID = result.get(REVISION_ID_KEY).asText();
// storageHubManagement.renameFile(resourceID, revisionID);
storageHubManagement.renameFile(resourceID);
}
}
return ret;
} catch(WebApplicationException e) {
// TODO Remove created file if any
throw e;
} catch(Exception e) {
// TODO Remove created file if any
throw new InternalServerErrorException(e);
}
}
@Override
public String create(String json) {
JsonNode jsonNode = getAsJsonNode(json);
return create(jsonNode);
}
@Override
public String read() {
return sendGetRequest(READ, getMapWithID(resourceID));
}
protected String update(JsonNode jsonNode) throws Exception {
ObjectNode resourceNode = (ObjectNode) jsonNode;
// This cannot be moved outside otherwise we don't
resourceNode = validate(resourceNode);
getPreviousRepresentation();
String oldURL = previousRepresentation.get(CKANResource.URL_KEY).asText();
String newURL = resourceNode.get(CKANResource.URL_KEY).asText();
if(!previousRepresentation.equals(resourceNode)) {
if(oldURL.compareTo(newURL) != 0) {
logger.trace("The URL of the resource with id {} was not changed", resourceID);
this.mimeType = previousRepresentation.get(CKANResource.MIME_TYPE_KEY).asText();
try {
storageHubManagement.retrievePersistedFile(resourceID, mimeType);
}catch (Exception e) {
// If the file was not persisted by gCat (e.g. created with the portlet) some errors can occurs
}
} else {
logger.trace("The URL of resource with id {} has been changed the old URL was {}, the new URL is {}",
resourceID, oldURL, newURL);
resourceNode = persistStorageFile(resourceNode);
/*
try {
URL urlOLD = new URL(oldURL);
deleteStorageResource(urlOLD);
}catch (Exception e) {
logger.error("Unable to remove old file at URL {}", oldURL);
}
*/
}
String ret = super.update(getAsString(resourceNode));
// if(storageHubManagement.getPersistedFile()!= null) {
// String revisionID = result.get(REVISION_ID_KEY).asText();
// storageHubManagement.addRevisionID(resourceID, revisionID);
// }
return ret;
}
return previousRepresentation.asText();
}
@Override
public String update(String json) {
try {
JsonNode jsonNode = getAsJsonNode(json);
return update(jsonNode);
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new WebApplicationException(e);
}
}
@Override
public String patch(String json) {
String[] moreAllowed = new String[] {HEAD.class.getSimpleName(), GET.class.getSimpleName(),
PUT.class.getSimpleName(), DELETE.class.getSimpleName()};
throw new NotAllowedException(OPTIONS.class.getSimpleName(), moreAllowed);
}
@Override
public void delete(boolean purge) {
delete();
}
@Override
public void delete() {
try {
deleteFile();
sendPostRequest(DELETE, createJsonNodeWithID(resourceID));
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new WebApplicationException(e);
}
}
@Override
public void purge() {
String[] moreAllowed = new String[] {HEAD.class.getSimpleName(), GET.class.getSimpleName(),
PUT.class.getSimpleName(), DELETE.class.getSimpleName()};
throw new NotAllowedException(OPTIONS.class.getSimpleName(), moreAllowed);
}
public JsonNode createOrUpdate(JsonNode jsonNode) {
ObjectNode resourceNode = (ObjectNode) jsonNode;
if(resourceNode.has(ID_KEY)) {
try {
update(resourceNode);
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new WebApplicationException(e);
}
} else {
create(resourceNode);
}
return result;
}
public void deleteFile() {
try {
getPreviousRepresentation();
URL url = new URL(previousRepresentation.get(URL_KEY).asText());
mimeType = previousRepresentation.get(MIME_TYPE_KEY).asText();
deleteStorageResource(url, resourceID, mimeType);
} catch(Exception e) {
logger.error("Unable to delete resource {}",
previousRepresentation != null ? getAsString(previousRepresentation) : "");
}
}
public void rollback() {
if(previousRepresentation != null) {
try {
update(previousRepresentation);
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new WebApplicationException(e);
}
} else {
delete();
}
}
}

View File

@ -1,339 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import java.util.Collection;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response.Status;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.user.User;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.api.moderation.Moderated;
import org.gcube.gcat.api.roles.Role;
import org.gcube.gcat.configuration.CatalogueConfigurationFactory;
import org.gcube.gcat.utils.RandomString;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANUser extends CKAN {
private static final Logger logger = LoggerFactory.getLogger(CKANUser.class);
/* User Paths */
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.get.user_list
public static final String USER_LIST = CKAN.CKAN_API_PATH + "user_list";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.create.user_create
public static final String USER_CREATE = CKAN.CKAN_API_PATH + "user_create";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.get.user_show
public static final String USER_SHOW = CKAN.CKAN_API_PATH + "user_show";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.update.user_update
public static final String USER_UPDATE = CKAN.CKAN_API_PATH + "user_update";
// see https://docs.ckan.org/en/latest/api/#ckan.logic.action.delete.user_delete
public static final String USER_DELETE = CKAN.CKAN_API_PATH + "user_delete";
public static final String ADD_USER_TO_GROUP = CKAN.CKAN_API_PATH + "member_create";
public static final String NAME = "name";
public static final String DISPLAY_NAME = "display_name";
public static final String FULL_NAME = "fullname";
public static final String ABOUT = "about";
public static final String EMAIL = "email";
public static final String PASSWORD = "password";
private static final String API_KEY = "apikey";
public static final String PORTAL_ROLES = "portal_roles";
protected String nameSurname;
protected Role role;
protected Boolean catalogueModerator;
protected CatalogueConfiguration configuration;
public CKANUser() {
this(CatalogueConfigurationFactory.getInstance());
}
protected CKANUser(CatalogueConfiguration configuration) {
super();
this.LIST = USER_LIST;
this.CREATE = USER_CREATE;
this.READ = USER_SHOW;
this.UPDATE = USER_UPDATE;
this.PATCH = null;
this.DELETE = USER_DELETE;
this.PURGE = null;
this.catalogueModerator = null;
this.configuration = configuration;
}
public void setName(String name) {
name = getCKANUsername(name);
this.name = name;
}
public String createInCkan() {
RandomString randomString = new RandomString(12);
ObjectNode objectNode = mapper.createObjectNode();
objectNode.put(NAME, name);
objectNode.put(PASSWORD, randomString.nextString());
checkAndSetEmail(objectNode);
checkAndSetFullName(objectNode);
checkAndSetJobTitle(objectNode);
return create(getAsString(objectNode));
}
@Override
public void delete(boolean purge) {
this.delete();
}
/**
*
* @param objectNode
* @return true if the display name and the full name has been updated in objectNode
*/
private boolean checkAndSetJobTitle(ObjectNode objectNode) {
String jobTitle = SecretManagerProvider.instance.get().getUser().getAbout();
String ckanJobTitle = "";
if(objectNode.has(ABOUT)) {
ckanJobTitle = objectNode.get(ABOUT).asText();
}
if(jobTitle!=null && jobTitle.compareTo(ckanJobTitle) != 0) {
objectNode.put(ABOUT, jobTitle);
return true;
}
return false;
}
/**
*
* @param objectNode
* @return true if the display name and the full name has been updated in objectNode
*/
private boolean checkAndSetFullName(ObjectNode objectNode) {
User user = SecretManagerProvider.instance.get().getUser();
String portalFullname = user.getFullName();
this.nameSurname = user.getFullName(true);
String ckanFullname = "";
if(objectNode.has(FULL_NAME)) {
ckanFullname = objectNode.get(FULL_NAME).asText();
}
if(portalFullname!=null && portalFullname.compareTo(ckanFullname) != 0) {
objectNode.put(FULL_NAME, portalFullname);
objectNode.put(DISPLAY_NAME, portalFullname);
return true;
}
return false;
}
/**
*
* @param objectNode
* @return true if the display name and the full name has been updated
*/
private boolean checkAndSetEmail(ObjectNode objectNode) {
User user = SecretManagerProvider.instance.get().getUser();
String portalEmail = user.getEmail();
String ckanEmail = "";
if(objectNode.has(EMAIL)) {
ckanEmail = objectNode.get(EMAIL).asText();
}
if(portalEmail==null) {
String username = user.getUsername();
String eMail = username + "@d4science.org";
objectNode.put(EMAIL, eMail);
return true;
} else if(portalEmail.compareTo(ckanEmail) != 0) {
objectNode.put(EMAIL, portalEmail);
return true;
}
return false;
}
/**
* Update the user profile on CKAN if the got got informations differs from the portal information
* @return true if the profile information has been updated
*/
protected boolean updateProfileIfNeeded() {
ObjectNode objectNode = (ObjectNode) result;
boolean toBeUpdated = false;
toBeUpdated = checkAndSetEmail(objectNode) || toBeUpdated;
toBeUpdated = checkAndSetFullName(objectNode) || toBeUpdated;
toBeUpdated = checkAndSetJobTitle(objectNode) || toBeUpdated;
if(toBeUpdated) {
update(getAsString(objectNode));
}
return toBeUpdated;
}
public void retrieve() {
setApiKey(CKANUtility.getSysAdminAPI());
try {
if(name == null || name.compareTo("") == 0) {
setName(getCKANUsername());
}
read();
updateProfileIfNeeded();
} catch(WebApplicationException e) {
if(e.getResponse().getStatusInfo() == Status.NOT_FOUND) {
createInCkan();
} else {
throw e;
}
}
try {
CatalogueConfiguration configuration = CatalogueConfigurationFactory.getInstance();
for(String supportedOrganization : configuration.getSupportedOrganizations()) {
addUserToOrganization(supportedOrganization);
}
}catch (Exception e) {
// The organization could not exists and this is fine in some cases like organization create or
// for listing items at VO level. The organization corresponding to the VO could not exists.
logger.warn("Add user to organization {} failed. This is acceptable in the case the request is at VO level and the corresponding orgnization does not esists and should not, as well as when the organization is going to be created", CKANOrganization.getCKANOrganizationName());
}
}
protected String parseResult() {
name = result.get(NAME).asText();
// Only managers can read Ckan API key
if(getRole().ordinal()<Role.MANAGER.ordinal()) {
try {
apiKey = result.get(API_KEY).asText();
}catch (Exception e) {
// The user reading its own Ckan profile must be able to read its API key
if(name.compareTo(getCKANUsername())==0) {
throw e;
}
}
}else {
((ObjectNode) result).remove(API_KEY);
}
if(name.compareTo(getCKANUsername())==0) {
ArrayNode roles = ((ObjectNode) result).putArray(PORTAL_ROLES);
roles.add(getRole().getPortalRole());
if(isCatalogueModerator()) {
roles.add(Moderated.CATALOGUE_MODERATOR);
}
}
return getAsString(result);
}
protected static String getCKANUsername(String username) {
if(username == null) {
return null;
}
return username.trim().replaceAll("\\.", "_");
}
public static String getUsernameFromCKANUsername(String ckanUsername) {
if(ckanUsername == null) {
return null;
}
return ckanUsername.trim().replaceAll("_", ".");
}
public static String getCKANUsername() {
String username = SecretManagerProvider.instance.get().getUser().getUsername();
return getCKANUsername(username);
}
public String create(String json) {
super.create(json);
String ret = parseResult();
return ret;
}
public String read() {
super.read();
String ret = parseResult();
return ret;
}
public String update(String json) {
super.update(json);
String ret = parseResult();
return ret;
}
public void addUserToOrganization(String organizationName, String ckanUsername, String role) {
logger.trace("Going to add user {} to organization {} with role {}", ckanUsername, organizationName, role);
CKANOrganization ckanOrganization = new CKANOrganization();
ckanOrganization.setApiKey(CKANUtility.getSysAdminAPI());
ckanOrganization.setName(organizationName);
ckanOrganization.addUserToOrganisation(ckanUsername, role);
}
public Role getRole() {
if(role == null) {
role = Role.MEMBER;
Collection<String> roles = SecretManagerProvider.instance.get().getUser().getRoles();
for(String portalRole : roles) {
Role gotRole = Role.getRoleFromPortalRole(portalRole);
if(gotRole != null && gotRole.ordinal() > role.ordinal()) {
role = gotRole;
}
}
}
return role;
}
public void addUserToOrganization(String organizationName) {
addUserToOrganization(organizationName, name, getRole().getCkanRole());
}
public void addUserToOrganization() {
String organizationName = CKANOrganization.getCKANOrganizationName();
addUserToOrganization(organizationName);
}
public void addToGroup(String groupName) throws WebApplicationException {
try {
ObjectNode objectNode = mapper.createObjectNode();
objectNode.put(ID_KEY, CKANGroup.getCKANGroupName(groupName));
objectNode.put("object", name);
objectNode.put("object_type", "user");
objectNode.put("capacity", "member");
sendPostRequest(ADD_USER_TO_GROUP, getAsString(objectNode));
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
public boolean isCatalogueModerator() {
if(catalogueModerator == null) {
catalogueModerator = SecretManagerProvider.instance.get().getUser().getRoles().contains(Moderated.CATALOGUE_MODERATOR);
}
return catalogueModerator;
}
public String getSurnameName(){
return result.get(FULL_NAME).asText();
}
public String getNameSurname() {
return nameSurname;
}
public String getEMail() {
return result.get(EMAIL).asText();
}
}

View File

@ -1,38 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import javax.ws.rs.InternalServerErrorException;
import org.gcube.gcat.configuration.CatalogueConfigurationFactory;
import org.gcube.gcat.persistence.ckan.cache.CKANUserCache;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANUtility {
public static String getCkanURL() {
try {
return CatalogueConfigurationFactory.getInstance().getCkanURL();
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
public static String getSysAdminAPI() {
try {
return CatalogueConfigurationFactory.getInstance().getSysAdminToken();
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
public static String getApiKey() {
try {
CKANUser ckanUser = CKANUserCache.getCurrrentCKANUser();
return ckanUser.getApiKey();
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
}

View File

@ -1,84 +0,0 @@
package org.gcube.gcat.persistence.ckan.cache;
import java.util.concurrent.TimeUnit;
import javax.cache.Cache;
import javax.cache.CacheManager;
import javax.cache.Caching;
import javax.cache.configuration.MutableConfiguration;
import javax.cache.expiry.CreatedExpiryPolicy;
import javax.cache.expiry.Duration;
import javax.cache.spi.CachingProvider;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.gcat.persistence.ckan.CKANUser;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public abstract class CKANUserCache {
private static final CacheManager cacheManager;
private static final MutableConfiguration<String,CKANUser> userCacheConfiguration;
static {
CachingProvider provider = Caching.getCachingProvider();
cacheManager = provider.getCacheManager();
userCacheConfiguration = new MutableConfiguration<String,CKANUser>().setTypes(String.class, CKANUser.class)
.setStoreByValue(false)
.setExpiryPolicyFactory(CreatedExpiryPolicy.factoryOf(new Duration(TimeUnit.MINUTES, 15)));
}
private CKANUserCache() {
}
public synchronized static CKANUser getCurrrentCKANUser() {
SecretManager secretManager = SecretManagerProvider.instance.get();
String gcubeUsername = secretManager.getUser().getUsername();
String context = secretManager.getContext();
Cache<String,CKANUser> userCache = cacheManager.getCache(context);
if(userCache == null) {
userCache = cacheManager.createCache(context, userCacheConfiguration);
}
CKANUser ckanUser = userCache.get(gcubeUsername);
if(ckanUser == null) {
ckanUser = new CKANUser();
ckanUser.retrieve();
userCache.put(gcubeUsername, ckanUser);
}
return ckanUser;
}
public synchronized static void removeUserFromCache() {
SecretManager secretManager = SecretManagerProvider.instance.get();
String gcubeUsername = secretManager.getUser().getUsername();
removeUserFromCache(gcubeUsername);
}
public synchronized static void removeUserFromCache(String gcubeUsername) {
SecretManager secretManager = SecretManagerProvider.instance.get();
String context = secretManager.getContext();
Cache<String,CKANUser> userCache = cacheManager.getCache(context);
if(userCache != null) {
userCache.remove(gcubeUsername);
}
}
public synchronized static void emptyUserCache() {
SecretManager secretManager = SecretManagerProvider.instance.get();
String context = secretManager.getContext();
cacheManager.destroyCache(context);
}
@Override
protected void finalize() throws Throwable {
super.finalize();
cacheManager.close();
}
}

View File

@ -1,16 +1,31 @@
package org.gcube.gcat.profile;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
import java.io.StringWriter;
import java.util.List;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import javax.ws.rs.BadRequestException;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.NotAuthorizedException;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.WebApplicationException;
import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.common.resources.gcore.GenericResource;
import org.gcube.common.resources.gcore.Resources;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataField;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataFormat;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataValidator;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataVocabulary;
import org.gcube.datacatalogue.metadatadiscovery.reader.MetadataFormatDiscovery;
import org.gcube.datacatalogue.metadatadiscovery.reader.QueryForResourceUtil;
import org.gcube.gcat.api.roles.Role;
@ -29,9 +44,6 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.xml.sax.SAXException;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
/**
* @author Luca Frosini (ISTI - CNR)
*/
@ -169,7 +181,61 @@ public class ISProfile {
}
}
public boolean createOrUpdate(String name, String xml) throws SAXException {
public static MetadataFormat getMetadataFormat(String xml) throws JAXBException {
JAXBContext jaxbContext = JAXBContext.newInstance(MetadataFormat.class);
Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
InputStream stream = new ByteArrayInputStream(xml.getBytes());
MetadataFormat metadataFormat = (MetadataFormat) unmarshaller.unmarshal(stream);
return metadataFormat;
}
public static void checkRegex(String regex, String text) {
try {
Pattern pattern = Pattern.compile(regex);
if(text!=null) {
Matcher matcher = pattern.matcher(text);
if(!matcher.find()) {
throw new RuntimeException();
}
}
} catch (PatternSyntaxException e) {
throw e;
} catch (RuntimeException e) {
throw e;
}
}
public static void validateMetadataFormat(MetadataFormat metadataFormat) throws BadRequestException {
List<MetadataField> metadataFields = metadataFormat.getMetadataFields();
for(MetadataField metadataField : metadataFields) {
String defaultValue = metadataField.getDefaultValue();
MetadataValidator metadataValidator = metadataField.getValidator();
if(metadataValidator!=null) {
String regularExpression = metadataValidator.getRegularExpression();
if(regularExpression!=null && regularExpression.length()>0) {
try {
checkRegex(regularExpression, defaultValue);
} catch (PatternSyntaxException e) {
throw new BadRequestException("The regular expression provided for metadata field '" + metadataField.getFieldName() + "' (i.e. '" + regularExpression + "') is not valid." );
} catch (RuntimeException e) {
throw new BadRequestException("The default value provided for metadata field '" + metadataField.getFieldName() + "' (i.e. '" + defaultValue + "') does not match the regular expression defined (i.e. '" + regularExpression + "')");
}
}
}
MetadataVocabulary metadataVocabulary = metadataField.getVocabulary();
if(metadataVocabulary!=null && defaultValue!=null) {
List<String> vocabularyFields = metadataVocabulary.getVocabularyFields();
if(!vocabularyFields.contains(defaultValue)) {
throw new BadRequestException("The default value provided for metadata field '" + metadataField.getFieldName() + "' (i.e. '" + defaultValue + "') does not match the vocabulary (i.e. '" + vocabularyFields.toString() + "')");
}
}
}
}
public boolean createOrUpdate(String name, String xml) throws Exception {
try {
CKANUser ckanUser = CKANUserCache.getCurrrentCKANUser();
if(ckanUser.getRole().ordinal()<Role.EDITOR.ordinal()) {
@ -177,7 +243,12 @@ public class ISProfile {
}
MetadataUtility metadataUtility = new MetadataUtility();
metadataUtility.validateProfile(xml);
if(metadataUtility.getMetadataFormat(name) == null) {
MetadataFormat newMetadataFormat = getMetadataFormat(xml);
validateMetadataFormat(newMetadataFormat);
MetadataFormat oldMetadataFormat = metadataUtility.getMetadataFormat(name);
if(oldMetadataFormat == null) {
createGenericResource(name, xml);
return true;
} else {

View File

@ -1,70 +0,0 @@
package org.gcube.gcat.profile;
import java.io.IOException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.xml.parsers.ParserConfigurationException;
import org.gcube.datacatalogue.metadatadiscovery.DataCalogueMetadataFormatReader;
import org.gcube.datacatalogue.metadatadiscovery.bean.MetadataProfile;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.MetadataFormat;
import org.gcube.datacatalogue.metadatadiscovery.bean.jaxb.NamespaceCategory;
import org.xml.sax.SAXException;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class MetadataUtility {
private DataCalogueMetadataFormatReader dataCalogueMetadataFormatReader;
/*
* this map contains the Metadata Profiles. The key is the name of the profile.
*/
private Map<String,MetadataProfile> metadataProfiles;
public MetadataUtility() throws Exception {
dataCalogueMetadataFormatReader = new DataCalogueMetadataFormatReader();
}
public void validateProfile(String xmlProfile) throws ParserConfigurationException, SAXException, IOException {
dataCalogueMetadataFormatReader.validateProfile(xmlProfile);
}
public Map<String,MetadataProfile> getMetadataProfiles() throws Exception {
if(metadataProfiles == null) {
metadataProfiles = new HashMap<>();
List<MetadataProfile> list = dataCalogueMetadataFormatReader.getListOfMetadataProfiles();
for(MetadataProfile profile : list) {
metadataProfiles.put(profile.getName(), profile);
}
}
return metadataProfiles;
}
/**
* Returns the names of the metadata profiles in a given context
* @return the set of profile names
* @throws Exception
*/
public Set<String> getProfilesNames() throws Exception {
return getMetadataProfiles().keySet();
}
public MetadataFormat getMetadataFormat(String profileName) throws Exception {
MetadataProfile profile = getMetadataProfiles().get(profileName);
if(profile != null) {
return dataCalogueMetadataFormatReader.getMetadataFormatForMetadataProfile(profile);
}
return null;
}
public List<NamespaceCategory> getNamespaceCategories() throws Exception {
return dataCalogueMetadataFormatReader.getListOfNamespaceCategories();
}
}

View File

@ -222,7 +222,7 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
// @AuthorizationControl(allowedRoles={Role.CATALOGUE_MANAGER}, exception=NotAuthorizedException.class)
public Response create(String json) throws WebServiceException {
try {
ServiceCatalogueConfiguration catalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(json);
ServiceCatalogueConfiguration catalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(json, ServiceCatalogueConfiguration.class);
checkContext(CURRENT_CONTEXT_PATH_PARAMETER, catalogueConfiguration);
String ret = createOrUpdate(catalogueConfiguration);
ResponseBuilder responseBuilder = Response.status(Status.CREATED);
@ -352,7 +352,7 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
@OperationId("Create or Update")
public String createOrUpdate(@PathParam(CONTEXT_FULLNAME_PARAMETER) String context, String json) throws WebServiceException {
try {
ServiceCatalogueConfiguration catalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(json);
ServiceCatalogueConfiguration catalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(json, ServiceCatalogueConfiguration.class);
checkContext(context, catalogueConfiguration);
return createOrUpdate(catalogueConfiguration);
}catch (WebApplicationException e) {
@ -365,7 +365,7 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
@Override
public Response update(String json) throws WebServiceException {
try {
ServiceCatalogueConfiguration catalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(json);
ServiceCatalogueConfiguration catalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(json, ServiceCatalogueConfiguration.class);
checkContext(CURRENT_CONTEXT_PATH_PARAMETER);
catalogueConfiguration = CatalogueConfigurationFactory.createOrUpdate(catalogueConfiguration);
String configuration = catalogueConfiguration.toJsonString();
@ -451,7 +451,7 @@ public class Configuration extends BaseREST implements org.gcube.gcat.api.interf
configuration.set(fieldName, node.get(fieldName));
}
ServiceCatalogueConfiguration newCatalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(configuration);
ServiceCatalogueConfiguration newCatalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(configuration, ServiceCatalogueConfiguration.class);
newCatalogueConfiguration = CatalogueConfigurationFactory.createOrUpdate(newCatalogueConfiguration);
String ret = newCatalogueConfiguration.toJsonString();
logger.debug("Configuration in context {} has been patched to {}", catalogueConfiguration.getContext(), ret);

View File

@ -1,175 +0,0 @@
package org.gcube.gcat.social;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.List;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.configuration.CatalogueConfigurationFactory;
import org.gcube.gcat.utils.Constants;
import org.gcube.portal.databook.shared.Post;
import org.gcube.social_networking.social_networking_client_library.PostClient;
import org.gcube.social_networking.socialnetworking.model.beans.PostInputBean;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class SocialPost extends Thread {
private static final Logger logger = LoggerFactory.getLogger(SocialPost.class);
protected static final String NOTIFICATION_MESSAGE = "%s just published the item \"%s\"\n"
+ "Please find it at %s\n";
protected String userFullName;
protected String itemID;
protected String itemURL;
protected String itemTitle;
protected List<String> tags;
protected Boolean notification;
public SocialPost() throws Exception {
super();
}
public String getUserFullName() {
return userFullName;
}
public void setUserFullName(String userFullName) {
this.userFullName = userFullName;
}
public String getItemID() {
return itemID;
}
public void setItemID(String itemID) {
this.itemID = itemID;
}
public String getItemURL() {
return itemURL;
}
public void setItemURL(String itemURL) {
this.itemURL = itemURL;
}
public String getItemTitle() {
return itemTitle;
}
public void setItemTitle(String itemTitle) {
this.itemTitle = itemTitle;
}
public List<String> getTags() {
return tags;
}
public void setTags(List<String> tags) {
this.tags = tags;
}
public void setTags(ArrayNode tags) {
this.tags = new ArrayList<>();
if(tags != null && tags.size() > 0) {
for(int i = 0; i < tags.size(); i++) {
JsonNode jsonNode = tags.get(i);
String tagName = "";
if(jsonNode.has("display_name")) {
tagName = jsonNode.get("display_name").asText();
} else {
tagName = jsonNode.get("name").asText();
}
this.tags.add(tagName);
}
}
}
public Boolean isNotification() {
return notification;
}
public void setNotification(Boolean notification) {
this.notification = notification;
}
@Override
public void run() {
try {
CatalogueConfiguration instance = CatalogueConfigurationFactory.getInstance();
if(!instance.isSocialPostEnabled()) {
logger.info("Social Post are disabled in the context {}", SecretManagerProvider.instance.get().getContext());
return;
}
logger.info("Going to send Social Post about the Item {} available at {}", itemID, itemURL);
boolean notifyUsers = instance.isNotificationToUsersEnabled();
if(notification != null) {
if(notifyUsers) {
notifyUsers = notifyUsers && notification;
}else {
notifyUsers = notification;
}
}
// write notification post
sendSocialPost(notifyUsers);
} catch(Exception e) {
logger.error("Error while executing post creation actions", e);
}
}
public void sendSocialPost(boolean notifyUsers) {
SecretManager secretManager = SecretManagerProvider.instance.get();
try {
StringWriter messageWriter = new StringWriter();
messageWriter.append(String.format(NOTIFICATION_MESSAGE, userFullName, itemTitle, itemURL));
for(String tag : tags) {
tag = tag.trim();
tag = tag.replaceAll(" ", "_").replace("_+", "_");
if(tag.endsWith("_")) {
tag = tag.substring(0, tag.length() - 1);
}
messageWriter.append("#");
messageWriter.append(tag);
messageWriter.append(" ");
}
String message = messageWriter.toString();
logger.debug("The social post that is going to be written is\n{}", message);
Secret secret = Constants.getCatalogueSecret();
secretManager.startSession(secret);
PostClient postClient = new PostClient();
PostInputBean postInputBean = new PostInputBean();
postInputBean.setEnablenotification(notifyUsers);
postInputBean.setText(message);
Post post = postClient.writeApplicationPost(postInputBean);
logger.trace("Sent post {}", post);
} catch(Exception e) {
logger.error("Unable to send Social Post", e);
} finally {
secretManager.endSession();
}
}
}

View File

@ -1,19 +0,0 @@
package org.gcube.gcat.social;
import java.util.HashSet;
import java.util.Set;
import org.gcube.social_networking.social_networking_client_library.UserClient;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class SocialUsers {
public static Set<String> getUsernamesByRole(String roleName) throws Exception {
UserClient userClient = new UserClient();
Set<String> usernames = new HashSet<>(userClient.getAllUsernamesByRole(roleName));
return usernames;
}
}

View File

@ -1,70 +0,0 @@
package org.gcube.gcat.utils;
import java.io.InputStream;
import java.net.URL;
import java.util.AbstractMap.SimpleEntry;
import java.util.Map.Entry;
import java.util.Properties;
import javax.ws.rs.InternalServerErrorException;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.secret.JWTSecret;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.common.keycloak.KeycloakClientFactory;
import org.gcube.common.keycloak.model.TokenResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class Constants {
private static final Logger logger = LoggerFactory.getLogger(Constants.class);
public static final String CATALOGUE_NAME = "gCat";
protected static final String CLIENT_ID_SECRET_FILENAME = "config.properties";
protected static final String CLIENT_ID_PROPERTY_NAME = "clientId";
private static Entry<String, String> getClientIdAndClientSecret(String context) {
try {
Properties properties = new Properties();
ClassLoader classLoader = Constants.class.getClassLoader();
URL url = classLoader.getResource(CLIENT_ID_SECRET_FILENAME);
logger.trace("Going to read {} at {}", CLIENT_ID_SECRET_FILENAME, url.toString());
InputStream input = classLoader.getResourceAsStream(CLIENT_ID_SECRET_FILENAME);
properties.load(input);
String clientId = "gcat";
if(properties.containsKey(CLIENT_ID_PROPERTY_NAME)) {
clientId = properties.getProperty(CLIENT_ID_PROPERTY_NAME);
}
int index = context.indexOf('/', 1);
String root = context.substring(0, index == -1 ? context.length() : index);
String clientSecret = properties.getProperty(root);
SimpleEntry<String, String> entry = new SimpleEntry<String, String>(clientId, clientSecret);
return entry;
} catch(Exception e) {
throw new InternalServerErrorException(
"Unable to retrieve Application Token for context " + SecretManagerProvider.instance.get().getContext(), e);
}
}
private static TokenResponse getJWTAccessToken() throws Exception {
String context = SecretManagerProvider.instance.get().getContext();
Entry<String,String> entry = getClientIdAndClientSecret(context);
TokenResponse tr = KeycloakClientFactory.newInstance().queryUMAToken(context, entry.getKey(), entry.getValue(), context, null);
return tr;
}
public static Secret getCatalogueSecret() throws Exception {
TokenResponse tr = getJWTAccessToken();
Secret secret = new JWTSecret(tr.getAccessToken());
return secret;
}
}

View File

@ -1,90 +0,0 @@
package org.gcube.gcat.utils;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.concurrent.TimeUnit;
import javax.ws.rs.InternalServerErrorException;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response.Status;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class HTTPCall {
protected static final String USER_AGENT_KEY = "User-Agent";
protected static final String USER_AGENT_NAME = "gCat";
protected final String address;
/**
* When the target service is a gCube Service it adds the HTTP header
* to provide gCube authorization token and/or scope
*/
protected boolean gCubeTargetService;
public boolean isgCubeTargetService() {
return gCubeTargetService;
}
public void setgCubeTargetService(boolean gCubeTargetService) {
this.gCubeTargetService = gCubeTargetService;
}
public HTTPCall(String address) {
this(address, HTTPCall.USER_AGENT_NAME);
}
protected HTTPCall(String address, String userAgent) {
this.address = address;
this.gCubeTargetService = true;
}
protected URL getURL(String urlString) throws MalformedURLException {
URL url = new URL(urlString);
if(url.getProtocol().compareTo("https") == 0) {
url = new URL(url.getProtocol(), url.getHost(), url.getDefaultPort(), url.getFile());
}
return url;
}
public URL getFinalURL(URL url) {
try {
URL finalURL = url;
HttpURLConnection connection = (HttpURLConnection) url.openConnection();
connection.setInstanceFollowRedirects(false);
connection.setRequestProperty(USER_AGENT_KEY, USER_AGENT_NAME);
connection.setConnectTimeout((int) TimeUnit.SECONDS.toMillis(1));
// connection.setRequestMethod(HEAD.class.getSimpleName());
int responseCode = connection.getResponseCode();
if(responseCode >= Status.BAD_REQUEST.getStatusCode()) {
Status status = Status.fromStatusCode(responseCode);
String responseMessage = connection.getResponseMessage();
throw new WebApplicationException(responseMessage, status);
}
if(responseCode == HttpURLConnection.HTTP_MOVED_TEMP || responseCode == HttpURLConnection.HTTP_MOVED_PERM
|| responseCode == HttpURLConnection.HTTP_SEE_OTHER
|| responseCode == Status.TEMPORARY_REDIRECT.getStatusCode() || responseCode == 308) {
URL newURL = getURL(connection.getHeaderField("Location"));
connection.disconnect();
finalURL = getFinalURL(newURL);
}
return finalURL;
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new InternalServerErrorException(e);
}
}
}

View File

@ -1,65 +0,0 @@
package org.gcube.gcat.utils;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.UnsupportedEncodingException;
import java.net.HttpURLConnection;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.HttpHeaders;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response.Status;
import org.gcube.common.gxhttp.request.GXHTTPStringRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class HTTPUtility {
private static final Logger logger = LoggerFactory.getLogger(HTTPUtility.class);
public static StringBuilder getStringBuilder(InputStream inputStream) throws IOException {
StringBuilder result = new StringBuilder();
try(BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream))) {
String line;
while((line = reader.readLine()) != null) {
result.append(line);
}
}
return result;
}
public static GXHTTPStringRequest createGXHTTPStringRequest(String url, String path, boolean post)
throws UnsupportedEncodingException {
GXHTTPStringRequest gxhttpStringRequest = GXHTTPStringRequest.newRequest(url);
gxhttpStringRequest.from(Constants.CATALOGUE_NAME);
if(post) {
gxhttpStringRequest.header(HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON);
}
gxhttpStringRequest.header(HttpHeaders.ACCEPT, MediaType.APPLICATION_JSON);
gxhttpStringRequest.path(path);
return gxhttpStringRequest;
}
public static String getResultAsString(HttpURLConnection httpURLConnection) throws IOException {
int responseCode = httpURLConnection.getResponseCode();
if(responseCode >= Status.BAD_REQUEST.getStatusCode()) {
Status status = Status.fromStatusCode(responseCode);
InputStream inputStream = httpURLConnection.getErrorStream();
StringBuilder result = getStringBuilder(inputStream);
logger.trace(result.toString());
throw new WebApplicationException(result.toString(), status);
}
InputStream inputStream = httpURLConnection.getInputStream();
String ret = getStringBuilder(inputStream).toString();
logger.trace("Got Respose is {}", ret);
return ret;
}
}

View File

@ -1,37 +0,0 @@
package org.gcube.gcat.utils;
import java.util.Random;
/**
* @author Lucio Lelii (ISTI - CNR)
* @author Luca Frosini (ISTI - CNR)
*/
public class RandomString {
private static final char[] symbols;
static {
StringBuilder tmp = new StringBuilder();
for(char ch = '0'; ch <= '9'; ++ch)
tmp.append(ch);
for(char ch = 'a'; ch <= 'z'; ++ch)
tmp.append(ch);
symbols = tmp.toString().toCharArray();
}
private final Random random = new Random();
private final char[] buf;
public RandomString(int length) {
if(length < 1)
throw new IllegalArgumentException("length < 1: " + length);
buf = new char[length];
}
public String nextString() {
for(int idx = 0; idx < buf.length; ++idx)
buf[idx] = symbols[random.nextInt(symbols.length)];
return new String(buf);
}
}

View File

@ -1,66 +0,0 @@
package org.gcube.gcat.utils;
import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;
import javax.ws.rs.WebApplicationException;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.portlets.user.uriresolvermanager.UriResolverManager;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class URIResolver {
private static final String CATALOGUE_CONTEXT = "gcube_scope";
private static final String ENTITY_TYPE = "entity_context";
private static final String ENTITY_NAME = "entity_name";
private static final String DATASET = "dataset";
protected static URIResolver uriResolver;
protected UriResolverManager uriResolverManager;
protected Calendar expireTime;
public static URIResolver getInstance() {
if(uriResolver == null) {
uriResolver = new URIResolver();
}else {
Calendar now = Calendar.getInstance();
if(now.after(uriResolver.expireTime)) {
uriResolver = new URIResolver();
}
}
return uriResolver;
}
private URIResolver() {
try {
uriResolverManager = new UriResolverManager("CTLG");
expireTime = Calendar.getInstance();
expireTime.add(Calendar.MINUTE, 30);
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public String getCatalogueItemURL(String name) {
try {
String context = SecretManagerProvider.instance.get().getContext();
Map<String, String> params = new HashMap<>();
params.put(CATALOGUE_CONTEXT, context);
params.put(ENTITY_TYPE, DATASET);
params.put(ENTITY_NAME, name);
String url = uriResolverManager.getLink(params, false);
return url;
} catch(WebApplicationException e) {
throw e;
} catch(Exception e) {
throw new WebApplicationException(e);
}
}
}

View File

@ -1,40 +0,0 @@
package org.gcube.gcat.workspace;
import java.util.HashMap;
import java.util.Map;
import org.gcube.common.storagehub.model.Metadata;
import org.gcube.gcat.utils.Constants;
import org.gcube.storagehub.MetadataMatcher;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class GcatMetadataMatcher extends MetadataMatcher {
public static final String GCAT_METADATA_VERSION = "2.0.0";
public static final String CATALOGUE_ITEM_ID = "CatalogueItemID";
public GcatMetadataMatcher(String id) {
super(Constants.CATALOGUE_NAME, GCAT_METADATA_VERSION, id);
}
@Override
public boolean check(Metadata metadata) {
Map<String,Object> map = metadata.getMap();
Object obj = map.get(CATALOGUE_ITEM_ID);
if(obj!=null && obj.toString().compareTo(id) == 0) {
return true;
}
return false;
}
@Override
protected Map<String, Object> getSpecificMetadataMap() {
Map<String,Object> map = new HashMap<>();
map.put(CATALOGUE_ITEM_ID, id);
return map;
}
}

View File

@ -1,164 +0,0 @@
package org.gcube.gcat.workspace;
import java.net.HttpURLConnection;
import java.net.URL;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.common.gxhttp.request.GXHTTPStringRequest;
import org.gcube.common.storagehub.client.dsl.FileContainer;
import org.gcube.gcat.utils.Constants;
import org.gcube.storagehub.MetadataMatcher;
import org.gcube.storagehub.StorageHubManagement;
import org.glassfish.jersey.media.multipart.ContentDisposition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class GcatStorageHubManagement {
private static final Logger logger = LoggerFactory.getLogger(GcatStorageHubManagement.class);
protected StorageHubManagement storageHubManagement;
protected String itemId;
protected String originalFilename;
protected String mimeType;
public String getOriginalFilename() {
return originalFilename;
}
public String getMimeType() {
return mimeType;
}
public GcatStorageHubManagement() {
this.storageHubManagement = new StorageHubManagement();
}
protected MetadataMatcher getMetadataMatcher() {
MetadataMatcher metadataMatcher = new GcatMetadataMatcher(itemId);
return metadataMatcher;
}
protected String getOriginalFileName(HttpURLConnection httpURLConnection) throws Exception {
String contentDisposition = httpURLConnection.getHeaderField("Content-Disposition");
contentDisposition = contentDisposition.replaceAll("= ", "=").replaceAll(" =", "=");
ContentDisposition formDataContentDisposition = new ContentDisposition(contentDisposition);
return formDataContentDisposition.getFileName();
}
public URL ensureResourcePersistence(URL persistedURL, String itemID, String resourceID) throws Exception {
SecretManager secretManager = SecretManagerProvider.instance.get();
Secret secret = Constants.getCatalogueSecret();
try {
secretManager.startSession(secret);
GXHTTPStringRequest gxhttpStringRequest = GXHTTPStringRequest.newRequest(persistedURL.toString());
gxhttpStringRequest.from(Constants.CATALOGUE_NAME);
gxhttpStringRequest.isExternalCall(true);
HttpURLConnection httpURLConnection = gxhttpStringRequest.get();
mimeType = httpURLConnection.getContentType().split(";")[0];
originalFilename = getOriginalFileName(httpURLConnection);
this.itemId = itemID;
storageHubManagement.setMetadataMatcher(getMetadataMatcher());
persistedURL = storageHubManagement.persistFile(httpURLConnection.getInputStream(), resourceID, mimeType);
return persistedURL;
} catch (Exception e) {
logger.error("Error while trying to persists the resource", e);
throw e;
} finally {
secretManager.endSession();
}
}
public void deleteResourcePersistence(String itemID, String resourceID, String mimeType) throws Exception {
SecretManager secretManager = SecretManagerProvider.instance.get();
Secret secret = Constants.getCatalogueSecret();
try {
secretManager.startSession(secret);
storageHubManagement = new StorageHubManagement();
this.itemId = itemID;
storageHubManagement.setMetadataMatcher(getMetadataMatcher());
storageHubManagement.removePersistedFile(resourceID, mimeType);
} finally {
secretManager.endSession();
}
}
// protected void internalAddRevisionID(String resourceID, String revisionID) throws Exception {
// try {
// FileContainer fileContainer = null;
// AbstractFileItem fileItem = null;
// try {
// fileContainer = storageHubManagement.getPersistedFile();
// fileItem = fileContainer.get();
// }catch (Exception e) {
// // This is a workaround because storage-hub invalidate the item
// // when I rename it (just before this operation)
// // then I get java.lang.RuntimeException: javax.ws.rs.ProcessingException: Error reading entity from input stream.
// // invoking fileContainer.get()
// // see issue #25373
// fileContainer = storageHubManagement.getPersistedFile(resourceID, mimeType);
// fileItem = fileContainer.get();
// }
// Metadata metadata = fileItem.getMetadata();
// Map<String,Object> map = metadata.getMap();
// map.put(CatalogueMetadata.CATALOGUE_RESOURCE_ID, resourceID);
// map.put(CatalogueMetadata.CATALOGUE_RESOURCE_REVISION_ID, revisionID);
// metadata.setMap(map);
// fileContainer.setMetadata(metadata);
// } catch (Exception e) {
// logger.warn(
// "Unable to set revision id {} to the file of resource with id {} because the file was NOT found on storage-hub.",
// revisionID, resourceID);
// throw e;
// }
// }
// public void renameFile(String resourceID, String revisionID) throws Exception {
public void renameFile(String resourceID) throws Exception {
SecretManager secretManager = SecretManagerProvider.instance.get();
Secret secret = Constants.getCatalogueSecret();
try {
secretManager.startSession(secret);
FileContainer createdfile = storageHubManagement.getPersistedFile();
createdfile.rename(resourceID);
// internalAddRevisionID(resourceID, revisionID);
} finally {
secretManager.endSession();
}
}
// public void addRevisionID(String resourceID, String revisionID) throws Exception {
// SecretManager secretManager = SecretManagerProvider.instance.get();
// Secret secret = Constants.getCatalogueSecret();
// try {
// secretManager.startSession(secret);
// internalAddRevisionID(resourceID, revisionID);
// } finally {
// secretManager.endSession();
// }
// }
public FileContainer retrievePersistedFile(String filename, String mimeType) throws Exception {
SecretManager secretManager = SecretManagerProvider.instance.get();
Secret secret = Constants.getCatalogueSecret();
try {
secretManager.startSession(secret);
return storageHubManagement.getPersistedFile(filename, mimeType);
} finally {
secretManager.endSession();
}
}
public FileContainer getPersistedFile() throws Exception {
return storageHubManagement.getPersistedFile();
}
}

View File

@ -1,10 +1,10 @@
{
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -1,24 +1,24 @@
{
"@class": "Configuration",
"type": "Configuration",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "IdentifierFacet",
"type": "IdentifierFacet",
"value": "catalogue-configuration"
}
}
],
"isRelatedTo": [
{
"@class": "IsCustomizedBy",
"type": "IsCustomizedBy",
"source": {
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -1,28 +1,28 @@
{
"@class": "SimpleFacet",
"_in": {
"@class": "ConsistsOf",
"type": "SimpleFacet",
"_source": {
"type": "ConsistsOf",
"source": {
"@class": "Configuration",
"type": "Configuration",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "IdentifierFacet",
"type": "IdentifierFacet",
"value": "gcat-configuration"
}
}
],
"isRelatedTo": [
{
"@class": "IsCustomizedBy",
"type": "IsCustomizedBy",
"source": {
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -1,10 +1,10 @@
{
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "ckan-organization",
"name": "ckan"
}
@ -12,14 +12,14 @@
],
"isRelatedTo": [
{
"@class": "CallsFor",
"type": "CallsFor",
"source": {
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -1,14 +1,14 @@
{
"@class": "AccessPointFacet",
"_in": {
"@class": "ConsistsOf",
"type": "AccessPointFacet",
"_source": {
"type": "ConsistsOf",
"source": {
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "ckan-organization",
"name": "ckan"
}
@ -16,14 +16,14 @@
],
"isRelatedTo": [
{
"@class": "CallsFor",
"type": "CallsFor",
"source": {
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -1,10 +1,10 @@
{
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.postgresql",
"name": "postgresql"
}
@ -12,14 +12,14 @@
],
"isRelatedTo": [
{
"@class": "Uses",
"type": "Uses",
"source": {
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "ckan-organization",
"name": "ckan"
}
@ -27,14 +27,14 @@
],
"isRelatedTo": [
{
"@class": "CallsFor",
"type": "CallsFor",
"source": {
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -1,14 +1,14 @@
{
"@class": "AccessPointFacet",
"_in": {
"@class": "ConsistsOf",
"type": "AccessPointFacet",
"_source": {
"type": "ConsistsOf",
"source": {
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.postgresql",
"name": "postgresql"
}
@ -16,14 +16,14 @@
],
"isRelatedTo": [
{
"@class": "Uses",
"type": "Uses",
"source": {
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "ckan-organization",
"name": "ckan"
}
@ -31,14 +31,14 @@
],
"isRelatedTo": [
{
"@class": "CallsFor",
"type": "CallsFor",
"source": {
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -1,10 +1,10 @@
{
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.apache.solr",
"name": "solr"
}
@ -12,14 +12,14 @@
],
"isRelatedTo": [
{
"@class": "Uses",
"type": "Uses",
"source": {
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "ckan-organization",
"name": "ckan"
}
@ -27,14 +27,14 @@
],
"isRelatedTo": [
{
"@class": "CallsFor",
"type": "CallsFor",
"source": {
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -1,14 +1,14 @@
{
"@class": "AccessPointFacet",
"_in": {
"@class": "ConsistsOf",
"type": "AccessPointFacet",
"_source": {
"type": "ConsistsOf",
"source": {
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.apache.solr",
"name": "solr"
}
@ -16,14 +16,14 @@
],
"isRelatedTo": [
{
"@class": "Uses",
"type": "Uses",
"source": {
"@class": "EService",
"type": "EService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "ckan-organization",
"name": "ckan"
}
@ -31,14 +31,14 @@
],
"isRelatedTo": [
{
"@class": "CallsFor",
"type": "CallsFor",
"source": {
"@class": "VirtualService",
"type": "VirtualService",
"consistsOf": [
{
"@class": "IsIdentifiedBy",
"type": "IsIdentifiedBy",
"target": {
"@class": "SoftwareFacet",
"type": "SoftwareFacet",
"group": "org.gcube.data-catalogue",
"name": "catalogue-virtual-service"
}

View File

@ -9,76 +9,177 @@ import java.util.Properties;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.secret.JWTSecret;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.common.authorization.utils.secret.SecretUtility;
import org.gcube.common.keycloak.KeycloakClientFactory;
import org.gcube.common.keycloak.KeycloakClientHelper;
import org.gcube.common.keycloak.model.TokenResponse;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class ContextTest {
protected static Properties properties;
protected static final String PROPERTIES_FILENAME = "token.properties";
private static final Logger logger = LoggerFactory.getLogger(ContextTest.class);
protected static final String CONFIG_INI_FILENAME = "config.ini";
public static final String DEFAULT_TEST_SCOPE;
public static final String GCUBE;
public static final String DEVNEXT;
public static final String NEXTNEXT;
public static final String DEVSEC;
public static final String DEVVRE;
public static final String ROOT;
public static final String VO;
public static final String VRE;
private static final String ROOT_PRE;
private static final String VO_PREPROD;
protected static final String VRE_GRSF_PRE;
private static final String ROOT_PROD;
protected static final Properties properties;
public static final String TYPE_PROPERTY_KEY = "type";
public static final String USERNAME_PROPERTY_KEY = "username";
public static final String PASSWORD_PROPERTY_KEY = "password";
public static final String CLIENT_ID_PROPERTY_KEY = "clientId";
static {
properties = new Properties();
InputStream input = ContextTest.class.getClassLoader().getResourceAsStream(PROPERTIES_FILENAME);
GCUBE = "/gcube";
DEVNEXT = GCUBE + "/devNext";
NEXTNEXT = DEVNEXT + "/NextNext";
DEVSEC = GCUBE + "/devsec";
DEVVRE = DEVSEC + "/devVRE";
ROOT = GCUBE;
VO = DEVSEC;
VRE = DEVVRE;
ROOT_PRE = "/pred4s";
VO_PREPROD = ROOT_PRE + "/preprod";
VRE_GRSF_PRE = VO_PREPROD + "/GRSF_Pre";
ROOT_PROD = "/d4science.research-infrastructures.eu";
DEFAULT_TEST_SCOPE = VRE;
// DEFAULT_TEST_SCOPE = VRE_GRSF_PRE;
properties = new Properties();
InputStream input = ContextTest.class.getClassLoader().getResourceAsStream(CONFIG_INI_FILENAME);
try {
// load the properties file
properties.load(input);
} catch(IOException e) {
} catch (IOException e) {
throw new RuntimeException(e);
}
// DEFAULT_TEST_SCOPE_NAME = "/pred4s/preprod/preVRE";
// DEFAULT_TEST_SCOPE_NAME = "/gcube/devsec/devVRE";
ROOT = "/gcube";
VO = ROOT + "/devsec";
VRE = VO + "/devVRE";
// VO = ROOT + "/devNext";
// VRE = VO + "/NextNext";
}
private enum Type{
USER, CLIENT_ID
};
public static void set(Secret secret) throws Exception {
SecretManagerProvider.instance.reset();
SecretManager secretManager = new SecretManager();
SecretManagerProvider.instance.set(secretManager);
SecretManager secretManager = new SecretManager();
secretManager.addSecret(secret);
secretManager.set();
SecretManagerProvider.instance.set(secretManager);
SecretManagerProvider.instance.get().set();
}
public static void setContextByName(String fullContextName) throws Exception {
logger.debug("Going to set credentials for context {}", fullContextName);
Secret secret = getSecretByContextName(fullContextName);
set(secret);
}
private static TokenResponse getJWTAccessToken(String context) throws Exception {
Type type = Type.valueOf(properties.get(TYPE_PROPERTY_KEY).toString());
TokenResponse tr = null;
int index = context.indexOf('/', 1);
String root = context.substring(0, index == -1 ? context.length() : index);
switch (type) {
case CLIENT_ID:
String clientId = properties.getProperty(CLIENT_ID_PROPERTY_KEY);
String clientSecret = properties.getProperty(root);
tr = KeycloakClientFactory.newInstance().queryUMAToken(context, clientId, clientSecret, context, null);
break;
case USER:
default:
String username = properties.getProperty(USERNAME_PROPERTY_KEY);
String password = properties.getProperty(PASSWORD_PROPERTY_KEY);
switch (root) {
case "/gcube":
default:
clientId = "next.d4science.org";
break;
case "/pred4s":
clientId = "pre.d4science.org";
break;
case "/d4science.research-infrastructures.eu":
clientId = "services.d4science.org";
break;
}
clientSecret = null;
tr = KeycloakClientHelper.getTokenForUser(context, username, password);
break;
}
return tr;
}
public static Secret getSecretByContextName(String context) throws Exception {
TokenResponse tr = getJWTAccessToken(context);
Secret secret = new JWTSecret(tr.getAccessToken());
return secret;
}
public static void setContext(String token) throws Exception {
Secret secret = getSecret(token);
set(secret);
}
public static void setContextByName(String fullContextName) throws Exception {
Secret secret = getSecretByContextName(fullContextName);
set(secret);
}
private static Secret getSecret(String token) throws Exception {
Secret secret = SecretUtility.getSecretByTokenString(token);
return secret;
}
private static Secret getSecretByContextName(String fullContextName) throws Exception {
String token = ContextTest.properties.getProperty(fullContextName);
return getSecret(token);
public static String getUser() {
String user = "UNKNOWN";
try {
user = SecretManagerProvider.instance.get().getUser().getUsername();
} catch(Exception e) {
logger.error("Unable to retrieve user. {} will be used", user);
}
return user;
}
@BeforeClass
public static void beforeClass() throws Exception {
setContextByName(VRE);
setContextByName(DEFAULT_TEST_SCOPE);
}
@AfterClass

View File

@ -0,0 +1,89 @@
/**
*
*/
package org.gcube.gcat;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import org.gcube.common.authorization.utils.manager.SecretManager;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.common.authorization.utils.secret.SecretUtility;
import org.junit.AfterClass;
import org.junit.BeforeClass;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class ContextTestOldAuth {
protected static Properties properties;
protected static final String PROPERTIES_FILENAME = "token.properties";
public static final String ROOT;
public static final String VO;
public static final String VRE;
static {
properties = new Properties();
InputStream input = ContextTestOldAuth.class.getClassLoader().getResourceAsStream(PROPERTIES_FILENAME);
try {
// load the properties file
properties.load(input);
} catch(IOException e) {
throw new RuntimeException(e);
}
// DEFAULT_TEST_SCOPE_NAME = "/pred4s/preprod/preVRE";
// DEFAULT_TEST_SCOPE_NAME = "/gcube/devsec/devVRE";
ROOT = "/gcube";
VO = ROOT + "/devsec";
VRE = VO + "/devVRE";
// VO = ROOT + "/devNext";
// VRE = VO + "/NextNext";
}
public static void set(Secret secret) throws Exception {
SecretManagerProvider.instance.reset();
SecretManager secretManager = new SecretManager();
SecretManagerProvider.instance.set(secretManager);
secretManager.addSecret(secret);
secretManager.set();
}
public static void setContext(String token) throws Exception {
Secret secret = getSecret(token);
set(secret);
}
public static void setContextByName(String fullContextName) throws Exception {
Secret secret = getSecretByContextName(fullContextName);
set(secret);
}
private static Secret getSecret(String token) throws Exception {
Secret secret = SecretUtility.getSecretByTokenString(token);
return secret;
}
private static Secret getSecretByContextName(String fullContextName) throws Exception {
String token = ContextTestOldAuth.properties.getProperty(fullContextName);
return getSecret(token);
}
@BeforeClass
public static void beforeClass() throws Exception {
setContextByName(VRE);
}
@AfterClass
public static void afterClass() throws Exception {
SecretManagerProvider.instance.reset();
}
}

View File

@ -1,23 +0,0 @@
package org.gcube.gcat.configuration;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.configuration.service.ServiceCatalogueConfiguration;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CatalogueConfigurationFactoryTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CatalogueConfigurationFactoryTest.class);
@Test
public void testConf() throws Exception {
ServiceCatalogueConfiguration serviceCatalogueConfiguration = CatalogueConfigurationFactory.getInstance();
logger.debug("{}", serviceCatalogueConfiguration.toJsonString());
logger.debug("{}", serviceCatalogueConfiguration.toJsonString(true));
}
}

View File

@ -1,23 +0,0 @@
package org.gcube.gcat.configuration;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class VersionTest {
private static final Logger logger = LoggerFactory.getLogger(VersionTest.class);
@Test
public void testVersions() {
String[] versions = new String[]{"2.2.0-SNAPSHOT", "1.3.5", "1.4.5-beta", "1.5.6-gcore"};
for(String v : versions) {
Version version = new Version(v);
logger.debug("Version is {}", version);
}
}
}

View File

@ -1,44 +0,0 @@
package org.gcube.gcat.configuration.isproxies.impl;
import java.util.List;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.configuration.service.ServiceCatalogueConfiguration;
import org.gcube.informationsystem.serialization.ElementMapper;
import org.gcube.resourcemanagement.model.reference.entities.facets.SimpleFacet;
import org.gcube.resourcemanagement.model.reference.entities.resources.EService;
import org.gcube.resourcemanagement.model.reference.entities.resources.VirtualService;
import org.gcube.resourcemanagement.model.reference.relations.isrelatedto.CallsFor;
import org.junit.Ignore;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class FacetBasedISConfigurationProxyTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(FacetBasedISConfigurationProxyTest.class);
@Ignore
@Test
public void test() throws Exception {
FacetBasedISConfigurationProxyFactory facetBasedISConfigurationProxyFactory = new FacetBasedISConfigurationProxyFactory();
FacetBasedISConfigurationProxy fbiscp = facetBasedISConfigurationProxyFactory.getInstance();
fbiscp.setServiceEServiceID("f00bbacd-92b8-46d7-b41c-828f71a78753");
CallsFor<EService, VirtualService> callsFor = fbiscp.createCallsForToVirtualService();
logger.debug("Created {}", ElementMapper.marshal(callsFor));
SimpleFacet simpleFacet = fbiscp.getISResource();
logger.debug("{}", ElementMapper.marshal(simpleFacet));
ServiceCatalogueConfiguration catalogueConfiguration = fbiscp.getCatalogueConfiguration();
logger.debug("{}", catalogueConfiguration.toJsonString());
logger.debug("{}", catalogueConfiguration.toJsonString(true));
List<CallsFor<EService, VirtualService>> callsForList = fbiscp.deleteCallsForToVirtualService();
logger.debug("Deleted {} {} relations {}", callsForList.size(), CallsFor.NAME, ElementMapper.marshal(callsForList));
}
}

View File

@ -1,149 +0,0 @@
package org.gcube.gcat.configuration.isproxies.impl;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.Set;
import java.util.stream.Collectors;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.configuration.service.ServiceCatalogueConfiguration;
import org.junit.Assert;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class GCoreISConfigurationProxyTest extends ContextTest {
private static final Logger logger = LoggerFactory.getLogger(GCoreISConfigurationProxyTest.class);
// @Test
public void testGetSupportedOrganizationsFromIS() throws Exception {
ContextTest.setContextByName("/gcube/devNext/NextNext");
String context = SecretManagerProvider.instance.get().getContext();
GCoreISConfigurationProxy gCoreISConfigurationProxy = new GCoreISConfigurationProxy(context);
@SuppressWarnings("deprecation")
Set<String> organizations = gCoreISConfigurationProxy.getSupportedOrganizationsFromGenericResource();
Assert.assertTrue(organizations.size()>0);
}
@Test
public void testCatalogueConfiguration() throws Exception {
ContextTest.setContextByName("/gcube/devsec/devVRE");
String context = SecretManagerProvider.instance.get().getContext();
GCoreISConfigurationProxy gCoreISConfigurationProxy = new GCoreISConfigurationProxy(context);
ServiceCatalogueConfiguration catalogueConfiguration = gCoreISConfigurationProxy.readFromIS();
String json = catalogueConfiguration.toJsonString();
logger.info("Configuration in context {} is {}", context, json);
/*
ServiceCatalogueConfiguration secondCatalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(json);
String secondJson = secondCatalogueConfiguration.toJsonString();
logger.info("After marshalling and unmarshalling configuration in context {} is {}", context, secondJson);
String decryptedJson = secondCatalogueConfiguration.toJsonString(true);
logger.info("Decrypted configuration in context {} is {}", context, decryptedJson);
ServiceCatalogueConfiguration thirdCatalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(decryptedJson);
String thirdJson = thirdCatalogueConfiguration.toJsonString();
logger.info("After marshalling and unmarshalling decrypted configuration in context {} is {}", context, thirdJson);
logger.info("All as JsonArray [{},{},{},{}]", json, secondJson, decryptedJson, thirdJson);
*/
}
// @Test
public void updateConfigurationToNewVersion() throws Exception {
ContextTest.setContextByName("/gcube/devsec/devVRE");
String context = SecretManagerProvider.instance.get().getContext();
GCoreISConfigurationProxy gCoreISConfigurationProxy = new GCoreISConfigurationProxy(context);
@SuppressWarnings("deprecation")
ServiceCatalogueConfiguration catalogueConfiguration = gCoreISConfigurationProxy.getOLDCatalogueConfigurationFromGCoreIS();
String json = catalogueConfiguration.toJsonString();
logger.debug("Read configuration {}", json);
catalogueConfiguration = gCoreISConfigurationProxy.createOrUpdateOnIS();
json = catalogueConfiguration.toJsonString();
logger.debug("Updated configuration {}", json);
}
public static String DEVVRE_CONFIG_JSON = "devvre.conf.json";
//@Test
public void createConfiguration() throws Exception {
ContextTest.setContextByName("/gcube/devsec/devVRE");
String context = SecretManagerProvider.instance.get().getContext();
InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream(DEVVRE_CONFIG_JSON);
String json = new BufferedReader(new InputStreamReader(inputStream)).lines().collect(Collectors.joining("\n"));
ServiceCatalogueConfiguration catalogueConfiguration = ServiceCatalogueConfiguration.getServiceCatalogueConfiguration(json);
GCoreISConfigurationProxy gCoreISConfigurationProxy = new GCoreISConfigurationProxy(context);
gCoreISConfigurationProxy.setCatalogueConfiguration(catalogueConfiguration);
gCoreISConfigurationProxy.createOnIS();
}
// protected GenericResource instantiateGenericResource(String secondaryType, String name, String xml) throws Exception {
// GenericResource genericResource = new GenericResource();
// org.gcube.common.resources.gcore.GenericResource.Profile profile = genericResource.newProfile();
// profile.type(secondaryType);
// profile.name(name);
// profile.description("This resource is read by gCat and define the list of CKAN organizations where a client is allowed to publish for the current context");
// profile.newBody(xml);
// StringWriter stringWriter = new StringWriter();
// Resources.marshal(genericResource, stringWriter);
// logger.debug("The generated {} is\n{}", GenericResource.class.getSimpleName(), stringWriter.toString());
// return genericResource;
// }
//
// protected void createGenericResource(String xml) throws Exception {
// GenericResource genericResource = instantiateGenericResource(
// GCoreISConfigurationProxy.GENERIC_RESOURCE_SECONDARY_TYPE_FOR_ORGANIZATIONS,
// GCoreISConfigurationProxy.GENERIC_RESOURCE_NAME_FOR_ORGANIZATIONS, xml);
// RegistryPublisher registryPublisher = RegistryPublisherFactory.create();
// genericResource = registryPublisher.create(genericResource);
// StringWriter stringWriter = new StringWriter();
// Resources.marshal(genericResource, stringWriter);
// logger.trace("The {} with ID {} has been created \n{}", GenericResource.class.getSimpleName(),
// genericResource.id(), stringWriter.toString());
// }
//
// protected String createGRBody(List<String> organizations) throws Exception {
// if(organizations==null || organizations.size()<1) {
// throw new Exception("Unable to create the body for the generic resource with empty organization list");
// }
// ObjectMapper objectMapper = new ObjectMapper();
// ObjectNode objectNode = objectMapper.createObjectNode();
// ArrayNode arrayNode = objectNode.putArray(GCoreISConfigurationProxy.GENERIC_RESOURCE_CKAN_ORGANIZATIONS);
// for(String organizationName : organizations) {
// arrayNode.add(organizationName);
// }
// return objectMapper.writeValueAsString(objectNode);
// }
//
// protected void createGenericResourceForSupportedOrganizations(List<String> organizations) throws Exception {
// String json = createGRBody(organizations);
// createGenericResource(json);
// }
//
// // @Test
// public void createGenericResourceForSupportedOrganizationsByName() throws Exception {
// List<String> organizations = new ArrayList<>();
// organizations.add("nextnext");
// organizations.add("devvre");
// createGenericResourceForSupportedOrganizations(organizations);
// }
//
// // @Test
// public void createGenericResourceForSupportedOrganizationsByScopeBean() throws Exception {
// ContextTest.setContextByName("/gcube/devNext/NextNext");
//
// List<ScopeBean> scopeBeans = new ArrayList<>();
// scopeBeans.add(new ScopeBean("/gcube/devNext/NextNext"));
// scopeBeans.add(new ScopeBean("/gcube/devsec/devVRE"));
// List<String> organizations = new ArrayList<>();
// for(ScopeBean scopeBean : scopeBeans) {
// organizations.add(CatalogueConfiguration.getOrganizationName(scopeBean));
// }
// createGenericResourceForSupportedOrganizations(organizations);
// }
}

View File

@ -1,58 +0,0 @@
package org.gcube.gcat.moderation;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.api.moderation.CMItemStatus;
import org.gcube.gcat.moderation.thread.ModerationThread;
import org.gcube.gcat.persistence.ckan.CKANUser;
import org.junit.Test;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class ModerationThreadTest extends ContextTest {
protected ModerationThread getModerationThread(CKANUser ckanUser) {
ModerationThread moderationThread = ModerationThread.getDefaultInstance();
moderationThread.setItemCoordinates("b1040e70-774f-47b6-95e9-f24efca50caf", "my_first_restful_transaction_model", "RESTful Transaction Model", "https://data.dev.d4science.org/ctlg/devVRE/my_first_restful_transaction_model");
moderationThread.setCKANUser(ckanUser);
return moderationThread;
}
@Test
// @Ignore
public void testModerationThread() throws Exception {
ContextTest.setContextByName("pasquale.pagano_/gcube/devsec/devVRE");
CKANUser ckanUser = new CKANUser();
ckanUser.setName(CKANUser.getCKANUsername());
ckanUser.read();
ModerationThread moderationThread = getModerationThread(ckanUser);
moderationThread.postItemCreated();
moderationThread = getModerationThread(ckanUser);
moderationThread.postItemUpdated();
moderationThread = getModerationThread(ckanUser);
moderationThread.postUserMessage(CMItemStatus.PENDING, "Pensaci Bene");
moderationThread = getModerationThread(ckanUser);
moderationThread.postItemRejected(null);
moderationThread = getModerationThread(ckanUser);
moderationThread.postItemRejected("reject con messaggio: Non mi garba");
moderationThread = getModerationThread(ckanUser);
moderationThread.postItemApproved(null);
moderationThread = getModerationThread(ckanUser);
moderationThread.postItemApproved("approve con messaggio: Ora mi garba");
moderationThread = getModerationThread(ckanUser);
moderationThread.setItemAuthor(true);
moderationThread.postUserMessage(CMItemStatus.APPROVED, "Grazie");
Thread.sleep(1000);
}
}

View File

@ -1,14 +0,0 @@
package org.gcube.gcat.oldutils;
import org.gcube.gcat.ContextTest;
import org.junit.Test;
public class ValidatorTest extends ContextTest {
@Test
public void createGroupAsSysAdmin() throws Exception {
String groupName = "Italian";
Validator validator = new Validator();
validator.createGroupAsSysAdmin(groupName);
}
}

View File

@ -1,87 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import java.util.Arrays;
import java.util.List;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.gcat.ContextTest;
import org.junit.Ignore;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANGroupTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CKANGroupTest.class);
@Ignore
@Test
public void count() throws Exception {
CKANGroup ckanGroup = new CKANGroup();
int count = ckanGroup.count();
logger.debug("The groups are {}", count);
}
@Ignore
@Test
public void list() throws Exception {
CKANGroup ckanGroup = new CKANGroup();
String ret = ckanGroup.list(10000, 0);
logger.debug("{}", ret);
}
@Ignore
@Test
public void read() throws Exception {
CKANGroup ckanGroup = new CKANGroup();
ckanGroup.setApiKey(CKANUtility.getSysAdminAPI());
String name = "abundance-level";
ckanGroup.setName(name);
String ret = ckanGroup.read();
logger.debug("{}", ret);
}
@Ignore
@Test
public void createDeleteGroup() throws Exception {
CKANGroup ckanGroup = new CKANGroup();
ckanGroup.setApiKey(CKANUtility.getSysAdminAPI());
String name = "my-test-group";
ckanGroup.setName(name);
ckanGroup.create();
ckanGroup.delete(true);
}
public static List<String> listGroup() throws Exception {
CKANGroup group = new CKANGroup();
String groups = group.list(1000, 0);
ObjectMapper objectMapper = new ObjectMapper();
String[] groupArray = objectMapper.readValue(groups, String[].class);
return Arrays.asList(groupArray);
}
// @Test
public void listAllGroups() throws Exception {
ContextTest.setContextByName("");
CKANGroup ckanGroup = new CKANGroup();
ckanGroup.setApiKey(CKANUtility.getSysAdminAPI());
List<String> groups = listGroup();
logger.debug("Groups are:\n{}", groups);
}
// @Test
public void deleteAllGroups() throws Exception {
ContextTest.setContextByName("/gcube");
CKANGroup ckanGroup = new CKANGroup();
ckanGroup.setApiKey(CKANUtility.getSysAdminAPI());
List<String> groups = listGroup();
for(String name : groups) {
ckanGroup.setName(name);
// ckanGroup.delete(true);
}
}
}

View File

@ -1,22 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.configuration.CatalogueConfigurationFactory;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class CKANInstanceTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CKANInstanceTest.class);
@Test
public void testSerialization() throws Exception {
CatalogueConfiguration configuration = CatalogueConfigurationFactory.getInstance();
ObjectMapper mapper = new ObjectMapper();
logger.debug("Configuration is {}", mapper.writeValueAsString(configuration));
}
}

View File

@ -1,49 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import java.util.ArrayList;
import java.util.List;
import org.gcube.gcat.ContextTest;
import org.junit.Assert;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
public class CKANLicenseTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CKANLicenseTest.class);
@Test
public void list() throws Exception {
CKANLicense license = new CKANLicense();
license.list(-1, -1);
JsonNode gotList = license.getJsonNodeResult();
Assert.assertTrue(gotList instanceof ArrayNode);
ObjectMapper mapper = new ObjectMapper();
logger.debug("List :\n{}", mapper.writeValueAsString(gotList));
}
@Test
public void testCheckLicense() throws Exception {
ArrayNode arrayNode = CKANLicense.getLicenses();
for(JsonNode jsonNode : arrayNode) {
String licenseId = jsonNode.get(CKAN.ID_KEY).asText();
assertTrue(CKANLicense.checkLicenseId(arrayNode, licenseId));
logger.debug("'{}' is a valid License ID", licenseId);
}
List<String> invalidIds = new ArrayList<>();
invalidIds.add("InvaliLicense");
invalidIds.add("CCO");
for(String licenseId : invalidIds) {
assertFalse(CKANLicense.checkLicenseId(arrayNode, licenseId));
logger.debug("As expected '{}' is an INVALID License ID", licenseId);
}
}
}

View File

@ -1,104 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import java.util.Arrays;
import java.util.List;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.scope.impl.ScopeBean;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.junit.Ignore;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class CKANOrganizationTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CKANOrganizationTest.class);
/*
@Test
public void getUserRole() throws Exception {
CKANOrganization ckanOrganization = new CKANOrganization();
ckanOrganization.setApiKey(CKANUtility.getSysAdminAPI());
ckanOrganization.setName(CKANOrganization.getCKANOrganizationName());
String ret = ckanOrganization.getUserRole("luca.frosini");
logger.debug("{}", ret);
}
*/
@Test
public void countOrganizations() throws Exception {
CKANOrganization ckanOrganization = new CKANOrganization();
int count = ckanOrganization.count();
logger.debug("The organizations are {}", count);
}
public static List<String> listOrg() throws Exception {
CKANOrganization ckanOrganization = new CKANOrganization();
String ret = ckanOrganization.list(1000, 0);
ObjectMapper objectMapper = new ObjectMapper();
String[] groupArray = objectMapper.readValue(ret, String[].class);
return Arrays.asList(groupArray);
}
@Test
public void listOrganizations() throws Exception {
CKANOrganization ckanOrganization = new CKANOrganization();
String ret = ckanOrganization.list(1000, 0);
logger.debug("{}", ret);
}
@Ignore
@Test
public void deleteOrganization() throws Exception {
ContextTest.setContextByName("/gcube");
CKANOrganization ckanOrganization = new CKANOrganization();
ckanOrganization.setApiKey(CKANUtility.getSysAdminAPI());
String name = "aquamaps1";
ckanOrganization.setName(name);
logger.debug("Going to delete {}", name);
// ckanOrganization.delete(true);
}
@Ignore
@Test
public void createOrganization() throws Exception {
ContextTest.setContextByName("/gcube/devNext/NextNext");
String context = SecretManagerProvider.instance.get().getContext();
ScopeBean scopeBean = new ScopeBean(context);
CKANOrganization ckanOrganization = new CKANOrganization();
ckanOrganization.setApiKey(CKANUtility.getSysAdminAPI());
String name = CatalogueConfiguration.getOrganizationName(context);
ckanOrganization.setName(name);
String json = "{\"display_name\": \"" + scopeBean.name() + "\",\"description\": \"" + context + " Organization\",\"name\": \"" + name + "\"}";
logger.info("Going to create Organization {} : {}", name, json);
// ckanOrganization.create(json);
}
//@Ignore
@Test
public void deleteAllOrganizations() throws Exception {
ContextTest.setContextByName("/gcube");
CKANOrganization ckanOrganization = new CKANOrganization();
ckanOrganization.setApiKey(CKANUtility.getSysAdminAPI());
String ret = ckanOrganization.list(1000, 0);
logger.debug("{}", ret);
ObjectMapper mapper = new ObjectMapper();
JsonNode organizations = (ArrayNode) mapper.readTree(ret);
for(JsonNode jn : organizations) {
ckanOrganization.setName(jn.asText());
logger.debug("Going to delete organization '{}'", jn.asText());
try {
// ckanOrganization.delete(true);
}catch (Exception e) {
// A not empty organization cannot be deleted
}
}
}
}

View File

@ -1,603 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import static org.gcube.common.authorization.client.Constants.authorizationService;
import java.io.StringWriter;
import java.net.URI;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.ws.rs.ForbiddenException;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.core.MultivaluedHashMap;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.PathSegment;
import javax.ws.rs.core.UriBuilder;
import javax.ws.rs.core.UriInfo;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.common.authorization.library.provider.UserInfo;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.scope.impl.ScopeBean;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.api.GCatConstants;
import org.gcube.gcat.api.configuration.CatalogueConfiguration;
import org.gcube.gcat.api.moderation.CMItemStatus;
import org.gcube.gcat.api.moderation.Moderated;
import org.junit.Assert;
import org.junit.Ignore;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANPackageTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CKANPackageTest.class);
private static final String NOTES_KEY = "notes";
private static final String URL_KEY = "url";
private static final String PRIVATE_KEY = "private";
public static final String ITEM_NAME_VALUE = "restful_transaction_model";
private static final String LICENSE_VALUE = "CC-BY-SA-4.0";
private static final String EXTRAS_TYPE_VALUE_VALUE = "EmptyProfile";
@Test
public void count() throws Exception {
CKANPackage ckanPackage = new CKANPackage();
int count = ckanPackage.count();
logger.debug("Number of items in {} is {}", SecretManagerProvider.instance.get().getContext(), count);
}
@Test
public void list() throws Exception {
ContextTest.setContextByName("/gcube/devsec/devVRE");
CKANPackage ckanPackage = new CKANPackage();
MultivaluedMap<String, String> mvm = new MultivaluedHashMap<String,String>();
// mvm.add(Moderated.CM_ITEM_STATUS_QUERY_PARAMETER, CMItemStatus.PENDING.getValue());
UriInfo uriInfo = getUriInfo(mvm);
ckanPackage.setUriInfo(uriInfo);
ObjectMapper mapper = new ObjectMapper();
String ret = ckanPackage.list(10, 0);
JsonNode gotList = mapper.readTree(ret);
Assert.assertTrue(gotList instanceof ArrayNode);
logger.debug("List:\n{}", mapper.writeValueAsString(gotList));
}
public static UriInfo getUriInfo(MultivaluedMap<String, String> queryParameters) {
UriInfo uriInfo = new UriInfo() {
@Override
public URI resolve(URI uri) {
return null;
}
@Override
public URI relativize(URI uri) {
return null;
}
@Override
public UriBuilder getRequestUriBuilder() {
return null;
}
@Override
public URI getRequestUri() {
return null;
}
@Override
public MultivaluedMap<String, String> getQueryParameters(boolean decode) {
return null;
}
@Override
public MultivaluedMap<String, String> getQueryParameters() {
return queryParameters;
}
@Override
public List<PathSegment> getPathSegments(boolean decode) {
return null;
}
@Override
public List<PathSegment> getPathSegments() {
return null;
}
@Override
public MultivaluedMap<String, String> getPathParameters(boolean decode) {
return null;
}
@Override
public MultivaluedMap<String, String> getPathParameters() {
return null;
}
@Override
public String getPath(boolean decode) {
return null;
}
@Override
public String getPath() {
return null;
}
@Override
public List<String> getMatchedURIs(boolean decode) {
return null;
}
@Override
public List<String> getMatchedURIs() {
return null;
}
@Override
public List<Object> getMatchedResources() {
return null;
}
@Override
public UriBuilder getBaseUriBuilder() {
return null;
}
@Override
public URI getBaseUri() {
return null;
}
@Override
public UriBuilder getAbsolutePathBuilder() {
return null;
}
@Override
public URI getAbsolutePath() {
return null;
}
};
return uriInfo;
}
@Test
public void listWithParameters() throws Exception {
String contextName = "/gcube/devNext/NextNext";
String ckanOrganizationName = CatalogueConfiguration.getOrganizationName(contextName);
ContextTest.setContextByName(contextName);
CKANPackage ckanPackage = new CKANPackage();
ObjectMapper mapper = new ObjectMapper();
boolean[] values = new boolean[]{true, false};
for(boolean includeValidOrganization : values) {
for(boolean includeFakeOrganization : values) {
MultivaluedMap<String,String> queryParameters = new MultivaluedHashMap<>();
StringWriter stringWriter = new StringWriter();
boolean addOr = false;
if(includeFakeOrganization) {
stringWriter.append("organization:fakeorganization");
addOr = true;
}
if(includeValidOrganization) {
if(addOr) {
stringWriter.append(" OR ");
}
stringWriter.append("organization:");
stringWriter.append(ckanOrganizationName);
}
String filter = stringWriter.toString();
if(filter.length()>0) {
queryParameters.add(GCatConstants.Q_KEY, filter);
}
queryParameters.add(GCatConstants.OWN_ONLY_QUERY_PARAMETER, Boolean.TRUE.toString());
/*
queryParameters.add("fl","[\"name\"]");
*/
/*
queryParameters.add("facet.field","[\"name\"]");
queryParameters.add("sort","name asc");
*/
Map<String,String> parameters = null;
try {
ckanPackage.setUriInfo(getUriInfo(queryParameters));
parameters = ckanPackage.getListingParameters(10, 0);
}catch (ForbiddenException e) {
if(includeFakeOrganization) {
// This is the expected behaviour
continue;
}else {
throw e;
}
}
String ret = ckanPackage.list(parameters);
JsonNode gotList = mapper.readTree(ret);
Assert.assertTrue(gotList instanceof ArrayNode);
logger.debug("List :\n{}", mapper.writeValueAsString(gotList));
}
}
}
@Test(expected=ForbiddenException.class)
public void checkParameter() throws Exception {
ContextTest.setContextByName("/gcube/devNext/NextNext");
Map<String, String> parameters = new HashMap<>();
CKANPackage ckanPackage = new CKANPackage();
MultivaluedMap<String,String> queryParameters = new MultivaluedHashMap<>();
queryParameters.add(GCatConstants.Q_KEY, "organization:nextnext OR organization:fakeorg");
parameters = ckanPackage.checkListParameters(queryParameters, parameters);
logger.debug("{}", parameters);
}
/*
* PRE
*
* Workspace(luca.frosini) > RESTful Transaction Model.pdf
* https://data1-d.d4science.org/shub/E_YjI4STdKKzRlNjgzMm9jQWxjcmtReDNwbDFYR3lpTHo3SjdtN1RDZ3c2OGk0ZHZhdE5iZElBKzNxUDAyTGFqZw==
* https://goo.gl/HcUWni
*
*
* Workspace(luca.frosini) > RESTful Transaction Model v 1.0.pdf
* https://data1-d.d4science.org/shub/E_aThRa1NpWFJpTGEydEU2bEJhMXNjZy8wK3BxekJKYnpYTy81cUkwZVdicEZ0aGFRZmY4MkRnUC8xWW0zYzVoVg==
* https://goo.gl/J8AwQW
* ContextTest.setContextByName("/gcube/devsec/devVRE");
*
* Workspace(luca.frosini) > RESTful Transaction Model v 1.1.pdf
* https://data1-d.d4science.org/shub/E_NkhrbVV4VTluT0RKVUtCRldobFZTQU5ySTZneFdpUzJ2UjJBNlZWNDlURDVHamo4WjY5RnlrcHZGTGNkT2prUg==
* https://goo.gl/78ViuR
*
*/
@Test
public void testNameRegex() {
Map<String,Boolean> stringsToTest = new HashMap<>();
stringsToTest.put("Test", false); // Fails for T
stringsToTest.put("test-test+test-test", false); // Fails for +
stringsToTest.put("t", false); // Fails because is too short. Min length is 2 characters
stringsToTest.put("te", true);
stringsToTest.put("test-test_test-test", true);
stringsToTest.put(
"test-test_test-test_test-test_test-test_test-test_test-test_test-test_test-test_test-test_test-test_",
true);
// // Fails because is too long. Max length is 100 characters
stringsToTest.put(
"test-test_test-test_test-test_test-test_test-test_test-test_test-test_test-test_test-test_test-test_t",
false);
for(String testString : stringsToTest.keySet()) {
boolean match = testString.matches(CKANPackage.NAME_REGEX);
logger.debug("'{}' does {}match the regex {}", testString, match ? "" : "NOT ", CKANPackage.NAME_REGEX);
Assert.assertEquals(stringsToTest.get(testString), match);
}
}
protected CKANPackage createPackage(ObjectMapper mapper, Boolean socialPost) throws Exception {
String currentContext = SecretManagerProvider.instance.get().getContext();
String organization = CatalogueConfiguration.getOrganizationName(currentContext);
ObjectNode itemObjectNode = mapper.createObjectNode();
itemObjectNode.put(CKAN.NAME_KEY, ITEM_NAME_VALUE);
itemObjectNode.put(CKANPackage.TITLE_KEY, "RESTful Transaction Model");
itemObjectNode.put(CKANPackage.LICENSE_KEY, LICENSE_VALUE);
itemObjectNode.put(PRIVATE_KEY, false);
itemObjectNode.put(NOTES_KEY, "A research of Luca Frosini");
itemObjectNode.put(URL_KEY, "https://www.d4science.org");
itemObjectNode.put(CKANPackage.OWNER_ORG_KEY, organization);
ArrayNode tagArrayNode = itemObjectNode.putArray(CKANPackage.TAGS_KEY);
ObjectNode tagNode = mapper.createObjectNode();
tagNode.put(CKANPackage.NAME_KEY, "REST");
tagArrayNode.add(tagNode);
ArrayNode resourceArrayNode = itemObjectNode.putArray(CKANPackage.RESOURCES_KEY);
ObjectNode resourceNode = mapper.createObjectNode();
resourceNode.put(CKANResource.NAME_KEY, "RESTful Transaction Model");
// Workspace(luca.frosini) > RESTful Transaction Model v 1.1.pdf
resourceNode.put(CKANResource.URL_KEY, "https://data-dev.d4science.net/Qpw2");
resourceArrayNode.add(resourceNode);
ArrayNode extraArrayNode = itemObjectNode.putArray(CKANPackage.EXTRAS_KEY);
ObjectNode typeNode = mapper.createObjectNode();
typeNode.put(CKANPackage.EXTRAS_KEY_KEY, CKANPackage.EXTRAS_KEY_VALUE_SYSTEM_TYPE);
typeNode.put(CKANPackage.EXTRAS_VALUE_KEY, EXTRAS_TYPE_VALUE_VALUE);
extraArrayNode.add(typeNode);
/*
ObjectNode modelNode = mapper.createObjectNode();
modelNode.put(CKANPackage.EXTRAS_KEY_KEY, "test");
modelNode.put(CKANPackage.EXTRAS_VALUE_KEY, "test 2.9°");
extraArrayNode.add(modelNode);
*/
ObjectNode populationNode = mapper.createObjectNode();
populationNode.put(CKANPackage.EXTRAS_KEY_KEY, "Population");
populationNode.put(CKANPackage.EXTRAS_VALUE_KEY, "Italian");
extraArrayNode.add(populationNode);
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
//ckanPackage.setApiKey(CKANUtility.getSysAdminAPI());
MultivaluedMap<String, String> mvm = new MultivaluedHashMap<String,String>();
mvm.add(GCatConstants.SOCIAL_POST_QUERY_PARAMETER, socialPost.toString());
UriInfo uriInfo = getUriInfo(mvm);
ckanPackage.setUriInfo(uriInfo);
String createdItem = ckanPackage.create(mapper.writeValueAsString(itemObjectNode));
logger.debug(createdItem);
return ckanPackage;
}
@Test
public void create() throws Exception {
ObjectMapper mapper = new ObjectMapper();
createPackage(mapper, true);
}
@Test
public void testURIResolver() {
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName("Test");
ObjectMapper objectMapper = new ObjectMapper();
ObjectNode objectNode = objectMapper.createObjectNode();
ckanPackage.addItemURLViaResolver(objectNode);
}
@Test
public void createReadUpdateUpdatePurge() throws Exception {
ObjectMapper mapper = new ObjectMapper();
createPackage(mapper, false);
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
String readItem = ckanPackage.read();
JsonNode readItemObjectNode = mapper.readTree(readItem);
String readID = readItemObjectNode.get(CKANPackage.NAME_KEY).asText();
Assert.assertNotNull(readID);
Assert.assertTrue(ITEM_NAME_VALUE.compareTo(readID) == 0);
String updatedNotes = "A research of Luca Frosini made during the PhD";
((ObjectNode) readItemObjectNode).put(NOTES_KEY, updatedNotes);
// ArrayNode resources = (ArrayNode) readItemObjectNode.get(CKANPackage.RESOURCES_KEY);
// ObjectNode objectNode = (ObjectNode) resources.get(0);
// // Workspace(luca.frosini) > RESTful Transaction Model v 1.1.pdf
// objectNode.put(CKANResource.URL_KEY, "https://data-dev.d4science.net/Qpw2");
// resources.set(0, objectNode);
//
// ((ObjectNode) readItemObjectNode).replace(CKANPackage.RESOURCES_KEY, resources);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
String updatedItem = ckanPackage.update(mapper.writeValueAsString(readItemObjectNode));
logger.trace(updatedItem);
JsonNode updatedItemObjectNode = mapper.readTree(updatedItem);
String gotUpdatedNotes = updatedItemObjectNode.get(NOTES_KEY).asText();
Assert.assertTrue(gotUpdatedNotes.compareTo(updatedNotes) == 0);
/*
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
((ObjectNode) updatedItemObjectNode).remove(CKANPackage.RESOURCES_KEY);
String secondUpdateItem = ckanPackage.update(mapper.writeValueAsString(updatedItemObjectNode));
logger.trace(secondUpdateItem);
*/
/*
ObjectNode patchObjectNode = mapper.createObjectNode();
String patchedNotes = updatedNotes + " in October 2018";
patchObjectNode.put(NOTES_KEY, patchedNotes);
patchObjectNode.put(CKANPackage.NAME_KEY, ITEM_NAME_VALUE);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
String patchedItem = ckanPackage.patch(mapper.writeValueAsString(patchObjectNode));
logger.trace(patchedItem);
JsonNode patchedItemObjectNode = mapper.readTree(patchedItem);
String gotPatchedNotes = patchedItemObjectNode.get(NOTES_KEY).asText();
Assert.assertTrue(gotPatchedNotes.compareTo(patchedNotes)==0);
*/
/*
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
ckanPackage.purge();
logger.debug("Item {} purge successfully", ITEM_NAME_VALUE);
*/
}
@Test
//(expected = NotFoundException.class)
public void read() throws Exception {
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
String ret = ckanPackage.read();
logger.debug(ret);
}
// @Ignore
@Test
//(expected = NotFoundException.class)
public void delete() throws Exception {
delete(true);
}
public void delete(boolean purge) throws Exception {
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
ckanPackage.delete(purge);
}
@Test
public void testUpdate() {
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName("knime_workflow_with_joined_consumer_phase_and_dose_response_model");
ckanPackage.update("{\"rating\":0.0,\"license_title\":\"Academic Free License 3.0\",\"maintainer\":\"\",\"relationships_as_object\":[],\"private\":false,\"maintainer_email\":\"\",\"num_tags\":5,\"id\":\"f4292d0e-c94f-4542-bfa3-25f78638fc1b\",\"metadata_created\":\"2020-01-07T16:40:16.987780\",\"owner_org\":\"3571cca5-b0ae-4dc6-b791-434a8e062ce5\",\"metadata_modified\":\"2020-02-03T14:24:59.221160\",\"author\":\"Buschhardt Tasja\",\"author_email\":\"tasja.buschhardt@bfr.bund.de\",\"state\":\"active\",\"version\":\"1\",\"license_id\":\"AFL-3.0\",\"type\":\"dataset\",\"resources\":[{\"cache_last_updated\":null,\"cache_url\":null,\"mimetype_inner\":null,\"hash\":\"\",\"description\":\"\",\"format\":\"knwf\",\"url\":\"https://data.d4science.net/g9QY\",\"created\":\"2019-09-16T20:49:02.168666\",\"state\":\"active\",\"package_id\":\"f4292d0e-c94f-4542-bfa3-25f78638fc1b\",\"last_modified\":null,\"mimetype\":null,\"url_type\":null,\"position\":0,\"revision_id\":\"a84a35ec-2786-4835-9f50-ad52202c4e33\",\"size\":null,\"datastore_active\":false,\"id\":\"0734b380-ea5d-4c99-be03-c38ff6ae6fbf\",\"resource_type\":null,\"name\":\"KNIME_WF_ICPMF11\"}],\"num_resources\":1,\"tags\":[{\"vocabulary_id\":null,\"state\":\"active\",\"display_name\":\"Campylobacter\",\"id\":\"84c76669-d135-4c5e-9e3a-b163689a10de\",\"name\":\"Campylobacter\"},{\"vocabulary_id\":null,\"state\":\"active\",\"display_name\":\"KNIME workflow\",\"id\":\"30bce4d2-fc45-46ab-8f8b-5da582fff3c3\",\"name\":\"KNIME workflow\"},{\"vocabulary_id\":null,\"state\":\"active\",\"display_name\":\"chicken meat\",\"id\":\"f1aac698-a865-4bf4-ac55-b53f8bf7ecac\",\"name\":\"chicken meat\"},{\"vocabulary_id\":null,\"state\":\"active\",\"display_name\":\"consumer phase model\",\"id\":\"9e6b2337-9ac0-4bfc-8e7f-4327c531bbec\",\"name\":\"consumer phase model\"},{\"vocabulary_id\":null,\"state\":\"active\",\"display_name\":\"dose response model\",\"id\":\"21311c09-a928-4a9a-83de-7ef98b257af5\",\"name\":\"dose response model\"}],\"groups\":[],\"creator_user_id\":\"7020f836-45f4-4ee8-9c65-e7504209644f\",\"relationships_as_subject\":[],\"name\":\"knime_workflow_with_joined_consumer_phase_and_dose_response_model\",\"isopen\":true,\"url\":\"\",\"notes\":\"This KNIME workflow shows how to use FSK-Lab to read, customise, run, \\r\\ncombine and change simulation settings for food safety models- specifically \\r\\nthis workflow exemplifies a joined consumer phase model for Campylobacter \\r\\nin chicken meat and a dose response model for Campylobacter\",\"title\":\"KNIME workflow with joined consumer phase and dose response model\",\"extras\":[{\"value\":\"\",\"key\":\"Author\"},{\"value\":\"https://data.d4science.org/ctlg/RAKIP_trial/knime_workflow_with_joined_consumer_phase_and_dose_response_model\",\"key\":\"Item URL\"},{\"value\":\"ResearchObject\",\"key\":\"system:type\"},{\"value\":\"{\\\"relatedIdentifierType\\\":\\\"URL\\\",\\\"relationType\\\":\\\"isReferencedBy\\\",\\\"link\\\":\\\"https://doi.org/10.5072/zenodo.488235\\\",\\\"zenodoId\\\":488235}\",\"key\":\"relatedIdentifier:Zenodo.DOI\"}],\"license_url\":\"https://www.opensource.org/licenses/AFL-3.0\",\"ratings_count\":0,\"organization\":{\"description\":\"\",\"title\":\"devVRE\",\"created\":\"2016-05-30T11:30:41.710079\",\"approval_status\":\"approved\",\"is_organization\":true,\"state\":\"active\",\"image_url\":\"\",\"revision_id\":\"7c8463df-ed3f-4d33-87d8-6c0bcbe30d5d\",\"type\":\"organization\",\"id\":\"3571cca5-b0ae-4dc6-b791-434a8e062ce5\",\"name\":\"devvre\"},\"revision_id\":\"9f51fa28-0732-46c9-a208-9a0e6da0cd2c\"}");
}
@Test
public void testUpdate2() {
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName("vre_picture");
ckanPackage.update("{\"rating\": 0.0, \"license_title\": \"Academic Free License 3.0\", \"maintainer\": \"Kerekes Kata\", \"relationships_as_object\": [], \"private\": false, \"maintainer_email\": \"kerekeska@nebih.gov.hu\", \"num_tags\": 1, \"id\": \"7731b70f-47ff-4b74-b943-188215e82d07\", \"metadata_created\": \"2020-01-07T16:40:24.822719\", \"owner_org\": \"3571cca5-b0ae-4dc6-b791-434a8e062ce5\", \"metadata_modified\": \"2020-02-03T15:16:42.596068\", \"author\": \"Kerekes Kata\", \"author_email\": \"kerekeska@nebih.gov.hu\", \"state\": \"active\", \"version\": \"1\", \"license_id\": \"AFL-3.0\", \"type\": \"dataset\", \"resources\": [{\"cache_last_updated\": null, \"cache_url\": null, \"mimetype_inner\": null, \"hash\": \"\", \"description\": \"\", \"format\": \"JPEG\", \"url\": \"https://goo.gl/SnwAM7\", \"created\": \"2019-04-01T13:24:40.738838\", \"state\": \"active\", \"package_id\": \"7731b70f-47ff-4b74-b943-188215e82d07\", \"last_modified\": null, \"mimetype\": \"image/jpeg\", \"url_type\": null, \"position\": 0, \"revision_id\": \"06d61000-a0c1-4155-ad2d-78ede56d6bb5\", \"size\": null, \"datastore_active\": false, \"id\": \"1de8851d-1385-47ae-9c93-6040d170a9cc\", \"resource_type\": null, \"name\": \"th.jpeg\"}], \"num_resources\": 1, \"tags\": [{\"vocabulary_id\": null, \"state\": \"active\", \"display_name\": \"DEMETER\", \"id\": \"4e05058b-a006-4dbf-94f5-277a30318323\", \"name\": \"DEMETER\"}], \"groups\": [], \"creator_user_id\": \"7020f836-45f4-4ee8-9c65-e7504209644f\", \"relationships_as_subject\": [], \"name\": \"vre_picture\", \"isopen\": true, \"url\": \"\", \"notes\": \"This is a nice picture of a VRE ;)\", \"title\": \"VRE picture\", \"extras\": [{\"value\": \"https://data.d4science.org/ctlg/DEMETER_trial/vre_picture\", \"key\": \"Item URL\"}, {\"value\": \"ResearchObject\", \"key\": \"system:type\"}], \"license_url\": \"https://www.opensource.org/licenses/AFL-3.0\", \"ratings_count\": 0, \"organization\": {\"description\": \"\", \"title\": \"devVRE\", \"created\": \"2016-05-30T11:30:41.710079\", \"approval_status\": \"approved\", \"is_organization\": true, \"state\": \"active\", \"image_url\": \"\", \"revision_id\": \"7c8463df-ed3f-4d33-87d8-6c0bcbe30d5d\", \"type\": \"organization\", \"id\": \"3571cca5-b0ae-4dc6-b791-434a8e062ce5\", \"name\": \"devvre\"}, \"revision_id\": \"bdb6169a-6268-43d6-b7e1-265c0c9e1a1c\"}");
}
@Test
public void generateLinoTokenModeration() throws Exception {
UserInfo userInfo = new UserInfo("leonardo.candela", new ArrayList<>());
String userToken = authorizationService().generateUserToken(userInfo, VRE);
logger.debug(userToken);
}
@Test
public void testModeration() throws Exception {
CKANPackage ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
try {
ckanPackage.purge();
}catch (NotFoundException e) {
logger.trace("The item does not exist. This is correct");
}
ObjectMapper mapper = new ObjectMapper();
createPackage(mapper, false);
ContextTest.setContextByName("leonardo.candela_"+VRE);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
ckanPackage.message("Please add the notes.");
ContextTest.setContextByName(VRE);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
String readItem = ckanPackage.read();
JsonNode readItemObjectNode = mapper.readTree(readItem);
String updatedNotes = "A research of Luca Frosini made during the PhD";
((ObjectNode) readItemObjectNode).put(NOTES_KEY, updatedNotes);
String ret = ckanPackage.update(mapper.writeValueAsString(readItemObjectNode));
logger.debug("Updated {}", ret);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
ckanPackage.message("I hope now it can be approved.");
ContextTest.setContextByName("leonardo.candela_"+VRE);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
ckanPackage.reject("You must specify the institution.");
ContextTest.setContextByName(VRE);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
readItem = ckanPackage.read();
readItemObjectNode = mapper.readTree(readItem);
updatedNotes = "A research of Luca Frosini at ISTI";
((ObjectNode) readItemObjectNode).put(NOTES_KEY, updatedNotes);
ckanPackage.update(mapper.writeValueAsString(readItemObjectNode));
ContextTest.setContextByName("pasquale.pagano_"+VRE);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
ckanPackage.approve("It seems fine now");
ContextTest.setContextByName(VRE);
ckanPackage = new CKANPackage();
ckanPackage.setName(ITEM_NAME_VALUE);
ckanPackage.purge();
}
@Ignore
// @Test
public void deleteAllInASpecificOrganization() {
CKANPackage ckanPackage = new CKANPackage();
MultivaluedMap<String, String> mvm = new MultivaluedHashMap<String,String>();
mvm.add(GCatConstants.Q_KEY, "organization:devvre");
mvm.add(GCatConstants.OWN_ONLY_QUERY_PARAMETER, "false");
UriInfo uriInfo = getUriInfo(mvm);
ckanPackage.setUriInfo(uriInfo);
// String res = ckanPackage.deleteAll(true);
// logger.debug("{}", res);
}
// @Ignore
@Test
public void deleteAllItemsInAllOrganizations() {
CKANPackage ckanPackage = new CKANPackage();
MultivaluedMap<String, String> mvm = new MultivaluedHashMap<String,String>();
mvm.add(GCatConstants.OWN_ONLY_QUERY_PARAMETER, "false");
UriInfo uriInfo = getUriInfo(mvm);
ckanPackage.setUriInfo(uriInfo);
String res = ckanPackage.deleteAll(true);
logger.debug("{}", res);
}
@Test
public void listTest() {
CKANPackage ckanPackage = new CKANPackage();
MultivaluedMap<String, String> mvm = new MultivaluedHashMap<String,String>();
mvm.add(GCatConstants.OWN_ONLY_QUERY_PARAMETER, "false");
UriInfo uriInfo = getUriInfo(mvm);
ckanPackage.setUriInfo(uriInfo);
String res = ckanPackage.list(10, 0);
logger.debug("{}", res);
}
@Test
public void teet() {
Boolean b = Boolean.parseBoolean("false");
logger.debug("{}", b);
b = Boolean.parseBoolean("False");
logger.debug("{}", b);
}
}

View File

@ -1,139 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
import org.gcube.gcat.ContextTest;
import org.junit.Assert;
import org.junit.Ignore;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class CKANResourceTest extends ContextTest {
private static final Logger logger = LoggerFactory.getLogger(CKANResourceTest.class);
/*
* PRE
*
* Workspace(luca.frosini) > RESTful Transaction Model.pdf
* https://data1-d.d4science.org/shub/E_YjI4STdKKzRlNjgzMm9jQWxjcmtReDNwbDFYR3lpTHo3SjdtN1RDZ3c2OGk0ZHZhdE5iZElBKzNxUDAyTGFqZw==
* https://goo.gl/HcUWni
*
*
* Workspace(luca.frosini) > RESTful Transaction Model v 1.0.pdf
* https://data1-d.d4science.org/shub/E_aThRa1NpWFJpTGEydEU2bEJhMXNjZy8wK3BxekJKYnpYTy81cUkwZVdicEZ0aGFRZmY4MkRnUC8xWW0zYzVoVg==
* https://goo.gl/J8AwQW
*
*
* Workspace(luca.frosini) > RESTful Transaction Model v 1.1.pdf
* https://data1-d.d4science.org/shub/E_NkhrbVV4VTluT0RKVUtCRldobFZTQU5ySTZneFdpUzJ2UjJBNlZWNDlURDVHamo4WjY5RnlrcHZGTGNkT2prUg==
* https://goo.gl/78ViuR
*
*/
@Ignore
@Test
public void testCopyStorageResource() throws Exception {
// ContextTest.setContextByName("/d4science.research-infrastructures.eu/D4Research/AGINFRAplusDev");
URL url = new URL("https://data.d4science.net/gS9k");
String itemID = UUID.randomUUID().toString();
CKANResource ckanResource = new CKANResource(itemID);
ckanResource.resourceID = UUID.randomUUID().toString();
URL finalURL = ckanResource.copyStorageResource(url);
logger.debug("Initial URL is {} - Final URL is {}", url, finalURL);
ckanResource.deleteStorageResource(finalURL, ckanResource.resourceID, ckanResource.mimeType);
}
@Ignore
@Test
public void testCreate() throws Exception {
ObjectMapper objectMapper = new ObjectMapper();
ObjectNode objectNode = objectMapper.createObjectNode();
objectNode.put(CKANResource.NAME_KEY, "MyTestTy_rest_upload");
objectNode.put(CKANResource.URL_KEY, "https://data.d4science.org/shub/58a13287-3e91-4afd-bd80-cf4605a0edaa");
objectNode.put("description", "i uploaded this file using the REST API");
// objectNode.put(CKANResource.ID_KEY, "ba7ab7e8-c268-4219-98cd-c73470870999");
CKANResource ckanResource = new CKANResource("ba7ab7e8-c268-4219-98cd-c73470870999");
String json = ckanResource.getAsString(objectNode);
logger.debug("Going to create Resource {}", json);
ckanResource.create(objectNode);
}
@Test
public void testCreateUpdate() throws Exception {
ObjectMapper objectMapper = new ObjectMapper();
ObjectNode objectNode = objectMapper.createObjectNode();
objectNode.put(CKANResource.NAME_KEY, "MyTestTy_rest_upload");
objectNode.put(CKANResource.URL_KEY, "https://data-dev.d4science.net/C1G2");
objectNode.put("description", "File uploaded using the REST API");
// objectNode.put(CKANResource.ID_KEY, "ba7ab7e8-c268-4219-98cd-c73470870999");
String id = "5795a7ce-4444-439e-b77d-1df3beaa8a42"; // name = my_restful
CKANResource ckanResource = new CKANResource(id);
String json = ckanResource.getAsString(objectNode);
logger.debug("Going to create Resource {}", json);
String createdJson = ckanResource.create(objectNode);
ckanResource = new CKANResource(id);
ckanResource.update(createdJson);
}
// @Test
public void testDelete() throws Exception {
CKANResource ckanResource = new CKANResource("f0326fec-d8ac-42c7-abff-c7905b4d938e");
ckanResource.setResourceID("fcf98272-41e7-4f05-9294-fdafb1a33074");
ckanResource.delete();
}
@Test
public void testGetFormat() {
CKANResource ckanResource = new CKANResource(UUID.randomUUID().toString());
ckanResource.mimeType = "application/zip";
ckanResource.originalFileExtension = ".fskk";
String format = ckanResource.getFormat();
Assert.assertTrue(format.compareTo("fskk") == 0);
ckanResource.originalFileExtension = null;
format = ckanResource.getFormat();
Assert.assertTrue(format.compareTo("zip") == 0);
ckanResource.mimeType = "image/jpeg";
format = ckanResource.getFormat();
Assert.assertTrue(format.compareTo("jpg") == 0);
}
@Test
public void testFinalURIResolverURL() throws Exception {
List<String> urlsString = new ArrayList<>();
urlsString.add("https://data-pre.d4science.net/wgsZ");
urlsString.add("https://data-dev.d4science.net/TzQv");
urlsString.add("https://data-d.d4science.org/shub/E_MkxMbitjYzY3R3VlTmp1cDF6cHVHY2w1Zk15RTdFakUrZnpKYXVLN1R6T0dtT1FXaXpIOHJmb2dSZ2p4WS9hYw==");
urlsString.add("https://data.d4science.net/Cuvn");
//urlsString.add("");
for(String urlString : urlsString) {
try {
URL url = CKANResource.getFinalURL(new URL(urlString));
System.out.println(urlString + " -> " + url.toString());
logger.debug("{} -> {}", urlString, url.toString());
}catch (Exception e) {
System.out.println("Error while getting final URL for " + urlString);
logger.debug("Error while getting final URL for {}", urlString);
}
}
}
}

View File

@ -1,95 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.persistence.ckan.cache.CKANUserCache;
import org.junit.Assert;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.gcube.com.fasterxml.jackson.databind.JsonNode;
import org.gcube.com.fasterxml.jackson.databind.ObjectMapper;
import org.gcube.com.fasterxml.jackson.databind.node.ObjectNode;
public class CKANUserTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CKANUserTest.class);
private static final String USERNAME = "lucio_lelii";
private CKANUser getCKANUser() {
CKANUser user = new CKANUser();
user.setApiKey(CKANUtility.getSysAdminAPI());
user.setName(USERNAME);
return user;
}
@Test
public void getUsernameFromCkanUsername() {
String username = "luca.frosini";
String ckanUsername = CKANUser.getCKANUsername(username);
Assert.assertTrue(ckanUsername.compareTo("luca_frosini")==0);
String gotUsername = CKANUser.getUsernameFromCKANUsername(ckanUsername);
Assert.assertTrue(gotUsername.compareTo(username)==0);
}
@Test
public void list() throws Exception {
CKANUser ckanUser = getCKANUser();
String ret = ckanUser.list(-1, -1);
logger.debug("{}", ret);
}
@Test
public void create() throws Exception {
CKANUser ckanUser = getCKANUser();
String ret = ckanUser.createInCkan();
logger.debug("{}", ret);
}
@Test
public void read() throws Exception {
CKANUser ckanUser = getCKANUser();
String ret = ckanUser.read();
logger.debug("{}", ret);
}
public final static String DISPLAY_NAME = "display_name";
@Test
public void update() throws Exception {
CKANUser ckanUser = getCKANUser();
String ret = ckanUser.read();
ObjectMapper mapper = new ObjectMapper();
JsonNode readUser = mapper.readTree(ret);
((ObjectNode) readUser).put(CKANUser.EMAIL, USERNAME + "@gcube.ckan.org");
((ObjectNode) readUser).put("state", "active");
ret = ckanUser.update(ckanUser.getAsString(readUser));
logger.debug("{}", ret);
}
@Test
public void delete() throws Exception {
CKANUser ckanUser = getCKANUser();
ckanUser.delete(false);
}
@Test
public void testAddSpecialUserToOrganization() throws Exception {
CKANUser ckanUser = getCKANUser();
ckanUser.addUserToOrganization();
}
@Test
public void checkAndUpdateInformation() throws Exception {
CKANUser ckanUser = CKANUserCache.getCurrrentCKANUser();
logger.debug("{}", ckanUser.result);
ckanUser = CKANUserCache.getCurrrentCKANUser();
logger.debug("{}", ckanUser.result);
ckanUser = CKANUserCache.getCurrrentCKANUser();
logger.debug("{}", ckanUser.result);
}
}

View File

@ -1,21 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import org.gcube.gcat.ContextTest;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class CKANUtilityTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CKANPackageTest.class);
@Test
public void testGetApiKey() throws Exception {
String ckanAPI = CKANUtility.getApiKey();
logger.debug("User {} has the following API key {}", CKANUser.getCKANUsername(), ckanAPI);
}
}

View File

@ -1,178 +0,0 @@
package org.gcube.gcat.persistence.ckan;
import javax.ws.rs.NotFoundException;
import org.gcube.com.fasterxml.jackson.databind.node.ArrayNode;
import org.gcube.gcat.ContextTest;
import org.junit.Assert;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI-CNR)
*/
public class CKanPackageTrashTest extends ContextTest {
private static Logger logger = LoggerFactory.getLogger(CKanPackageTrashTest.class);
protected boolean find(ArrayNode ids, String name) {
boolean found = false;
for(int i=0; i<ids.size(); i++) {
if(name.compareTo(ids.get(i).asText())==0) {
found = true;
break;
}
}
return found;
}
@Test
public void testListAndEmptyTrash() throws Exception {
// Cleanign the env
ContextTest.setContextByName(VRE);
CKANPackageTest ckanPackageTest = new CKANPackageTest();
ckanPackageTest.delete(true);
ckanPackageTest = new CKANPackageTest();
ckanPackageTest.create();
ckanPackageTest.delete(false);
CKANPackageTrash ckanPackageTrash = new CKANPackageTrash();
ArrayNode ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
boolean found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(found);
ckanPackageTest.delete(true);
ids = ckanPackageTrash.getItems();
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
logger.debug("{}", ids);
}
public static final String NON_CATALOGUE_ADMIN_USER = "lucio.lelii";
@Test
public void testListAndEmptyTrashFromAdmin() throws Exception {
// Cleanign the env
ContextTest.setContextByName(VRE);
CKANPackageTest ckanPackageTest = new CKANPackageTest();
try {
ckanPackageTest.delete(true);
}catch (NotFoundException e) {
// It is expected. the env was clean
}
ContextTest.setContextByName(NON_CATALOGUE_ADMIN_USER+"_"+VRE);
ckanPackageTest = new CKANPackageTest();
ckanPackageTest.create();
ckanPackageTest.delete(false);
// I'm admin
ContextTest.setContextByName(VRE);
CKANPackageTrash ckanPackageTrash = new CKANPackageTrash();
ckanPackageTrash.setOwnOnly(false);
ArrayNode ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
boolean found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(found);
ckanPackageTrash.setOwnOnly(true);
ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
ContextTest.setContextByName(NON_CATALOGUE_ADMIN_USER+"_"+VRE);
ckanPackageTest.delete(true);
// I'm admin
ContextTest.setContextByName(VRE);
ckanPackageTrash = new CKANPackageTrash();
ckanPackageTrash.setOwnOnly(false);
ids = ckanPackageTrash.getItems();
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
logger.debug("{}", ids);
}
@Test
public void testListAndEmptyTrashFromNonAdmin() throws Exception {
// Cleaning the env
ContextTest.setContextByName(VRE);
CKANPackageTest ckanPackageTest = new CKANPackageTest();
try {
ckanPackageTest.delete(true);
}catch (NotFoundException e) {
// It is expected. the env was clean
}
ContextTest.setContextByName(VRE);
ckanPackageTest = new CKANPackageTest();
ckanPackageTest.create();
ckanPackageTest.delete(false);
// He is not admin
ContextTest.setContextByName(NON_CATALOGUE_ADMIN_USER+"_"+VRE);
CKANPackageTrash ckanPackageTrash = new CKANPackageTrash();
ckanPackageTrash.setOwnOnly(false);
ArrayNode ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
boolean found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
ckanPackageTrash.setOwnOnly(true);
ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
ContextTest.setContextByName(VRE);
ckanPackageTrash = new CKANPackageTrash();
ckanPackageTrash.setOwnOnly(false);
ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(found);
ckanPackageTrash.setOwnOnly(true);
ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(found);
ckanPackageTest.delete(true);
ckanPackageTrash = new CKANPackageTrash();
ckanPackageTrash.setOwnOnly(false);
ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
ckanPackageTrash.setOwnOnly(true);
ids = ckanPackageTrash.getItems();
logger.debug("{}", ids);
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
ContextTest.setContextByName(NON_CATALOGUE_ADMIN_USER+"_"+VRE);
ckanPackageTrash = new CKANPackageTrash();
ckanPackageTrash.setOwnOnly(false);
ids = ckanPackageTrash.getItems();
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
logger.debug("{}", ids);
ckanPackageTrash = new CKANPackageTrash();
ckanPackageTrash.setOwnOnly(true);
ids = ckanPackageTrash.getItems();
found = find(ids, CKANPackageTest.ITEM_NAME_VALUE);
Assert.assertTrue(!found);
logger.debug("{}", ids);
}
}

View File

@ -5,6 +5,7 @@ import java.io.StringReader;
import java.net.URL;
import java.nio.file.Files;
import java.util.Iterator;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;
@ -163,4 +164,12 @@ public class ProfileTest extends ContextTest {
}
}
@Test
public void testRegex() throws Exception {
File resDirectory = getResourcesDirectory();
File regexFile = new File(resDirectory, "regex.txt");
String regex = fileToString(regexFile);
Pattern.compile(regex);
}
}

View File

@ -1,40 +0,0 @@
package org.gcube.gcat.social;
import java.util.ArrayList;
import java.util.List;
import java.util.UUID;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.utils.Constants;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class SocialPostTest extends ContextTest {
private static final Logger logger = LoggerFactory.getLogger(SocialPostTest.class);
@Test
public void testToken() throws Exception {
Secret secret = Constants.getCatalogueSecret();
logger.debug("Application Token is {}", secret.getToken());
ContextTest.set(secret);
}
@Test
public void testSendPost() throws Exception {
SocialPost socialService = new SocialPost();
socialService.setItemID(UUID.randomUUID().toString());
socialService.setItemTitle("Test Item");
socialService.setItemURL("https://www.d4science.org");
List<String> tags = new ArrayList<>();
tags.add("Test");
tags.add("ThisIsATest");
tags.add("IgnoreIt");
socialService.setTags(tags);
socialService.sendSocialPost(false);
}
}

View File

@ -1,19 +0,0 @@
package org.gcube.gcat.social;
import org.gcube.common.authorization.utils.socialservice.SocialService;
import org.gcube.gcat.ContextTest;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class SocialServiceTest {
private static Logger logger = LoggerFactory.getLogger(SocialServiceTest.class);
@Test
public void get() throws Exception {
ContextTest.setContextByName("/d4science.research-infrastructures.eu/D4Research/AGINFRAplusDev");
SocialService socialService = SocialService.getSocialService();
logger.debug(socialService.getServiceBasePath());
}
}

View File

@ -1,51 +0,0 @@
package org.gcube.gcat.utils;
import java.net.URL;
import org.gcube.common.authorization.utils.manager.SecretManagerProvider;
import org.gcube.common.authorization.utils.secret.Secret;
import org.gcube.common.encryption.encrypter.StringEncrypter;
import org.gcube.gcat.ContextTest;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Luca Frosini (ISTI - CNR)
*/
public class ConstantsTest extends ContextTest {
private static final Logger logger = LoggerFactory.getLogger(ConstantsTest.class);
@Test
public void testGetApplicationToken() throws Exception {
logger.debug("Application token for Context {} is {}", SecretManagerProvider.instance.get().getContext(),
Constants.getCatalogueSecret().getToken());
}
@Test
public void decrypt() throws Exception {
StringEncrypter stringEncrypter = StringEncrypter.getEncrypter();
String decrypted = stringEncrypter.decrypt("w0KVc+78b2yUQsndDh/cXyyRquuwyILTygmoF0Y5Dls=");
logger.debug("{}", decrypted);
}
@Test
public void getToken() throws Exception {
Secret secret = Constants.getCatalogueSecret();
logger.debug(secret.getToken());
}
@Test
public void getResourceTest() {
URL url1 = ConstantsTest.class.getResource(Constants.CLIENT_ID_SECRET_FILENAME);
logger.debug("{}", url1);
URL url2 = ConstantsTest.class.getClassLoader().getResource(Constants.CLIENT_ID_SECRET_FILENAME);
logger.debug("{}", url2);
URL url3 = ClassLoader.getSystemClassLoader().getResource(Constants.CLIENT_ID_SECRET_FILENAME);
logger.debug("{}", url3);
}
}

View File

@ -1,44 +0,0 @@
package org.gcube.gcat.utils;
import java.util.Calendar;
import org.gcube.common.encryption.encrypter.StringEncrypter;
import org.gcube.gcat.ContextTest;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class URIResolverTest extends ContextTest {
private static final Logger logger = LoggerFactory.getLogger(URIResolverTest.class);
@Test
public void getInstanceTest() throws Exception {
URIResolver uriResolver = URIResolver.getInstance();
String catalogueItemURL = uriResolver.getCatalogueItemURL("my_first_restful_transaction_model");
logger.debug("Item URL is {}", catalogueItemURL);
URIResolver.uriResolver = null;
uriResolver = URIResolver.getInstance();
catalogueItemURL = uriResolver.getCatalogueItemURL("my_first_restful_transaction_model");
logger.debug("Item URL is {}", catalogueItemURL);
uriResolver.expireTime = Calendar.getInstance();
uriResolver.expireTime.add(Calendar.MINUTE, -1);
uriResolver = URIResolver.getInstance();
catalogueItemURL = uriResolver.getCatalogueItemURL("my_first_restful_transaction_model");
logger.debug("Item URL is {}", catalogueItemURL);
}
@Test
public void decrypt() throws Exception {
ContextTest.setContextByName("/gcube/devsec/devVRE");
String encrypted = "";
String pwd = StringEncrypter.getEncrypter().decrypt(encrypted);
logger.info(pwd);
}
}

View File

@ -1,116 +0,0 @@
package org.gcube.gcat.workspace;
import java.net.URL;
import java.util.Map;
import org.gcube.common.storagehub.client.dsl.FileContainer;
import org.gcube.common.storagehub.model.Metadata;
import org.gcube.gcat.ContextTest;
import org.gcube.gcat.persistence.ckan.CKANResource;
import org.gcube.storagehub.MetadataMatcher;
import org.gcube.storagehub.StorageHubManagement;
import org.junit.Assert;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class GCatStorageHubManagementTest extends ContextTest {
private static final Logger logger = LoggerFactory.getLogger(GCatStorageHubManagementTest.class);
/*
* PRE
*
* Workspace(luca.frosini) > RESTful Transaction Model.pdf
* https://data1-d.d4science.org/shub/E_YjI4STdKKzRlNjgzMm9jQWxjcmtReDNwbDFYR3lpTHo3SjdtN1RDZ3c2OGk0ZHZhdE5iZElBKzNxUDAyTGFqZw==
* https://goo.gl/HcUWni
*
* Workspace(luca.frosini) > RESTful Transaction Model v 1.0.pdf
* https://data1-d.d4science.org/shub/E_aThRa1NpWFJpTGEydEU2bEJhMXNjZy8wK3BxekJKYnpYTy81cUkwZVdicEZ0aGFRZmY4MkRnUC8xWW0zYzVoVg==
* https://goo.gl/J8AwQW
*
*
* Workspace(luca.frosini) > RESTful Transaction Model v 1.1.pdf
* https://data1-d.d4science.org/shub/E_NkhrbVV4VTluT0RKVUtCRldobFZTQU5ySTZneFdpUzJ2UjJBNlZWNDlURDVHamo4WjY5RnlrcHZGTGNkT2prUg==
* https://goo.gl/78ViuR
*
*/
public static final String ORIGINAL_STORAGE_URL_STRING = "https://data1-d.d4science.org/shub/E_YjI4STdKKzRlNjgzMm9jQWxjcmtReDNwbDFYR3lpTHo3SjdtN1RDZ3c2OGk0ZHZhdE5iZElBKzNxUDAyTGFqZw==";
public static final URL ORIGINAL_STORAGE_URL;
public static final String SHORT_URL_STRING = "https://goo.gl/HcUWni";
public static final URL SHORT_STORAGE_URL;
public static final String MIME_TYPE = "application/pdf";
static {
try {
ORIGINAL_STORAGE_URL = new URL(ORIGINAL_STORAGE_URL_STRING);
SHORT_STORAGE_URL = new URL(SHORT_URL_STRING);
} catch(Exception e) {
throw new RuntimeException(e);
}
}
public static final String ITEM_ID = "MyItem";
public static final String RESOURCE_ID = "1234";
protected GcatStorageHubManagement catalogueStorageHubManagement;
protected StorageHubManagement storageHubManagement;
protected GcatMetadataMatcher catalogueMetadata;
public GCatStorageHubManagementTest() {
catalogueStorageHubManagement = new GcatStorageHubManagement();
storageHubManagement = catalogueStorageHubManagement.storageHubManagement;
catalogueMetadata = new GcatMetadataMatcher(ITEM_ID);
}
@Test
public void getFinalURL() {
URL finalURL = CKANResource.getFinalURL(SHORT_STORAGE_URL);
Assert.assertTrue(finalURL.toString().compareTo(ORIGINAL_STORAGE_URL_STRING) == 0);
}
protected void checkMetadata(FileContainer fileContainer) {
Metadata gotMetadata = fileContainer.get().getMetadata();
Map<String,Object> gotMap = gotMetadata.getMap();
MetadataMatcher catalogueMetadata = new GcatMetadataMatcher(ITEM_ID);
Metadata expectedMetadata = catalogueMetadata.getMetadata();
Map<String,Object> expectedMap = expectedMetadata.getMap();
for(String key : gotMap.keySet()) {
String value = (String) gotMap.get(key);
String expectedValue = (String) expectedMap.get(key);
Assert.assertTrue(value.compareTo(expectedValue) == 0);
}
}
@Test
public void testPersistence() throws Exception {
URL persistedURL = catalogueStorageHubManagement.ensureResourcePersistence(ORIGINAL_STORAGE_URL, ITEM_ID,
RESOURCE_ID);
logger.debug("Publick Link of persisted file is {}", persistedURL);
Assert.assertTrue(catalogueStorageHubManagement.getMimeType().compareTo(MIME_TYPE) == 0);
FileContainer createdFileContainer = storageHubManagement.getPersistedFile();
// String version = "2";
// catalogueStorageHubManagement.renameFile(RESOURCE_ID, version);
catalogueStorageHubManagement.renameFile(RESOURCE_ID);
checkMetadata(createdFileContainer);
// version = "3";
// catalogueStorageHubManagement.addRevisionID(RESOURCE_ID, version);
// checkMetadata(createdFileContainer);
catalogueStorageHubManagement.deleteResourcePersistence(ITEM_ID, RESOURCE_ID, MIME_TYPE);
}
}

View File

@ -7,7 +7,6 @@
<xs:element name="metadatafield" minOccurs="0" maxOccurs="unbounded">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="fieldId" minOccurs="0"/>
<xs:element type="xs:string" name="fieldName" />
<xs:element type="xs:boolean" name="mandatory"
minOccurs="0" maxOccurs="1" />
@ -22,7 +21,6 @@
<xs:enumeration value="Boolean" />
<xs:enumeration value="Number" />
<xs:enumeration value="GeoJSON" />
<xs:enumeration value="File" />
</xs:restriction>
</xs:simpleType>
</xs:element>
@ -32,22 +30,24 @@
minOccurs="0" maxOccurs="1" />
<xs:element type="xs:string" name="note" minOccurs="0"
maxOccurs="1" />
<xs:element name="vocabulary" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="vocabularyField"
minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
<xs:attribute type="xs:boolean" name="isMultiSelection" />
</xs:complexType>
</xs:element>
<xs:element name="validator" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="regularExpression" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:choice>
<xs:element name="vocabulary" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="vocabularyField"
minOccurs="1" maxOccurs="unbounded" />
</xs:sequence>
<xs:attribute type="xs:boolean" name="isMultiSelection" />
</xs:complexType>
</xs:element>
<xs:element name="validator" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="regularExpression" />
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
<xs:element name="tagging" type="TaggingType"
minOccurs="0" maxOccurs="1">
</xs:element>
@ -92,4 +92,4 @@
<xs:minLength value="1" />
</xs:restriction>
</xs:simpleType>
</xs:schema>
</xs:schema>

View File

@ -128,14 +128,16 @@
<xs:element type="xs:string" name="defaultValue" minOccurs="0"
maxOccurs="1"/>
<xs:element type="xs:string" name="note" minOccurs="0" maxOccurs="1"/>
<xs:element type="VocabularyType" name="vocabulary" minOccurs="0" maxOccurs="1" />
<xs:element name="validator" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="regularExpression"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:choice>
<xs:element type="VocabularyType" name="vocabulary" minOccurs="0" maxOccurs="1" />
<xs:element name="validator" minOccurs="0" maxOccurs="1">
<xs:complexType>
<xs:sequence>
<xs:element type="xs:string" name="regularExpression"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
<xs:choice>
<xs:element name="tags" minOccurs="0" maxOccurs="1">
<xs:complexType>

View File

@ -0,0 +1 @@
^([a-zA-ZÀ-ÿ .-]+),\s*([a-zA-ZÀ-ÿ .-]+)(?:,\s*([a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}))?(?:,\s*(orcid.org/\d{4}-\d{4}-\d{4}-\d{3}[0-9X]))?$