updated

solved Incident #22230

.classpath

@@ -9,6 +9,7 @@
 	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="optional" value="true"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
@@ -22,12 +23,12 @@
 		<attributes>
 			<attribute name="test" value="true"/>
 			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="optional" value="true"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>
-			<attribute name="org.eclipse.jst.component.dependency" value="/WEB-INF/lib"/>
 		</attributes>
 	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8">

.gitignore

@@ -1 +1,2 @@
 target
+/.externalToolBuilders/

.settings/org.eclipse.wst.common.component

@@ -18,6 +18,7 @@
     
     
     
+    
     
     
     
@@ -43,6 +44,7 @@
         
         
         
+        
         
         
         
@@ -67,6 +69,7 @@
         
         
         
+        
         
         
         
@@ -91,6 +94,7 @@
         
         
         
+        
         
         
         
@@ -115,16 +119,12 @@
         
         
         
+        
         
         
         
         <wb-resource deploy-path="/WEB-INF/classes" source-path="/src/main/resources"/>
-        <dependent-module archiveName="storagehub-model-1.1.0-SNAPSHOT.jar" deploy-path="/WEB-INF/lib" handle="module:/resource/storagehub-model/storagehub-model">
-            <dependency-type>uses</dependency-type>
-        </dependent-module>
-        <dependent-module archiveName="storagehub-script-utils-1.0.0.jar" deploy-path="/WEB-INF/lib" handle="module:/resource/storagehub-scripting-util/storagehub-scripting-util">
-            <dependency-type>uses</dependency-type>
-        </dependent-module>
+                                                                                                                                                                                                        
         
         
         
@@ -169,6 +169,7 @@
         
         
         
+        
         
         
         
@@ -192,6 +193,7 @@
     
     
     
+    
     
     
     
@@ -216,6 +218,7 @@
 
 
 
+
 
 
 

CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v1.4.2] - [2023-05-22]
+
+- added enunciate libraries for documentation
+
+## [v1.4.1] - [2022-11-14]
+
+- added libraries to manage different image format
+
 ## [v1.4.0] - [2021-10-07]
 
 - slow query removed from VRE retrieving and recents

distro/gcube-app.xml

@@ -1,7 +1,8 @@
 <application mode='online'>
 		<name>StorageHub</name>
 		<group>DataAccess</group>
-		<version>${version}</version>
+		<version>1.4.2</version>
 		<description>Storage Hub webapp</description>
 		<local-persistence location='target' />
+		<exclude>/workspace/api-docs/*</exclude>
 </application>

enunciate.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<enunciate
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+	xsi:noNamespaceSchemaLocation="http://enunciate.webcohesion.com/schemas/enunciate-2.14.0.xsd">
+	<api-classes>
+		<!-- Use patterns to exclude classes... e.g. for URI-Resolver <exclude 
+			pattern="org.gcube.datatransfer.resolver.services.DocsGenerator" /> -->
+	</api-classes>
+	<modules>
+		<gwt-json-overlay disabled="true" />
+		<php-json-client disabled="true" />
+		<ruby-json-client disabled="true" />
+		<java-json-client disabled="true" />
+		<javascript-client disabled="true" />
+		<docs docsDir="${project.build.directory}" docsSubdir="api-docs" />
+		
+		<docs
+			freemarkerTemplate="${project.basedir}/src/main/resources/META-INF/enunciate/d4science_docs.fmt">
+			<additional-css
+				file="css/d4science_enunciate_custom.css" />
+		</docs>
+		<swagger basePath="/workspace" />
+	</modules>
+</enunciate>

pom.xml

@@ -1,29 +1,23 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0"
 	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-
 	<parent>
 		<artifactId>maven-parent</artifactId>
 		<groupId>org.gcube.tools</groupId>
 		<version>1.1.0</version>
 		<relativePath />
 	</parent>
-
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.gcube.data.access</groupId>
 	<artifactId>storagehub</artifactId>
-	<version>1.4.0</version>
+	<version>1.4.2</version>
 	<name>storagehub</name>
-
 	<scm>
 		<connection>scm:git:https://code-repo.d4science.org/gCubeSystem/storagehub.git</connection>
 		<developerConnection>scm:git:https://code-repo.d4science.org/gCubeSystem/storagehub.git</developerConnection>
 		<url>https://code-repo.d4science.org/gCubeSystem/storagehub</url>
 	</scm>
-
-
 	<packaging>war</packaging>
-
 	<properties>
 		<webappDirectory>${project.basedir}/src/main/webapp/WEB-INF</webappDirectory>
 		<jackrabbit.version>2.20.2</jackrabbit.version>
@@ -32,21 +26,19 @@
 		<tomcat.version>7.0.40</tomcat.version>
 		<jetty.version>6.1.26</jetty.version>
 		<tika.version>1.21</tika.version>
-
 		<distroDirectory>${project.basedir}/distro</distroDirectory>
 		<description>REST web service for Jackrabbit</description>
 		<warname>storagehub</warname>
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-
+		<enunciate.version>2.14.0</enunciate.version>
 	</properties>
-
 	<dependencyManagement>
 		<dependencies>
 			<dependency>
 				<groupId>org.gcube.distribution</groupId>
 				<artifactId>gcube-smartgears-bom</artifactId>
-				<version>2.0.0</version>
+				<version>2.1.1</version>
 				<type>pom</type>
 				<scope>import</scope>
 			</dependency>
@@ -57,87 +49,85 @@
 			</dependency>
 		</dependencies>
 	</dependencyManagement>
-
 	<dependencies>
-
 		<dependency>
 			<groupId>org.aspectj</groupId>
 			<artifactId>aspectjrt</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.core</groupId>
 			<artifactId>common-smartgears</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.core</groupId>
 			<artifactId>common-smartgears-app</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.common</groupId>
 			<artifactId>authorization-control-library</artifactId>
 			<version>[1.0.0,2.0.0-SNAPSHOT)</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.common</groupId>
 			<artifactId>common-authorization</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.core</groupId>
 			<artifactId>common-encryption</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.core</groupId>
 			<artifactId>common-scope-maps</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.core</groupId>
 			<artifactId>common-scope</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.common</groupId>
 			<artifactId>storagehub-model</artifactId>
-			<version>[1.0.0,2.0.0-SNAPSHOT)</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.data.access</groupId>
 			<artifactId>storagehub-script-utils</artifactId>
-			<version>[1.0.0-SNAPSHOT,2.0.0)</version>
+			<version>[1.0.0, 2.0.0-SNAPSHOT)</version>
 		</dependency>
-
 		<dependency>
 			<groupId>com.itextpdf</groupId>
 			<artifactId>itextpdf</artifactId>
 			<version>5.5.13.2</version>
 		</dependency>
-
+		<!-- needed to manage strange image types -->
+		<dependency>
+			<groupId>com.twelvemonkeys.imageio</groupId>
+			<artifactId>imageio-jpeg</artifactId>
+			<version>3.3.2</version>
+		</dependency>
+		<dependency>
+			<groupId>com.twelvemonkeys.imageio</groupId>
+			<artifactId>imageio-bmp</artifactId>
+			<version>3.3.2</version>
+		</dependency>
+		<dependency>
+			<groupId>com.twelvemonkeys.imageio</groupId>
+			<artifactId>imageio-core</artifactId>
+			<version>3.3.2</version>
+		</dependency>
 		<!-- https://mvnrepository.com/artifact/org.bouncycastle/bcprov-jdk15on -->
 		<dependency>
 			<groupId>org.bouncycastle</groupId>
 			<artifactId>bcprov-jdk15on</artifactId>
 			<version>1.62</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.common</groupId>
 			<artifactId>gxJRS</artifactId>
 		</dependency>
-
 		<!-- JCR dependencies -->
-
 		<dependency>
 			<groupId>javax.jcr</groupId>
 			<artifactId>jcr</artifactId>
@@ -158,74 +148,67 @@
 			<artifactId>jackrabbit-jcr-server</artifactId>
 			<version>${jackrabbit.version}</version>
 		</dependency>
-
 		<dependency>
 			<groupId>com.fasterxml.jackson.core</groupId>
 			<artifactId>jackson-annotations</artifactId>
 			<version>${jackson.version}</version>
 		</dependency>
-
 		<dependency>
 			<groupId>com.fasterxml.jackson.core</groupId>
 			<artifactId>jackson-core</artifactId>
 			<version>${jackson.version}</version>
 		</dependency>
-
 		<dependency>
 			<groupId>com.fasterxml.jackson.core</groupId>
 			<artifactId>jackson-databind</artifactId>
 			<version>${jackson.version}</version>
 		</dependency>
-
-
 		<!-- https://mvnrepository.com/artifact/org.apache.tika/tika-parsers -->
 		<dependency>
 			<groupId>org.apache.tika</groupId>
 			<artifactId>tika-parsers</artifactId>
 			<version>1.21</version>
 		</dependency>
-
 		<!-- https://mvnrepository.com/artifact/org.apache.tika/tika-core -->
 		<dependency>
 			<groupId>org.apache.tika</groupId>
 			<artifactId>tika-core</artifactId>
 			<version>1.21</version>
 		</dependency>
-
 		<!-- https://mvnrepository.com/artifact/net.bull.javamelody/javamelody-core -->
 		<dependency>
 			<groupId>net.bull.javamelody</groupId>
 			<artifactId>javamelody-core</artifactId>
 			<version>1.82.0</version>
 		</dependency>
-
-
+		<dependency>
+			<groupId>org.projectlombok</groupId>
+			<artifactId>lombok</artifactId>
+			<version>1.18.2</version>
+			<scope>provided</scope>
+		</dependency>
 		<!-- jersey & weld -->
 		<dependency>
 			<groupId>javax.servlet</groupId>
 			<artifactId>javax.servlet-api</artifactId>
 			<version>3.0.1</version>
 		</dependency>
-
 		<!-- https://mvnrepository.com/artifact/javax.interceptor/javax.interceptor-api -->
 		<dependency>
 			<groupId>javax.interceptor</groupId>
 			<artifactId>javax.interceptor-api</artifactId>
 			<version>1.2.2</version>
 		</dependency>
-
 		<!-- https://mvnrepository.com/artifact/javax.enterprise/cdi-api -->
 		<dependency>
 			<groupId>javax.enterprise</groupId>
 			<artifactId>cdi-api</artifactId>
 			<version>2.0</version>
 		</dependency>
-
 		<dependency>
 			<groupId>javax.ws.rs</groupId>
 			<artifactId>javax.ws.rs-api</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.glassfish.jersey.containers</groupId>
 			<artifactId>jersey-container-servlet</artifactId>
@@ -234,14 +217,12 @@
 			<groupId>org.glassfish.jersey.containers</groupId>
 			<artifactId>jersey-container-servlet-core</artifactId>
 		</dependency>
-
 		<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.inject/jersey-hk2 -->
 		<dependency>
 			<groupId>org.glassfish.jersey.inject</groupId>
 			<artifactId>jersey-hk2</artifactId>
 			<version>2.30.1</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.glassfish.jersey.core</groupId>
 			<artifactId>jersey-server</artifactId>
@@ -259,87 +240,67 @@
 			<artifactId>weld-servlet-core</artifactId>
 			<version>3.1.0.Final</version>
 		</dependency>
-
 		<!-- https://mvnrepository.com/artifact/org.jboss/jandex -->
 		<dependency>
 			<groupId>org.jboss</groupId>
 			<artifactId>jandex</artifactId>
 			<version>2.2.2.Final</version>
 		</dependency>
-
-		<dependency>
-			<groupId>javax.servlet</groupId>
-			<artifactId>javax.servlet-api</artifactId>
-			<version>3.0.1</version>
-		</dependency>
-
 		<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.core/jersey-common -->
 		<dependency>
 			<groupId>org.glassfish.jersey.core</groupId>
 			<artifactId>jersey-common</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.glassfish.jersey.media</groupId>
 			<artifactId>jersey-media-json-jackson</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>org.glassfish.jersey.media</groupId>
 			<artifactId>jersey-media-multipart</artifactId>
 		</dependency>
-
 		<dependency>
 			<groupId>postgresql</groupId>
 			<artifactId>postgresql</artifactId>
 			<version>9.1-901.jdbc4</version>
 			<scope>runtime</scope>
 		</dependency>
-
 		<!-- Storage dependencies -->
 		<dependency>
 			<groupId>org.gcube.contentmanagement</groupId>
 			<artifactId>storage-manager-core</artifactId>
 			<version>[3.0.0-SNAPSHOT,4.0.0-SNAPSHOT)</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.gcube.contentmanagement</groupId>
 			<artifactId>storage-manager-wrapper</artifactId>
 			<version>[3.0.0-SNAPSHOT,4.0.0-SNAPSHOT)</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.reflections</groupId>
 			<artifactId>reflections</artifactId>
 			<version>0.9.10</version>
 		</dependency>
-
 		<dependency>
 			<groupId>com.google.guava</groupId>
 			<artifactId>guava</artifactId>
 			<version>16.0</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.apache.commons</groupId>
 			<artifactId>commons-compress</artifactId>
 			<version>1.17</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.tukaani</groupId>
 			<artifactId>xz</artifactId>
 			<version>1.5</version>
 		</dependency>
-
-
 		<dependency>
 			<groupId>org.glassfish.jersey.test-framework.providers</groupId>
 			<artifactId>jersey-test-framework-provider-simple</artifactId>
 			<scope>test</scope>
 		</dependency>
-
 		<dependency>
 			<groupId>org.apache.derby</groupId>
 			<artifactId>derby</artifactId>
@@ -352,7 +313,6 @@
 			<version>10.8.2.2</version>
 			<scope>test</scope>
 		</dependency>
-
 		<dependency>
 			<groupId>com.googlecode.jeeunit</groupId>
 			<artifactId>jeeunit</artifactId>
@@ -365,20 +325,29 @@
 			<artifactId>gson</artifactId>
 			<version>2.7</version>
 		</dependency>
-
 		<dependency>
 			<groupId>ch.qos.logback</groupId>
 			<artifactId>logback-classic</artifactId>
 			<scope>test</scope>
 		</dependency>
-
 		<dependency>
 			<groupId>com.vlkan.rfos</groupId>
 			<artifactId>rotating-fos</artifactId>
 			<version>0.9.2</version>
 		</dependency>
-
-
+		<!-- enunciate deps -->
+		<dependency>
+			<groupId>com.webcohesion.enunciate</groupId>
+			<artifactId>enunciate-core-annotations</artifactId>
+			<version>${enunciate.version}</version>
+			<scope>provided</scope>
+		</dependency>
+		<dependency>
+			<groupId>com.webcohesion.enunciate</groupId>
+			<artifactId>enunciate-rt-util</artifactId>
+			<version>${enunciate.version}</version>
+			<scope>provided</scope>
+		</dependency>
 		<!-- https://mvnrepository.com/artifact/org.mockito/mockito-all -->
 		<dependency>
 			<groupId>org.mockito</groupId>
@@ -386,14 +355,11 @@
 			<version>1.9.5</version>
 			<scope>test</scope>
 		</dependency>
-
-
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>jul-to-slf4j</artifactId>
 			<version>${slf4j.version}</version>
 		</dependency>
-
 		<dependency>
 			<groupId>org.jboss.weld.se</groupId>
 			<artifactId>weld-se</artifactId>
@@ -406,19 +372,16 @@
 			<version>4.11</version>
 			<scope>test</scope>
 		</dependency>
-
 		<dependency>
 			<groupId>org.glassfish.jersey.test-framework</groupId>
 			<artifactId>jersey-test-framework-core</artifactId>
 			<scope>test</scope>
 		</dependency>
-
 		<dependency>
 			<groupId>org.glassfish.jersey.test-framework.providers</groupId>
 			<artifactId>jersey-test-framework-provider-grizzly2</artifactId>
 			<scope>test</scope>
 		</dependency>
-
 	</dependencies>
 	<build>
 		<finalName>${project.artifactId}</finalName>
@@ -452,7 +415,7 @@
 				<plugin>
 					<groupId>org.codehaus.mojo</groupId>
 					<artifactId>aspectj-maven-plugin</artifactId>
-					<version>1.7</version>
+					<version>1.14.0</version>
 					<configuration>
 						<complianceLevel>1.8</complianceLevel>
 						<source>1.8</source>
@@ -509,7 +472,46 @@
 					</execution>
 				</executions>
 			</plugin>
+			<!-- Enunciate Maven plugin -->
+			<plugin>
+				<groupId>com.webcohesion.enunciate</groupId>
+				<artifactId>enunciate-maven-plugin</artifactId>
+				<version>${enunciate.version}</version>
+				<configuration></configuration>
+				<executions>
+					<execution>
+						<id>assemble</id>
+						<goals>
+							<goal>assemble</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			<!-- Copy Enunciate Documentation from your-application/docs to your-application.war -->
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-resources-plugin</artifactId>
+				<version>2.5</version>
+				<executions>
+					<execution>
+						<id>copy-enunciate-docs</id>
+						<phase>process-resources</phase>
+						<goals>
+							<goal>copy-resources</goal>
+						</goals>
+						<configuration>
+							<outputDirectory>target</outputDirectory>
+							<resources>
+								<resource>
+									<targetPath>${project.build.directory}/${project.artifactId}/api-docs</targetPath>
+									<directory>${project.build.directory}/api-docs</directory>
+									<filtering>true</filtering>
+								</resource>
+							</resources>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
-
 </project>

src/main/java/org/gcube/data/access/storagehub/StorageHub.java

@@ -8,6 +8,7 @@ import javax.ws.rs.core.Application;
 
 import org.gcube.common.gxrest.response.entity.SerializableErrorEntityTextWriter;
 import org.gcube.data.access.storagehub.services.ACLManager;
+import org.gcube.data.access.storagehub.services.DocManager;
 import org.gcube.data.access.storagehub.services.GroupManager;
 import org.gcube.data.access.storagehub.services.Impersonable;
 import org.gcube.data.access.storagehub.services.ItemSharing;
@@ -39,6 +40,7 @@ public class StorageHub extends Application {
         classes.add(MultiPartFeature.class);
         classes.add(SerializableErrorEntityTextWriter.class);
         classes.add(MyApplicationListener.class);
+        classes.add(DocManager.class);
         return classes;
     }
 

src/main/java/org/gcube/data/access/storagehub/services/ACLManager.java

@@ -47,8 +47,14 @@ import org.glassfish.jersey.media.multipart.FormDataParam;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
+
 @Path("items")
 @ManagedBy(StorageHubAppllicationManager.class)
+@RequestHeaders({
+	  @RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
+	})
 public class ACLManager extends Impersonable {
 
 	private static final Logger log = LoggerFactory.getLogger(ACLManager.class);

src/main/java/org/gcube/data/access/storagehub/services/DocManager.java

@@ -0,0 +1,47 @@
+package org.gcube.data.access.storagehub.services;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.InputStream;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.Context;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+@Path("api-docs")
+public class DocManager {
+
+    private static Logger logger = LoggerFactory.getLogger(DocManager.class);
+
+    @GET
+    @Path("/{any: .*}")
+    public InputStream toDoc(@Context HttpServletRequest req) throws WebApplicationException {
+        logger.info(DocManager.class.getSimpleName() + " toDoc called");
+
+        String pathInfo = req.getPathInfo();
+        logger.debug("pathInfo {}", pathInfo);
+        try {
+
+            if (pathInfo.endsWith("/api-docs")) {
+                pathInfo += "index.html";
+            }
+
+            if (pathInfo.endsWith("/api-docs/")) {
+                pathInfo += "index.html";
+            }
+
+            logger.info("going to {}", pathInfo);
+
+            String realPath = req.getServletContext().getRealPath(pathInfo);
+            return new FileInputStream(new File(realPath));
+
+        } catch (Exception e) {
+        	throw new WebApplicationException("error getting docs",e);
+        }
+    }
+}

src/main/java/org/gcube/data/access/storagehub/services/GroupManager.java

@@ -73,8 +73,14 @@ import org.glassfish.jersey.media.multipart.FormDataParam;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
+
 @Path("groups")
 @ManagedBy(StorageHubAppllicationManager.class)
+@RequestHeaders({
+	  @RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
+	})
 public class GroupManager {
 
 	

src/main/java/org/gcube/data/access/storagehub/services/ItemSharing.java

@@ -55,9 +55,15 @@ import org.glassfish.jersey.media.multipart.FormDataParam;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
+
 
 
 @Path("items")
+@RequestHeaders({
+	  @RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
+	})
 public class ItemSharing extends Impersonable{
 
 	private static final Logger log = LoggerFactory.getLogger(ItemSharing.class);

src/main/java/org/gcube/data/access/storagehub/services/ItemsCreator.java

@@ -38,10 +38,14 @@ import org.glassfish.jersey.media.multipart.FormDataParam;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
 
 @Path("items")
 @ManagedBy(StorageHubAppllicationManager.class)
-public class ItemsCreator extends Impersonable{
+@RequestHeaders({
+		@RequestHeader(name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"), })
+public class ItemsCreator extends Impersonable {
 
 	private static final Logger log = LoggerFactory.getLogger(ItemsCreator.class);
 
@@ -62,21 +66,22 @@ public class ItemsCreator extends Impersonable{
 		log.info("create folder item called");
 		Session ses = null;
 		String toReturn = null;
-		try{
+		try {
 			ses = repository.getRepository().login(CredentialHandler.getAdminCredentials(context));
-			ItemsParameterBuilder<FolderCreationParameters> builder = FolderCreationParameters.builder().name(name).description(description).hidden(hidden).on(id).with(ses).author(currentUser);
+			ItemsParameterBuilder<FolderCreationParameters> builder = FolderCreationParameters.builder().name(name)
+					.description(description).hidden(hidden).on(id).with(ses).author(currentUser);
 			toReturn = itemHandler.create(builder.build());
-		}catch(StorageHubException she ){
+		} catch (StorageHubException she) {
 			log.error(she.getErrorMessage(), she);
 			GXOutboundErrorResponse.throwException(she, Response.Status.fromStatusCode(she.getStatus()));
-		}catch(RepositoryException re ){
+		} catch (RepositoryException re) {
 			log.error("jcr error creating item", re);
 			GXOutboundErrorResponse.throwException(new BackendGenericError("jcr error creating item", re));
-		}catch(Throwable e ){
+		} catch (Throwable e) {
 			log.error("unexpected error", e);
 			GXOutboundErrorResponse.throwException(new BackendGenericError(e));
-		}finally{
-			if (ses!=null)
+		} finally {
+			if (ses != null)
 				ses.logout();
 
 		}
@@ -88,29 +93,29 @@ public class ItemsCreator extends Impersonable{
 	@Path("/{id}/create/EXTERNALFOLDER")
 	public Response createExternalFolder(@PathParam("id") String id, @FormParam("name") String name,
 			@FormParam("description") String description, @FormParam("hidden") boolean hidden,
-			@FormParam("pluginName") String pluginName,
-			@FormParam("parameters") String pluginParameters) {
+			@FormParam("pluginName") String pluginName, @FormParam("parameters") String pluginParameters) {
 		InnerMethodName.instance.set("createItem(EXTERNALFOLDER)");
 		log.info("create folder item called");
 		Session ses = null;
 		String toReturn = null;
-		try{
-			//TODO
+		try {
+			// TODO
 			ses = repository.getRepository().login(CredentialHandler.getAdminCredentials(context));
 			ItemsParameterBuilder<FolderCreationParameters> builder = FolderCreationParameters.builder().name(name)
-					.description(description).onRepository(pluginName).withParameters(null).hidden(hidden).on(id).with(ses).author(currentUser);
+					.description(description).onRepository(pluginName).withParameters(null).hidden(hidden).on(id)
+					.with(ses).author(currentUser);
 			toReturn = itemHandler.create(builder.build());
-		}catch(StorageHubException she ){
+		} catch (StorageHubException she) {
 			log.error(she.getErrorMessage(), she);
 			GXOutboundErrorResponse.throwException(she, Response.Status.fromStatusCode(she.getStatus()));
-		}catch(RepositoryException re ){
+		} catch (RepositoryException re) {
 			log.error("jcr error creating item", re);
 			GXOutboundErrorResponse.throwException(new BackendGenericError("jcr error creating item", re));
-		}catch(Throwable e ){
+		} catch (Throwable e) {
 			log.error("unexpected error", e);
 			GXOutboundErrorResponse.throwException(new BackendGenericError(e));
-		}finally{
-			if (ses!=null)
+		} finally {
+			if (ses != null)
 				ses.logout();
 
 		}
@@ -120,35 +125,36 @@ public class ItemsCreator extends Impersonable{
 	@POST
 	@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
 	@Path("/{id}/create/URL")
-	public Response createURL(@PathParam("id") String id, @FormParam("name") String name, @FormParam("description") String description, @FormParam("value") URL value) {
+	public Response createURL(@PathParam("id") String id, @FormParam("name") String name,
+			@FormParam("description") String description, @FormParam("value") URL value) {
 		InnerMethodName.instance.set("createItem(URL)");
 		log.info("create url called");
 		Session ses = null;
 		String toReturn = null;
-		try{
+		try {
 			ses = repository.getRepository().login(CredentialHandler.getAdminCredentials(context));
 
-			ItemsParameterBuilder<URLCreationParameters> builder = URLCreationParameters.builder().name(name).description(description).url(value).on(id).with(ses).author(currentUser);
+			ItemsParameterBuilder<URLCreationParameters> builder = URLCreationParameters.builder().name(name)
+					.description(description).url(value).on(id).with(ses).author(currentUser);
 
 			toReturn = itemHandler.create(builder.build());
-		}catch(StorageHubException she ){
+		} catch (StorageHubException she) {
 			log.error(she.getErrorMessage(), she);
 			GXOutboundErrorResponse.throwException(she, Response.Status.fromStatusCode(she.getStatus()));
-		}catch(RepositoryException re ){
+		} catch (RepositoryException re) {
 			log.error("jcr error creating item", re);
 			GXOutboundErrorResponse.throwException(new BackendGenericError("jcr error creating item", re));
-		}catch(Throwable e ){
+		} catch (Throwable e) {
 			log.error("unexpected error", e);
 			GXOutboundErrorResponse.throwException(new BackendGenericError(e));
-		}finally{
-			if (ses!=null)
+		} finally {
+			if (ses != null)
 				ses.logout();
 
 		}
 		return Response.ok(toReturn).build();
 	}
 
-	
 	@POST
 	@Consumes(MediaType.APPLICATION_JSON)
 	@Path("/{id}/create/GCUBEITEM")
@@ -158,58 +164,58 @@ public class ItemsCreator extends Impersonable{
 		Session ses = null;
 		String toReturn = null;
 
-		try{
+		try {
 			ses = repository.getRepository().login(CredentialHandler.getAdminCredentials(context));
-			ItemsParameterBuilder<GCubeItemCreationParameters> builder = GCubeItemCreationParameters.builder().item(item).on(id).with(ses).author(currentUser);
+			ItemsParameterBuilder<GCubeItemCreationParameters> builder = GCubeItemCreationParameters.builder()
+					.item(item).on(id).with(ses).author(currentUser);
 
 			toReturn = itemHandler.create(builder.build());
-		}catch(StorageHubException she ){
+		} catch (StorageHubException she) {
 			log.error(she.getErrorMessage(), she);
 			GXOutboundErrorResponse.throwException(she, Response.Status.fromStatusCode(she.getStatus()));
-		}catch(RepositoryException re ){
+		} catch (RepositoryException re) {
 			log.error("jcr error creating item", re);
 			GXOutboundErrorResponse.throwException(new BackendGenericError("jcr error creating item", re));
-		}catch(Throwable e ){
+		} catch (Throwable e) {
 			log.error("unexpected error", e);
 			GXOutboundErrorResponse.throwException(new BackendGenericError(e));
-		}finally{
-			if (ses!=null)
+		} finally {
+			if (ses != null)
 				ses.logout();
 		}
 		return toReturn;
 	}
 
-
 	@POST
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Path("/{id}/create/FILE")
 	public String createFileItem(@PathParam("id") String id, @FormDataParam("name") String name,
-			@FormDataParam("description") String description,
-			@FormDataParam("file") InputStream stream,
-			@FormDataParam("file") FormDataContentDisposition fileDetail){
+			@FormDataParam("description") String description, @FormDataParam("file") InputStream stream,
+			@FormDataParam("file") FormDataContentDisposition fileDetail) {
 		InnerMethodName.instance.set("createItem(FILE)");
 
 		Session ses = null;
 		String toReturn = null;
-		try{
+		try {
 
 			ses = repository.getRepository().login(CredentialHandler.getAdminCredentials(context));
-			ItemsParameterBuilder<FileCreationParameters> builder = FileCreationParameters.builder().name(name).description(description).stream(stream).fileDetails(fileDetail)
-					.on(id).with(ses).author(currentUser);
+			ItemsParameterBuilder<FileCreationParameters> builder = FileCreationParameters.builder().name(name)
+					.description(description).stream(stream).fileDetails(fileDetail).on(id).with(ses)
+					.author(currentUser);
 
 			toReturn = itemHandler.create(builder.build());
 
-		}catch(RepositoryException re ){
+		} catch (RepositoryException re) {
 			log.error("jcr error creating file item", re);
 			GXOutboundErrorResponse.throwException(new BackendGenericError("jcr error creating file item", re));
-		}catch(StorageHubException she ){
+		} catch (StorageHubException she) {
 			log.error(she.getErrorMessage(), she);
 			GXOutboundErrorResponse.throwException(she, Response.Status.fromStatusCode(she.getStatus()));
-		}catch(Throwable e ){
+		} catch (Throwable e) {
 			log.error("unexpected error", e);
 			GXOutboundErrorResponse.throwException(new BackendGenericError(e));
-		}finally{
-			if (ses!=null && ses.isLive()) {
+		} finally {
+			if (ses != null && ses.isLive()) {
 				log.info("session closed");
 				ses.logout();
 			}
@@ -218,47 +224,39 @@ public class ItemsCreator extends Impersonable{
 
 	}
 
-	
-
-	
-
-
 	@POST
 	@Consumes(MediaType.MULTIPART_FORM_DATA)
 	@Path("/{id}/create/ARCHIVE")
 	public String uploadArchive(@PathParam("id") String id, @FormDataParam("parentFolderName") String parentFolderName,
-			@FormDataParam("file") InputStream stream,
-			@FormDataParam("file") FormDataContentDisposition fileDetail){
+			@FormDataParam("file") InputStream stream, @FormDataParam("file") FormDataContentDisposition fileDetail) {
 		InnerMethodName.instance.set("createItem(ARCHIVE)");
 
 		Session ses = null;
 		String toReturn = null;
-		try{
+		try {
 			ses = repository.getRepository().login(CredentialHandler.getAdminCredentials(context));
 
-			ItemsParameterBuilder<ArchiveStructureCreationParameter> builder = ArchiveStructureCreationParameter.builder().parentName(parentFolderName).stream(stream).fileDetails(fileDetail)
-					.on(id).with(ses).author(currentUser);
+			ItemsParameterBuilder<ArchiveStructureCreationParameter> builder = ArchiveStructureCreationParameter
+					.builder().parentName(parentFolderName).stream(stream).fileDetails(fileDetail).on(id).with(ses)
+					.author(currentUser);
 
 			toReturn = itemHandler.create(builder.build());
 
-		}catch(RepositoryException | ArchiveException | IOException re){
+		} catch (RepositoryException | ArchiveException | IOException re) {
 			log.error("jcr error extracting archive", re);
 			GXOutboundErrorResponse.throwException(new BackendGenericError("jcr error extracting archive", re));
-		}catch(StorageHubException she ){
+		} catch (StorageHubException she) {
 			log.error(she.getErrorMessage(), she);
 			GXOutboundErrorResponse.throwException(she, Response.Status.fromStatusCode(she.getStatus()));
-		}catch(Throwable e ){
+		} catch (Throwable e) {
 			log.error("unexpected error", e);
 			GXOutboundErrorResponse.throwException(new BackendGenericError(e));
-		} finally{
-			if (ses!=null)
+		} finally {
+			if (ses != null)
 				ses.logout();
 
 		}
 		return toReturn;
 	}
 
-
-	
-
 }

src/main/java/org/gcube/data/access/storagehub/services/ItemsManager.java

@@ -94,9 +94,15 @@ import org.gcube.smartgears.utils.InnerMethodName;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
+
 
 @Path("items")
 @ManagedBy(StorageHubAppllicationManager.class)
+@RequestHeaders({
+	  @RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
+	})
 public class ItemsManager extends Impersonable{
 
 	private static final Logger log = LoggerFactory.getLogger(ItemsManager.class);

src/main/java/org/gcube/data/access/storagehub/services/MessageManager.java

@@ -63,8 +63,14 @@ import org.gcube.smartgears.utils.InnerMethodName;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
+
 @Path("messages")
 @ManagedBy(StorageHubAppllicationManager.class)
+@RequestHeaders({
+	  @RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
+	})
 public class MessageManager extends Impersonable{
 
 	private static final Logger log = LoggerFactory.getLogger(MessageManager.class);
@@ -375,13 +381,13 @@ public class MessageManager extends Impersonable{
 	private Node checkRights(String user, Message messageItem) throws RepositoryException, StorageHubException{
 		Node personalNode = null;
 		Node messageNode = (Node) messageItem.getRelatedNode();
-		if (messageNode.getPath().startsWith(pathUtil.getWorkspacePath(currentUser).toPath()))
+		if (messageNode.getPath().startsWith(pathUtil.getInboxPath(user).toPath()))
 			return messageNode;
 
 		NodeIterator nodeIt = messageNode.getSharedSet();
 		while (nodeIt.hasNext()) {
 			Node node = nodeIt.nextNode();
-			if (node.getPath().startsWith(pathUtil.getWorkspacePath(currentUser).toPath()))
+			if (node.getPath().startsWith(pathUtil.getInboxPath(user).toPath()))
 				personalNode = node;
 		}
 		if (personalNode == null && 

src/main/java/org/gcube/data/access/storagehub/services/UserManager.java

@@ -58,8 +58,14 @@ import org.gcube.smartgears.utils.InnerMethodName;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
+
 @Path("users")
 @ManagedBy(StorageHubAppllicationManager.class)
+@RequestHeaders({
+	  @RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
+	})
 public class UserManager {
 
 	private static final String INFRASTRUCTURE_MANAGER_ROLE = "Infrastructure-Manager";

src/main/java/org/gcube/data/access/storagehub/services/WorkspaceManager.java

@@ -55,10 +55,16 @@ import org.gcube.smartgears.utils.InnerMethodName;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
+
 
 
 @Path("/")
 @ManagedBy(StorageHubAppllicationManager.class)
+@RequestHeaders({
+	  @RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
+	})
 public class WorkspaceManager extends Impersonable{
 
 	private static final Logger log = LoggerFactory.getLogger(WorkspaceManager.class);

src/main/java/org/gcube/data/access/storagehub/services/admin/ScriptManager.java

@@ -40,7 +40,13 @@ import org.glassfish.jersey.media.multipart.FormDataParam;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.webcohesion.enunciate.metadata.rs.RequestHeader;
+import com.webcohesion.enunciate.metadata.rs.RequestHeaders;
+
 @Path("admin/script")
+@RequestHeaders({
+	  @RequestHeader( name = "Authorization", description = "Bearer token, see https://dev.d4science.org/how-to-access-resources"),
+	})
 public class ScriptManager {
 
 

src/main/webapp/WEB-INF/LICENSE

@@ -18,7 +18,6 @@ European Union Public Licence V. 1.1
             or has expressed by any other mean his willingness to license under the EUPL.
 
 
-
             1. Definitions
 
             In this Licence, the following terms have the following meaning:
@@ -59,7 +58,6 @@ European Union Public Licence V. 1.1
             person.
 
 
-
             2. Scope of the rights granted by the Licence
 
             The Licensor hereby grants You a world-wide, royalty-free, non-exclusive,
@@ -85,7 +83,6 @@ European Union Public Licence V. 1.1
             rights granted on the Work under this Licence.
 
 
-
             3. Communication of the Source Code
 
             The Licensor may provide the Work either in its Source Code form, or as
@@ -97,7 +94,6 @@ European Union Public Licence V. 1.1
             continues to distribute and/or communicate the Work.
 
 
-
             4. Limitations on copyright
 
             Nothing in this Licence is intended to deprive the Licensee of the benefits from
@@ -106,7 +102,6 @@ European Union Public Licence V. 1.1
             applicable limitations thereto.
 
 
-
             5. Obligations of the Licensee
 
             The grant of the rights mentioned above is subject to some restrictions and
@@ -147,7 +142,6 @@ European Union Public Licence V. 1.1
             reproducing the content of the copyright notice.
 
 
-
             6. Chain of Authorship
 
             The original Licensor warrants that the copyright in the Original Work granted
@@ -163,7 +157,6 @@ European Union Public Licence V. 1.1
             terms of this Licence.
 
 
-
             7. Disclaimer of Warranty
 
             The Work is a work in progress, which is continuously improved by numerous
@@ -180,7 +173,6 @@ European Union Public Licence V. 1.1
             for the grant of any rights to the Work.
 
 
-
             8. Disclaimer of Liability
 
             Except in the cases of wilful misconduct or damages directly caused to natural
@@ -193,7 +185,6 @@ European Union Public Licence V. 1.1
             laws as far such laws apply to the Work.
 
 
-
             9. Additional agreements
 
             While distributing the Original Work or Derivative Works, You may choose to
@@ -207,7 +198,6 @@ European Union Public Licence V. 1.1
             any such warranty or additional liability.
 
 
-
             10. Acceptance of the Licence
 
             The provisions of this Licence can be accepted by clicking on an icon “I agree”
@@ -222,7 +212,6 @@ European Union Public Licence V. 1.1
             Distribution and/or Communication by You of the Work or copies thereof.
 
 
-
             11. Information to the public
 
             In case of any Distribution and/or Communication of the Work by means of
@@ -233,7 +222,6 @@ European Union Public Licence V. 1.1
             accessible, concluded, stored and reproduced by the Licensee.
 
 
-
             12. Termination of the Licence
 
             The Licence and the rights granted hereunder will terminate automatically upon
@@ -244,7 +232,6 @@ European Union Public Licence V. 1.1
             remain in full compliance with the Licence.
 
 
-
             13. Miscellaneous
 
             Without prejudice of Article 9 above, the Licence represents the complete
@@ -265,7 +252,6 @@ European Union Public Licence V. 1.1
             their choice.
 
 
-
             14. Jurisdiction
 
             Any litigation resulting from the interpretation of this License, arising
@@ -279,7 +265,6 @@ European Union Public Licence V. 1.1
             conducts its primary business.
 
 
-
             15. Applicable Law
 
             This Licence shall be governed by the law of the European Union country where
@@ -298,7 +283,6 @@ European Union Public Licence V. 1.1
             Appendix
 
 
-
             “Compatible Licences” according to article 5 EUPL are:
 
 

src/main/webapp/WEB-INF/README

@@ -25,7 +25,7 @@ The projects leading to this software have received funding from a series of
 Version
 --------------------------------------------------
  
-1.3.1 (20210910-085653)
+1.4.2 (20230524-150450)
  
 Please see the file named "changelog.xml" in this directory for the release notes.
  

src/main/webapp/WEB-INF/gcube-app.xml

@@ -1,7 +1,8 @@
 <application mode='online'>
 		<name>StorageHub</name>
 		<group>DataAccess</group>
-		<version>1.3.1</version>
+		<version>1.4.2</version>
 		<description>Storage Hub webapp</description>
 		<local-persistence location='target' />
+		<exclude>/workspace/api-docs/*</exclude>
 </application>

src/main/webapp/api-docs/css/d4science_enunciate_custom.css

@@ -0,0 +1,26 @@
+.d4science_intro {
+	top: 0;
+	z-index: 2000;
+	position: fixed;
+	display: block ruby;
+	padding: 10px;
+	background: white;
+	width: 100%;
+	height: 100px;
+}
+
+.navbar-fixed-top {
+	top: 100px !important;
+}
+
+.sidebar {
+	top: 160px !important;
+}
+
+.navbar {
+	margin-bottom: 40px !important;
+}
+
+.main {
+	top: 90px;
+}