12141 - Storage Driver API #12182
+250
−203
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ### Breaking Changes | ||
|
|
||
| All the endpoints related to Storage Drivers have been moved out of the Admin API. | ||
|
|
||
| - The endpoints GET, PUT AND DELETE for `/api/admin/dataverse/{alias}/storageDriver` has been moved to `/api/dataverses/{alias}/storageDriver`. | ||
| - The endpoint `/api/admin/dataverse/storageDrivers` has been moved and renamed to `/api/dataverses/{alias}/allowedStorageDrivers`. Regarding the change of the name, this endpoint will in the future only display the storageDrivers that are allowed on the specified collection, as of now, it will display the entire list of available Drivers on the installation. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -52,29 +52,29 @@ Configure a Dataverse Collection to Store All New Files in a Specific File Store | |||||
|
|
||||||
| To direct new files (uploaded when datasets are created or edited) for all datasets in a given Dataverse collection, the store can be specified via the API as shown below, or by editing the 'General Information' for a Dataverse collection on the Dataverse collection page. Only accessible to superusers. :: | ||||||
|
There was a problem hiding this comment. This paragraph still says “Only accessible to superusers” but the new implementation in
Suggested change
|
||||||
|
|
||||||
| curl -H "X-Dataverse-key: $API_TOKEN" -X PUT -d $storageDriverLabel http://$SERVER/api/dataverses/$dataverse-alias/storageDriver | ||||||
|
|
||||||
| (Note that for ``dataverse.files.store1.label=MyLabel``, you should pass ``MyLabel``.) | ||||||
|
|
||||||
| A store assigned directly to a collection can be seen using:: | ||||||
|
|
||||||
| curl -H "X-Dataverse-key: $API_TOKEN" http://$SERVER/api/dataverses/$dataverse-alias/storageDriver | ||||||
|
|
||||||
| This may be null. To get the effective storageDriver for a collection, which may be inherited from a parent collection or be the installation default, you can use:: | ||||||
|
|
||||||
| curl -H "X-Dataverse-key: $API_TOKEN" http://$SERVER/api/dataverses/$dataverse-alias/storageDriver?getEffective=true | ||||||
|
|
||||||
| This will never be null. | ||||||
|
|
||||||
| (Note that for ``dataverse.files.store1.label=MyLabel``, the JSON response will include "name":"store1" and "label":"MyLabel".) | ||||||
|
|
||||||
| To delete a store assigned directly to a collection (so that the colllection's effective store is inherted from it's parent or is the global default), use:: | ||||||
|
|
||||||
| curl -H "X-Dataverse-key: $API_TOKEN" -X DELETE http://$SERVER/api/dataverses/$dataverse-alias/storageDriver | ||||||
|
|
||||||
| The available drivers within a collection can be listed with:: | ||||||
|
|
||||||
| curl -H "X-Dataverse-key: $API_TOKEN" http://$SERVER/api/dataverses/$dataverse-alias/allowedStorageDrivers | ||||||
|
|
||||||
| (Individual datasets can be configured to use specific file stores as well. See the "Datasets" section below.) | ||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,28 +3,24 @@ | |||||
| import com.google.common.collect.Lists; | ||||||
| import com.google.api.client.util.ArrayMap; | ||||||
| import edu.harvard.iq.dataverse.*; | ||||||
| import edu.harvard.iq.dataverse.api.auth.AuthRequired; | ||||||
| import edu.harvard.iq.dataverse.api.datadeposit.SwordServiceBean; | ||||||
| import edu.harvard.iq.dataverse.api.dto.*; | ||||||
| import edu.harvard.iq.dataverse.authorization.DataverseRole; | ||||||
| import edu.harvard.iq.dataverse.api.imports.ImportException; | ||||||
| import edu.harvard.iq.dataverse.api.imports.ImportServiceBean; | ||||||
| import edu.harvard.iq.dataverse.authorization.Permission; | ||||||
| import edu.harvard.iq.dataverse.authorization.RoleAssignee; | ||||||
| import edu.harvard.iq.dataverse.authorization.groups.impl.explicit.ExplicitGroup; | ||||||
| import edu.harvard.iq.dataverse.authorization.groups.impl.explicit.ExplicitGroupProvider; | ||||||
| import edu.harvard.iq.dataverse.authorization.groups.impl.explicit.ExplicitGroupServiceBean; | ||||||
| import edu.harvard.iq.dataverse.authorization.users.AuthenticatedUser; | ||||||
| import edu.harvard.iq.dataverse.authorization.users.User; | ||||||
| import edu.harvard.iq.dataverse.dataset.DatasetType; | ||||||
| import edu.harvard.iq.dataverse.dataverse.DataverseUtil; | ||||||
| import edu.harvard.iq.dataverse.dataverse.featured.DataverseFeaturedItem; | ||||||
| import edu.harvard.iq.dataverse.dataverse.featured.DataverseFeaturedItemServiceBean; | ||||||
| import edu.harvard.iq.dataverse.engine.command.DataverseRequest; | ||||||
| import edu.harvard.iq.dataverse.engine.command.impl.*; | ||||||
| import edu.harvard.iq.dataverse.pidproviders.PidProvider; | ||||||
| import edu.harvard.iq.dataverse.pidproviders.PidUtil; | ||||||
|
|
@@ -73,6 +69,7 @@ | |||||
| import jakarta.ws.rs.core.Context; | ||||||
| import jakarta.ws.rs.core.HttpHeaders; | ||||||
| import jakarta.ws.rs.core.StreamingOutput; | ||||||
|
|
||||||
| import org.glassfish.jersey.media.multipart.FormDataBodyPart; | ||||||
| import org.glassfish.jersey.media.multipart.FormDataContentDisposition; | ||||||
| import org.glassfish.jersey.media.multipart.FormDataParam; | ||||||
|
|
@@ -89,7 +86,6 @@ | |||||
| public class Dataverses extends AbstractApiBean { | ||||||
|
|
||||||
| private static final Logger logger = Logger.getLogger(Dataverses.class.getCanonicalName()); | ||||||
|
|
||||||
jp-tosca marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| @EJB | ||||||
| ExplicitGroupServiceBean explicitGroupSvc; | ||||||
|
|
@@ -1330,97 +1326,6 @@ public Response listAssignments(@Context ContainerRequestContext crc, @PathParam | |||||
| ), getRequestUser(crc)); | ||||||
| } | ||||||
|
|
||||||
| @POST | ||||||
| @AuthRequired | ||||||
| @Path("{identifier}/assignments") | ||||||
|
|
@@ -2140,4 +2045,91 @@ public Response getRoleAssignmentHistory(@Context ContainerRequestContext crc, | |||||
| return getRoleAssignmentHistoryResponse(dataverse, authenticatedUser, false, headers); | ||||||
| }, getRequestUser(crc)); | ||||||
| } | ||||||
|
|
||||||
| @GET | ||||||
| @AuthRequired | ||||||
| @Path("{identifier}/storageDriver") | ||||||
| public Response getStorageDriver(@Context ContainerRequestContext crc, @PathParam("identifier") String id, | ||||||
| @QueryParam("getEffective") Boolean getEffective) throws WrappedResponse { | ||||||
|
|
||||||
jp-tosca marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| Dataverse dataverse = findDataverseOrDie(id); | ||||||
|
|
||||||
| if (dataverse == null) { | ||||||
| return error(Response.Status.NOT_FOUND, "Could not find dataverse based on the identifier supplied: " + id + "."); | ||||||
| } | ||||||
jp-tosca marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| return response(req -> { | ||||||
| String storageDriver = execCommand(new GetDataverseStorageDriverCommand(req, findDataverseOrDie(id), getEffective)); | ||||||
|
There was a problem hiding this comment. This does a second
Suggested change
Contributor
There was a problem hiding this comment. I don't see where this was resolved. 'findDataverseOrDie(id)' should be replaced with 'dataverse'. Also where is the EditDataverse permission check? |
||||||
| return ok(JsonPrinter.jsonStorageDriver(storageDriver)); | ||||||
| }, getRequestUser(crc)); | ||||||
| } | ||||||
|
|
||||||
| @PUT | ||||||
| @AuthRequired | ||||||
| @Path("{identifier}/storageDriver") | ||||||
| public Response setStorageDriver(@Context ContainerRequestContext crc, | ||||||
| @PathParam("identifier") String id, String label) throws WrappedResponse { | ||||||
|
|
||||||
| Dataverse dataverse = findDataverseOrDie(id); | ||||||
|
|
||||||
| if (dataverse == null) { | ||||||
| return error(Response.Status.NOT_FOUND, "Could not find dataverse based on the identifier supplied: " + id + "."); | ||||||
| } | ||||||
|
|
||||||
| try { | ||||||
| AuthenticatedUser user = getRequestAuthenticatedUserOrDie(crc); | ||||||
| DataverseRequest request = createDataverseRequest(user); | ||||||
| SetDataverseStorageDriverCommand setDriverCommand = new SetDataverseStorageDriverCommand(request, dataverse, label); | ||||||
| return ok(execCommand(setDriverCommand)); | ||||||
|
|
||||||
| } catch (WrappedResponse wr) { | ||||||
| return handleWrappedResponse(wr); | ||||||
|
||||||
| } | ||||||
| } | ||||||
|
|
||||||
| @DELETE | ||||||
| @AuthRequired | ||||||
| @Path("{identifier}/storageDriver") | ||||||
| public Response resetStorageDriver(@Context ContainerRequestContext crc, @PathParam("identifier") String id) throws WrappedResponse { | ||||||
|
|
||||||
| Dataverse dataverse = findDataverseOrDie(id); | ||||||
| if (dataverse == null) { | ||||||
| return error(Response.Status.NOT_FOUND, "Could not find dataverse based on the identifier supplied: " + id + "."); | ||||||
| } | ||||||
|
|
||||||
| try { | ||||||
| AuthenticatedUser user = getRequestAuthenticatedUserOrDie(crc); | ||||||
| DataverseRequest request = createDataverseRequest(user); | ||||||
| DeleteDataverseStorageDriverCommand deleteDriverCommand = new DeleteDataverseStorageDriverCommand(request, dataverse); | ||||||
| return ok(execCommand(deleteDriverCommand)); | ||||||
| } catch (WrappedResponse wr) { | ||||||
| return handleWrappedResponse(wr); | ||||||
|
||||||
| } | ||||||
| } | ||||||
|
|
||||||
| @GET | ||||||
| @AuthRequired | ||||||
| @Path("{identifier}/allowedStorageDrivers") | ||||||
| public Response listStorageDrivers(@Context ContainerRequestContext crc, @PathParam("identifier") String id) throws WrappedResponse { | ||||||
|
|
||||||
| Dataverse dv = findDataverseOrDie(id); | ||||||
|
|
||||||
|
|
||||||
| /* | ||||||
| * TODO: This endpoint ad GetDataverseAllowedStorageDriverCommand needs to be completed, | ||||||
| * currently it mocks things that will be required to model the behavior requested by Jim Myers, | ||||||
| * which is to return the list of storage drivers that the dataverse can use. | ||||||
| * Currently it will return the full list of drivers available. | ||||||
| */ | ||||||
| try { | ||||||
| AuthenticatedUser user = getRequestAuthenticatedUserOrDie(crc); | ||||||
| DataverseRequest request = createDataverseRequest(user); | ||||||
| GetDataverseAllowedStorageDriverCommand getAllowedStorageDriversCommand = new GetDataverseAllowedStorageDriverCommand(request, dv); | ||||||
| return ok(execCommand(getAllowedStorageDriversCommand)); | ||||||
| } catch (WrappedResponse wr) { | ||||||
| return handleWrappedResponse(wr); | ||||||
|
||||||
| } | ||||||
| } | ||||||
|
|
||||||
| } | ||||||
|
|
||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All breaking changes need to be documented in changelog.rst