Updated documentation

.classpath

@@ -19,7 +19,11 @@
 			<attribute name="maven.pomderived" value="true"/>
 		</attributes>
 	</classpathentry>
-	<classpathentry kind="src" path="src/main/resources"/>
+	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
 	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
 		<attributes>
 			<attribute name="maven.pomderived" value="true"/>

src/main/java/org/gcube/datatransfer/resolver/services/AnalyticsCreateResolver.java

@@ -57,7 +57,13 @@ import org.slf4j.LoggerFactory;
 import org.xml.sax.SAXException;
 
 /**
- * The Class AnalyticsCreateResolver.
+ * The AnalyticsCreateResolver provides a method to get the Analytics URLs (that
+ * are simply URLs) by which is possible to invoke through the DataMiner
+ * Executor the run of an algorithm stored in a certain VRE. By the DataMiner
+ * Executor then the user is able to monitoring the algorithm execution.
+ * 
+ * See more at
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#Analytics_Resolver
  * 
  * @author Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it)
  *         Dec 12, 2018
@@ -80,6 +86,11 @@ public class AnalyticsCreateResolver {
 	/**
 	 * Creates the analytics url.
 	 * 
+	 * Request format: [URI_RESOLVER_SERVICE_ENDPOINT]/analytics/create
+	 * 
+	 * See more at
+	 * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#HTTP_POST:_Create_an_Analytics_URL
+	 * 
 	 * @param req  the req
 	 * @param body the body
 	 * @return the response

src/main/java/org/gcube/datatransfer/resolver/services/AnalyticsGetResolver.java

@@ -24,7 +24,13 @@ import org.slf4j.LoggerFactory;
 import com.google.common.cache.CacheLoader.InvalidCacheLoadException;
 
 /**
- * The Class AnalyticsGetResolver.
+ * The AnalyticsGetResolver to resolve an Analytics URL
+ * 
+ * Request format
+ * [URI_RESOLVER_SERVICE_ENDPOINT]/analytics/get/[VRE_NAME]?dim=[PUBLIC_URL_TO_DATAMIER_INVOCATION_FILE_GENERATED_BY_POST_REQUEST]
+ * 
+ * See more at
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#Analytics_Resolver
  *
  * @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
  * 
@@ -46,6 +52,9 @@ public class AnalyticsGetResolver {
 	/**
 	 * Resolve analytics url.
 	 *
+	 * See more at
+	 * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#HTTP_GET:_Resolve_an_Analytics_URL
+	 * 
 	 * @param req     the req
 	 * @param vreName the vre name
 	 * @return the response

src/main/java/org/gcube/datatransfer/resolver/services/CatalogueResolver.java

@@ -44,7 +44,13 @@ import com.google.common.cache.CacheLoader.InvalidCacheLoadException;
 import eu.trentorise.opendata.jackan.model.CkanDataset;
 
 /**
- * The Class CatalogueResolver.
+ * The CatalogueResolver is able to get/resolve a link to a "Catalogue Entity"
+ * stored in one of the gCube Data Catalogue's instances. A Catalogue Entity is
+ * either a "group" or an "organization" or a "product" of D4Science Data
+ * Catalogue.
+ *
+ * See more at
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#CATALOGUE_Resolver
  * 
  * @author Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it)
  *         Nov 16, 2018
@@ -67,7 +73,10 @@ public class CatalogueResolver {
 	}
 
 	/**
-	 * Resolve catalogue.
+	 * Resolve an entity of the Catalogue
+	 * 
+	 * Request format:
+	 * [URI_RESOLVER_SERVICE_ENDPOINT]/[ctlg|ctlg-d|ctlg-o|ctlg-g]/[VRE_NAME]/[entity_name]
 	 *
 	 * @param req           the req
 	 * @param entityName    the entity name
@@ -126,7 +135,8 @@ public class CatalogueResolver {
 	}
 
 	/**
-	 * Post catalogue.
+	 * Create a Catalogue Link
+	 * 
 	 *
 	 * @param req         the req
 	 * @param jsonRequest the json request

src/main/java/org/gcube/datatransfer/resolver/services/GeonetworkResolver.java

@@ -48,7 +48,14 @@ import org.slf4j.LoggerFactory;
 import org.w3c.dom.Document;
 
 /**
- * The Class GeonetworkResolver.
+ * The GeonetworkResolver is a "middle tier" (like a Proxy) to perform queries
+ * on D4Science Geonetwork services.
+ * 
+ * Request format
+ * http[s]://[GEONETWORK_RESOLVER_BASE_URL]/[SCOPE]/[MODE]/[VISIBILITY]/[FILTER_KEY]/[FILTER_VALUE]/$$
+ * 
+ * See more at
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#Geonetwork_Resolver
  *
  * @author Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it)
  *         Oct 23, 2018
@@ -60,7 +67,8 @@ public class GeonetworkResolver {
 	 *
 	 */
 	public static final String REPLACED_A_PUBLIC_UUID_PLEASE_IGNORE = "Replaced a public UUID, please ignore";
-	public static final String REPLACED_UUID_BY_FILTER_PLEASE_IGNORE = "Replaced UUID by "+GeonetworkResolver.class.getSimpleName()+" filters, please ignore";
+	public static final String REPLACED_UUID_BY_FILTER_PLEASE_IGNORE = "Replaced UUID by "
+			+ GeonetworkResolver.class.getSimpleName() + " filters, please ignore";
 
 	private static Logger logger = LoggerFactory.getLogger(GeonetworkResolver.class);
 
@@ -89,13 +97,10 @@ public class GeonetworkResolver {
 	private String helpURI = "https://wiki.gcube-system.org/gcube/GCube_Resource_Catalogue#Geonetwork_Resolver";
 
 	/**
-	 * Gets the geonetwork request criteria.
+	 * Gets the geonetwork request criteria. Creates a request criteria from input
-	 * Creates a request criteria from input parameter pathWithoutGN
+	 * parameter pathWithoutGN The parameter pathWithoutGN should be an ordered
-	 * The parameter pathWithoutGN should be an ordered string (like REST request):
+	 * string (like REST request): SCOPE/MODE/VISIBILITY/OWNER/$$ SCOPE must be:
-	 * SCOPE/MODE/VISIBILITY/OWNER/$$
+	 * ROOT|VO|VRE MODE must be: {@link MODE} VISIBILITY must be: {@link VISIBILITY}
-	 * SCOPE must be: ROOT|VO|VRE
-	 * MODE must be: {@link MODE}
-	 * VISIBILITY must be: {@link VISIBILITY}
 	 * OWNER (is optional): filter by owner
 	 *
 	 * @param req         the req
@@ -112,31 +117,35 @@ public class GeonetworkResolver {
 	 */
 
 	@GET
-	@Path("/{"+PATH_PARAM_SCOPE+"}/{"+PATH_PARAM_MODE+"}/{"+PATH_PARAM_VISIBILITY+"}/{filterKey}/{filterValue}/$${"+PATH_PARAM_REMAINPATH+":(/[^?$]+)?}")
+	@Path("/{" + PATH_PARAM_SCOPE + "}/{" + PATH_PARAM_MODE + "}/{" + PATH_PARAM_VISIBILITY
-	public Response submitGet(@Context HttpServletRequest req,
+			+ "}/{filterKey}/{filterValue}/$${" + PATH_PARAM_REMAINPATH + ":(/[^?$]+)?}")
-		@PathParam(PATH_PARAM_SCOPE) @Nullable String scope,
+	public Response submitGet(@Context HttpServletRequest req, @PathParam(PATH_PARAM_SCOPE) @Nullable String scope,
 			@PathParam(PATH_PARAM_MODE) @Nullable String mode,
 			@PathParam(PATH_PARAM_VISIBILITY) @Nullable String visibility,
-		@PathParam("filterKey") @Nullable String filterKey,
+			@PathParam("filterKey") @Nullable String filterKey, @PathParam("filterValue") @Nullable String filterValue,
-		@PathParam("filterValue") @Nullable String filterValue,
 			@PathParam(PATH_PARAM_REMAINPATH) @Nullable String remainPath,
 			@QueryParam(QUERY_PARAM_RESET_CACHE_PARAM) @Nullable String resetCache,
-		@QueryParam(QUERY_PARAM_RESET_CACHED_SCOPE_PARAM) @Nullable String resetScope) throws WebApplicationException{
+			@QueryParam(QUERY_PARAM_RESET_CACHED_SCOPE_PARAM) @Nullable String resetScope)
+			throws WebApplicationException {
 
 		logger.info(this.getClass().getSimpleName() + " GET starts...");
 		String gnGetlURL = null;
 
 		try {
-			logger.info("Params are [mode: "+mode+", scope: "+scope+", visibility: "+visibility+", filterKey: "+filterKey+", filterValue: "+filterValue+", remainPath: "+remainPath+"]");
+			logger.info(
+					"Params are [mode: " + mode + ", scope: " + scope + ", visibility: " + visibility + ", filterKey: "
+							+ filterKey + ", filterValue: " + filterValue + ", remainPath: " + remainPath + "]");
 
 			if (scope == null || scope.isEmpty()) {
 				logger.error("Path Parameter 'scope' not found");
-				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'scope'", this.getClass(), helpURI);
+				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'scope'",
+						this.getClass(), helpURI);
 			}
 
 			if (mode == null || mode.isEmpty()) {
 				logger.error("Path Parameter 'scope' not found");
-				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'mode'", this.getClass(), helpURI);
+				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'mode'",
+						this.getClass(), helpURI);
 			}
 
 			scope = ScopeUtil.normalizeScope(scope, "|");
@@ -145,13 +154,16 @@ public class GeonetworkResolver {
 				MODE.valueOf(mode);
 			} catch (Exception e) {
 				List<MODE> toPrint = Arrays.asList(MODE.values());
-				logger.error("The 'mode' parameter is wrong, Have you pass a valid parameter MODE like "+toPrint+"?");
+				logger.error(
-				throw ExceptionManager.wrongParameterException(req, "The 'mode' parameter must be value of "+toPrint, this.getClass(), helpURI);
+						"The 'mode' parameter is wrong, Have you pass a valid parameter MODE like " + toPrint + "?");
+				throw ExceptionManager.wrongParameterException(req, "The 'mode' parameter must be value of " + toPrint,
+						this.getClass(), helpURI);
 			}
 
 			if (visibility == null) {
 				logger.error("Path Parameter 'visibility' not found");
-				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'visibility'", this.getClass(), helpURI);
+				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'visibility'",
+						this.getClass(), helpURI);
 			}
 
 			visibility = visibility.toUpperCase();
@@ -159,17 +171,21 @@ public class GeonetworkResolver {
 				VISIBILITY.valueOf(visibility);
 			} catch (Exception e) {
 				List<VISIBILITY> toPrint = Arrays.asList(VISIBILITY.values());
-				logger.error("The 'visibility' parameter is wrong, Have you pass a valid parameter VISIBILITY like "+toPrint+"?");
+				logger.error("The 'visibility' parameter is wrong, Have you pass a valid parameter VISIBILITY like "
-				throw ExceptionManager.wrongParameterException(req, "The 'visibility' parameter must be value of "+toPrint, this.getClass(), helpURI);
+						+ toPrint + "?");
+				throw ExceptionManager.wrongParameterException(req,
+						"The 'visibility' parameter must be value of " + toPrint, this.getClass(), helpURI);
 			}
 
 			logger.info("Remaining path is: " + remainPath);
 
-			
 			try {
 
-				//I'M LOADING GN CONFIGURATIONS (ENDPOINT, USER, PWD AND SO ON..) FOR PASSED SCOPE FROM GN LIBRARY BY A GENERAL METHOD WITHOUT TO PERFORM AUTHENTICATION ON GN,
+				// I'M LOADING GN CONFIGURATIONS (ENDPOINT, USER, PWD AND SO ON..) FOR PASSED
-				//AFTER THAT I'M USING THEM TO PERFORM AUTHENTICATION ON GN VIA HTTP_CLIENTS IF NEEDED
+				// SCOPE FROM GN LIBRARY BY A GENERAL METHOD WITHOUT TO PERFORM AUTHENTICATION
+				// ON GN,
+				// AFTER THAT I'M USING THEM TO PERFORM AUTHENTICATION ON GN VIA HTTP_CLIENTS IF
+				// NEEDED
 				GeonetworkInstance gnInstance = getGeonetworkInstanceForScope(scope);
 				logger.info("set scope provider " + scope);
 				ScopeProvider.instance.set(scope);
@@ -186,7 +202,8 @@ public class GeonetworkResolver {
 					geonetworkUrl = config.getGeoNetworkEndpoint();
 				}
 
-				logger.info("SCOPE: {}, CKAN user used is: {}, GN EndPoint: {}",scope, account.getUser(), geonetworkUrl);
+				logger.info("SCOPE: {}, CKAN user used is: {}, GN EndPoint: {}", scope, account.getUser(),
+						geonetworkUrl);
 
 				HTTPCallsUtils httpUtils = new HTTPCallsUtils();
 
@@ -194,7 +211,8 @@ public class GeonetworkResolver {
 					if (account.getUser() != null) {
 						switch (version) {
 						case DUE:
-							boolean authorized = GNAuthentication.login(httpUtils, geonetworkUrl, account.getUser(), account.getPassword());
+							boolean authorized = GNAuthentication.login(httpUtils, geonetworkUrl, account.getUser(),
+									account.getPassword());
 							logger.info("Authorized on GN2 " + geonetworkUrl + " ? " + authorized);
 							break;
 
@@ -205,13 +223,16 @@ public class GeonetworkResolver {
 						}
 
 					} else {
-						logger.warn("I'm not able to perform authentication, the user read from config with "+Type.CKAN+" is null");
+						logger.warn("I'm not able to perform authentication, the user read from config with "
+								+ Type.CKAN + " is null");
 					}
 				}
 
-				String baseURL = remainPath==null ||remainPath.isEmpty()?geonetworkUrl+"/"+CSW_SERVER:geonetworkUrl+"/"+CSW_SERVER+remainPath;
+				String baseURL = remainPath == null || remainPath.isEmpty() ? geonetworkUrl + "/" + CSW_SERVER
+						: geonetworkUrl + "/" + CSW_SERVER + remainPath;
 				logger.info("The base URL is: " + baseURL);
-				String queryString = req.getQueryString()==null || req.getQueryString().isEmpty()?"":"?"+req.getQueryString();
+				String queryString = req.getQueryString() == null || req.getQueryString().isEmpty() ? ""
+						: "?" + req.getQueryString();
 				gnGetlURL = baseURL + queryString;
 				logger.info("Sending get request to URL: " + gnGetlURL);
 				HttpResponse proxedGNResponse = httpUtils.get(gnGetlURL);
@@ -225,25 +246,28 @@ public class GeonetworkResolver {
 
 					logger.info("Response return Content-Type: " + httpUtils.getLastContentType());
 
-					ResponseBuilder responseBuilder = Response
+					ResponseBuilder responseBuilder = Response.ok(so).header(ConstantsResolver.CONTENT_TYPE,
-					.ok(so)
+							httpUtils.getLastContentType());
-					.header(ConstantsResolver.CONTENT_TYPE, httpUtils.getLastContentType());
 					return responseBuilder.build();
 
 				case HttpServletResponse.SC_FORBIDDEN:
-					throw ExceptionManager.forbiddenException(req, "You are not authorized to perform the request "+gnGetlURL, this.getClass(), helpURI);
+					throw ExceptionManager.forbiddenException(req,
+							"You are not authorized to perform the request " + gnGetlURL, this.getClass(), helpURI);
 
 				default:
-					throw ExceptionManager.internalErrorException(req, "Sorry, an error occurred performing the geonetwork request "+gnGetlURL+" with scope "+scope, this.getClass(), helpURI);
+					throw ExceptionManager.internalErrorException(req,
+							"Sorry, an error occurred performing the geonetwork request " + gnGetlURL + " with scope "
+									+ scope,
+							this.getClass(), helpURI);
 				}
 
 			} catch (Exception e) {
 				logger.error("Exception:", e);
-				String error = "Sorry, an error occurred on resolving geonetwork request with scope "+scope+". Please, contact support!";
+				String error = "Sorry, an error occurred on resolving geonetwork request with scope " + scope
+						+ ". Please, contact support!";
 				throw ExceptionManager.internalErrorException(req, error, this.getClass(), helpURI);
 			}
 
-
 		} catch (Exception e) {
 
 			if (!(e instanceof WebApplicationException)) {
@@ -274,31 +298,35 @@ public class GeonetworkResolver {
 	 * @throws WebApplicationException the web application exception
 	 */
 	@POST
-	@Path("/{"+PATH_PARAM_SCOPE+"}/{"+PATH_PARAM_MODE+"}/{"+PATH_PARAM_VISIBILITY+"}/{filterKey}/{filterValue}/$${"+PATH_PARAM_REMAINPATH+":(/[^?$]+)?}")
+	@Path("/{" + PATH_PARAM_SCOPE + "}/{" + PATH_PARAM_MODE + "}/{" + PATH_PARAM_VISIBILITY
-	public Response submitPost(@Context HttpServletRequest req,
+			+ "}/{filterKey}/{filterValue}/$${" + PATH_PARAM_REMAINPATH + ":(/[^?$]+)?}")
-		@PathParam(PATH_PARAM_SCOPE) @Nullable String scope,
+	public Response submitPost(@Context HttpServletRequest req, @PathParam(PATH_PARAM_SCOPE) @Nullable String scope,
 			@PathParam(PATH_PARAM_MODE) @Nullable String mode,
 			@PathParam(PATH_PARAM_VISIBILITY) @Nullable String visibility,
-		@PathParam("filterKey") @Nullable String filterKey,
+			@PathParam("filterKey") @Nullable String filterKey, @PathParam("filterValue") @Nullable String filterValue,
-		@PathParam("filterValue") @Nullable String filterValue,
 			@PathParam(PATH_PARAM_REMAINPATH) @Nullable String remainPath,
 			@QueryParam(QUERY_PARAM_RESET_CACHE_PARAM) @Nullable String resetCache,
-		@QueryParam(QUERY_PARAM_RESET_CACHED_SCOPE_PARAM) @Nullable String resetScope) throws WebApplicationException{
+			@QueryParam(QUERY_PARAM_RESET_CACHED_SCOPE_PARAM) @Nullable String resetScope)
+			throws WebApplicationException {
 
 		logger.info(this.getClass().getSimpleName() + " POST starts...");
 		String gnCSWlURL = null;
 
 		try {
-			logger.info("Params are [mode: "+mode+", scope: "+scope+", visibility: "+visibility+", filterKey: "+filterKey+", filterValue: "+filterValue+", remainPath: "+remainPath+"]");
+			logger.info(
+					"Params are [mode: " + mode + ", scope: " + scope + ", visibility: " + visibility + ", filterKey: "
+							+ filterKey + ", filterValue: " + filterValue + ", remainPath: " + remainPath + "]");
 
 			if (scope == null || scope.isEmpty()) {
 				logger.error("Path Parameter 'scope' not found");
-				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'scope'", this.getClass(), helpURI);
+				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'scope'",
+						this.getClass(), helpURI);
 			}
 
 			if (mode == null || mode.isEmpty()) {
 				logger.error("Path Parameter 'scope' not found");
-				ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'mode'", this.getClass(), helpURI);
+				ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'mode'", this.getClass(),
+						helpURI);
 			}
 
 			scope = ScopeUtil.normalizeScope(scope, "|");
@@ -307,13 +335,16 @@ public class GeonetworkResolver {
 				MODE.valueOf(mode);
 			} catch (Exception e) {
 				List<MODE> toPrint = Arrays.asList(MODE.values());
-				logger.error("The 'mode' parameter is wrong, Have you pass a valid parameter MODE like "+toPrint+"?");
+				logger.error(
-				throw ExceptionManager.wrongParameterException(req, "The 'mode' parameter must be value of "+toPrint, this.getClass(), helpURI);
+						"The 'mode' parameter is wrong, Have you pass a valid parameter MODE like " + toPrint + "?");
+				throw ExceptionManager.wrongParameterException(req, "The 'mode' parameter must be value of " + toPrint,
+						this.getClass(), helpURI);
 			}
 
 			if (visibility == null) {
 				logger.error("Path Parameter 'visibility' not found");
-				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'visibility'", this.getClass(), helpURI);
+				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter 'visibility'",
+						this.getClass(), helpURI);
 			}
 
 			visibility = visibility.toUpperCase();
@@ -321,8 +352,10 @@ public class GeonetworkResolver {
 				VISIBILITY.valueOf(visibility);
 			} catch (Exception e) {
 				List<VISIBILITY> toPrint = Arrays.asList(VISIBILITY.values());
-				logger.error("The 'visibility' parameter is wrong, Have you pass a valid parameter VISIBILITY like "+toPrint+"?");
+				logger.error("The 'visibility' parameter is wrong, Have you pass a valid parameter VISIBILITY like "
-				throw ExceptionManager.wrongParameterException(req, "The 'visibility' parameter must be value of "+toPrint, this.getClass(), helpURI);
+						+ toPrint + "?");
+				throw ExceptionManager.wrongParameterException(req,
+						"The 'visibility' parameter must be value of " + toPrint, this.getClass(), helpURI);
 			}
 
 			// HOW TO PASS ANY FILTER?
@@ -336,11 +369,13 @@ public class GeonetworkResolver {
 				}
 			}
 
-
 			try {
 
-				//I'M LOADING GN CONFIGURATIONS (ENDPOINT, USER, PWD AND SO ON..) FOR PASSED SCOPE FROM GN LIBRARY BY A GENERAL METHOD WITHOUT TO PERFORM AUTHENTICATION ON GN,
+				// I'M LOADING GN CONFIGURATIONS (ENDPOINT, USER, PWD AND SO ON..) FOR PASSED
-				//AFTER THAT I'M USING THEM TO PERFORM AUTHENTICATION ON GN VIA HTTP_CLIENTS IF NEEDED
+				// SCOPE FROM GN LIBRARY BY A GENERAL METHOD WITHOUT TO PERFORM AUTHENTICATION
+				// ON GN,
+				// AFTER THAT I'M USING THEM TO PERFORM AUTHENTICATION ON GN VIA HTTP_CLIENTS IF
+				// NEEDED
 				GeonetworkInstance gnInstance = getGeonetworkInstanceForScope(scope);
 				logger.info("set scope provider " + scope);
 				ScopeProvider.instance.set(scope);
@@ -356,12 +391,14 @@ public class GeonetworkResolver {
 					version = config.getGeoNetworkVersion();
 					geonetworkUrl = config.getGeoNetworkEndpoint();
 				}
-				logger.info("SCOPE: {}, CKAN user used is: {}, GN EndPoint: {}",scope, account.getUser(), geonetworkUrl);
+				logger.info("SCOPE: {}, CKAN user used is: {}, GN EndPoint: {}", scope, account.getUser(),
+						geonetworkUrl);
 
 				// logger.info("Parameters..");
 				// for (Enumeration<String> e = req.getParameterNames(); e.hasMoreElements();){
 				// String p = e.nextElement();
-	//			   logger.debug("param "+p + " value "+Arrays.toString(req.getParameterValues(p)));
+				// logger.debug("param "+p + " value
+				// "+Arrays.toString(req.getParameterValues(p)));
 				// }
 
 				// DEBUG BODY
@@ -369,7 +406,6 @@ public class GeonetworkResolver {
 				// logger.debug("doPost read body request: "+readBody);
 				ByteArrayOutputStream byteArray = new ByteArrayOutputStream();
 
-
 				// SPECIFIC HANDLER FOR GEONETWORK REQUEST: /srv/en/mef.export
 				if (remainPath != null && remainPath.compareTo(SRV_EN_MEF_EXPORT) == 0) {
 					logger.info("In case of mef.export, perfoming a custom handler");
@@ -389,7 +425,8 @@ public class GeonetworkResolver {
 						IOUtils.copy(req.getInputStream(), byteArray);
 				} else {
 					logger.debug("IS NOT A REQUEST TO " + SRV_EN_MEF_EXPORT);
-					gnCSWlURL = remainPath==null || remainPath.isEmpty()?geonetworkUrl+"/"+CSW_SERVER:geonetworkUrl+"/"+CSW_SERVER+remainPath;
+					gnCSWlURL = remainPath == null || remainPath.isEmpty() ? geonetworkUrl + "/" + CSW_SERVER
+							: geonetworkUrl + "/" + CSW_SERVER + remainPath;
 					IOUtils.copy(req.getInputStream(), byteArray);
 				}
 
@@ -404,13 +441,15 @@ public class GeonetworkResolver {
 						// HARVESTED LAYERS
 					} else {
 						filters.put("isHarvested", "y");
-						logger.info("Getting "+MODE.HARVEST+" layers, I added 'isHarvested = y' to the filters ["+filters+"]");
+						logger.info("Getting " + MODE.HARVEST + " layers, I added 'isHarvested = y' to the filters ["
+								+ filters + "]");
 					}
 
 					if (account.getUser() != null) {
 						switch (version) {
 						case DUE:
-							boolean authorized = GNAuthentication.login(httpUtils, geonetworkUrl, account.getUser(), account.getPassword());
+							boolean authorized = GNAuthentication.login(httpUtils, geonetworkUrl, account.getUser(),
+									account.getPassword());
 							logger.info("Authorized on GN2 " + geonetworkUrl + " ? " + authorized);
 							break;
 
@@ -421,7 +460,8 @@ public class GeonetworkResolver {
 						}
 
 					} else {
-						logger.warn("I'm not able to perform authentication, the user read from config with "+Type.CKAN+" is null");
+						logger.warn("I'm not able to perform authentication, the user read from config with "
+								+ Type.CKAN + " is null");
 					}
 
 					// PUBLIC LAYERS
@@ -429,7 +469,8 @@ public class GeonetworkResolver {
 					logger.info("Visibility: " + VISIBILITY.PUB + " getting public layers..");
 					// VRE LAYERS
 					if (mode.equals(MODE.VRE.name())) {
-						logger.info("Getting "+MODE.VRE+" layers, the VRE account: "+account.getUser() +" will be used as owner user for filtering... Is it right?");
+						logger.info("Getting " + MODE.VRE + " layers, the VRE account: " + account.getUser()
+								+ " will be used as owner user for filtering... Is it right?");
 						filters.put("ownername", account.getUser());
 						// HARVESTED LAYERS
 					} else {
@@ -443,11 +484,14 @@ public class GeonetworkResolver {
 
 				// DEBUG
 				// logger.debug("POST - BODY : "+byteArray.toString());
-				InputStream in = httpUtils.post(gnCSWlURL, new ByteArrayInputStream(byteArray.toByteArray()), req.getContentType(), req.getParameterMap());
+				InputStream in = httpUtils.post(gnCSWlURL, new ByteArrayInputStream(byteArray.toByteArray()),
+						req.getContentType(), req.getParameterMap());
 
 				if (in == null) {
 					logger.warn("Input stream returned is null, sending " + HttpServletResponse.SC_NOT_FOUND);
-					throw ExceptionManager.notFoundException(req, "Input stream is null to the request "+gnCSWlURL+ " with body: "+byteArray.toString(), this.getClass(), helpURI);
+					throw ExceptionManager.notFoundException(req,
+							"Input stream is null to the request " + gnCSWlURL + " with body: " + byteArray.toString(),
+							this.getClass(), helpURI);
 				}
 
 				try {
@@ -455,41 +499,56 @@ public class GeonetworkResolver {
 					ReusableInputStream reus = new ReusableInputStream(in);
 
 					if (visibility.equals(VISIBILITY.PRV.name())) {
-						logger.info("Private VISIBILITY requested, retrieving public file identifiers to apply filtering..");
+						logger.info(
+								"Private VISIBILITY requested, retrieving public file identifiers to apply filtering..");
 						FilterGetRecords filterGetRecords = new FilterGetRecords(byteArray.toString(), geonetworkUrl);
-						if(filterGetRecords.getFoundPublicIds()!=null && filterGetRecords.getFoundPublicIds().size()>0){
+						if (filterGetRecords.getFoundPublicIds() != null
-							logger.info("I'm removing list of public IDs with "+filterGetRecords.getFoundPublicIds().size() +" item/s. Is it right?");
+								&& filterGetRecords.getFoundPublicIds().size() > 0) {
-							in = GetResponseRecordFilter.overrideResponseIdsByListIds(reus, filterGetRecords.getFoundPublicIds(), REPLACED_A_PUBLIC_UUID_PLEASE_IGNORE);
+							logger.info("I'm removing list of public IDs with "
+									+ filterGetRecords.getFoundPublicIds().size() + " item/s. Is it right?");
+							in = GetResponseRecordFilter.overrideResponseIdsByListIds(reus,
+									filterGetRecords.getFoundPublicIds(), REPLACED_A_PUBLIC_UUID_PLEASE_IGNORE);
 						}
 					}
 
 					if (filters.size() > 0) {
 						logger.info("Applying filtering on geonet:info... filter/s used: " + filters);
 						Document doc = GetResponseRecordFilter.inputStreamToW3CDocument(reus);
-						List<String> fileIdentifiers = GetResponseRecordFilter.getTextContentStringsForTagName(doc, "gmd:fileIdentifier");
+						List<String> fileIdentifiers = GetResponseRecordFilter.getTextContentStringsForTagName(doc,
+								"gmd:fileIdentifier");
 						List<String> noMatchingFilter = new ArrayList<String>();
 						for (String fileId : fileIdentifiers) {
 
 							// CKECKING THE FILTERS
 							for (String fkey : filters.keySet()) {
-									String value = GetResponseRecordFilter.getMetadataValueByFileIdentifier(fileId, config.getGeoNetworkEndpoint(),config.getAdminAccount().getUser(), config.getAdminAccount().getPassword(), fkey);
+								String value = GetResponseRecordFilter.getMetadataValueByFileIdentifier(fileId,
-									//String own = GetResponseRecordFilter.getMetaOwnerNameByFileIdentifier(fileId, config.getGeoNetworkEndpoint(),config.getAdminAccount().getUser(), config.getAdminAccount().getPassword());
+										config.getGeoNetworkEndpoint(), config.getAdminAccount().getUser(),
+										config.getAdminAccount().getPassword(), fkey);
+								// String own = GetResponseRecordFilter.getMetaOwnerNameByFileIdentifier(fileId,
+								// config.getGeoNetworkEndpoint(),config.getAdminAccount().getUser(),
+								// config.getAdminAccount().getPassword());
 								String fValue = filters.get(fkey);
 								// Either the filter KEY doesn't matching any geonet:info (value==null)
-									//or the value of filterKey in geonet:info doesn't matching the passed filterValue (value.compareTo(fValue)!=0)
+								// or the value of filterKey in geonet:info doesn't matching the passed
+								// filterValue (value.compareTo(fValue)!=0)
 								if (value == null || value.compareTo(fValue) != 0) {
-										logger.trace(fkey +" of File Identifier "+fileId+" not matching the filter: "+fkey+" with value: "+fValue+", adding it to list to remove file identifier and exit from loop..");
+									logger.trace(fkey + " of File Identifier " + fileId + " not matching the filter: "
+											+ fkey + " with value: " + fValue
+											+ ", adding it to list to remove file identifier and exit from loop..");
 									noMatchingFilter.add(fileId);
-										//WHEN I ADD THE FILE IDENTIFIER TO FILTERED ID, I CAN EXIT FROM CKECKING FILTERS LOOP
+									// WHEN I ADD THE FILE IDENTIFIER TO FILTERED ID, I CAN EXIT FROM CKECKING
+									// FILTERS LOOP
 									break;
 								}
 							}
 						}
 
 						if (noMatchingFilter.size() > 0) {
-							logger.info("Removing "+noMatchingFilter.size()+" layer/s that not macthing the filters: "+filters);
+							logger.info("Removing " + noMatchingFilter.size()
+									+ " layer/s that not macthing the filters: " + filters);
 							// Document doc2 = GetResponseRecordFilter.inputStreamToW3CDocument(reus);
-							in = GetResponseRecordFilter.overrideResponseIdsByListIds(reus, noMatchingFilter, REPLACED_UUID_BY_FILTER_PLEASE_IGNORE);
+							in = GetResponseRecordFilter.overrideResponseIdsByListIds(reus, noMatchingFilter,
+									REPLACED_UUID_BY_FILTER_PLEASE_IGNORE);
 							// in = GetResponseRecordFilter.w3CDocumentToInputStream(doc);
 
 						} else {
@@ -503,25 +562,28 @@ public class GeonetworkResolver {
 
 					// END DEBUG
 					logger.info("Response return Content-Type: " + httpUtils.getLastContentType());
-					return Response
+					return Response.ok(reusIs)
-					.ok(reusIs)
+							// .header(ConstantsResolver.CONTENT_DISPOSITION,"attachment; filename =
-					//.header(ConstantsResolver.CONTENT_DISPOSITION,"attachment; filename = \""+fileName+"\"")
+							// \""+fileName+"\"")
 							.header(ConstantsResolver.CONTENT_TYPE, httpUtils.getLastContentType()).build();
 
 				} catch (Exception e) {
 					logger.error("Error on copy the response to send to client: ", e);
-					throw ExceptionManager.internalErrorException(req, "Error on copy the response!",  this.getClass(), helpURI);
+					throw ExceptionManager.internalErrorException(req, "Error on copy the response!", this.getClass(),
+							helpURI);
 				} finally {
 					IOUtils.closeQuietly(in);
 				}
 
 			} catch (IllegalArgumentException e) {
 				logger.error("IllegalArgumentException:", e);
-				throw ExceptionManager.badRequestException(req, "Illegal argument to carry out the request!",  this.getClass(), helpURI);
+				throw ExceptionManager.badRequestException(req, "Illegal argument to carry out the request!",
+						this.getClass(), helpURI);
 
 			} catch (Exception e) {
 				logger.error("Exception:", e);
-				String error = "Sorry, an error occurred on resolving geonetwork request with scope "+scope+". Please, contact support!";
+				String error = "Sorry, an error occurred on resolving geonetwork request with scope " + scope
+						+ ". Please, contact support!";
 				throw ExceptionManager.internalErrorException(req, error, this.getClass(), helpURI);
 			}
 
@@ -529,7 +591,8 @@ public class GeonetworkResolver {
 
 			if (!(e instanceof WebApplicationException)) {
 				// UNEXPECTED EXCEPTION managing it as WebApplicationException
-				String error = "Error during perform POST operation to: "+gnCSWlURL+". Please, contact the support!";
+				String error = "Error during perform POST operation to: " + gnCSWlURL
+						+ ". Please, contact the support!";
 				if (e.getCause() != null)
 					error += "\n\nCaused: " + e.getCause().getMessage();
 				throw ExceptionManager.internalErrorException(req, error, this.getClass(), helpURI);
@@ -541,7 +604,6 @@ public class GeonetworkResolver {
 
 	}
 
-
 	/**
 	 * Gets the geonetwork instance for scope.
 	 *

src/main/java/org/gcube/datatransfer/resolver/services/GisResolver.java

@@ -33,7 +33,16 @@ import org.slf4j.LoggerFactory;
 import com.google.common.cache.CacheLoader.InvalidCacheLoadException;
 
 /**
- * The Class GisResolver.
+ * The GisResolver is able to resolve GIS Links (as a redirect to Gis Viewer
+ * Application) in order to display and navigate on web-map the gis layers
+ * stored in D4Science Geonetwork
+ * (e.g. http://wiki.i-marine.eu/index.php/Blue_Hackathon_iMarine_Data_Challenges#iMarine_GeoNetwork)
+ *
+ * Request format 
+ * [URI_RESOLVER_SERVICE_ENDPOINT]/gis?gis-UUID=[UUID]&scope=[SCOPE]
+ * 
+ * See more at 
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#GIS_Resolver
  * 
  * @author Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it)
  *         Dec 14, 2018

src/main/java/org/gcube/datatransfer/resolver/services/KnimeCreateResolver.java

@@ -24,7 +24,13 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The Class KnimeCreateResolver.
+ * The KnimeCreateResolver is able to create a KNIME URL.
+ * 
+ * Request format
+ * [URI_RESOLVER_SERVICE_ENDPOINT]/knime/create?[QUERY_STRING_TO_INVOKE_A_KNIME_MODEL]
+ * 
+ * See more at
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#KNIME_Resolver
  * 
  * @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
  * 
@@ -38,7 +44,11 @@ public class KnimeCreateResolver {
 	private static String helpURI = "https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#KNIME_Resolver";
 
 	/**
-	 * Creates the knime URL.
+	 * Creates the KNIME URL. Generate a Knime URL (then resolved by the /get path)
+	 * for a KNIME Model Simulation passed by query string.
+	 * 
+	 * See more at
+	 * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#HTTP_POST:_Create_a_KNIME_URL
 	 *
 	 * @param req the req
 	 * @return the response

src/main/java/org/gcube/datatransfer/resolver/services/KnimeGetResolver.java

@@ -23,12 +23,14 @@ import org.slf4j.LoggerFactory;
 
 import com.google.common.cache.CacheLoader.InvalidCacheLoadException;
 
-
 /**
- * The Class KnimeGetResolver.
+ * The KnimeGetResolver provides a method to get the Knime URLs (that are simply
+ * URLs) by which is possible to invoke the KNIME Model Simulation Application.
  *
- * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it
+ * See more at
- * Dec 13, 2018
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#KNIME_Resolver
+ * 
+ * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it Dec 13, 2018
  */
 @Path("knime")
 public class KnimeGetResolver {
@@ -37,8 +39,7 @@ public class KnimeGetResolver {
 
 	private static String helpURI = "https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#KNIME_Resolver";
 
-	private static final String ORG_GCUBE_PORTLETS_USER_KNIMEMODELSIMULATION_MANAGER_SERVICE_IMPL =
+	private static final String ORG_GCUBE_PORTLETS_USER_KNIMEMODELSIMULATION_MANAGER_SERVICE_IMPL = "org.gcube.portlets.user.model-simulation-configuration.server.KnimeModelSimulationManagerServiceImpl";
-					"org.gcube.portlets.user.model-simulation-configuration.server.KnimeModelSimulationManagerServiceImpl";
 
 	private static final String APPLICATION_PROFILE = "ApplicationProfile";
 
@@ -59,7 +60,8 @@ public class KnimeGetResolver {
 		try {
 			if (vreName == null || vreName.isEmpty()) {
 				logger.error("The path parameter 'vreName' not found or empty in the path");
-				throw ExceptionManager.badRequestException(req, "Mandatory path parameter 'vreName' not found or empty", this.getClass(), helpURI);
+				throw ExceptionManager.badRequestException(req, "Mandatory path parameter 'vreName' not found or empty",
+						this.getClass(), helpURI);
 			}
 
 			ScopeBean scopeBean = null;
@@ -67,15 +69,21 @@ public class KnimeGetResolver {
 				scopeBean = LoadingMapOfScopeCache.get(vreName);
 			} catch (ExecutionException | InvalidCacheLoadException e) {
 				logger.error("Error on getting the fullscope from cache for vreName " + vreName, e);
-				throw ExceptionManager.wrongParameterException(req, "Error on getting full scope for the VRE name "+vreName+". Is it registered as VRE in the D4Science Infrastructure System?", this.getClass(), helpURI);
+				throw ExceptionManager.wrongParameterException(req,
+						"Error on getting full scope for the VRE name " + vreName
+								+ ". Is it registered as VRE in the D4Science Infrastructure System?",
+						this.getClass(), helpURI);
 			}
 			ApplicationProfileReader reader = null;
 			String fullScope = scopeBean.toString();
 			try {
-				reader = new ApplicationProfileReader(fullScope, APPLICATION_PROFILE, ORG_GCUBE_PORTLETS_USER_KNIMEMODELSIMULATION_MANAGER_SERVICE_IMPL, false);
+				reader = new ApplicationProfileReader(fullScope, APPLICATION_PROFILE,
+						ORG_GCUBE_PORTLETS_USER_KNIMEMODELSIMULATION_MANAGER_SERVICE_IMPL, false);
 			} catch (Exception e) {
-				logger.error("Error on reading the "+APPLICATION_PROFILE+" with APPID: "+ORG_GCUBE_PORTLETS_USER_KNIMEMODELSIMULATION_MANAGER_SERVICE_IMPL, e);
+				logger.error("Error on reading the " + APPLICATION_PROFILE + " with APPID: "
-				throw ExceptionManager.internalErrorException(req, "Error on reading the Application Profile for the "+KNIME_EXECUTOR_APPLICATION+". Please contact the support", this.getClass(), helpURI);
+						+ ORG_GCUBE_PORTLETS_USER_KNIMEMODELSIMULATION_MANAGER_SERVICE_IMPL, e);
+				throw ExceptionManager.internalErrorException(req, "Error on reading the Application Profile for the "
+						+ KNIME_EXECUTOR_APPLICATION + ". Please contact the support", this.getClass(), helpURI);
 			}
 
 			// READ THE KNIME URL PORTLET FROM APPLICATION PROFRILE IN THE SCOPE fullScope

src/main/java/org/gcube/datatransfer/resolver/services/PartheosRegistryResolver.java

@@ -28,12 +28,13 @@ import org.gcube.datatransfer.resolver.services.error.ExceptionManager;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-
 /**
- * The Class PartheosRegistryResolver.
+ * The PartheosRegistryResolver.
  * 
- * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it
+ * See more at
- * Nov 16, 2018
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#Parthenos_URL_Resolver
+ *
+ * @author Francesco Mangiacrapa francesco.mangiacrapa@isti.cnr.it Nov 16, 2018
  */
 @Path("parthenos_registry")
 public class PartheosRegistryResolver {
@@ -44,6 +45,9 @@ public class PartheosRegistryResolver {
 	/**
 	 * Resolve parthenos url.
 	 * 
+	 * To resolve an "item" from a Parthenos URL stored in the Parthenos Catalogue
+	 * at https://ckan-parthenos.d4science.org/
+	 *
 	 * @param req        the req
 	 * @param provider   the provider
 	 * @param path       the path
@@ -52,10 +56,8 @@ public class PartheosRegistryResolver {
 	 */
 	@GET
 	@Path("/{provider}/{path}{remainPath:(/[^?$]+)?}")
-	public Response resolveParthenosURL(@Context HttpServletRequest req,
+	public Response resolveParthenosURL(@Context HttpServletRequest req, @PathParam("provider") String provider,
-		@PathParam("provider") String provider,
+			@PathParam("path") String path, @PathParam("remainPath") String remainPath) throws WebApplicationException {
-		@PathParam("path") String path,
-		@PathParam("remainPath") String remainPath) throws WebApplicationException {
 
 		logger.info(this.getClass().getSimpleName() + " GET starts...");
 		String remainPathParthenosURL = null;
@@ -78,14 +80,17 @@ public class PartheosRegistryResolver {
 			// APPLYING NAME TRANSFORMATION
 			String normalizedEntityName = toNameForCatalogue(remainPathParthenosURL);
 			logger.info("Trying to resolve with Catalogue EntityName: " + normalizedEntityName);
-			ItemCatalogueURLs itemCatalogueURLs = CatalogueResolver.getItemCatalogueURLs(req, UriResolverSmartGearManagerInit.getParthenosVREName(), ResourceCatalogueCodes.CTLGD.getId(), normalizedEntityName);
+			ItemCatalogueURLs itemCatalogueURLs = CatalogueResolver.getItemCatalogueURLs(req,
+					UriResolverSmartGearManagerInit.getParthenosVREName(), ResourceCatalogueCodes.CTLGD.getId(),
+					normalizedEntityName);
 			return Response.seeOther(new URL(itemCatalogueURLs.getPrivateVRECataloguePortletURL()).toURI()).build();
 
 		} catch (Exception e) {
 
 			if (!(e instanceof WebApplicationException)) {
 				// UNEXPECTED EXCEPTION managing it as WebApplicationException
-				String error = "Error occurred on resolving the path "+remainPathParthenosURL+". Please, contact the support!";
+				String error = "Error occurred on resolving the path " + remainPathParthenosURL
+						+ ". Please, contact the support!";
 				if (e.getCause() != null)
 					error += "\n\nCaused: " + e.getCause().getMessage();
 				throw ExceptionManager.internalErrorException(req, error, this.getClass(), helpURI);
@@ -97,9 +102,10 @@ public class PartheosRegistryResolver {
 
 	}
 
-
 	/**
-	 * Post catalogue.
+	 * To get a normalized item name from a Parthenos URL. It applies a
+	 * normalization function to get from an input Parthenos URL an item name that
+	 * is catalogue compliant.
 	 *
 	 * @param req         the req
 	 * @param jsonRequest the json request
@@ -110,7 +116,8 @@ public class PartheosRegistryResolver {
 	@Path("")
 	@Consumes(MediaType.APPLICATION_JSON)
 	@Produces(MediaType.TEXT_PLAIN)
-	public Response postCatalogue(@Context HttpServletRequest req, ParthenosRequest jsonRequest) throws WebApplicationException{
+	public Response postCatalogue(@Context HttpServletRequest req, ParthenosRequest jsonRequest)
+			throws WebApplicationException {
 		logger.info(this.getClass().getSimpleName() + " POST starts...");
 
 		try {
@@ -118,7 +125,8 @@ public class PartheosRegistryResolver {
 
 			if (entityName == null || entityName.isEmpty()) {
 				logger.error("Entity Name Parameter like 'entity_name' not found or empty");
-				throw ExceptionManager.badRequestException(req, "Mandatory body parameter 'entity_name' not found or empty", this.getClass(), helpURI);
+				throw ExceptionManager.badRequestException(req,
+						"Mandatory body parameter 'entity_name' not found or empty", this.getClass(), helpURI);
 			}
 
 			// REMOVING FIRST '/' IF EXISTS
@@ -126,9 +134,12 @@ public class PartheosRegistryResolver {
 
 			// APPLYING NAME TRANSFORMATION
 			String normalizedEntityName = toNameForCatalogue(entityName);
-			ItemCatalogueURLs itemCatalogueURLs = CatalogueResolver.getItemCatalogueURLs(req, UriResolverSmartGearManagerInit.getParthenosVREName(), ResourceCatalogueCodes.CTLGD.getId(), normalizedEntityName);
+			ItemCatalogueURLs itemCatalogueURLs = CatalogueResolver.getItemCatalogueURLs(req,
+					UriResolverSmartGearManagerInit.getParthenosVREName(), ResourceCatalogueCodes.CTLGD.getId(),
+					normalizedEntityName);
 			logger.info("Returining Catalogue URL: " + itemCatalogueURLs.getPrivateVRECataloguePortletURL());
-			return Response.ok(normalizedEntityName).header("Location", itemCatalogueURLs.getPrivateVRECataloguePortletURL()).build();
+			return Response.ok(normalizedEntityName)
+					.header("Location", itemCatalogueURLs.getPrivateVRECataloguePortletURL()).build();
 
 		} catch (Exception e) {
 
@@ -143,17 +154,19 @@ public class PartheosRegistryResolver {
 		}
 	}
 
-
 	/**
-	 * To name for catalogue.
+	 * To name for catalogue. this method applyes a fuction to transform a parthenos
-	 * this method applyes a fuction to transform a parthenos URL to acceptable catalogue name (that is URL)
+	 * URL to acceptable catalogue name (that is URL)
+	 * 
 	 * @param remainPathParthenosURL the remain path parthenos url
 	 * @return the string
 	 * @throws UnsupportedEncodingException the unsupported encoding exception
 	 */
 	protected String toNameForCatalogue(final String remainPathParthenosURL) throws UnsupportedEncodingException {
-		//need to double decode for URLs like: http://parthenos.d4science.org/handle/Parthenos/REG/Dataset/Appellation/Isidore%2520Dataset
+		// need to double decode for URLs like:
-		String name = StringUtils.replaceChars(URLDecoder.decode(remainPathParthenosURL,"UTF-8"),"/ .:", "_").toLowerCase().replaceAll("[^A-Za-z0-9]", "_");
+		// http://parthenos.d4science.org/handle/Parthenos/REG/Dataset/Appellation/Isidore%2520Dataset
+		String name = StringUtils.replaceChars(URLDecoder.decode(remainPathParthenosURL, "UTF-8"), "/ .:", "_")
+				.toLowerCase().replaceAll("[^A-Za-z0-9]", "_");
 		// TO LOWERCASE FOR CKAN SUPPORTING
 		return name.toLowerCase();
 	}
@@ -161,7 +174,8 @@ public class PartheosRegistryResolver {
 	// TO TEST
 	// public static void main(String[] args) throws UnsupportedEncodingException {
 	//
-	//		String remainPathParthenosURL = "Culturalitalia/unknown/Dataset/oai%3Aculturaitalia.it%3Aoai%3Aculturaitalia.it%3Amuseiditalia-mus_11953";
+	// String remainPathParthenosURL =
+	// "Culturalitalia/unknown/Dataset/oai%3Aculturaitalia.it%3Aoai%3Aculturaitalia.it%3Amuseiditalia-mus_11953";
 	// System.out.println(URLDecoder.decode(remainPathParthenosURL, "UTF-8"));
 	//
 	// }

src/main/java/org/gcube/datatransfer/resolver/services/SMPIDResolver.java

@@ -20,7 +20,13 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The Class SMPIDResolver.
+ * The SMPIDResolver is able to give HTTP resolution to storage resource by ID.
+ * 
+ * Request format
+ * [URI_RESOLVER_SERVICE_ENDPOINT]/id?smp-id=[STORAGE_SMP_ID]&fileName=[FILENAME]&contentType=[CONTENT_TYPE]
+ * 
+ * See more at 
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#SMP-ID_Resolver
  * 
  * @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
  * 

src/main/java/org/gcube/datatransfer/resolver/services/SMPResolver.java

@@ -20,7 +20,13 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The Class SMPResolver.
+ * The SMPResolver is able to give HTTP resolution to SMP protocol URIs
+ * 
+ * Request format
+ * [URI_RESOLVER_SERVICE_ENDPOINT]/smp?smp-uri=smp://.....
+ *
+ * See more at 
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#SMP_Resolver
  * 
  * @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
  * 

src/main/java/org/gcube/datatransfer/resolver/services/StorageHubResolver.java

@@ -25,7 +25,14 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The Class StorageHubResolver.
+ * The StorageHubResolver provides the methods either to download a gCube
+ * Workspace file or to get its metadata. 
+ * 
+ * Request format
+ * [URI_RESOLVER_SERVICE_ENDPOINT]/shub/[STORAGE_HUB_FILE_ID]
+ * 
+ * See more at 
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#STORAGE-HUB_Resolver
  * 
  * @author Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it)
  *         Dec 14, 2018
@@ -46,7 +53,6 @@ public class StorageHubResolver {
 	@PathParam(STORAGE_HUB_ID)
 	String id;
 
-
 	/**
 	 * Gets the metadata.
 	 *
@@ -64,7 +70,8 @@ public class StorageHubResolver {
 			// Checking mandatory parameter id
 			if (id == null || id.isEmpty()) {
 				logger.error("Path Parameter " + STORAGE_HUB_ID + " not found");
-				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter "+STORAGE_HUB_ID, this.getClass(), help);
+				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter " + STORAGE_HUB_ID,
+						this.getClass(), help);
 			}
 
 			try {
@@ -72,7 +79,8 @@ public class StorageHubResolver {
 				ItemManagerClient client = AbstractPlugin.item().build();
 				StreamDescriptor descriptor = client.resolvePublicLink(id);
 				ResponseBuilder response = Response.ok();
-				response = new StorageHubMetadataResponseBuilder(req, response).fillMetadata(descriptor, id, CONTENT_DISPOSITION_VALUE.attachment);
+				response = new StorageHubMetadataResponseBuilder(req, response).fillMetadata(descriptor, id,
+						CONTENT_DISPOSITION_VALUE.attachment);
 				return response.build();
 
 			} catch (Exception e) {
@@ -85,7 +93,8 @@ public class StorageHubResolver {
 
 			if (!(e instanceof WebApplicationException)) {
 				// UNEXPECTED EXCEPTION managing it as WebApplicationException
-				String error = "Error occurred on resolving the StorageHub URL with id: "+id+". Please, contact the support!";
+				String error = "Error occurred on resolving the StorageHub URL with id: " + id
+						+ ". Please, contact the support!";
 				throw ExceptionManager.internalErrorException(req, error, this.getClass(), help);
 			}
 			// ALREADY MANAGED as WebApplicationException
@@ -94,7 +103,6 @@ public class StorageHubResolver {
 		}
 	}
 
-
 	/**
 	 * Download.
 	 *
@@ -103,7 +111,8 @@ public class StorageHubResolver {
 	 */
 	@GET
 	@Path("/{id}")
-	public Response download(@Context HttpServletRequest req, @QueryParam(ConstantsResolver.QUERY_PARAM_CONTENTDISPOSITION) String contentDisposition) {
+	public Response download(@Context HttpServletRequest req,
+			@QueryParam(ConstantsResolver.QUERY_PARAM_CONTENTDISPOSITION) String contentDisposition) {
 		logger.info(this.getClass().getSimpleName() + " GET download called");
 
 		try {
@@ -112,7 +121,8 @@ public class StorageHubResolver {
 			// Checking mandatory parameter "id"
 			if (id == null || id.isEmpty()) {
 				logger.error("Path Parameter " + STORAGE_HUB_ID + " not found");
-				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter "+STORAGE_HUB_ID, StorageHubResolver.class, help);
+				throw ExceptionManager.badRequestException(req, "Missing mandatory path parameter " + STORAGE_HUB_ID,
+						StorageHubResolver.class, help);
 			}
 
 			// Checking the optional parameter "Content-Disposition"
@@ -126,7 +136,8 @@ public class StorageHubResolver {
 				StreamDescriptor descriptor = client.resolvePublicLink(id);
 				ResponseBuilder response = Response.ok(descriptor.getStream());
 
-				response = new StorageHubMetadataResponseBuilder(req, response).fillMetadata(descriptor, id, dispositionValue);
+				response = new StorageHubMetadataResponseBuilder(req, response).fillMetadata(descriptor, id,
+						dispositionValue);
 				return response.build();
 
 			} catch (Exception e) {
@@ -139,7 +150,8 @@ public class StorageHubResolver {
 
 			if (!(e instanceof WebApplicationException)) {
 				// UNEXPECTED EXCEPTION managing it as WebApplicationException
-				String error = "Error occurred on resolving the StorageHub URL with id: "+id+". Please, contact the support!";
+				String error = "Error occurred on resolving the StorageHub URL with id: " + id
+						+ ". Please, contact the support!";
 				throw ExceptionManager.internalErrorException(req, error, this.getClass(), help);
 			}
 			// ALREADY MANAGED AS WebApplicationException

src/main/java/org/gcube/datatransfer/resolver/services/StorageIDResolver.java

@@ -36,7 +36,13 @@ import org.slf4j.LoggerFactory;
 
 
 /**
- * The Class StorageIDResolver.
+ * The StorageIDResolver is able to give HTTP resolution to storage resource by ID
+ * 
+ * Request Format
+ * [URI_RESOLVER_SERVICE_ENDPOINT]/[STORAGE_ID]
+ * 
+ * See more at 
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#STORAGE-ID_Resolver
  * 
  * @author Francesco Mangiacrapa at ISTI-CNR (francesco.mangiacrapa@isti.cnr.it)
  * Dec 14, 2018

src/main/java/org/gcube/datatransfer/resolver/services/UriResolverDocs.java

@@ -10,17 +10,15 @@ import java.io.InputStream;
 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
-import javax.ws.rs.Produces;
 import javax.ws.rs.WebApplicationException;
 import javax.ws.rs.core.Context;
-import javax.ws.rs.core.MediaType;
 
 import org.gcube.datatransfer.resolver.services.error.ExceptionManager;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The Class UriResolverDocs.
+ * The UriResolverDocs provides the URI Resolver API Documentation
  *
  * @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
  * 

src/main/java/org/gcube/datatransfer/resolver/services/UriResolverInfo.java

@@ -14,7 +14,7 @@ import javax.ws.rs.core.Context;
 import javax.ws.rs.core.MediaType;
 
 /**
- * The Class UriResolverInfo.
+ * The UriResolverInfo get index.
  *
  * @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
  * 

src/main/java/org/gcube/datatransfer/resolver/services/WekeoResolver.java

@@ -36,7 +36,14 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 /**
- * The Class WekeoResolver.
+ * The WekeoResolver provides a method to wrap the basic authentication from
+ * D4Science account to WekeoBroker service.
+ * 
+ * Request format
+ * [URI_RESOLVER_SERVICE_ENDPOINT]/wekeo/gettoken?gcube-token=[YOUR_GCUBE_TOKEN]
+ * 
+ * See more at
+ * https://gcube.wiki.gcube-system.org/gcube/URI_Resolver#Wekeo_Resolver
  *
  * @author Francesco Mangiacrapa at ISTI-CNR francesco.mangiacrapa@isti.cnr.it
  *