Some refactoring per suggestions during QA #11987

Author: landreev

doc/sphinx-guides/source/admin/dataverses-datasets.rst

@@ -271,6 +271,8 @@ The effective store can be seen using::
 
     curl http://$SERVER/api/datasets/$dataset-id/storageDriver
 
+The output of the API will include the id, label, type (for example, "file" or "s3") as well as the support for direct download and upload.
+
 To remove an assigned store, and allow the dataset to inherit the store from it's parent collection, use the following (only a superuser can do this) ::
 
     curl -H "X-Dataverse-key: $API_TOKEN" -X DELETE http://$SERVER/api/datasets/$dataset-id/storageDriver

src/main/java/edu/harvard/iq/dataverse/DatasetServiceBean.java

@@ -1122,7 +1122,7 @@ public int getDataFileCountByOwner(long id) {
 
     /**
      * 
-     * @todo: consider moving the quota methods, from here and the DataverseServiceBean,
+     * @todo: consider moving the quota method, from here and the DataverseServiceBean,
      * to DvObjectServiceBean. 
      */
     public void saveStorageQuota(Dataset target, Long allocation) {
@@ -1140,13 +1140,4 @@ public void saveStorageQuota(Dataset target, Long allocation) {
         }
         em.flush();
     }
-    
-    public void disableStorageQuota(StorageQuota storageQuota) {
-        if (storageQuota != null && storageQuota.getAllocation() != null) {
-            storageQuota.setAllocation(null);
-            em.merge(storageQuota);
-            em.flush();
-        }
-    }
-
 }

src/main/java/edu/harvard/iq/dataverse/DataverseServiceBean.java

@@ -1307,7 +1307,12 @@ static String getBaseSchemaStringFromFile(String pathToJsonFile) {
 "    },\n" +
 "    \"required\": [\"datasetVersion\"]\n" +
 "}\n";
-    
+
+    /**
+     * 
+     * @todo: consider moving these quota methods, and the DatasetServiceBean
+     * equivalent to DvObjectServiceBean. 
+     */    
     public void saveStorageQuota(Dataverse target, Long allocation) {
         StorageQuota storageQuota = target.getStorageQuota();
 

src/main/java/edu/harvard/iq/dataverse/api/Datasets.java

@@ -6182,11 +6182,17 @@ public Response getDatasetQuota(@Context ContainerRequestContext crc, @PathParam
         }
     }
 
-    @POST
+    @PUT
     @AuthRequired
-    @Path("{identifier}/storage/quota/{bytesAllocated}")
-    public Response setDatasetQuota(@Context ContainerRequestContext crc, @PathParam("identifier") String dvIdtf, @PathParam("bytesAllocated") Long bytesAllocated) throws WrappedResponse {
+    @Path("{identifier}/storage/quota")
+    public Response setDatasetQuota(@Context ContainerRequestContext crc, @PathParam("identifier") String dvIdtf, String value) throws WrappedResponse {
         try {
+            Long bytesAllocated; 
+            try {
+                bytesAllocated = Long.parseLong(value);
+            } catch (NumberFormatException nfe){
+                return error(Status.BAD_REQUEST, value + " is not a valid number of bytes");
+            }
             execCommand(new SetDatasetQuotaCommand(createDataverseRequest(getRequestUser(crc)), findDatasetOrDie(dvIdtf), bytesAllocated));
             return ok(BundleUtil.getStringFromBundle("dataset.storage.quota.updated"));
         } catch (WrappedResponse ex) {

src/main/java/edu/harvard/iq/dataverse/api/Dataverses.java

@@ -1248,11 +1248,17 @@ public Response getCollectionQuota(@Context ContainerRequestContext crc, @PathPa
         }
     }
 
-    @POST
+    @PUT
     @AuthRequired
-    @Path("{identifier}/storage/quota/{bytesAllocated}")
-    public Response setCollectionQuota(@Context ContainerRequestContext crc, @PathParam("identifier") String dvIdtf, @PathParam("bytesAllocated") Long bytesAllocated) throws WrappedResponse {
+    @Path("{identifier}/storage/quota")
+    public Response setCollectionQuota(@Context ContainerRequestContext crc, @PathParam("identifier") String dvIdtf, String value) throws WrappedResponse {
         try {
+            Long bytesAllocated; 
+            try {
+                bytesAllocated = Long.parseLong(value);
+            } catch (NumberFormatException nfe){
+                return error(Status.BAD_REQUEST, value + " is not a valid number of bytes");
+            }
             execCommand(new SetCollectionQuotaCommand(createDataverseRequest(getRequestUser(crc)), findDataverseOrDie(dvIdtf), bytesAllocated));
             return ok(BundleUtil.getStringFromBundle("dataverse.storage.quota.updated"));
         } catch (WrappedResponse ex) {

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/DeleteDatasetQuotaCommand.java

@@ -48,6 +48,8 @@ public void executeImpl(CommandContext ctxt) throws CommandException {
         if (storageQuota != null && storageQuota.getAllocation() != null) {
             // The method below, in dataverseServiceBean, can be used to delete
             // quotas defined on either of the DvObjectContainer classes:
+            targetDataset.setStorageQuota(null);
+            storageQuota.setDefinitionPoint(null);
             ctxt.dataverses().disableStorageQuota(storageQuota);
         } 
         // ... and if no quota was enabled on the dataset - nothing to do = success

src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java

@@ -3278,7 +3278,7 @@ public void testCollectionStorageQuotas() {
         assertEquals(BundleUtil.getStringFromBundle("dataverse.storage.quota.notdefined"), JsonPath.from(checkQuotaResponse.body().asString()).getString("data.message"));
 
         // Set quota to 1K:
-        Response setQuotaResponse = UtilIT.setCollectionQuota(dataverseAlias, 1024, apiToken);
+        Response setQuotaResponse = UtilIT.setCollectionQuota(dataverseAlias, Long.valueOf(1024), apiToken);
         setQuotaResponse.then().assertThat().statusCode(OK.getStatusCode());
         assertEquals(BundleUtil.getStringFromBundle("dataverse.storage.quota.updated"), JsonPath.from(setQuotaResponse.body().asString()).getString("data.message"));
 
@@ -3402,7 +3402,7 @@ public void testDatasetStorageQuotas() {
         assertEquals(BundleUtil.getStringFromBundle("dataset.storage.quota.notdefined"), JsonPath.from(checkQuotaResponse.body().asString()).getString("data.message"));
 
         // Set quota to 1K:
-        Response setQuotaResponse = UtilIT.setDatasetQuota(datasetId.toString(), 1024, apiToken);
+        Response setQuotaResponse = UtilIT.setDatasetQuota(datasetId.toString(), Long.valueOf(1024), apiToken);
         setQuotaResponse.then().assertThat().statusCode(OK.getStatusCode());
         assertEquals(BundleUtil.getStringFromBundle("dataset.storage.quota.updated"), JsonPath.from(setQuotaResponse.body().asString()).getString("data.message"));
 

src/test/java/edu/harvard/iq/dataverse/api/UtilIT.java

@@ -3689,10 +3689,11 @@ static Response checkCollectionQuota(String collectionId, String apiToken) {
                 .get("/api/dataverses/" + collectionId + "/storage/quota");
     }
 
-    static Response setCollectionQuota(String collectionId, long allocatedSize, String apiToken) {
+    static Response setCollectionQuota(String collectionId, Long allocatedSize, String apiToken) {
         Response response = given()
                 .header(API_TOKEN_HTTP_HEADER, apiToken)
-                .post("/api/dataverses/" + collectionId + "/storage/quota/" + allocatedSize);
+                .body(allocatedSize.toString())
+                .put("/api/dataverses/" + collectionId + "/storage/quota");
         return response;
     }
 
@@ -3715,10 +3716,11 @@ static Response checkDatasetQuota(String datasetId, String apiToken) {
                 .get("/api/datasets/" + datasetId + "/storage/quota");
     }
 
-    static Response setDatasetQuota(String datasetId, long allocatedSize, String apiToken) {
+    static Response setDatasetQuota(String datasetId, Long allocatedSize, String apiToken) {
         Response response = given()
                 .header(API_TOKEN_HTTP_HEADER, apiToken)
-                .post("/api/datasets/" + datasetId + "/storage/quota/" + allocatedSize);
+                .body(allocatedSize.toString())
+                .put("/api/datasets/" + datasetId + "/storage/quota");
         return response;
     }