Feature/bulk operations

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/registry/core/AasRepository.java

@@ -183,4 +183,37 @@ public interface AasRepository {
      * @throws ResourceNotFoundException if the requested resource does not exist
      */
     public void deleteSubmodel(String submodelId) throws ResourceNotFoundException;
+
+
+    /**
+     * Starts a transaction.
+     */
+    public void startTransaction();
+
+
+    /**
+     * Commits a Transaction.
+     */
+    public void commitTransaction();
+
+
+    /**
+     * Rollback a Transaction.
+     */
+    public void rollbackTransaction();
+
+
+    /**
+     * Returns a value indicating whether a transaction is active.
+     *
+     * @return True when a transaction is active, false otherwise.
+     */
+    public boolean getTransactionActive();
+
+
+    /**
+     * Clears the repos and deletes all descriptors.
+     * Only used for tests!
+     */
+    public void clear();
 }

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/registry/core/exception/ForbiddenException.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2021 Fraunhofer IOSB, eine rechtlich nicht selbstaendige
+ * Einrichtung der Fraunhofer-Gesellschaft zur Foerderung der angewandten
+ * Forschung e.V.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package de.fraunhofer.iosb.ilt.faaast.registry.core.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+
+/**
+ * Exception class for bad request.
+ */
+@ResponseStatus(value = HttpStatus.FORBIDDEN)
+public class ForbiddenException extends RuntimeException {
+
+    public ForbiddenException() {
+        super();
+    }
+
+
+    public ForbiddenException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+
+
+    public ForbiddenException(final String message) {
+        super(message);
+    }
+
+
+    public ForbiddenException(final Throwable cause) {
+        super(cause);
+    }
+}

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/registry/core/exception/InternalServerErrorException.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2021 Fraunhofer IOSB, eine rechtlich nicht selbstaendige
+ * Einrichtung der Fraunhofer-Gesellschaft zur Foerderung der angewandten
+ * Forschung e.V.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package de.fraunhofer.iosb.ilt.faaast.registry.core.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+
+/**
+ * Exception class for bad request.
+ */
+@ResponseStatus(value = HttpStatus.INTERNAL_SERVER_ERROR)
+public class InternalServerErrorException extends RuntimeException {
+
+    public InternalServerErrorException() {
+        super();
+    }
+
+
+    public InternalServerErrorException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+
+
+    public InternalServerErrorException(final String message) {
+        super(message);
+    }
+
+
+    public InternalServerErrorException(final Throwable cause) {
+        super(cause);
+    }
+}

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/registry/core/exception/MovedPermanentlyException.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright (c) 2021 Fraunhofer IOSB, eine rechtlich nicht selbstaendige
+ * Einrichtung der Fraunhofer-Gesellschaft zur Foerderung der angewandten
+ * Forschung e.V.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package de.fraunhofer.iosb.ilt.faaast.registry.core.exception;
+
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+
+/**
+ * Exception class for completed status request.
+ */
+@ResponseStatus(value = HttpStatus.FOUND)
+public class MovedPermanentlyException extends RuntimeException {
+    private final HttpHeaders headers;
+
+    public MovedPermanentlyException() {
+        super();
+        headers = new HttpHeaders();
+    }
+
+
+    public MovedPermanentlyException(final String message, Exception cause) {
+        super(message, cause);
+        headers = new HttpHeaders();
+    }
+
+
+    public MovedPermanentlyException(final Throwable cause) {
+        super(cause);
+        headers = new HttpHeaders();
+    }
+
+
+    public MovedPermanentlyException(final String message, HttpHeaders headers) {
+        super(message);
+        this.headers = headers;
+    }
+
+
+    public HttpHeaders getHeaders() {
+        return headers;
+    }
+}

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/registry/core/exception/UnauthorizedException.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2021 Fraunhofer IOSB, eine rechtlich nicht selbstaendige
+ * Einrichtung der Fraunhofer-Gesellschaft zur Foerderung der angewandten
+ * Forschung e.V.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package de.fraunhofer.iosb.ilt.faaast.registry.core.exception;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.web.bind.annotation.ResponseStatus;
+
+
+/**
+ * Exception class for bad request.
+ */
+@ResponseStatus(value = HttpStatus.UNAUTHORIZED)
+public class UnauthorizedException extends RuntimeException {
+
+    public UnauthorizedException() {
+        super();
+    }
+
+
+    public UnauthorizedException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+
+
+    public UnauthorizedException(final String message) {
+        super(message);
+    }
+
+
+    public UnauthorizedException(final Throwable cause) {
+        super(cause);
+    }
+}

core/src/main/java/de/fraunhofer/iosb/ilt/faaast/registry/core/util/DeepCopyHelper.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2021 Fraunhofer IOSB, eine rechtlich nicht selbstaendige
+ * Einrichtung der Fraunhofer-Gesellschaft zur Foerderung der angewandten
+ * Forschung e.V.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package de.fraunhofer.iosb.ilt.faaast.registry.core.util;
+
+import java.util.HashMap;
+import java.util.Map;
+import org.eclipse.digitaltwin.aas4j.v3.dataformat.core.DeserializationException;
+import org.eclipse.digitaltwin.aas4j.v3.dataformat.core.SerializationException;
+import org.eclipse.digitaltwin.aas4j.v3.dataformat.json.JsonDeserializer;
+import org.eclipse.digitaltwin.aas4j.v3.dataformat.json.JsonSerializer;
+import org.eclipse.digitaltwin.aas4j.v3.model.Descriptor;
+
+
+/**
+ * Helper class with methods to create deep copies.
+ */
+public class DeepCopyHelper {
+
+    private DeepCopyHelper() {}
+
+
+    /**
+     * Create a deep copy of a list of {@link org.eclipse.digitaltwin.aas4j.v3.model.Descriptor} objects.
+     *
+     * @param <T> type of the desriptor.
+     * @param descriptor which should be deep copied.
+     * @param outputClass of the referable.
+     * @return the deep copied descriptor.
+     */
+    public static <T extends Descriptor> T deepCopy(Descriptor descriptor, Class<T> outputClass) {
+        if (outputClass == null) {
+            throw new IllegalArgumentException("outputClass must be non-null");
+        }
+        if ((descriptor != null) && !outputClass.isAssignableFrom(descriptor.getClass())) {
+            throw new IllegalArgumentException(
+                    String.format("type mismatch - can not create deep copy of instance of type %s with target type %s", descriptor.getClass(), outputClass));
+        }
+        try {
+            return new JsonDeserializer().read(new JsonSerializer().write(descriptor), outputClass);
+        }
+        catch (SerializationException | DeserializationException e) {
+            throw new IllegalArgumentException("deep copy of descriptor failed", e);
+        }
+    }
+
+
+    /**
+     * Creates a backup of a map of {@link org.eclipse.digitaltwin.aas4j.v3.model.Descriptor} objects.
+     *
+     * @param <T> type of the desriptor.
+     * @param descriptors the descriptor map.
+     * @return a map with descriptor backups.
+     */
+    public static <T extends Descriptor> Map<String, String> createBackupMap(Map<String, ? extends T> descriptors) {
+        HashMap<String, String> retval = new HashMap<>();
+        for (var entry: descriptors.entrySet()) {
+            retval.put(entry.getKey(), createBackup(entry.getValue()));
+        }
+        return retval;
+    }
+
+
+    /**
+     * restores a map of {@link org.eclipse.digitaltwin.aas4j.v3.model.Descriptor} objects from a backup map..
+     *
+     * @param <T> type of the desriptor.
+     * @param backupDescriptors the descriptor backup map.
+     * @param outputClass of the descriptors
+     * @return a map with the restored descriptors.
+     */
+    public static <T extends Descriptor> Map<String, T> restoreBackupMap(Map<String, String> backupDescriptors, Class<? extends T> outputClass) {
+        HashMap<String, T> retval = new HashMap<>();
+        for (var entry: backupDescriptors.entrySet()) {
+            retval.put(entry.getKey(), restoreBackup(entry.getValue(), outputClass));
+        }
+        return retval;
+    }
+
+
+    private static String createBackup(Descriptor descriptor) {
+        try {
+            return new JsonSerializer().write(descriptor);
+        }
+        catch (SerializationException e) {
+            throw new IllegalArgumentException("create backup of descriptor failed", e);
+        }
+    }
+
+
+    private static <T extends Descriptor> T restoreBackup(String backupDescriptor, Class<T> outputClass) {
+        try {
+            return new JsonDeserializer().read(backupDescriptor, outputClass);
+        }
+        catch (DeserializationException e) {
+            throw new IllegalArgumentException("restore backup of descriptor failed", e);
+        }
+    }
+}

docs/source/api/api.md

@@ -4,6 +4,8 @@ The Registry allows accessing the data via REST-API.
 
 Please be aware, that HTTPS is used.
 
+The Registry uses a configurable API prefix for all API calls. By default, the prefix is "/api/v3.0". The prefix can be changed in the Configuration.
+
 ## Supported API calls
 
 - Asset Administration Shell Registry Interface
@@ -16,12 +18,24 @@ Please be aware, that HTTPS is used.
   - /submodel-descriptors ![GET](https://img.shields.io/badge/GET-blue) ![POST](https://img.shields.io/badge/POST-brightgreen)
   - /submodel-descriptors/{submodelIdentifier} ![GET](https://img.shields.io/badge/GET-blue) ![PUT](https://img.shields.io/badge/PUT-orange) ![DELETE](https://img.shields.io/badge/DELETE-red)
 
+- Description Interface
+  - /description ![GET](https://img.shields.io/badge/GET-blue)
+
 - Discovery Interface
   - /lookup/shells ![GET](https://img.shields.io/badge/GET-blue)
   - /lookup/shells/{aasIdentifier} ![GET](https://img.shields.io/badge/GET-blue) ![POST](https://img.shields.io/badge/POST-orange) ![DELETE](https://img.shields.io/badge/DELETE-red)
 
-- Description Interface
-  - /description ![GET](https://img.shields.io/badge/GET-blue)
+-   Async Bulk Asset Administration Shell Registry API
+    -   /bulk/shell-descriptors ![POST](https://img.shields.io/badge/POST-brightgreen) ![PUT](https://img.shields.io/badge/PUT-orange) ![DELETE](https://img.shields.io/badge/DELETE-red)
+
+-   Async Bulk Submodel Registry API
+    -   /bulk/submodel-descriptors ![POST](https://img.shields.io/badge/POST-brightgreen) ![PUT](https://img.shields.io/badge/PUT-orange) ![DELETE](https://img.shields.io/badge/DELETE-red)
+
+-   Async Bulk Status API
+    -   /bulk/status/{handleId} ![GET](https://img.shields.io/badge/GET-blue)
+
+-   Async Bulk Result API
+    -   /bulk/result/{handleId} ![GET](https://img.shields.io/badge/GET-blue)
 
 ## Example
 

docs/source/changelog/changelog.md

@@ -4,8 +4,9 @@
 
 **New Features & Major Changes**
 - HTTP
-  - Add discovery API (v3.0.1)
-  - Ignore trailing slashes in URLs
+	- Add discovery API (v3.0.1)
+	- Ignore trailing slashes in URLs
+	- Support Async Bulk APIs
 
 **Internal changes & bugfixes**
 - General