From fb67d4cc8002316ad91be0d874173f9cc9e7a3fa Mon Sep 17 00:00:00 2001
From: anttil <anttil>
Date: Fri, 17 Mar 2017 12:58:09 +0000
Subject: [PATCH] SSDM-4905: Add method to create PermIds to V3 API
SVN: 37919
---
.../server/asapi/v3/ApplicationServerApi.java | 17 +++++++
.../asapi/v3/ApplicationServerApiLogger.java | 7 +++
.../systemtest/asapi/v3/CreatePermIdTest.java | 46 +++++++++++++++++++
.../asapi/v3/IApplicationServerApi.java | 3 ++
.../v3/dto/dataset/id/ContentCopyPermId.java | 2 +-
5 files changed, 74 insertions(+), 1 deletion(-)
create mode 100644 openbis/sourceTest/java/ch/ethz/sis/openbis/systemtest/asapi/v3/CreatePermIdTest.java
diff --git a/openbis/source/java/ch/ethz/sis/openbis/generic/server/asapi/v3/ApplicationServerApi.java b/openbis/source/java/ch/ethz/sis/openbis/generic/server/asapi/v3/ApplicationServerApi.java
index f2935b701f7..c70e094f80c 100644
--- a/openbis/source/java/ch/ethz/sis/openbis/generic/server/asapi/v3/ApplicationServerApi.java
+++ b/openbis/source/java/ch/ethz/sis/openbis/generic/server/asapi/v3/ApplicationServerApi.java
@@ -266,6 +266,7 @@ import ch.ethz.sis.openbis.generic.asapi.v3.dto.vocabulary.update.UpdateVocabula
import ch.ethz.sis.openbis.generic.asapi.v3.dto.vocabulary.update.VocabularyTermUpdate;
import ch.ethz.sis.openbis.generic.server.asapi.v3.executor.OperationContext;
import ch.ethz.sis.openbis.generic.server.asapi.v3.executor.operation.IExecuteOperationExecutor;
+import ch.systemsx.cisd.common.exceptions.UserFailureException;
import ch.systemsx.cisd.openbis.common.spring.IInvocationLoggerContext;
import ch.systemsx.cisd.openbis.generic.server.AbstractServer;
import ch.systemsx.cisd.openbis.generic.server.business.IPropertiesBatchManager;
@@ -932,4 +933,20 @@ public class ApplicationServerApi extends AbstractServer<IApplicationServerApi>
{
return 2;
}
+
+ @Override
+ public List<String> createPermIdStrings(String sessionToken, int amount)
+ {
+ if (amount > 100)
+ {
+ throw new UserFailureException("Cannot create more than 100 ids in one call (" + amount + " requested)");
+ }
+
+ if (amount <= 0)
+ {
+ throw new UserFailureException("Invalid amount: " + amount);
+ }
+
+ return getDAOFactory().getPermIdDAO().createPermIds(amount);
+ }
}
diff --git a/openbis/source/java/ch/ethz/sis/openbis/generic/server/asapi/v3/ApplicationServerApiLogger.java b/openbis/source/java/ch/ethz/sis/openbis/generic/server/asapi/v3/ApplicationServerApiLogger.java
index 9e9c3077ebd..786ec7628c5 100644
--- a/openbis/source/java/ch/ethz/sis/openbis/generic/server/asapi/v3/ApplicationServerApiLogger.java
+++ b/openbis/source/java/ch/ethz/sis/openbis/generic/server/asapi/v3/ApplicationServerApiLogger.java
@@ -678,4 +678,11 @@ public class ApplicationServerApiLogger extends AbstractServerLogger implements
logAccess(sessionToken, "delete-external-dms", "EXTERNAL_DMS_IDS(%s) DELETION_OPTIONS(%s)", abbreviate(externalDmsIds), deletionOptions);
}
+ @Override
+ public List<String> createPermIdStrings(String sessionToken, int amount)
+ {
+ logAccess(sessionToken, "get-perm-id-strings", Integer.toString(amount));
+ return null;
+ }
+
}
diff --git a/openbis/sourceTest/java/ch/ethz/sis/openbis/systemtest/asapi/v3/CreatePermIdTest.java b/openbis/sourceTest/java/ch/ethz/sis/openbis/systemtest/asapi/v3/CreatePermIdTest.java
new file mode 100644
index 00000000000..d581b939203
--- /dev/null
+++ b/openbis/sourceTest/java/ch/ethz/sis/openbis/systemtest/asapi/v3/CreatePermIdTest.java
@@ -0,0 +1,46 @@
+package ch.ethz.sis.openbis.systemtest.asapi.v3;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import org.testng.annotations.DataProvider;
+import org.testng.annotations.Test;
+
+import ch.systemsx.cisd.common.exceptions.UserFailureException;
+
+public class CreatePermIdTest extends AbstractTest
+{
+
+ @Test
+ public void correctAmountOfUniqueIdsGenerated()
+ {
+ String session = v3api.login(TEST_USER, PASSWORD);
+ List<String> batch1 = v3api.createPermIdStrings(session, 3);
+ List<String> batch2 = v3api.createPermIdStrings(session, 5);
+
+ Set<String> both = new HashSet<>();
+ both.addAll(batch1);
+ both.addAll(batch2);
+
+ assertThat(batch1.size(), is(3));
+ assertThat(batch2.size(), is(5));
+ assertThat(both.size(), is(8));
+ }
+
+ @DataProvider(name = "InvalidAmounts")
+ public static Object[][] invalidAmounts()
+ {
+ return new Object[][] { { Integer.MIN_VALUE }, { -1000 }, { -1 }, { 0 }, { 1000 }, { Integer.MAX_VALUE } };
+ }
+
+ @Test(dataProvider = "InvalidAmounts", expectedExceptions = UserFailureException.class)
+ public void cannotCreateTooManyOrNonPositive(int amount)
+ {
+ String session = v3api.login(TEST_USER, PASSWORD);
+ v3api.createPermIdStrings(session, amount);
+ }
+}
diff --git a/openbis_api/source/java/ch/ethz/sis/openbis/generic/asapi/v3/IApplicationServerApi.java b/openbis_api/source/java/ch/ethz/sis/openbis/generic/asapi/v3/IApplicationServerApi.java
index ddb176ef6a4..7d5d060e15c 100644
--- a/openbis_api/source/java/ch/ethz/sis/openbis/generic/asapi/v3/IApplicationServerApi.java
+++ b/openbis_api/source/java/ch/ethz/sis/openbis/generic/asapi/v3/IApplicationServerApi.java
@@ -332,4 +332,7 @@ public interface IApplicationServerApi extends IRpcService
IOperationExecutionOptions options);
public Map<String, String> getServerInformation(String sessionToken);
+
+ @TechPreview
+ public List<String> createPermIdStrings(String sessionToken, int amount);
}
diff --git a/openbis_api/source/java/ch/ethz/sis/openbis/generic/asapi/v3/dto/dataset/id/ContentCopyPermId.java b/openbis_api/source/java/ch/ethz/sis/openbis/generic/asapi/v3/dto/dataset/id/ContentCopyPermId.java
index 265b849ada7..f54bc03d928 100644
--- a/openbis_api/source/java/ch/ethz/sis/openbis/generic/asapi/v3/dto/dataset/id/ContentCopyPermId.java
+++ b/openbis_api/source/java/ch/ethz/sis/openbis/generic/asapi/v3/dto/dataset/id/ContentCopyPermId.java
@@ -10,7 +10,7 @@ public class ContentCopyPermId extends ObjectPermId implements IContentCopyId
private static final long serialVersionUID = 1L;
/**
- * @param permId Data set perm id, e.g. "201108050937246-1031".
+ * @param permId Content copy perm id
*/
public ContentCopyPermId(String permId)
{
--
GitLab