Refactor artifact management

Author: avgustinmm

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/AbstractArtifactRepository.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2025 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact;
 
@@ -18,8 +24,8 @@
 import lombok.extern.slf4j.Slf4j;
 import org.eclipse.hawkbit.repository.artifact.exception.ArtifactStoreException;
 import org.eclipse.hawkbit.repository.artifact.exception.HashNotMatchException;
-import org.eclipse.hawkbit.repository.artifact.model.AbstractDbArtifact;
-import org.eclipse.hawkbit.repository.artifact.model.DbArtifactHash;
+import org.eclipse.hawkbit.repository.artifact.model.StoredArtifactInfo;
+import org.eclipse.hawkbit.repository.artifact.model.ArtifactHashes;
 import org.springframework.util.ObjectUtils;
 
 /**
@@ -34,9 +40,9 @@ public abstract class AbstractArtifactRepository implements ArtifactRepository {
     // suppress warning, of not strong enough hashing algorithm, SHA-1 and MD5 is not used security related
     @SuppressWarnings("squid:S2070")
     @Override
-    public AbstractDbArtifact store(
+    public StoredArtifactInfo store(
             final String tenant, final InputStream content, final String filename, final String contentType,
-            final DbArtifactHash providedHashes) {
+            final ArtifactHashes providedHashes) {
         final MessageDigest mdSHA1;
         final MessageDigest mdMD5;
         final MessageDigest mdSHA256;
@@ -54,19 +60,19 @@ public AbstractDbArtifact store(
 
             final HexFormat hexFormat = HexFormat.of().withLowerCase();
 
-            final String sha1Hash16 = hexFormat.formatHex(mdSHA1.digest());
-            final String md5Hash16 = hexFormat.formatHex(mdMD5.digest());
-            final String sha256Hash16 = hexFormat.formatHex(mdSHA256.digest());
+            final String sha1Hash = hexFormat.formatHex(mdSHA1.digest());
+            final String md5Hash = hexFormat.formatHex(mdMD5.digest());
+            final String sha256Hash = hexFormat.formatHex(mdSHA256.digest());
 
-            checkHashes(providedHashes, sha1Hash16, md5Hash16, sha256Hash16);
+            checkHashes(providedHashes, sha1Hash, md5Hash, sha256Hash);
 
             // Check if file with same sha1 hash exists and if so return it
-            if (existsBySha1(tenant, sha1Hash16)) {
+            if (existsBySha1(tenant, sha1Hash)) {
                 // TODO - shall check if the file is really the same as bytes or just sha1 hash is the same
-                return addMissingHashes(getBySha1(tenant, sha1Hash16), sha1Hash16, md5Hash16, sha256Hash16);
+                return new StoredArtifactInfo(contentType, tempFile.length(), new ArtifactHashes(sha1Hash, md5Hash, sha256Hash));
             }
 
-            return store(sanitizeTenant(tenant), new DbArtifactHash(sha1Hash16, md5Hash16, sha256Hash16), contentType, tempFile);
+            return store(sanitizeTenant(tenant), new ArtifactHashes(sha1Hash, md5Hash, sha256Hash), contentType, tempFile);
         } catch (final IOException e) {
             throw new ArtifactStoreException(e.getMessage(), e);
         } finally {
@@ -98,8 +104,8 @@ protected String storeTempFile(final InputStream content) throws IOException {
         return file.getPath();
     }
 
-    protected abstract AbstractDbArtifact store(final String tenant, final DbArtifactHash base16Hashes,
-            final String contentType, final String tempFile) throws IOException;
+    protected abstract StoredArtifactInfo store(
+            final String tenant, final ArtifactHashes base16Hashes, final String contentType, final String tempFile) throws IOException;
 
     // java:S1066 - more readable with separate "if" statements
     // java:S4042 - delete reason is not needed
@@ -132,8 +138,8 @@ public static File createTempFile(final boolean directory) {
         }
     }
 
-    private static void checkHashes(final DbArtifactHash providedHashes,
-            final String sha1Hash16, final String md5Hash16, final String sha256Hash16) {
+    private static void checkHashes(
+            final ArtifactHashes providedHashes, final String sha1Hash16, final String md5Hash16, final String sha256Hash16) {
         if (providedHashes == null) {
             return;
         }
@@ -161,16 +167,6 @@ private static DigestInputStream wrapInDigestInputStream(final InputStream input
         return new DigestInputStream(new DigestInputStream(new DigestInputStream(input, mdSHA256), mdMD5), mdSHA1);
     }
 
-    private AbstractDbArtifact addMissingHashes(final AbstractDbArtifact existing,
-            final String calculatedSha1, final String calculatedMd5, final String calculatedSha256) {
-        final String sha1 = checkEmpty(existing.getHashes().sha1(), calculatedSha1);
-        final String md5 = checkEmpty(existing.getHashes().md5(), calculatedMd5);
-        final String sha256 = checkEmpty(existing.getHashes().sha256(), calculatedSha256);
-
-        existing.setHashes(new DbArtifactHash(sha1, md5, sha256));
-        return existing;
-    }
-
     private String checkEmpty(final String value, final String fallback) {
         return ObjectUtils.isEmpty(value) ? fallback : value;
     }

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/ArtifactRepository.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2025 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact;
 
@@ -11,8 +17,8 @@
 import org.eclipse.hawkbit.repository.artifact.exception.ArtifactBinaryNotFoundException;
 import org.eclipse.hawkbit.repository.artifact.exception.ArtifactStoreException;
 import org.eclipse.hawkbit.repository.artifact.exception.HashNotMatchException;
-import org.eclipse.hawkbit.repository.artifact.model.AbstractDbArtifact;
-import org.eclipse.hawkbit.repository.artifact.model.DbArtifactHash;
+import org.eclipse.hawkbit.repository.artifact.model.StoredArtifactInfo;
+import org.eclipse.hawkbit.repository.artifact.model.ArtifactHashes;
 
 /**
  * ArtifactRepository service interface.
@@ -32,19 +38,20 @@ public interface ArtifactRepository {
      * @throws ArtifactStoreException in case storing of the artifact was not successful
      * @throws HashNotMatchException in case {@code hash} is provided and not matching to the calculated hashes during storing
      */
-    AbstractDbArtifact store(
+    StoredArtifactInfo store(
             @NotEmpty String tenant, @NotNull InputStream content, @NotEmpty String filename,
-            String contentType, DbArtifactHash hash);
+            String contentType, ArtifactHashes hash);
 
     /**
-     * Retrieves a {@link AbstractDbArtifact} from the store by its SHA1 hash. Throws {@link ArtifactBinaryNotFoundException} if not found.
+     * Retrieves a {@link StoredArtifactInfo} from the store by its SHA1 hash. Throws {@link ArtifactBinaryNotFoundException} if not found.
+     * The caller is responsible to close the InputStream.
      *
      * @param tenant the tenant to store the artifact
      * @param sha1Hash the sha1-hash of the file to lookup.
      * @return The artifact file object or {@code null} if no file exists.
      * @throws UnsupportedOperationException if implementation does not support the operation
      */
-    AbstractDbArtifact getBySha1(@NotEmpty String tenant, @NotEmpty String sha1Hash);
+    InputStream getBySha1(@NotEmpty String tenant, @NotEmpty String sha1Hash);
 
     /**
      * Checks if an artifact exists for a given tenant by its sha1 hash

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/encryption/ArtifactEncryption.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2025 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact.encryption;
 
@@ -55,4 +61,4 @@ public interface ArtifactEncryption {
      * @return encryption overhead in byte
      */
     int encryptionSizeOverhead();
-}
+}

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/encryption/ArtifactEncryptionSecretsStore.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2025 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact.encryption;
 

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/encryption/ArtifactEncryptionService.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2025 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact.encryption;
 
@@ -15,8 +21,7 @@
 import org.springframework.beans.factory.annotation.Autowired;
 
 /**
- * Service responsible for encryption operations. Should be registered as a bean in order its autowired dependencies
- * to be injected.
+ * Service responsible for encryption operations. Should be registered as a bean in order its autowired dependencies to be injected.
  */
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 @SuppressWarnings("java:S6548") // singleton holder ensures static access to spring resources in some places
@@ -105,7 +110,7 @@ public InputStream decryptArtifact(final long id, final InputStream encryptedArt
             throw new ArtifactEncryptionUnsupportedException("Artifact decryption is not supported.");
         }
 
-        final var secrets = getEncryptionSecrets(id);
+        final Map<String, String> secrets = getEncryptionSecrets(id);
         try {
             return artifactEncryption.decryptStream(secrets, encryptedArtifactStream);
         } finally {

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/exception/ArtifactBinaryNoLongerExistsException.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2021 Bosch.IO GmbH and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact.exception;
 

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/exception/ArtifactBinaryNotFoundException.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact.exception;
 

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/exception/ArtifactDeleteFailedException.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact.exception;
 

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/exception/ArtifactEncryptionFailedException.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2025 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact.exception;
 

hawkbit-artifact/hawkbit-artifact-api/src/main/java/org/eclipse/hawkbit/repository/artifact/exception/ArtifactEncryptionUnsupportedException.java

@@ -1,5 +1,11 @@
 /**
- * Copyright (c) 2025 Bosch Digital GmbH, Germany. All rights reserved.
+ * Copyright (c) 2025 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
  */
 package org.eclipse.hawkbit.repository.artifact.exception;