9175 api package

modules/dataverse-parent/pom.xml

@@ -14,6 +14,7 @@
         <module>../../pom.xml</module>
         <module>../../scripts/zipdownload</module>
         <module>../container-base</module>
+        <module>../extension-api</module>
     </modules>
 
     <!-- Transitive dependencies, bigger library "bill of materials" (BOM) and

modules/extension-api/pom.xml

@@ -0,0 +1,80 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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;">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>edu.harvard.iq</groupId>
+        <artifactId>dataverse-parent</artifactId>
+        <version>${revision}</version>
+        <relativePath>../dataverse-parent</relativePath>
+    </parent>
+
+    <groupId>io.gdcc</groupId>
+    <artifactId>extension-api</artifactId>
+    <!--
+            @qqmyers and @poikilotherm discussed the versioning. We found that we should make this independent of
+            the Dataverse release numbers as the APIs might change in their own time and ways. We want to use SemVer
+            because we will have breaking (major) changes, minor changes (additions, etc) or patch changes
+            (docstrings, etc).
+        -->
+    <version>1.0.0-SNAPSHOT</version>
+    <packaging>jar</packaging>
+    <name>Extension API</name>
+    <description>
+        This package provides interfaces, data transfer objects, utilities and so on to create Dataverse extensions.
+        For more information on how to use, please read the developer guide of Dataverse at https://guides.dataverse.org.
+    </description>
+
+    <developers>
+        <developer>
+            <id>poikilotherm</id>
+            <name>Oliver Bertuch</name>
+            <email>[email protected]</email>
+            <timezone>Europe/Berlin</timezone>
+            <roles>
+                <role>maintainer</role>
+            </roles>
+        </developer>
+    </developers>
+
+    <properties>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>jakarta.platform</groupId>
+            <artifactId>jakarta.jakartaee-api</artifactId>
+            <version>${jakartaee-api.version}</version>
+            <scope>provided</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <resources>
+        </resources>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <release>${target.java.version}</release>
+                    <!-- for use with `mvn -DcompilerArgument=-Xlint:unchecked compile` -->
+                    <compilerArgument>${compilerArgument}</compilerArgument>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+                            <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
+                        </manifest>
+                    </archive>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>

src/main/java/edu/harvard/iq/dataverse/export/ExportException.java → modules/extension-api/src/main/java/io/gdcc/dataverse/extension/exceptions/ExportException.java

@@ -3,7 +3,7 @@
  * To change this template file, choose Tools | Templates
  * and open the template in the editor.
  */
-package edu.harvard.iq.dataverse.export;
+package io.gdcc.dataverse.extension.exceptions;
 
 /**
  *

modules/extension-api/src/main/java/io/gdcc/dataverse/extension/spi/Exporter.java

@@ -0,0 +1,41 @@
+/*
+ * To change this license header, choose License Headers in Project Properties.
+ * To change this template file, choose Tools | Templates
+ * and open the template in the editor.
+ */
+package io.gdcc.dataverse.extension.spi;
+
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+
+import javax.json.JsonObject;
+import javax.ws.rs.core.MediaType;
+import java.io.OutputStream;
+
+public interface Exporter {
+
+    void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException;
+
+    String getProviderName();
+
+    String getDisplayName();
+
+    Boolean isXMLFormat();
+
+    Boolean isHarvestable();
+
+    Boolean isAvailableToUsers();
+
+    /* These should throw an ExportException if called on an Exporter that is not isXMLFormat(): */
+    String getXMLNameSpace() throws ExportException;
+
+    String getXMLSchemaLocation() throws ExportException;
+
+    String getXMLSchemaVersion() throws ExportException;
+
+    void setParam(String name, Object value);
+
+    default String getMediaType() {
+        return MediaType.APPLICATION_XML;
+    }
+
+}

pom.xml

@@ -53,6 +53,12 @@
     -->
     <!-- TODO: Housekeeping is utterly needed. -->
     <dependencies>
+
+        <dependency>
+            <groupId>io.gdcc</groupId>
+            <artifactId>extension-api</artifactId>
+            <version>1.0.0-SNAPSHOT</version>
+        </dependency>
 
         <!-- This dependency ensures the lib is on the classpath. That way, anything coming from
              SLF4J should flow through our usual ways of using java.util.logging.
@@ -398,9 +404,7 @@
         <dependency>
             <groupId>com.google.auto.service</groupId>
             <artifactId>auto-service</artifactId>
-            <version>1.0-rc2</version>
-            <optional>true</optional>
-            <type>jar</type>
+            <version>1.0.1</version>
         </dependency>
         <!-- For API File Upload: 1 of 2 -->
         <dependency>

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

@@ -1,5 +1,6 @@
 package edu.harvard.iq.dataverse;
 
+import edu.harvard.iq.dataverse.export.ExportService;
 import edu.harvard.iq.dataverse.provenance.ProvPopupFragmentBean;
 import edu.harvard.iq.dataverse.api.AbstractApiBean;
 import edu.harvard.iq.dataverse.authorization.AuthenticationServiceBean;
@@ -33,9 +34,6 @@
 import edu.harvard.iq.dataverse.engine.command.impl.PublishDatasetCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.PublishDataverseCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.UpdateDatasetVersionCommand;
-import edu.harvard.iq.dataverse.export.ExportException;
-import edu.harvard.iq.dataverse.export.ExportService;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.ingest.IngestRequest;
 import edu.harvard.iq.dataverse.ingest.IngestServiceBean;
 import edu.harvard.iq.dataverse.license.LicenseServiceBean;
@@ -88,6 +86,8 @@
 import javax.inject.Inject;
 import javax.inject.Named;
 
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
 import org.apache.commons.lang3.StringUtils;
 import org.primefaces.event.FileUploadEvent;
 import org.primefaces.model.file.UploadedFile;

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

@@ -22,9 +22,7 @@
 import edu.harvard.iq.dataverse.engine.command.impl.PersistProvFreeFormCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.RestrictFileCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.UpdateDatasetVersionCommand;
-import edu.harvard.iq.dataverse.export.ExportException;
 import edu.harvard.iq.dataverse.export.ExportService;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.externaltools.ExternalTool;
 import edu.harvard.iq.dataverse.externaltools.ExternalToolHandler;
 import edu.harvard.iq.dataverse.externaltools.ExternalToolServiceBean;
@@ -59,6 +57,8 @@
 import javax.inject.Named;
 import javax.validation.ConstraintViolation;
 
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
 import org.primefaces.PrimeFaces;
 import org.primefaces.component.tabview.TabView;
 import org.primefaces.event.TabChangeEvent;
@@ -341,7 +341,7 @@ public List< String[]> getExporters(){
             String formatName = provider[1];
             String formatDisplayName = provider[0];
 
-            Exporter exporter = null; 
+            Exporter exporter = null;
             try {
                 exporter = ExportService.getInstance().getExporter(formatName);
             } catch (ExportException ex) {

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

@@ -30,7 +30,6 @@
 import edu.harvard.iq.dataverse.engine.command.impl.RestrictFileCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.UningestFileCommand;
 import edu.harvard.iq.dataverse.engine.command.impl.UpdateDatasetVersionCommand;
-import edu.harvard.iq.dataverse.export.ExportException;
 import edu.harvard.iq.dataverse.export.ExportService;
 import edu.harvard.iq.dataverse.externaltools.ExternalTool;
 import edu.harvard.iq.dataverse.externaltools.ExternalToolHandler;
@@ -71,6 +70,8 @@
 import javax.ws.rs.core.Response;
 import static javax.ws.rs.core.Response.Status.BAD_REQUEST;
 import javax.ws.rs.core.UriInfo;
+
+import io.gdcc.dataverse.extension.exceptions.ExportException;
 import org.glassfish.jersey.media.multipart.FormDataBodyPart;
 import org.glassfish.jersey.media.multipart.FormDataContentDisposition;
 import org.glassfish.jersey.media.multipart.FormDataParam;

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

@@ -1,13 +1,11 @@
 package edu.harvard.iq.dataverse.engine.command.impl;
 
 import edu.harvard.iq.dataverse.authorization.Permission;
-import edu.harvard.iq.dataverse.datavariable.VarGroup;
 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.engine.command.exception.IllegalCommandException;
-import edu.harvard.iq.dataverse.export.ExportException;
 import edu.harvard.iq.dataverse.export.ExportService;
 import edu.harvard.iq.dataverse.util.BundleUtil;
 import edu.harvard.iq.dataverse.util.DatasetFieldUtil;
@@ -19,8 +17,8 @@
 import edu.harvard.iq.dataverse.FileMetadata;
 import edu.harvard.iq.dataverse.DataFileCategory;
 import edu.harvard.iq.dataverse.DatasetVersionDifference;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
 
-import java.util.Collection;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;

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

@@ -15,15 +15,14 @@
 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.engine.command.exception.IllegalCommandException;
-import edu.harvard.iq.dataverse.export.ExportException;
 import edu.harvard.iq.dataverse.export.ExportService;
-import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
-import edu.harvard.iq.dataverse.util.BundleUtil;
+
 import java.io.IOException;
 import java.util.logging.Logger;
 import edu.harvard.iq.dataverse.batch.util.LoggingUtil;
 import java.util.concurrent.Future;
+
+import io.gdcc.dataverse.extension.exceptions.ExportException;
 import org.apache.solr.client.solrj.SolrServerException;
 
 /**

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

@@ -9,10 +9,10 @@
 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.export.ExportException;
 import edu.harvard.iq.dataverse.export.ExportService;
 import edu.harvard.iq.dataverse.util.EjbUtil;
 import edu.harvard.iq.dataverse.util.FileUtil;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
 
 import java.io.File;
 import java.io.FileOutputStream;

src/main/java/edu/harvard/iq/dataverse/export/DCTermsExporter.java

@@ -2,13 +2,14 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
 import edu.harvard.iq.dataverse.export.dublincore.DublinCoreExportUtil;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
-import java.io.OutputStream;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
 import javax.json.JsonObject;
 import javax.xml.stream.XMLStreamException;
+import java.io.OutputStream;
 
 /**
  *
@@ -30,7 +31,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         try {
             DublinCoreExportUtil.datasetJson2dublincore(json, outputStream, DublinCoreExportUtil.DC_FLAVOR_DCTERMS);
         } catch (XMLStreamException xse) {

src/main/java/edu/harvard/iq/dataverse/export/DDIExporter.java

@@ -2,15 +2,16 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-import edu.harvard.iq.dataverse.DatasetVersion;
 import edu.harvard.iq.dataverse.export.ddi.DdiExportUtil;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
-import java.io.OutputStream;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
 import javax.json.JsonObject;
+import javax.xml.stream.XMLOutputFactory;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.XMLStreamWriter;
-import javax.xml.stream.XMLOutputFactory;
+import java.io.OutputStream;
 
 /**
  * This exporter is for the "full" DDI, that includes the file-level,
@@ -39,7 +40,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream) throws ExportException {
+    public void exportDataset(JsonObject json, OutputStream outputStream) throws ExportException {
         try {
         XMLStreamWriter xmlw = XMLOutputFactory.newInstance().createXMLStreamWriter(outputStream);
         xmlw.writeStartDocument();

src/main/java/edu/harvard/iq/dataverse/export/DataCiteExporter.java

@@ -2,17 +2,17 @@
 package edu.harvard.iq.dataverse.export;
 
 import com.google.auto.service.AutoService;
-
 import edu.harvard.iq.dataverse.DOIDataCiteRegisterService;
 import edu.harvard.iq.dataverse.DataCitation;
-import edu.harvard.iq.dataverse.DatasetVersion;
-import edu.harvard.iq.dataverse.export.spi.Exporter;
 import edu.harvard.iq.dataverse.util.BundleUtil;
+import io.gdcc.dataverse.extension.exceptions.ExportException;
+import io.gdcc.dataverse.extension.spi.Exporter;
+
+import javax.json.JsonObject;
 import java.io.IOException;
 import java.io.OutputStream;
 import java.nio.charset.Charset;
 import java.util.Map;
-import javax.json.JsonObject;
 
 /**
  *
@@ -39,7 +39,7 @@ public String getDisplayName() {
     }
 
     @Override
-    public void exportDataset(DatasetVersion version, JsonObject json, OutputStream outputStream)
+    public void exportDataset(JsonObject json, OutputStream outputStream)
             throws ExportException {
         try {
             DataCitation dc = new DataCitation(version);