Merge branch 'Feature/Add_Rest_Api_with_Java_client' of https://github.com/bsinno/hawkbit into Feature/Add_Rest_Api_with_Java_client

README.md

@@ -58,26 +58,27 @@ $ java -jar ./examples/hawkbit-mgmt-api-client/target/hawkbit-mgmt-api-client-#v
 
 # Modules
 
-`examples` : HawkBit examples 
-`hawkbit-artifact-repository-mongo` : Artifact repository implementation to mongoDB. 
-`hawkbit-autoconfigure` : Spring-boot auto-configuration. 
-`hawkbit-cache-redis` : Spring cache manager configuration and implementation with redis, distributed cache and distributed events.
-`hawkbit-core` : Core elements.  
-`hawkbit-ddi-api` : The hawkBit DDI API.
-`hawkbit-ddi-resource` : Implementation of the hawkBit DDI API
-`hawkbit-dmf-amqp` : AMQP endpoint implementation for the DMF API. 
-`hawkbit-dmf-api` : API for the Device Management Integration.  
-`hawkbit-http-security` : Implementation for security filters for HTTP.  
-`hawkbit-mgmt-api` : The hawkBit Management API
-`hawkbit-mgmt-resource` : Implementation of the hawkBit Management API
-`hawkbit-repository` : Repository implementation based on SQL for all meta-data.   
-`hawkbit-rest-core` : Core elements for the rest modules.
-`hawkbit-security-core` : Core security elements.  
-`hawkbit-security-integration` : Security integration elements to integrate security into hawkbit.  
-`hawkbit-system-api` : The hawkBit System API
-`hawkbit-system-resource` : Implementation of the hawkBit System API
-`hawkbit-test-report` : Test reports
-`hawkbit-ui` : Vaadin UI.  
+* `examples` : hawkBit examples 
+* `hawkbit-artifact-repository-mongo` : Artifact repository implementation to mongoDB. 
+* `hawkbit-autoconfigure` : Spring-boot auto-configuration. 
+* `hawkbit-cache-redis` : Spring cache manager configuration and implementation with redis, distributed cache and distributed events.
+* `hawkbit-core` : Core elements.  
+* `hawkbit-ddi-api` : The hawkBit DDI API.
+* `hawkbit-ddi-resource` : Implementation of the hawkBit DDI API
+* `hawkbit-dmf-amqp` : AMQP endpoint implementation for the DMF API. 
+* `hawkbit-dmf-api` : API for the Device Management Integration.  
+* `hawkbit-http-security` : Implementation for security filters for HTTP.  
+* `hawkbit-mgmt-api` : The hawkBit Management API
+* `hawkbit-mgmt-resource` : Implementation of the hawkBit Management API
+* `hawkbit-mgmt-ui` : Vaadin UI.  
+* `hawkbit-repository` : Repository implementation based on SQL for all meta-data.   
+* `hawkbit-rest-core` : Core elements for the rest modules.
+* `hawkbit-security-core` : Core security elements.  
+* `hawkbit-security-integration` : Security integration elements to integrate security into hawkBit.  
+* `hawkbit-system-api` : The hawkBit System API
+* `hawkbit-system-resource` : Implementation of the hawkBit System API
+* `hawkbit-test-report` : Test reports
+
  
 
 

examples/README.md

@@ -4,9 +4,9 @@ Example projects that show how _hawkBit_ can be used to create, run or access an
 
 - `hawkbit-custom-theme-example` : Example for a customized theme for Management UI.
 - `hawkbit-device-simulator` : Simulates device software updates, leveraging the hawkBit device integration options.  
-- `hawkbit-example-app` : Allows you to run a Spring Boot and hawkBit based update server. Includes all _hawkBit_ interfaces, i.e. DDI, DMF, Mgmt-API, Mgmt-UI.
-- `hawkbit-example-ddi-client` : Example _hawkBit_ DDI client based on the _hawkBit_ DDI API. 
+- `hawkbit-example-app` : Allows you to run the Spring Boot hawkBit app. Includes all _hawkBit_ interfaces, i.e. DDI, DMF, Mgmt-API, Mgmt-UI.
+- `hawkbit-example-ddi-client` : Example _hawkBit_ DDI client based on the _hawkBit_ DDI API. Includes simulation of target.
 - `hawkbit-example-feign-core-client` : Core resources for the examples.
 - `hawkbit-example-mgmt-client` : Example client for the _hawkBit_ Management API
-- `hawkbit-example-mgmt-spring-client` : Example client for the _hawkBit_ Management API based on Spring boot.  
+- `hawkbit-example-mgmt-spring-client` : Example client for the _hawkBit_ Management API based on Spring Boot.  
 

examples/hawkbit-example-ddi-client/README.md

@@ -1,6 +1,6 @@
 # Eclipse.IoT hawkBit - Example DDI Client 
 
-The hawkBit Example DDI Client is an implementation of a simulated device/controller that communicates with the hawkBit server via the DDI API.  
+The hawkBit Example DDI Client is an implementation of a simulated device/target that communicates with the hawkBit server via the DDI API.  
 
 # Compile, Run and Getting Started
 
@@ -25,6 +25,5 @@ executorService.execute(ddiExampleClient);
 
 #### Getting started with hawkBit Example DDI Client
 
-After the hawkBit Example DDI Client has started it will poll once against the given hawkBit server and form then on depending on your polling configuration.
-After the hawkBit Example DDI Client has polled successful your will see a target in the deployment view regarding the given controller id of your hawkBit Example DDI Client. 
+After the hawkBit Example DDI Client has started it will poll once against the given hawkBit server and form then depending on your polling configuration. After the hawkBit Example DDI Client has polled successful you will see a target in the deployment view regarding the given controller id of your hawkBit Example DDI Client. You can know assign a distributionSet to the target and let the hawkBit Example DDI Client simulated an update. 
 

examples/hawkbit-example-feign-core-client/README.md

@@ -0,0 +1,13 @@
+# Eclipse.IoT hawkBit - Example Feign Core Client 
+
+This modules contains core resources that are needed by the hawkBit Example DDI Client and the hawkBit Example Management Spring Client.
+
+# Compile
+
+#### Build hawkbit-example-feign-core-client
+
+```
+$ cd hawkbit/examples/hawkbit-example-feign-core-client
+$ mvn clean install
+```
+

examples/hawkbit-example-mgmt-client/README.md

@@ -0,0 +1,15 @@
+# Eclipse.IoT hawkBit - Example Management Client 
+
+This modules contains an example feign client implementation based on the Mgmt API. 
+
+Powered by [Feign](https://github.com/Netflix/feign).
+
+# Compile
+
+#### Build hawkbit-example-mgmt-client
+
+```
+$ cd hawkbit/examples/hawkbit-example-mgmt-client
+$ mvn clean install
+```
+

examples/hawkbit-example-mgmt-spring-client/README.md

@@ -1,6 +1,6 @@
-# hawkBit Management API example client
+# Eclipse.IoT hawkBit - Management API Example Client
 
-Example client that shows how to efficiently use the hawkBit management API.
+Example Spring Boot client that shows how to efficiently use the hawkBit Example Management Client and the hawkBit Management API.
 
 Powered by [Feign](https://github.com/Netflix/feign).
 

hawkbit-ddi-api/README.md

@@ -0,0 +1,12 @@
+# Eclipse.IoT hawkBit - DDI API 
+
+The Direct Device Integration (DDI) API is used by devices for communicating with the HawkBit Update Server through HTTP. 
+
+# Compile
+
+#### Build hawkbit-ddi-api
+
+```
+$ cd hawkbit/hawkbit-ddi-api
+$ mvn clean install
+```

hawkbit-ddi-dl-api/README.md

@@ -0,0 +1,12 @@
+# Eclipse.IoT hawkBit - DDI Download API 
+
+This module is part of the Direct Device Integration (DDI) API and is used by devices/targets for downloading artifacts through HTTP. 
+
+# Compile
+
+#### Build hawkbit-ddi-dl-api
+
+```
+$ cd hawkbit/hawkbit-ddi-dl-api
+$ mvn clean install
+```

hawkbit-ddi-resource/README.md

@@ -0,0 +1,13 @@
+# Eclipse.IoT hawkBit - DDI Resource 
+
+This is the server-side implementation of the hawkBit DDI API that is used by devices for communicating with the HawkBit Update Server through HTTP. 
+
+# Compile
+
+#### Build hawkbit-ddi-resource
+
+```
+$ cd hawkbit/hawkbit-ddi-resource
+$ mvn clean install
+```
+

hawkbit-mgmt-api/README.md

@@ -0,0 +1,14 @@
+# Eclipse.IoT hawkBit - Mgmt API 
+
+This Management (Mgmt) API is used to manage and monitor the HawkBit Update Server via HTTP. This API allows Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).
+
+
+# Compile
+
+#### Build hawkbit-mgmt-api
+
+```
+$ cd hawkbit/hawkbit-mgmt-api
+$ mvn clean install
+```
+

hawkbit-mgmt-resource/README.md

@@ -0,0 +1,13 @@
+# Eclipse.IoT hawkBit - Mgmt Resource 
+
+This is the server-side implementation of the hawkBit Mgmt API that is used to manage and monitor the HawkBit Update Server via HTTP.
+
+# Compile
+
+#### Build hawkbit-mgmt-resource
+
+```
+$ cd hawkbit/hawkbit-mgmt-resource
+$ mvn clean install
+```
+

hawkbit-system-api/README.md

@@ -0,0 +1,14 @@
+# Eclipse.IoT hawkBit - System API 
+
+The System API is used to configurate the hawkBit Update Server. This includes tenants specific operations as well as system wide operations.
+
+
+# Compile
+
+#### Build hawkbit-system-api
+
+```
+$ cd hawkbit/hawkbit-system-api
+$ mvn clean install
+```
+

hawkbit-system-resource/README.md

@@ -0,0 +1,13 @@
+# Eclipse.IoT hawkBit - System Resource 
+
+This is the server-side implementation of the hawkBit System API that is used to configurate the hawkBit Update Server
+
+# Compile
+
+#### Build hawkbit-system-resource
+
+```
+$ cd hawkbit/hawkbit-system-resource
+$ mvn clean install
+```
+