11914 set template default

doc/release-notes/11914-set-template-default-api.md

@@ -0,0 +1,15 @@
+## New Endpoint: POST `/dataverses/{id}/template/default/{templateId}`
+
+A new endpoint has been implemented to set the default template to a given dataverse collection.
+
+### Functionality
+- Sets the default template of the given dataverse collection.
+- You must have edit dataverse permission in the collection in order to use this endpoint.
+
+## New Endpoint: DELETE `/dataverses/{id}/template/default`
+
+A new endpoint has been implemented to remove the default template to a given dataverse collection.
+
+### Functionality
+- Removes the default template of the given dataverse collection.
+- You must have edit dataverse permission in the collection in order to use this endpoint.

doc/sphinx-guides/source/api/native-api.rst

@@ -1639,6 +1639,50 @@ The fully expanded example above (without environment variables) looks like this
 
   curl -H "X-Dataverse-key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X POST "https://demo.dataverse.org/api/dataverses/1/templates" --upload-file dataverse-template.json
 
+Set a Default Template for a Collection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sets a template as the default template for a collection:
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export ID=1
+  export TEMPLATEID=2
+
+  curl -H "X-Dataverse-key:$API_TOKEN" -X POST "$SERVER_URL/api/dataverses/$ID/template/default/$TEMPLATEID"
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X POST "https://demo.dataverse.org/api/dataverses/1/template/default/2"
+
+You must have Edit Dataverse permission within the given dataverse collection to invoke this api.
+
+Remove a Default Template for a Collection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Remove a template as the default template for a collection(Note: the template is not deleted; it will still be available for use in the collection):
+
+.. code-block:: bash
+
+  export API_TOKEN=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+  export SERVER_URL=https://demo.dataverse.org
+  export ID=1
+
+
+  curl -H "X-Dataverse-key:$API_TOKEN" -X DELETE "$SERVER_URL/api/dataverses/$ID/template/default"
+
+The fully expanded example above (without environment variables) looks like this:
+
+.. code-block:: bash
+
+  curl -H "X-Dataverse-key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" -X DELETE "https://demo.dataverse.org/api/dataverses/1/template/default"
+
+You must have Edit Dataverse permission within the given dataverse collection to invoke this api.
+
 
 Dataverse Role Assignment History
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

@@ -370,6 +370,25 @@ protected Dataverse findDataverseOrDie( String dvIdtf ) throws WrappedResponse {
         }
         return dv;
     }
+
+    protected Template findTemplateOrDie(Long templateId, Dataverse dataverse) throws WrappedResponse {
+
+        List<Template> templates = new ArrayList<>();
+
+        templates.addAll(dataverse.getTemplates());
+        templates.addAll(dataverse.getParentTemplates());
+
+        Template template = templates.stream()
+                .filter(t -> Objects.equals(t.getId(), templateId))
+                .findFirst()
+                .orElse(null);
+
+        if (template == null) {
+            throw new WrappedResponse(
+                    error(Response.Status.NOT_FOUND, "Can't find template with identifier='" + templateId + "'"));
+        }
+        return template;
+    }
 
     protected DataverseLinkingDataverse findDataverseLinkingDataverseOrDie(String dataverseId, String linkedDataverseId) throws WrappedResponse {
         DataverseLinkingDataverse dvld;

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

@@ -2031,6 +2031,45 @@ public Response createTemplate(@Context ContainerRequestContext crc, String body
         }
     }
 
+    @POST
+    @AuthRequired
+    @Path("{identifier}/template/default/{templateId}")
+    public Response setDefaultTemplate(@Context ContainerRequestContext crc,
+            @PathParam("identifier") String dvId,
+            @PathParam("templateId") Long templateId) {
+
+        try {
+
+            Dataverse dataverse = findDataverseOrDie(dvId);
+            Template template = findTemplateOrDie(templateId, dataverse);
+            DataverseRequest dvReq = createDataverseRequest(getRequestUser(crc));
+            SetDefaultTemplateCommand command = new SetDefaultTemplateCommand(template, dvReq, dataverse);
+
+            execCommand(command);
+
+            return ok(BundleUtil.getStringFromBundle("dataverse.setDefaultTemplate.success"));
+
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
+
+    @DELETE
+    @AuthRequired
+    @Path("{identifier}/template/default")
+    public Response removeDefaultTemplate(@Context ContainerRequestContext crc,
+            @PathParam("identifier") String dvId) {
+        try {
+            Dataverse dataverse = findDataverseOrDie(dvId);
+            RemoveDefaultTemplateCommand command = new RemoveDefaultTemplateCommand(createDataverseRequest(getRequestUser(crc)), dataverse);
+            execCommand(command);
+            return ok(BundleUtil.getStringFromBundle("dataverse.removeDefaultTemplate.success"));
+        } catch (WrappedResponse e) {
+            return e.getResponse();
+        }
+    }
+
+
     @GET
     @AuthRequired
     @Path("{identifier}/allowedMetadataLanguages")

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

@@ -53,6 +53,7 @@ public Template execute(CommandContext ctxt) throws CommandException {
         if (initialize && createdTemplate.isIsDefaultForDataverse()) {
             dataverse.setDefaultTemplate(createdTemplate);
             ctxt.em().merge(dataverse);
+            ctxt.em().flush();
         }
 
         //Flush so that api response can include the id

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

@@ -0,0 +1,33 @@
+package edu.harvard.iq.dataverse.engine.command.impl;
+
+import edu.harvard.iq.dataverse.*;
+import edu.harvard.iq.dataverse.authorization.Permission;
+
+import edu.harvard.iq.dataverse.engine.command.AbstractCommand;
+import edu.harvard.iq.dataverse.engine.command.CommandContext;
+import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
+import edu.harvard.iq.dataverse.engine.command.RequiredPermissions;
+import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
+
+/** 
+ * @author J.P. Tosca
+ * Removes the default template {@link Template} for a {@link Dataverse}.
+ */
+@RequiredPermissions(Permission.EditDataverse)
+public class RemoveDefaultTemplateCommand extends AbstractCommand<Dataverse>{
+
+    private final Dataverse dataverse;
+
+    public RemoveDefaultTemplateCommand(DataverseRequest request, Dataverse dataverse) {
+        super(request, dataverse);
+        this.dataverse = dataverse;
+    }
+
+    @Override
+    public Dataverse execute(CommandContext ctxt) throws CommandException {
+        dataverse.setDefaultTemplate(null);
+        Dataverse mergedDataverse = ctxt.em().merge(dataverse);
+        return mergedDataverse;
+    }
+
+}

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

@@ -0,0 +1,36 @@
+package edu.harvard.iq.dataverse.engine.command.impl;
+
+import edu.harvard.iq.dataverse.*;
+import edu.harvard.iq.dataverse.authorization.Permission;
+
+import edu.harvard.iq.dataverse.engine.command.AbstractCommand;
+import edu.harvard.iq.dataverse.engine.command.CommandContext;
+import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
+import edu.harvard.iq.dataverse.engine.command.RequiredPermissions;
+import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
+import edu.harvard.iq.dataverse.Template;
+
+/** 
+ * @author J.P. Tosca
+ * Sets a default template {@link Template} for a {@link Dataverse}.
+ */
+@RequiredPermissions(Permission.EditDataverse)
+public class SetDefaultTemplateCommand extends AbstractCommand<Template> {
+
+    private final Template template;
+    private final Dataverse dataverse;
+
+    public SetDefaultTemplateCommand(Template template, DataverseRequest request, Dataverse dataverse) {
+        super(request, dataverse);
+        this.template = template;
+        this.dataverse = dataverse;
+    }
+
+    @Override
+    public Template execute(CommandContext ctxt) throws CommandException {
+        dataverse.setDefaultTemplate(template);
+        ctxt.em().merge(dataverse);
+        return template;
+    }
+
+}

src/main/java/propertyFiles/Bundle.properties

@@ -1042,6 +1042,8 @@ dataverse.update.featuredItems.error.invalidType=Unknown 'type' must be one of {
 dataverse.update.featuredItems.error.typeAndDvObjectMismatch=The 'type' passed does not match the dvObject type.
 dataverse.delete.featuredItems.success=All featured items of this Dataverse have been successfully deleted.
 dataverse.createTemplate.error.jsonParseMetadataFields=Error parsing the POSTed template dataset fields: {0}
+dataverse.setDefaultTemplate.success=The default dataset template has been successfully set for this dataverse.
+dataverse.removeDefaultTemplate.success=The default dataset template has been successfully removed from this dataverse.
 # rolesAndPermissionsFragment.xhtml
 
 # advanced.xhtml