Interface for hawkBits repository implementation

.gitignore

@@ -53,3 +53,5 @@ local.properties
 # Maven
 maven.properties
 /*/maven.properties
+
+hawkbit-repository/hawkbit-repository-jpa/.springBeans

examples/hawkbit-custom-theme-example/pom.xml

@@ -79,6 +79,11 @@
          <artifactId>hawkbit-http-security</artifactId>
          <version>${project.version}</version>
       </dependency>
+       <dependency>
+         <groupId>org.eclipse.hawkbit</groupId>
+         <artifactId>hawkbit-repository-jpa</artifactId>
+         <version>${project.version}</version>
+      </dependency>
 
       <!-- Spring -->
       <dependency>

examples/hawkbit-custom-theme-example/src/main/java/org/eclipse/hawkbit/app/Start.java

@@ -8,22 +8,21 @@
  * http://www.eclipse.org/legal/epl-v10.html
  */
 
-import org.eclipse.hawkbit.RepositoryApplicationConfiguration;
+import org.eclipse.hawkbit.EnableJpaRepository;
 import org.eclipse.hawkbit.autoconfigure.security.EnableHawkbitManagedSecurityConfiguration;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.context.annotation.Import;
 
 /**
  * A {@link SpringBootApplication} annotated class with a main method to start.
  * The minimal configuration for the stand alone hawkBit server.
  *
  */
 @SpringBootApplication
-@Import({ RepositoryApplicationConfiguration.class })
 @EnableHawkbitManagedSecurityConfiguration
 // Exception squid:S1118 - Spring boot standard behavior
 @SuppressWarnings({ "squid:S1118" })
+@EnableJpaRepository
 public class Start {
     /**
      * Main method to start the spring-boot application.

examples/hawkbit-device-simulator/pom.xml

@@ -116,23 +116,17 @@
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-autoconfigure</artifactId>
       </dependency>
-      <dependency>
-         <groupId>org.springframework.boot</groupId>
-         <artifactId>spring-boot-autoconfigure</artifactId>
-      </dependency>
       <dependency>
          <groupId>com.google.guava</groupId>
          <artifactId>guava</artifactId>
       </dependency>
       <dependency>
          <groupId>com.netflix.feign</groupId>
          <artifactId>feign-jackson</artifactId>
-         <version>8.14.1</version>
       </dependency>
       <dependency>
          <groupId>com.netflix.feign</groupId>
          <artifactId>feign-core</artifactId>
-         <version>8.12.1</version>
       </dependency>
       <dependency>
          <groupId>com.jayway.jsonpath</groupId>

examples/hawkbit-device-simulator/src/main/java/org/eclipse/hawkbit/simulator/DeviceSimulatorUpdater.java

@@ -236,6 +236,10 @@ private static UpdateStatus downloadUrl(final String url, final String targetTok
                     }
 
                     final File tempFile = File.createTempFile("uploadFile", null);
+
+                    // Exception squid:S2070 - not used for hashing sensitive
+                    // data
+                    @SuppressWarnings("squid:S2070")
                     final MessageDigest md = MessageDigest.getInstance("SHA-1");
 
                     try (final DigestOutputStream dos = new DigestOutputStream(new FileOutputStream(tempFile), md)) {

examples/hawkbit-example-app/pom.xml

@@ -92,6 +92,11 @@
          <artifactId>hawkbit-http-security</artifactId>
          <version>${project.version}</version>
       </dependency>
+       <dependency>
+         <groupId>org.eclipse.hawkbit</groupId>
+         <artifactId>hawkbit-repository-jpa</artifactId>
+         <version>${project.version}</version>
+      </dependency>
 
       <!-- Spring -->
       <dependency>

examples/hawkbit-example-app/src/main/java/org/eclipse/hawkbit/app/Start.java

@@ -8,24 +8,23 @@
  */
 package org.eclipse.hawkbit.app;
 
-import org.eclipse.hawkbit.RepositoryApplicationConfiguration;
+import org.eclipse.hawkbit.EnableJpaRepository;
 import org.eclipse.hawkbit.autoconfigure.security.EnableHawkbitManagedSecurityConfiguration;
 import org.eclipse.hawkbit.ddi.EnableDdiApi;
 import org.eclipse.hawkbit.mgmt.EnableMgmtApi;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.context.annotation.Import;
 
 /**
  * A {@link SpringBootApplication} annotated class with a main method to start.
  * The minimal configuration for the stand alone hawkBit server.
  *
  */
 @SpringBootApplication
-@Import({ RepositoryApplicationConfiguration.class })
 @EnableHawkbitManagedSecurityConfiguration
 @EnableMgmtApi
 @EnableDdiApi
+@EnableJpaRepository
 // Exception squid:S1118 - Spring boot standard behavior
 @SuppressWarnings({ "squid:S1118" })
 public class Start {

examples/hawkbit-example-mgmt-simulator/.gitignore

@@ -1,3 +1,4 @@
 /target/
 /bin/
 /.apt_generated/
+/.springBeans

hawkbit-artifact-repository-mongo/src/main/java/org/eclipse/hawkbit/artifact/repository/ArtifactStore.java

@@ -124,11 +124,9 @@ public DbArtifact store(final InputStream content, final String filename, final
         try {
             LOGGER.debug("storing file {} of content {}", filename, contentType);
             tempFile = File.createTempFile("uploadFile", null);
-            try (final FileOutputStream os = new FileOutputStream(tempFile)) {
-                try (BufferedOutputStream bos = new BufferedOutputStream(os)) {
-                    try (BufferedInputStream bis = new BufferedInputStream(content)) {
-                        return store(content, contentType, bos, tempFile, hash);
-                    }
+            try (final BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(tempFile))) {
+                try (BufferedInputStream bis = new BufferedInputStream(content)) {
+                    return store(bis, contentType, bos, tempFile, hash);
                 }
             }
         } catch (final IOException | MongoException e1) {
@@ -207,6 +205,9 @@ private static String computeSHA1Hash(final InputStream stream, final OutputStre
             throws NoSuchAlgorithmException, IOException {
         String sha1Hash;
         // compute digest
+        // Exception squid:S2070 - not used for hashing sensitive
+        // data
+        @SuppressWarnings("squid:S2070")
         final MessageDigest md = MessageDigest.getInstance("SHA-1");
         try (final DigestOutputStream dos = new DigestOutputStream(os, md)) {
             ByteStreams.copy(stream, dos);

hawkbit-autoconfigure/pom.xml

@@ -46,7 +46,7 @@
       </dependency>
       <dependency>
          <groupId>org.eclipse.hawkbit</groupId>
-         <artifactId>hawkbit-repository</artifactId>
+         <artifactId>hawkbit-repository-jpa</artifactId>
          <version>${project.version}</version>
          <optional>true</optional>
       </dependency>

hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/eventbus/EventBusAutoConfiguration.java

@@ -12,7 +12,7 @@
 
 import org.eclipse.hawkbit.eventbus.EventBusSubscriberProcessor;
 import org.eclipse.hawkbit.eventbus.EventSubscriber;
-import org.eclipse.hawkbit.repository.model.helper.EventBusHolder;
+import org.eclipse.hawkbit.repository.jpa.model.helper.EventBusHolder;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Qualifier;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;

hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/repository/JpaRepositoryAutoConfiguration.java

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2015 Bosch Software Innovations GmbH and others.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.eclipse.hawkbit.autoconfigure.repository;
+
+import org.eclipse.hawkbit.EnableJpaRepository;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+
+/**
+ * Auto-Configuration for enabling the REST-Resources.
+ *
+ */
+@Configuration
+@ConditionalOnClass({ EnableJpaRepository.class })
+@Import({ EnableJpaRepository.class })
+public class JpaRepositoryAutoConfiguration {
+
+}

hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/security/SecurityAutoConfiguration.java

@@ -19,8 +19,8 @@
 import org.eclipse.hawkbit.im.authentication.SpPermission;
 import org.eclipse.hawkbit.im.authentication.TenantAwareAuthenticationDetails;
 import org.eclipse.hawkbit.im.authentication.UserAuthenticationFilter;
-import org.eclipse.hawkbit.security.SecurityContextTenantAware;
 import org.eclipse.hawkbit.security.DdiSecurityProperties;
+import org.eclipse.hawkbit.security.SecurityContextTenantAware;
 import org.eclipse.hawkbit.security.SpringSecurityAuditorAware;
 import org.eclipse.hawkbit.tenancy.TenantAware;
 import org.slf4j.Logger;

hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/configuration/TenantConfigurationKey.java

@@ -30,60 +30,45 @@ public enum TenantConfigurationKey {
     /**
      * boolean value {@code true} {@code false}.
      */
-    AUTHENTICATION_MODE_HEADER_ENABLED("authentication.header.enabled",
-            "hawkbit.server.ddi.security.authentication.header.enabled", Boolean.class, Boolean.FALSE.toString(),
-            TenantConfigurationBooleanValidator.class),
+    AUTHENTICATION_MODE_HEADER_ENABLED("authentication.header.enabled", "hawkbit.server.ddi.security.authentication.header.enabled", Boolean.class, Boolean.FALSE.toString(), TenantConfigurationBooleanValidator.class),
     /**
     *
     */
-    AUTHENTICATION_MODE_HEADER_AUTHORITY_NAME("authentication.header.authority",
-            "hawkbit.server.ddi.security.authentication.header.authority", String.class, Boolean.FALSE.toString(),
-            TenantConfigurationStringValidator.class),
+    AUTHENTICATION_MODE_HEADER_AUTHORITY_NAME("authentication.header.authority", "hawkbit.server.ddi.security.authentication.header.authority", String.class, Boolean.FALSE.toString(), TenantConfigurationStringValidator.class),
     /**
      * boolean value {@code true} {@code false}.
      */
-    AUTHENTICATION_MODE_TARGET_SECURITY_TOKEN_ENABLED("authentication.targettoken.enabled",
-            "hawkbit.server.ddi.security.authentication.targettoken.enabled", Boolean.class, Boolean.FALSE.toString(),
-            TenantConfigurationBooleanValidator.class),
+    AUTHENTICATION_MODE_TARGET_SECURITY_TOKEN_ENABLED("authentication.targettoken.enabled", "hawkbit.server.ddi.security.authentication.targettoken.enabled", Boolean.class, Boolean.FALSE.toString(), TenantConfigurationBooleanValidator.class),
 
     /**
      * boolean value {@code true} {@code false}.
      */
-    AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_ENABLED("authentication.gatewaytoken.enabled",
-            "hawkbit.server.ddi.security.authentication.gatewaytoken.enabled", Boolean.class, Boolean.FALSE.toString(),
-            TenantConfigurationBooleanValidator.class),
+    AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_ENABLED("authentication.gatewaytoken.enabled", "hawkbit.server.ddi.security.authentication.gatewaytoken.enabled", Boolean.class, Boolean.FALSE.toString(), TenantConfigurationBooleanValidator.class),
     /**
      * string value which holds the name of the security token key.
      */
-    AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_NAME("authentication.gatewaytoken.name",
-            "hawkbit.server.ddi.security.authentication.gatewaytoken.name", String.class, null,
-            TenantConfigurationStringValidator.class),
+    AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_NAME("authentication.gatewaytoken.name", "hawkbit.server.ddi.security.authentication.gatewaytoken.name", String.class, null, TenantConfigurationStringValidator.class),
 
     /**
      * string value which holds the actual security-key of the gateway security
      * token.
      */
-    AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_KEY("authentication.gatewaytoken.key",
-            "hawkbit.server.ddi.security.authentication.gatewaytoken.key", String.class, null,
-            TenantConfigurationStringValidator.class),
+    AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_KEY("authentication.gatewaytoken.key", "hawkbit.server.ddi.security.authentication.gatewaytoken.key", String.class, null, TenantConfigurationStringValidator.class),
 
     /**
      * string value which holds the polling time interval in the format HH:mm:ss
      */
-    POLLING_TIME_INTERVAL("pollingTime", "hawkbit.controller.pollingTime", String.class, null,
-            TenantConfigurationPollingDurationValidator.class),
+    POLLING_TIME_INTERVAL("pollingTime", "hawkbit.controller.pollingTime", String.class, null, TenantConfigurationPollingDurationValidator.class),
 
     /**
      * string value which holds the polling time interval in the format HH:mm:ss
      */
-    POLLING_OVERDUE_TIME_INTERVAL("pollingOverdueTime", "hawkbit.controller.pollingOverdueTime", String.class, null,
-            TenantConfigurationPollingDurationValidator.class),
+    POLLING_OVERDUE_TIME_INTERVAL("pollingOverdueTime", "hawkbit.controller.pollingOverdueTime", String.class, null, TenantConfigurationPollingDurationValidator.class),
 
     /**
      * boolean value {@code true} {@code false}.
      */
-    ANONYMOUS_DOWNLOAD_MODE_ENABLED("anonymous.download.enabled", "hawkbit.server.download.anonymous.enabled",
-            Boolean.class, Boolean.FALSE.toString(), TenantConfigurationBooleanValidator.class);
+    ANONYMOUS_DOWNLOAD_MODE_ENABLED("anonymous.download.enabled", "hawkbit.server.download.anonymous.enabled", Boolean.class, Boolean.FALSE.toString(), TenantConfigurationBooleanValidator.class);
 
     private final String keyName;
     private final String defaultKeyName;
@@ -140,8 +125,9 @@ public String getDefaultValue() {
      * @return the data type of the tenant configuration value. (e.g.
      *         Integer.class, String.class)
      */
-    public Class<?> getDataType() {
-        return dataType;
+    @SuppressWarnings("unchecked")
+    public <T> Class<T> getDataType() {
+        return (Class<T>) dataType;
     }
 
     /**

hawkbit-ddi-resource/pom.xml

@@ -38,7 +38,7 @@
       </dependency>
       <dependency>
          <groupId>org.eclipse.hawkbit</groupId>
-         <artifactId>hawkbit-repository</artifactId>
+         <artifactId>hawkbit-repository-api</artifactId>
          <version>${project.version}</version>
       </dependency>
       <dependency>
@@ -48,6 +48,18 @@
 
 
        <!-- Test -->
+       <dependency>
+         <groupId>org.eclipse.hawkbit</groupId>
+         <artifactId>hawkbit-repository-test</artifactId>
+         <version>${project.version}</version>
+         <scope>test</scope>
+      </dependency>
+      <dependency>
+         <groupId>org.eclipse.hawkbit</groupId>
+         <artifactId>hawkbit-repository-jpa</artifactId>
+         <version>${project.version}</version>
+         <scope>test</scope>
+      </dependency>
       <dependency>
          <groupId>org.eclipse.hawkbit</groupId>
          <artifactId>hawkbit-rest-core</artifactId>
@@ -93,7 +105,7 @@
       </dependency>
       <dependency>
          <groupId>org.eclipse.hawkbit</groupId>
-         <artifactId>hawkbit-repository</artifactId>
+         <artifactId>hawkbit-repository-jpa</artifactId>
          <version>${project.version}</version>
          <classifier>tests</classifier>
          <scope>test</scope>

hawkbit-ddi-resource/src/main/java/org/eclipse/hawkbit/ddi/rest/resource/DdiArtifactStoreController.java

@@ -15,10 +15,11 @@
 import javax.servlet.http.HttpServletRequest;
 
 import org.eclipse.hawkbit.artifact.repository.model.DbArtifact;
-import org.eclipse.hawkbit.cache.CacheWriteNotify;
 import org.eclipse.hawkbit.ddi.dl.rest.api.DdiDlArtifactStoreControllerRestApi;
 import org.eclipse.hawkbit.repository.ArtifactManagement;
 import org.eclipse.hawkbit.repository.ControllerManagement;
+import org.eclipse.hawkbit.repository.EntityFactory;
+import org.eclipse.hawkbit.repository.RepositoryConstants;
 import org.eclipse.hawkbit.repository.model.Action;
 import org.eclipse.hawkbit.repository.model.Action.Status;
 import org.eclipse.hawkbit.repository.model.ActionStatus;
@@ -58,15 +59,15 @@ public class DdiArtifactStoreController implements DdiDlArtifactStoreControllerR
     @Autowired
     private ControllerManagement controllerManagement;
 
-    @Autowired
-    private CacheWriteNotify cacheWriteNotify;
-
     @Autowired
     private HawkbitSecurityProperties securityProperties;
 
     @Autowired
     private RequestResponseContextHolder requestResponseContextHolder;
 
+    @Autowired
+    private EntityFactory entityFactory;
+
     @Override
     public ResponseEntity<InputStream> downloadArtifactByFilename(@PathVariable("fileName") final String fileName,
             @AuthenticationPrincipal final String targetid) {
@@ -96,7 +97,8 @@ public ResponseEntity<InputStream> downloadArtifactByFilename(@PathVariable("fil
                         requestResponseContextHolder.getHttpServletRequest(), targetid, artifact);
                 result = RestResourceConversionHelper.writeFileResponse(artifact,
                         requestResponseContextHolder.getHttpServletResponse(),
-                        requestResponseContextHolder.getHttpServletRequest(), file, cacheWriteNotify, action.getId());
+                        requestResponseContextHolder.getHttpServletRequest(), file, controllerManagement,
+                        action.getId());
             } else {
                 result = RestResourceConversionHelper.writeFileResponse(artifact,
                         requestResponseContextHolder.getHttpServletResponse(),
@@ -138,19 +140,19 @@ private Action checkAndReportDownloadByTarget(final HttpServletRequest request,
                 .getActionForDownloadByTargetAndSoftwareModule(target.getControllerId(), artifact.getSoftwareModule());
         final String range = request.getHeader("Range");
 
-        final ActionStatus actionStatus = new ActionStatus();
+        final ActionStatus actionStatus = entityFactory.generateActionStatus();
         actionStatus.setAction(action);
         actionStatus.setOccurredAt(System.currentTimeMillis());
         actionStatus.setStatus(Status.DOWNLOAD);
 
         if (range != null) {
-            actionStatus.addMessage(ControllerManagement.SERVER_MESSAGE_PREFIX + "Target downloads range " + range
+            actionStatus.addMessage(RepositoryConstants.SERVER_MESSAGE_PREFIX + "Target downloads range " + range
                     + " of: " + request.getRequestURI());
         } else {
             actionStatus.addMessage(
-                    ControllerManagement.SERVER_MESSAGE_PREFIX + "Target downloads: " + request.getRequestURI());
+                    RepositoryConstants.SERVER_MESSAGE_PREFIX + "Target downloads: " + request.getRequestURI());
         }
-        controllerManagement.addActionStatusMessage(actionStatus);
+        controllerManagement.addInformationalActionStatus(actionStatus);
         return action;
     }