Modular hawkBit (#378)

* Cleaned up component scan
* More flexibility for hawkBit micro services
* Introduce spring boot starters
* Eclipse Jetty as hawkBit default
* Fixed links as prep for wiki removal

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/amqp/DmfApiAutoConfiguration.java

@@ -8,25 +8,22 @@
  */
 package org.eclipse.hawkbit.autoconfigure.amqp;
 
-import org.eclipse.hawkbit.amqp.AmqpConfiguration;
-import org.eclipse.hawkbit.amqp.annotation.EnableAmqp;
+import org.eclipse.hawkbit.amqp.DmfApiConfiguration;
 import org.springframework.amqp.rabbit.listener.ConditionalRejectingErrorHandler;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 import org.springframework.util.ErrorHandler;
 
 /**
- * The amqp autoconfiguration.
- *
- *
- *
+ * The AMQP 0.9 based device Management Federation API (DMF) auto configuration.
  */
 @Configuration
-@ConditionalOnClass(value = AmqpConfiguration.class)
-@EnableAmqp
-public class AmqpAutoConfiguration {
+@ConditionalOnClass(DmfApiConfiguration.class)
+@Import(DmfApiConfiguration.class)
+public class DmfApiAutoConfiguration {
 
     /**
      * Create default error handler bean.

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

@@ -8,29 +8,21 @@
  */
 package org.eclipse.hawkbit.autoconfigure.repository;
 
-import org.eclipse.hawkbit.artifact.repository.ArtifactFilesystemProperties;
+import org.eclipse.hawkbit.artifact.repository.ArtifactFilesystemConfiguration;
 import org.eclipse.hawkbit.artifact.repository.ArtifactFilesystemRepository;
 import org.eclipse.hawkbit.artifact.repository.ArtifactRepository;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
-import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 
 /**
  * Auto configuration for the {@link ArtifactFilesystemRepository}.
  */
 @Configuration
 @ConditionalOnMissingBean(ArtifactRepository.class)
-@EnableConfigurationProperties(ArtifactFilesystemProperties.class)
-public class ArtifactStoreAutoConfiguration {
+@ConditionalOnClass({ ArtifactFilesystemConfiguration.class })
+@Import(ArtifactFilesystemConfiguration.class)
+public class ArtifactFilesystemAutoConfiguration {
 
-    /**
-     * @param artifactFilesystemProperties
-     *            the artifact file system properties
-     * @return Default {@link ArtifactRepository} implementation.
-     */
-    @Bean
-    public ArtifactRepository artifactRepository(final ArtifactFilesystemProperties artifactFilesystemProperties) {
-        return new ArtifactFilesystemRepository(artifactFilesystemProperties);
-    }
 }

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

@@ -8,7 +8,7 @@
  */
 package org.eclipse.hawkbit.autoconfigure.repository;
 
-import org.eclipse.hawkbit.EnableJpaRepository;
+import org.eclipse.hawkbit.repository.jpa.RepositoryApplicationConfiguration;
 import org.eclipse.hawkbit.repository.rsql.VirtualPropertyReplacer;
 import org.eclipse.hawkbit.repository.rsql.VirtualPropertyResolver;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -22,8 +22,8 @@ import org.springframework.context.annotation.Import;
  *
  */
 @Configuration
-@ConditionalOnClass({ EnableJpaRepository.class })
-@Import({ EnableJpaRepository.class })
+@ConditionalOnClass({ RepositoryApplicationConfiguration.class })
+@Import({ RepositoryApplicationConfiguration.class })
 public class JpaRepositoryAutoConfiguration {
 
     /**

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

@@ -10,8 +10,11 @@ package org.eclipse.hawkbit.autoconfigure.security;
 
 import org.eclipse.hawkbit.im.authentication.PermissionService;
 import org.eclipse.hawkbit.security.DdiSecurityProperties;
+import org.eclipse.hawkbit.security.HawkbitSecurityProperties;
 import org.eclipse.hawkbit.security.SecurityContextTenantAware;
+import org.eclipse.hawkbit.security.SecurityTokenGenerator;
 import org.eclipse.hawkbit.security.SpringSecurityAuditorAware;
+import org.eclipse.hawkbit.security.SystemSecurityContext;
 import org.eclipse.hawkbit.tenancy.TenantAware;
 import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -22,12 +25,9 @@ import org.springframework.data.domain.AuditorAware;
 
 /**
  * {@link EnableAutoConfiguration Auto-configuration} for security.
- * 
- *
- *
  */
 @Configuration
-@EnableConfigurationProperties(DdiSecurityProperties.class)
+@EnableConfigurationProperties({ DdiSecurityProperties.class, HawkbitSecurityProperties.class })
 public class SecurityAutoConfiguration {
 
     /**
@@ -62,4 +62,24 @@ public class SecurityAutoConfiguration {
         return new SpringSecurityAuditorAware();
     }
 
+    /**
+     * @param tenantAware
+     *            singleton bean
+     * @return tenantAware {@link SystemSecurityContext}
+     */
+    @Bean
+    @ConditionalOnMissingBean
+    public SystemSecurityContext systemSecurityContext(final TenantAware tenantAware) {
+        return new SystemSecurityContext(tenantAware);
+    }
+
+    /**
+     * @return {@link SecurityTokenGenerator} bean
+     */
+    @Bean
+    @ConditionalOnMissingBean
+    public SecurityTokenGenerator securityTokenGenerator() {
+        return new SecurityTokenGenerator();
+    }
+
 }

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

@@ -22,19 +22,21 @@ import javax.servlet.ServletException;
 import javax.servlet.ServletRequest;
 import javax.servlet.ServletResponse;
 
-import org.eclipse.hawkbit.ExcludePathAwareShallowETagFilter;
 import org.eclipse.hawkbit.cache.DownloadIdCache;
+import org.eclipse.hawkbit.ddi.rest.resource.DdiApiConfiguration;
 import org.eclipse.hawkbit.im.authentication.SpPermission;
 import org.eclipse.hawkbit.im.authentication.SpPermission.SpringEvalExpressions;
 import org.eclipse.hawkbit.im.authentication.TenantUserPasswordAuthenticationToken;
 import org.eclipse.hawkbit.im.authentication.UserAuthenticationFilter;
 import org.eclipse.hawkbit.mgmt.rest.api.MgmtRestConstants;
+import org.eclipse.hawkbit.mgmt.rest.resource.MgmtApiConfiguration;
 import org.eclipse.hawkbit.repository.ControllerManagement;
 import org.eclipse.hawkbit.repository.SystemManagement;
 import org.eclipse.hawkbit.repository.TenantConfigurationManagement;
 import org.eclipse.hawkbit.security.ControllerTenantAwareAuthenticationDetailsSource;
 import org.eclipse.hawkbit.security.DdiSecurityProperties;
 import org.eclipse.hawkbit.security.DosFilter;
+import org.eclipse.hawkbit.security.ExcludePathAwareShallowETagFilter;
 import org.eclipse.hawkbit.security.HawkbitSecurityProperties;
 import org.eclipse.hawkbit.security.HttpControllerPreAuthenticateAnonymousDownloadFilter;
 import org.eclipse.hawkbit.security.HttpControllerPreAuthenticateSecurityTokenFilter;
@@ -44,9 +46,11 @@ import org.eclipse.hawkbit.security.HttpDownloadAuthenticationFilter;
 import org.eclipse.hawkbit.security.PreAuthTokenSourceTrustAuthenticationProvider;
 import org.eclipse.hawkbit.security.SystemSecurityContext;
 import org.eclipse.hawkbit.tenancy.TenantAware;
+import org.eclipse.hawkbit.ui.MgmtUiConfiguration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.autoconfigure.security.SecurityProperties;
 import org.springframework.boot.context.embedded.FilterRegistrationBean;
@@ -96,9 +100,6 @@ public class SecurityManagedConfiguration {
 
     private static final Logger LOG = LoggerFactory.getLogger(SecurityManagedConfiguration.class);
 
-    @Autowired
-    private HawkbitSecurityProperties securityProperties;
-
     @Autowired
     private AuthenticationConfiguration configuration;
 
@@ -131,6 +132,7 @@ public class SecurityManagedConfiguration {
      */
     @Configuration
     @Order(300)
+    @ConditionalOnClass(DdiApiConfiguration.class)
     static class ControllerSecurityConfigurationAdapter extends WebSecurityConfigurerAdapter {
 
         @Autowired
@@ -151,6 +153,26 @@ public class SecurityManagedConfiguration {
         @Autowired
         private SystemSecurityContext systemSecurityContext;
 
+        /**
+         * Filter to protect the hawkBit server DDI interface against to many
+         * requests.
+         * 
+         * @param securityProperties
+         *            for filter configuration
+         *
+         * @return the spring filter registration bean for registering a denial
+         *         of service protection filter in the filter chain
+         */
+        @Bean
+        @ConditionalOnClass(DdiApiConfiguration.class)
+        public FilterRegistrationBean dosDDiFilter(final HawkbitSecurityProperties securityProperties) {
+
+            final FilterRegistrationBean filterRegBean = dosFilter(securityProperties);
+            filterRegBean.addUrlPatterns("/{tenant}/controller/v1/**");
+
+            return filterRegBean;
+        }
+
         @Override
         protected void configure(final HttpSecurity http) throws Exception {
 
@@ -221,14 +243,26 @@ public class SecurityManagedConfiguration {
     }
 
     /**
-     * Filter to protect the SP server against denial of service attacks.
+     * Filter to protect the hawkBit server system management interface against
+     * to many requests.
+     * 
+     * @param securityProperties
+     *            for filter configuration
      *
-     * @return he spring filter registration bean for registering an denial of
+     * @return the spring filter registration bean for registering a denial of
      *         service protection filter in the filter chain
      */
     @Bean
-    @Order(50)
-    public FilterRegistrationBean dosFilter() {
+    @Order(52)
+    public FilterRegistrationBean dosSystemFilter(final HawkbitSecurityProperties securityProperties) {
+
+        final FilterRegistrationBean filterRegBean = dosFilter(securityProperties);
+        filterRegBean.addUrlPatterns("/system/*");
+
+        return filterRegBean;
+    }
+
+    private static FilterRegistrationBean dosFilter(final HawkbitSecurityProperties securityProperties) {
 
         final FilterRegistrationBean filterRegBean = new FilterRegistrationBean();
 
@@ -236,7 +270,6 @@ public class SecurityManagedConfiguration {
                 securityProperties.getDos().getFilter().getMaxWrite(),
                 securityProperties.getDos().getFilter().getWhitelist(), securityProperties.getClients().getBlacklist(),
                 securityProperties.getClients().getRemoteIpHeader()));
-        filterRegBean.addUrlPatterns("/{tenant}/controller/v1/*", "/rest/*");
 
         return filterRegBean;
     }
@@ -268,6 +301,7 @@ public class SecurityManagedConfiguration {
      */
     @Configuration
     @Order(350)
+    @ConditionalOnClass(MgmtApiConfiguration.class)
     public static class RestSecurityConfigurationAdapter extends WebSecurityConfigurerAdapter {
 
         @Autowired
@@ -276,15 +310,31 @@ public class SecurityManagedConfiguration {
         @Autowired
         private SystemManagement systemManagement;
 
-        @Autowired
-        private TenantAware tenantAware;
-
         @Autowired
         private SecurityProperties springSecurityProperties;
 
         @Autowired
         private SystemSecurityContext systemSecurityContext;
 
+        /**
+         * Filter to protect the hawkBit server Management interface against to
+         * many requests.
+         * 
+         * @param securityProperties
+         *            for filter configuration
+         *
+         * @return the spring filter registration bean for registering a denial
+         *         of service protection filter in the filter chain
+         */
+        @Bean
+        public FilterRegistrationBean dosMgmtFilter(final HawkbitSecurityProperties securityProperties) {
+
+            final FilterRegistrationBean filterRegBean = dosFilter(securityProperties);
+            filterRegBean.addUrlPatterns("/rest/**");
+
+            return filterRegBean;
+        }
+
         @Override
         protected void configure(final HttpSecurity http) throws Exception {
 
@@ -330,6 +380,7 @@ public class SecurityManagedConfiguration {
     @Configuration
     @Order(400)
     @EnableVaadinSecurity
+    @ConditionalOnClass(MgmtUiConfiguration.class)
     public static class UISecurityConfigurationAdapter extends WebSecurityConfigurerAdapter {
         @Autowired
         private VaadinSecurityContext vaadinSecurityContext;
@@ -417,8 +468,7 @@ public class SecurityManagedConfiguration {
 
         @Override
         public void configure(final WebSecurity webSecurity) throws Exception {
-            webSecurity.ignoring().antMatchers("/documentation/**", "/VAADIN/**", "/*.*", "/v2/api-docs/**",
-                    "/docs/**");
+            webSecurity.ignoring().antMatchers("/documentation/**", "/VAADIN/**", "/*.*", "/docs/**");
         }
     }
 
@@ -428,6 +478,7 @@ public class SecurityManagedConfiguration {
     @Configuration
     @EnableWebSecurity
     @Order(200)
+    @ConditionalOnClass(DdiApiConfiguration.class)
     public static class IdRestSecurityConfigurationAdapter extends WebSecurityConfigurerAdapter {
 
         @Autowired

hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/ui/UIAutoConfiguration.java

@@ -11,14 +11,17 @@ package org.eclipse.hawkbit.autoconfigure.ui;
 import java.util.concurrent.ScheduledExecutorService;
 
 import org.eclipse.hawkbit.DistributedResourceBundleMessageSource;
+import org.eclipse.hawkbit.ui.MgmtUiConfiguration;
 import org.eclipse.hawkbit.ui.push.DelayedEventBusPushStrategy;
 import org.eclipse.hawkbit.ui.push.EventPushStrategy;
 import org.eclipse.hawkbit.ui.push.HawkbitEventProvider;
 import org.eclipse.hawkbit.ui.push.UIEventProvider;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
 import org.vaadin.spring.annotation.EnableVaadinExtensions;
 import org.vaadin.spring.events.EventBus.UIEventBus;
 import org.vaadin.spring.events.annotation.EnableEventBus;
@@ -33,6 +36,8 @@ import com.vaadin.spring.annotation.UIScope;
 @EnableVaadinSecurity
 @EnableVaadinExtensions
 @EnableEventBus
+@ConditionalOnClass(MgmtUiConfiguration.class)
+@Import(MgmtUiConfiguration.class)
 public class UIAutoConfiguration {
 
     /**

hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/web/DDiApiAutoConfiguration.java

@@ -8,19 +8,18 @@
  */
 package org.eclipse.hawkbit.autoconfigure.web;
 
-import org.eclipse.hawkbit.ddi.EnableDdiApi;
-import org.eclipse.hawkbit.mgmt.EnableMgmtApi;
+import org.eclipse.hawkbit.ddi.rest.resource.DdiApiConfiguration;
 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.
+ * Auto-Configuration for enabling the DDI REST-Resources.
  *
  */
 @Configuration
-@ConditionalOnClass({ EnableDdiApi.class, EnableMgmtApi.class })
-@Import({ EnableDdiApi.class, EnableMgmtApi.class })
-public class ResourceControllerAutoConfiguration {
+@ConditionalOnClass(DdiApiConfiguration.class)
+@Import(DdiApiConfiguration.class)
+public class DDiApiAutoConfiguration {
 
 }

hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/web/MgmtApiAutoConfiguration.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.web;
+
+import org.eclipse.hawkbit.mgmt.rest.resource.MgmtApiConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Import;
+
+/**
+ * Auto-Configuration for enabling the Management API REST-Resources.
+ *
+ */
+@Configuration
+@ConditionalOnClass(MgmtApiConfiguration.class)
+@Import(MgmtApiConfiguration.class)
+public class MgmtApiAutoConfiguration {
+
+}

hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/web/WebMvcAutoConfiguration.java

@@ -18,8 +18,6 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter
  * from Spring because it will truncate the dot in a REST URL which leads to
  * problem in case a controllerId contains dots and is a path parameter or
  * filename ending.
- * 
- *
  */
 @Configuration
 public class WebMvcAutoConfiguration extends WebMvcConfigurerAdapter {

hawkbit-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -5,11 +5,14 @@ org.eclipse.hawkbit.autoconfigure.ui.UIAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.security.SecurityAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.url.PropertyHostnameResolverAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.web.WebMvcAutoConfiguration,\
+org.eclipse.hawkbit.autoconfigure.web.DDiApiAutoConfiguration,\
+org.eclipse.hawkbit.autoconfigure.web.MgmtApiAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.cache.CacheAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.cache.DownloadIdCacheAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.event.EventPublisherAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.scheduling.AsyncConfigurerAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.scheduling.ExecutorAutoConfiguration,\
-org.eclipse.hawkbit.autoconfigure.amqp.AmqpAutoConfiguration,\
+org.eclipse.hawkbit.autoconfigure.amqp.DmfApiAutoConfiguration,\
 org.eclipse.hawkbit.autoconfigure.security.InMemoryUserManagementConfiguration,\
-org.eclipse.hawkbit.autoconfigure.repository.ArtifactStoreAutoConfiguration
+org.eclipse.hawkbit.autoconfigure.repository.ArtifactFilesystemAutoConfiguration,\
+org.eclipse.hawkbit.autoconfigure.repository.JpaRepositoryAutoConfiguration