v1 to v2 migration guide + other minor changes

Author: mKowalski256

CHANGELOG.md

@@ -1,7 +1,8 @@
 Significant changes since 0.1.0
 
-2.0.0 2026-03-09
-- feature: remove SWORD protocol dependency and upload option
+2.0.0 2026-03-16
+- breaking change: removed SWORD dependency and sword-related upload methods from DatasetOperations interface; more details in [Migration Guide](Migration_Guide_V1_to_V2.md)
+- dependencies: minor version updates of `commons-lang3`, `commons-io` and `spring` versions
 
 1.4.2 2026-02-25
 

Contributors.md

@@ -1,4 +1,4 @@
 ## Contributors
 
 Initial code contribution: Richard Adams (otter606).
-PRs and contributions: Aleix Mariné Tena (AleixMT)
+PRs and contributions: Aleix Mariné Tena (AleixMT), Kukucska Ákos (akos326)

Migration_Guide_V1_to_V2.md

@@ -0,0 +1,16 @@
+Version 2.0.0. removes the SWORD protocol as an upload mechanism.
+
+* SWORD library (`org.swordapp:sword2-client`) is no longer a dependency of the project.
+
+* `com.researchspace.dataverse.api.v1.DatasetOperations` interface and `DataverseOperationsImplV1`
+  implementation no longer provide `uploadFile()` methods. Use `uploadNativeFile()` methods instead.
+
+* `com.researchspace.dataverse.sword.FileUploader` was removed.
+
+For example usage of `uploadNativeFile()` method you can check implementation
+of [DataverseRSpaceRepository.java](https://github.com/rspace-os/rspace-dataverse-adapter/blob/main/src/main/java/com/researchspace/dataverse/rspaceadapter/DataverseRSpaceRepository.java)
+within [rspace-dataverse-adapter](https://github.com/rspace-os/rspace-dataverse-adapter) project.
+
+If you need to use old SWORD upload you can still use version 1.4.2, which is available on JitPack
+or buildable via git history.
+

Readme.md

@@ -3,10 +3,7 @@
 This project is a Java wrapper around the [Dataverse  API](http://guides.dataverse.org/en/4.2/api/).  
 It was initially contributed by [ResearchSpace](www.researchspace.com) in October 2016.
 
-## Version 2
-Version 2 removes the SWORD protocol as an upload mechanism. 
-
-If you make use of SWORD, you can still use version 1.X, which is available on JitPack or buildable via git history.
+Version 2.0.0 released in March 2026 no longer depends on SWORD protocol libs - see the [migration guide](Migration_Guide_V1_to_V2.md) for more details.
 
 ## Building 
 
@@ -61,7 +58,7 @@ If using Maven, add this to your pom.xml file (thanks AleixMT).
 
 <dependencies>
   <dependency>
-    <groupId>com.github.rspace-os</groupId>
+    <groupId>com.github.iqss</groupId>
     <artifactId>dataverse-client-java</artifactId>
     <version>v2.0.0</version>
   </dependency>
@@ -124,7 +121,7 @@ There are [instructions](https://projectlombok.org/features/index.html) on how t
 
 ### Coding standards
 
-Please make sure tests pass before committing, and to add new tests for new additions.
+Please make sure tests pass before committing, and add new tests for new additions.
 
 ## Progress
 

build.gradle

@@ -4,10 +4,10 @@ plugins {
 
 apply plugin: 'java'
 
-group = 'com.github.rspace-os'
+group = 'com.github.iqss'
 sourceCompatibility = 1.8
 version = 'v2.0.0'
-def springVersion='5.3.24'
+def springVersion='5.3.39'
 def jacksonVersion='2.20.0'
 def jacksonAnnotationsVersion='2.20'
 def lombokVersion='1.18.24'
@@ -84,7 +84,7 @@ task listJars {
 publishing {
     publications {
         maven(MavenPublication) {
-            groupId = 'com.github.rspace-os'
+            groupId = 'com.github.iqss'
             artifactId = 'dataverse-client-java'
 
             from components.java

src/main/java/com/researchspace/dataverse/http/DataverseOperationsImplV1.java

@@ -3,18 +3,36 @@
  */
 package com.researchspace.dataverse.http;
 
+import static org.apache.commons.lang3.StringUtils.isEmpty;
+import static org.apache.commons.lang3.Validate.isTrue;
+import static org.apache.commons.lang3.Validate.noNullElements;
+
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
 import com.researchspace.dataverse.api.v1.DatasetOperations;
 import com.researchspace.dataverse.api.v1.DataverseOperations;
 import com.researchspace.dataverse.api.v1.InfoOperations;
 import com.researchspace.dataverse.api.v1.MetadataOperations;
-import com.researchspace.dataverse.entities.*;
+import com.researchspace.dataverse.entities.Dataset;
+import com.researchspace.dataverse.entities.DatasetFileList;
+import com.researchspace.dataverse.entities.DatasetVersion;
+import com.researchspace.dataverse.entities.DataverseGet;
+import com.researchspace.dataverse.entities.DataverseObject;
+import com.researchspace.dataverse.entities.DataversePost;
+import com.researchspace.dataverse.entities.DataverseResponse;
+import com.researchspace.dataverse.entities.DvMessage;
+import com.researchspace.dataverse.entities.Identifier;
+import com.researchspace.dataverse.entities.MetadataBlock;
+import com.researchspace.dataverse.entities.PublishedDataset;
+import com.researchspace.dataverse.entities.Version;
 import com.researchspace.dataverse.entities.facade.DatasetBuilder;
 import com.researchspace.dataverse.entities.facade.DatasetFacade;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.List;
+import java.util.Map;
 import lombok.extern.slf4j.Slf4j;
-import org.apache.commons.lang3.StringUtils;
 import org.springframework.core.ParameterizedTypeReference;
 import org.springframework.core.io.AbstractResource;
 import org.springframework.core.io.ByteArrayResource;
@@ -24,17 +42,7 @@
 import org.springframework.http.HttpMethod;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.MultiValueMap;
-import org.springframework.web.client.RestClientException;
 
-import java.io.*;
-import java.net.URI;
-import java.net.URISyntaxException;
-import java.util.List;
-import java.util.Map;
-
-import static org.apache.commons.lang3.StringUtils.isEmpty;
-import static org.apache.commons.lang3.Validate.isTrue;
-import static org.apache.commons.lang3.Validate.noNullElements;
 /**  Copyright 2016 ResearchSpace
 
 Licensed under the Apache License, Version 2.0 (the "License");
@@ -53,9 +61,6 @@
 @Slf4j
 public class DataverseOperationsImplV1 extends AbstractOpsImplV1 implements DatasetOperations, MetadataOperations, InfoOperations, DataverseOperations {
 
-	
-
-
 	/* (non-Javadoc)
 	 * @see com.researchspace.dataverse.http.DataverseAPI#getDataverseById(java.lang.String)
 	 */
@@ -87,7 +92,6 @@ public DataverseResponse<DvMessage> deleteDataverse(String dataverseAlias) {
 		ResponseEntity<DataverseResponse<DvMessage>> resp = template.exchange(url, HttpMethod.DELETE, entity, type);
 		log.debug(resp.getBody().toString());
 		return resp.getBody();
-		
 	}
 
 	@Override
@@ -98,7 +102,6 @@ public DataverseResponse<DataversePost> createNewDataverse(String parentDv, Data
 		isTrue(!isEmpty(toCreate.getAlias()), "Alias must be specified");
 		String url = createV1Url("dataverses", parentDv);
 
-		
 		String json = marshalDataset(toCreate);
 		HttpEntity<String> entity = createHttpEntity(json);
 		ParameterizedTypeReference<DataverseResponse<DataversePost>> type = new ParameterizedTypeReference<DataverseResponse<DataversePost>>() {
@@ -107,7 +110,6 @@ public DataverseResponse<DataversePost> createNewDataverse(String parentDv, Data
 		log.debug(resp.getBody().toString());
 		handleError(resp);
 		return resp.getBody();
-		
 	}
 
 	/* (non-Javadoc)
@@ -139,7 +141,6 @@ public Identifier createDataset(String dataSetJson, String dataverseAlias)  {
 		return resp.getBody().getData();
 	}
 
-
 	/* (non-Javadoc)
 	 * @see com.researchspace.dataverse.http.DataverseAPI#updateDataset(com.researchspace.dataverse.entities.facade.DatasetFacade, com.researchspace.dataverse.entities.Identifier)
 	 */
@@ -150,15 +151,13 @@ public DatasetVersion updateDataset(DatasetFacade facade, Identifier id) {
 		Dataset ds = new DatasetBuilder().build(facade);
 		String json = marshalDataset(ds.getDatasetVersion());
 
-		
 		HttpEntity<String> entity = createHttpEntity(json);
 		ParameterizedTypeReference<DataverseResponse<DatasetVersion>> type = new ParameterizedTypeReference<DataverseResponse<DatasetVersion>>() {
 		};
 		ResponseEntity<DataverseResponse<DatasetVersion>> resp = template.exchange(url, HttpMethod.PUT, entity,type);
 
 		handleError(resp);
 		return resp.getBody().getData();
-		
 	}
 
 	/* (non-Javadoc)
@@ -216,7 +215,6 @@ public long contentLength() throws IOException {
 			}
 		};
 		return getDatasetFileList(metadata, dsIdentifier,  resource);
-
 	}
 
 	private DatasetFileList getDatasetFileList(FileUploadMetadata metadata, Identifier dsIdentifier, AbstractResource resource) {
@@ -329,8 +327,6 @@ public MetadataBlock getMetadataById(String name) {
 		return resp.getBody().getData();
 	}
 
-	
-
 	/* (non-Javadoc)
 	 * @see com.researchspace.dataverse.http.DataverseAPI#publishDataset(com.researchspace.dataverse.entities.Identifier, com.researchspace.dataverse.entities.Version)
 	 */
@@ -345,7 +341,6 @@ public DataverseResponse<PublishedDataset> publishDataset(Identifier dsIdentifie
 		ResponseEntity<DataverseResponse<PublishedDataset>> resp = template.exchange(url, HttpMethod.POST, entity, type);
 		log.debug(resp.getBody().toString());
     	return resp.getBody();
-		
 	}
 
 	@Override
@@ -357,7 +352,6 @@ public DataverseResponse<DataversePost> publishDataverse(String dvName) {
 		ResponseEntity<DataverseResponse<DataversePost>> resp = template.exchange(url, HttpMethod.POST, entity, type);
 		log.debug(resp.getBody().toString());
 		return resp.getBody();
-		
 	}
 
 	@Override
@@ -369,7 +363,6 @@ public DvMessage getDatasetPublishPopupCustomText() {
 		ResponseEntity<DataverseResponse<DvMessage>> resp = template.exchange(url, HttpMethod.GET, entity, type);
 		log.debug(resp.getBody().toString());
 		return resp.getBody().getData();
-		
 	}
 
 	@Override
@@ -393,6 +386,6 @@ public DataverseResponse<List<Map<String, String>>> getDataverseMetadataLanguage
 				entity, type);
 		log.debug(resp.getBody().toString());
 		return resp.getBody();
-
 	}
+
 }