Code format hawkbit (#1948)
Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
This commit is contained in:
Avgustin Marinov
8
.3rd-party/README.md
vendored
8
.3rd-party/README.md
vendored
@@ -1,5 +1,9 @@
|
|||||||
# Third-Party Dependencies
|
# Third-Party Dependencies
|
||||||
|
|
||||||
This folder provides listings of all 3rd-party dependencies incl. their licenses. There is a dedicated subfolder for each release (and milestone) holding the release-specific information.
|
This folder provides listings of all 3rd-party dependencies incl. their licenses. There is a dedicated subfolder for
|
||||||
|
each release (and milestone) holding the release-specific information.
|
||||||
|
|
||||||
The files are generated using the [check-dependencies.sh](https://github.com/eclipse-hawkbit/hawkbit/tree/master/check-dependencies.sh) script. The script makes use of the [Eclipse Dash License Tool](https://github.com/eclipse/dash-licenses) which identifies and vets the licenses of the project content.
|
The files are generated using
|
||||||
|
the [check-dependencies.sh](https://github.com/eclipse-hawkbit/hawkbit/tree/master/check-dependencies.sh) script. The
|
||||||
|
script makes use of the [Eclipse Dash License Tool](https://github.com/eclipse/dash-licenses) which identifies and vets
|
||||||
|
the licenses of the project content.
|
||||||
|
|||||||
2
.github/workflows/first-interaction.yml
vendored
2
.github/workflows/first-interaction.yml
vendored
@@ -2,7 +2,7 @@ name: First User Interaction
|
|||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request_target:
|
pull_request_target:
|
||||||
types: [opened]
|
types: [ opened ]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
greeting:
|
greeting:
|
||||||
|
|||||||
@@ -2,7 +2,10 @@
|
|||||||
|
|
||||||
## Our Pledge
|
## Our Pledge
|
||||||
|
|
||||||
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
|
||||||
|
participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
|
||||||
|
disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,
|
||||||
|
religion, or sexual identity and orientation.
|
||||||
|
|
||||||
## Our Standards
|
## Our Standards
|
||||||
|
|
||||||
@@ -24,23 +27,35 @@ Examples of unacceptable behavior by participants include:
|
|||||||
|
|
||||||
## Our Responsibilities
|
## Our Responsibilities
|
||||||
|
|
||||||
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
|
||||||
|
appropriate and fair corrective action in response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
|
||||||
|
issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
|
||||||
|
contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
|
||||||
|
|
||||||
## Scope
|
## Scope
|
||||||
|
|
||||||
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
|
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
|
||||||
|
project or its community. Examples of representing a project or community include using an official project e-mail
|
||||||
|
address, posting via an official social media account, or acting as an appointed representative at an online or offline
|
||||||
|
event. Representation of a project may be further defined and clarified by project maintainers.
|
||||||
|
|
||||||
## Enforcement
|
## Enforcement
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at hawkbit-dev@eclipse.org. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
|
||||||
|
hawkbit-dev@eclipse.org. The project team will review and investigate all complaints, and will respond in a way that it
|
||||||
|
deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the
|
||||||
|
reporter of an incident. Further details of specific enforcement policies may be posted separately.
|
||||||
|
|
||||||
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
|
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
|
||||||
|
repercussions as determined by other members of the project's leadership.
|
||||||
|
|
||||||
## Attribution
|
## Attribution
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available
|
||||||
|
at [http://contributor-covenant.org/version/1/4][version]
|
||||||
|
|
||||||
[homepage]: http://contributor-covenant.org
|
[homepage]: http://contributor-covenant.org
|
||||||
|
|
||||||
[version]: http://contributor-covenant.org/version/1/4/
|
[version]: http://contributor-covenant.org/version/1/4/
|
||||||
|
|||||||
@@ -9,37 +9,44 @@ Please read this if you intend to contribute to the project.
|
|||||||
### Code Style
|
### Code Style
|
||||||
|
|
||||||
* Java files:
|
* Java files:
|
||||||
* we follow the standard eclipse IDE (built in) code formatter with the following changes:
|
* we follow the standard eclipse IDE (built in) code formatter with the following changes:
|
||||||
* Tab policy: spaces only: 4
|
* Tab policy: spaces only: 4
|
||||||
* We recommend using at least Eclipse [Mars](https://www.eclipse.org/mars/) IDE release. It seems that the Java code formatter line break handling has been changed between [Luna](https://www.eclipse.org/luna/) and Mars.
|
* We recommend using at least Eclipse [Mars](https://www.eclipse.org/mars/) IDE release. It seems that the Java code
|
||||||
|
formatter line break handling has been changed between [Luna](https://www.eclipse.org/luna/) and Mars.
|
||||||
* XML files:
|
* XML files:
|
||||||
* we follow the standard eclipse IDE XML formatter with the following changes:
|
* we follow the standard eclipse IDE XML formatter with the following changes:
|
||||||
* Indent using spaces only: 3
|
* Indent using spaces only: 3
|
||||||
* SCSS files:
|
* SCSS files:
|
||||||
* we follow the standard [scss-lint](https://github.com/brigade/scss-lint/) rules with the following exception:
|
* we follow the standard [scss-lint](https://github.com/brigade/scss-lint/) rules with the following exception:
|
||||||
* disabled rules: ImportantRule, PropertySortOrder
|
* disabled rules: ImportantRule, PropertySortOrder
|
||||||
* Sonarqube:
|
* Sonarqube:
|
||||||
* Our rule set can be found [here](https://sonarcloud.io/organizations/bosch-iot-rollouts/rules)
|
* Our rule set can be found [here](https://sonarcloud.io/organizations/bosch-iot-rollouts/rules)
|
||||||
* Sonarqube reports can be found [here](https://sonarcloud.io/project/overview?id=org.eclipse.hawkbit%3Ahawkbit-parent)
|
* Sonarqube reports can be
|
||||||
|
found [here](https://sonarcloud.io/project/overview?id=org.eclipse.hawkbit%3Ahawkbit-parent)
|
||||||
|
|
||||||
### Utility library usage
|
### Utility library usage
|
||||||
|
|
||||||
hawkBit has currently [Apache commons lang](https://commons.apache.org/proper/commons-lang/) on the classpath in several of its modules. However, we see introducing too many utility libraries problematic as we force these as transitive dependencies on hawkBit users. We in fact are looking into reducing them in future not adding new ones.
|
hawkBit has currently [Apache commons lang](https://commons.apache.org/proper/commons-lang/) on the classpath in several
|
||||||
|
of its modules. However, we see introducing too many utility libraries problematic as we force these as transitive
|
||||||
|
dependencies on hawkBit users. We in fact are looking into reducing them in future not adding new ones.
|
||||||
|
|
||||||
So we kindly ask contributors:
|
So we kindly ask contributors:
|
||||||
|
|
||||||
* not introduce extra utility library dependencies
|
* not introduce extra utility library dependencies
|
||||||
* keep them out of the core modules (e.g. hawkbit-core, hawkbit-rest-core, hawkbit-http-security) to avoid that all modules have them as transitive dependency
|
* keep them out of the core modules (e.g. hawkbit-core, hawkbit-rest-core, hawkbit-http-security) to avoid that all
|
||||||
|
modules have them as transitive dependency
|
||||||
* use utility functions in general based in the following priority:
|
* use utility functions in general based in the following priority:
|
||||||
* use utility functions from JDK if feasible
|
* use utility functions from JDK if feasible
|
||||||
* use Spring utility classes if feasible
|
* use Spring utility classes if feasible
|
||||||
* use [Apache commons lang](https://commons.apache.org/proper/commons-lang/) if feasible
|
* use [Apache commons lang](https://commons.apache.org/proper/commons-lang/) if feasible
|
||||||
|
|
||||||
### Test documentation
|
### Test documentation
|
||||||
|
|
||||||
Please document the test cases that you contribute by means of [Allure](https://docs.qameta.io/allure/) annotations and proper test method naming.
|
Please document the test cases that you contribute by means of [Allure](https://docs.qameta.io/allure/) annotations and
|
||||||
|
proper test method naming.
|
||||||
|
|
||||||
All test classes are documented with [Allure's](https://docs.qameta.io/allure/#_behaviours_mapping) **@Feature** and **@Story** annotations in the following format:
|
All test classes are documented with [Allure's](https://docs.qameta.io/allure/#_behaviours_mapping) **@Feature** and *
|
||||||
|
*@Story** annotations in the following format:
|
||||||
|
|
||||||
```java
|
```java
|
||||||
@Feature("TEST_TYPE - HAWKBIT_COMPONENT")
|
@Feature("TEST_TYPE - HAWKBIT_COMPONENT")
|
||||||
@@ -49,7 +56,8 @@ All test classes are documented with [Allure's](https://docs.qameta.io/allure/#_
|
|||||||
Test types are:
|
Test types are:
|
||||||
|
|
||||||
* Unit Tests - for single units tests with a mocked environment
|
* Unit Tests - for single units tests with a mocked environment
|
||||||
* Component Tests - for complete components including lower layers, e.g. Spring MVC test on rest API including repository and database.
|
* Component Tests - for complete components including lower layers, e.g. Spring MVC test on rest API including
|
||||||
|
repository and database.
|
||||||
* Integration Tests - including clients, e.g. Selenium UI tests with various browsers.
|
* Integration Tests - including clients, e.g. Selenium UI tests with various browsers.
|
||||||
* System Tests - on target environments, e.g. Cloud Foundry.
|
* System Tests - on target environments, e.g. Cloud Foundry.
|
||||||
|
|
||||||
@@ -66,7 +74,8 @@ Examples for hawkBit components:
|
|||||||
@Story("Distribution Set Type Resource")
|
@Story("Distribution Set Type Resource")
|
||||||
```
|
```
|
||||||
|
|
||||||
In addition all test method's name describes in **camel case** what the test is all about and has in addition a long description in Allures **@Description** annotation.
|
In addition all test method's name describes in **camel case** what the test is all about and has in addition a long
|
||||||
|
description in Allures **@Description** annotation.
|
||||||
|
|
||||||
## Legal considerations for your contribution
|
## Legal considerations for your contribution
|
||||||
|
|
||||||
@@ -129,8 +138,11 @@ Submit a pull request via the normal GitHub UI (desktop or web).
|
|||||||
|
|
||||||
## Reporting a security vulnerability
|
## Reporting a security vulnerability
|
||||||
|
|
||||||
If you find a vulnerability, **DO NOT** disclose it in the public immediately! Instead, give us the possibility to fix it beforehand.
|
If you find a vulnerability, **DO NOT** disclose it in the public immediately! Instead, give us the possibility to fix
|
||||||
So please don’t report your finding using GitHub issues and better head over to [https://eclipse.org/security](https://eclipse.org/security) and learn how to disclose a vulnerability in a safe and responsible manner
|
it beforehand.
|
||||||
|
So please don’t report your finding using GitHub issues and better head over
|
||||||
|
to [https://eclipse.org/security](https://eclipse.org/security) and learn how to disclose a vulnerability in a safe and
|
||||||
|
responsible manner
|
||||||
|
|
||||||
## Further information
|
## Further information
|
||||||
|
|
||||||
|
|||||||
30
MIGRATION.md
30
MIGRATION.md
@@ -13,13 +13,17 @@
|
|||||||
|
|
||||||
### REST API model changes for clients
|
### REST API model changes for clients
|
||||||
|
|
||||||
- ENTITYPagedList classes have been removed; generic `PagedList` used instead (e.g. `PagedList<TargetRest>` instead of `TargetPagedList`).
|
- ENTITYPagedList classes have been removed; generic `PagedList` used instead (e.g. `PagedList<TargetRest>` instead
|
||||||
- ENTITYsrest classes have been removed; `List<ENTITYrest>` used instead (e.g. `List<TargetRest>` instead of `TargetsRest`)
|
of `TargetPagedList`).
|
||||||
|
- ENTITYsrest classes have been removed; `List<ENTITYrest>` used instead (e.g. `List<TargetRest>` instead
|
||||||
|
of `TargetsRest`)
|
||||||
|
|
||||||
### Renamed api annotations
|
### Renamed api annotations
|
||||||
|
|
||||||
- Annotation `org.eclipse.hawkbit.rest.resource.EnableRestResources` has changed to `org.eclipse.hawkbit.mgmt.annotation.EnableMgmtApi`
|
- Annotation `org.eclipse.hawkbit.rest.resource.EnableRestResources` has changed
|
||||||
- Annotation `org.eclipse.hawkbit.ddi.resource.EnableDirectDeviceApi` has changed to `org.eclipse.hawkbit.ddi.annotation.EnableDdiApi`
|
to `org.eclipse.hawkbit.mgmt.annotation.EnableMgmtApi`
|
||||||
|
- Annotation `org.eclipse.hawkbit.ddi.resource.EnableDirectDeviceApi` has changed
|
||||||
|
to `org.eclipse.hawkbit.ddi.annotation.EnableDdiApi`
|
||||||
|
|
||||||
### Renamed maven modules
|
### Renamed maven modules
|
||||||
|
|
||||||
@@ -29,17 +33,21 @@
|
|||||||
|
|
||||||
### Configuration Property changes
|
### Configuration Property changes
|
||||||
|
|
||||||
- `hawkbit.server.security.dos.maxTargetsPerManualAssignment` has changed to `hawkbit.server.security.dos.maxTargetDistributionSetAssignmentsPerManualAssignment`
|
- `hawkbit.server.security.dos.maxTargetsPerManualAssignment` has changed
|
||||||
|
to `hawkbit.server.security.dos.maxTargetDistributionSetAssignmentsPerManualAssignment`
|
||||||
|
|
||||||
## Milestone 0.3.0M7
|
## Milestone 0.3.0M7
|
||||||
|
|
||||||
### Configuration Property changes
|
### Configuration Property changes
|
||||||
|
|
||||||
- Due to Spring Boot version upgrade (see [spring boot 2.2 deprecations](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes#deprecations-in-spring-boot-22)) `server.use-forward-headers` has changed to `server.forward-headers-strategy`
|
- Due to Spring Boot version upgrade (
|
||||||
|
see [spring boot 2.2 deprecations](https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes#deprecations-in-spring-boot-22)) `server.use-forward-headers`
|
||||||
|
has changed to `server.forward-headers-strategy`
|
||||||
|
|
||||||
## Upgrade from Master Branch (after 0.3.0M6) to 0.3.0M7
|
## Upgrade from Master Branch (after 0.3.0M6) to 0.3.0M7
|
||||||
|
|
||||||
Due to changes in the DB migration scripts within PR [#1017](https://github.com/eclipse-hawkbit/hawkbit/pull/1017) the Hawkbit will not start up if one of the following cases is true:
|
Due to changes in the DB migration scripts within PR [#1017](https://github.com/eclipse-hawkbit/hawkbit/pull/1017) the
|
||||||
|
Hawkbit will not start up if one of the following cases is true:
|
||||||
|
|
||||||
- DB2 database is used
|
- DB2 database is used
|
||||||
- MSSQL database is used and the `sp_action` table is not empty
|
- MSSQL database is used and the `sp_action` table is not empty
|
||||||
@@ -47,9 +55,13 @@ Due to changes in the DB migration scripts within PR [#1017](https://github.com/
|
|||||||
|
|
||||||
The script was fixed with PR [#1061](https://github.com/eclipse-hawkbit/hawkbit/pull/1061).
|
The script was fixed with PR [#1061](https://github.com/eclipse-hawkbit/hawkbit/pull/1061).
|
||||||
|
|
||||||
In case you upgrade from 0.3.0M6 to 0.3.0M7 there is no issue. But if you have built the Hawkbit from the master branch between PR [#1017](https://github.com/eclipse-hawkbit/hawkbit/pull/1017) and PR [#1061](https://github.com/eclipse-hawkbit/hawkbit/pull/1061), use PostgreSQL or MSSQL and upgrade to 0.3.0M7, it will fail at startup with the message: `Validate failed: Migration checksum mismatch for migration version 1.12.16`
|
In case you upgrade from 0.3.0M6 to 0.3.0M7 there is no issue. But if you have built the Hawkbit from the master branch
|
||||||
|
between PR [#1017](https://github.com/eclipse-hawkbit/hawkbit/pull/1017) and
|
||||||
|
PR [#1061](https://github.com/eclipse-hawkbit/hawkbit/pull/1061), use PostgreSQL or MSSQL and upgrade to 0.3.0M7, it
|
||||||
|
will fail at startup with the message: `Validate failed: Migration checksum mismatch for migration version 1.12.16`
|
||||||
|
|
||||||
This can be fixed by adapting the schema_version table of the database. The checksum field of the entry with the version 1.12.16 has to be changed (mind the minus):
|
This can be fixed by adapting the schema_version table of the database. The checksum field of the entry with the version
|
||||||
|
1.12.16 has to be changed (mind the minus):
|
||||||
|
|
||||||
- -1684307461 for MSSQL
|
- -1684307461 for MSSQL
|
||||||
- -596342656 for PostgreSql
|
- -596342656 for PostgreSql
|
||||||
|
|||||||
94
README.md
94
README.md
@@ -2,7 +2,9 @@
|
|||||||
|
|
||||||
# Eclipse hawkBit™ - Update Server
|
# Eclipse hawkBit™ - Update Server
|
||||||
|
|
||||||
Eclipse [hawkBit](http://www.eclipse.org/hawkbit/index.html) is an domain independent back end solution for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.
|
Eclipse [hawkBit](http://www.eclipse.org/hawkbit/index.html) is an domain independent back end solution for rolling out
|
||||||
|
software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based
|
||||||
|
networking infrastructure.
|
||||||
|
|
||||||
Build:
|
Build:
|
||||||
[](https://github.com/eclipse-hawkbit/hawkbit/actions/workflows/verify.yml)
|
[](https://github.com/eclipse-hawkbit/hawkbit/actions/workflows/verify.yml)
|
||||||
@@ -13,8 +15,8 @@ Build:
|
|||||||
License:
|
License:
|
||||||
[](https://opensource.org/licenses/EPL-2.0)
|
[](https://opensource.org/licenses/EPL-2.0)
|
||||||
|
|
||||||
Docker:
|
Docker:
|
||||||
[](https://hub.docker.com/r/hawkbit/hawkbit-update-server)
|
[](https://hub.docker.com/r/hawkbit/hawkbit-update-server)
|
||||||
[](https://hub.docker.com/r/hawkbit/hawkbit-update-server)
|
[](https://hub.docker.com/r/hawkbit/hawkbit-update-server)
|
||||||
[](https://hub.docker.com/search?q=hawkbit%2Fhawkbit-update-server&type=image)
|
[](https://hub.docker.com/search?q=hawkbit%2Fhawkbit-update-server&type=image)
|
||||||
|
|
||||||
@@ -25,13 +27,17 @@ see [hawkBit Documentation](https://www.eclipse.dev/hawkbit/)
|
|||||||
# Contact us
|
# Contact us
|
||||||
|
|
||||||
- Having questions about hawkBit? Check [Stack Overflow](https://stackoverflow.com/questions/tagged/eclipse-hawkbit)
|
- Having questions about hawkBit? Check [Stack Overflow](https://stackoverflow.com/questions/tagged/eclipse-hawkbit)
|
||||||
- Want to chat with the team behind hawkBit? [](https://gitter.im/eclipse/hawkbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
- Want to chat with the team behind
|
||||||
|
hawkBit? [](https://gitter.im/eclipse/hawkbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||||
- Having issues with hawkBit? Open a [GitHub issue](https://github.com/eclipse-hawkbit/hawkbit/issues).
|
- Having issues with hawkBit? Open a [GitHub issue](https://github.com/eclipse-hawkbit/hawkbit/issues).
|
||||||
- You can also check out our [Project Homepage](https://www.eclipse.dev/hawkbit) for further contact options.
|
- You can also check out our [Project Homepage](https://www.eclipse.dev/hawkbit) for further contact options.
|
||||||
|
|
||||||
# hawkBit sandbox
|
# hawkBit sandbox
|
||||||
|
|
||||||
We offer a sandbox installation that is free for everyone to try out hawkBit. However, keep in mind that the sandbox database will be reset from time to time. It is also not possible to upload any artifacts into the sandbox. But you can use it to try out the Management API and DDI API. Keep in mind as well that you are not permitted to store any kind of personal data in the sandbox.
|
We offer a sandbox installation that is free for everyone to try out hawkBit. However, keep in mind that the sandbox
|
||||||
|
database will be reset from time to time. It is also not possible to upload any artifacts into the sandbox. But you can
|
||||||
|
use it to try out the Management API and DDI API. Keep in mind as well that you are not permitted to store any kind of
|
||||||
|
personal data in the sandbox.
|
||||||
|
|
||||||
[https://hawkbit.eclipseprojects.io](https://hawkbit.eclipseprojects.io)
|
[https://hawkbit.eclipseprojects.io](https://hawkbit.eclipseprojects.io)
|
||||||
|
|
||||||
@@ -42,29 +48,44 @@ In addition the following vendors offer free trial accounts for their hawkBit co
|
|||||||
|
|
||||||
# Device Integration (Client libraries)
|
# Device Integration (Client libraries)
|
||||||
|
|
||||||
hawkBit exposes HTTP/JSON based [Direct Device Integration (API) API](https://www.eclipse.org/hawkbit/apis/ddi_api/) that allow any update client to integrate quite easily.
|
hawkBit exposes HTTP/JSON based [Direct Device Integration (API) API](https://www.eclipse.org/hawkbit/apis/ddi_api/)
|
||||||
|
that allow any update client to integrate quite easily.
|
||||||
|
|
||||||
The [Eclipse Hara subproject](https://projects.eclipse.org/projects/iot.hawkbit.hara) aims to provide a reference agent software implementation of the Eclipse hawkBit device API. The [hara-ddiclient repository](https://github.com/eclipse-hara/hara-ddiclient) provides:
|
The [Eclipse Hara subproject](https://projects.eclipse.org/projects/iot.hawkbit.hara) aims to provide a reference agent
|
||||||
|
software implementation of the Eclipse hawkBit device API.
|
||||||
|
The [hara-ddiclient repository](https://github.com/eclipse-hara/hara-ddiclient) provides:
|
||||||
|
|
||||||
- a Kotlin library that facilitates and speeds up the development of DDI API clients running on the JVM
|
- a Kotlin library that facilitates and speeds up the development of DDI API clients running on the JVM
|
||||||
- a virtual-device application which provides:
|
- a virtual-device application which provides:
|
||||||
- a reference example on how to use the library
|
- a reference example on how to use the library
|
||||||
- a configurable virtual device that can be used for different testing scenarios
|
- a configurable virtual device that can be used for different testing scenarios
|
||||||
|
|
||||||
The hara-ddiclient library has [reached version 2.x](https://github.com/eclipse-hara/hara-ddiclient/releases), and has been successfully used in production for years.
|
The hara-ddiclient library has [reached version 2.x](https://github.com/eclipse-hara/hara-ddiclient/releases), and has
|
||||||
|
been successfully used in production for years.
|
||||||
|
|
||||||
Additionally, the hawkBit project has the long term goal to provide [Eclipse Hono](https://github.com/eclipse/hono) integration which will provide connectivity through various IoT protocols and as a result will allow a wide range of clients to connect to hawkBit.
|
Additionally, the hawkBit project has the long term goal to provide [Eclipse Hono](https://github.com/eclipse/hono)
|
||||||
|
integration which will provide connectivity through various IoT protocols and as a result will allow a wide range of
|
||||||
|
clients to connect to hawkBit.
|
||||||
|
|
||||||
## Other open-source hawkBit Clients
|
## Other open-source hawkBit Clients
|
||||||
|
|
||||||
There are clients outside of the Eclipse IoT eco system as well, e.g.:
|
There are clients outside of the Eclipse IoT eco system as well, e.g.:
|
||||||
|
|
||||||
- [SWupdate](https://github.com/sbabic/swupdate) which is a Linux Update agent with focus on a efficient and safe way to update embedded systems.
|
- [SWupdate](https://github.com/sbabic/swupdate) which is a Linux Update agent with focus on a efficient and safe way to
|
||||||
- [rauc-hawkbit-updater](https://github.com/rauc/rauc-hawkbit-updater) which is a hawkBit client for the [RAUC](https://github.com/rauc/rauc) update framework written in C/glib.
|
update embedded systems.
|
||||||
- [rauc-hawkbit](https://github.com/rauc/rauc-hawkbit) which is a python-based hawkBit client demo application and library for the [RAUC](https://github.com/rauc/rauc) update framework.
|
- [rauc-hawkbit-updater](https://github.com/rauc/rauc-hawkbit-updater) which is a hawkBit client for
|
||||||
- [hawkbit-rs](https://github.com/collabora/hawkbit-rs) provides a couple of [Rust](https://www.rust-lang.org) crates to help [implement](https://crates.io/crates/hawkbit) and [test](https://crates.io/crates/hawkbit_mock) hawkBit clients.
|
the [RAUC](https://github.com/rauc/rauc) update framework written in C/glib.
|
||||||
- [Zephyr-RTOS](https://docs.zephyrproject.org/apidoc/latest/group__hawkbit.html#details): The Zephyr OS is a small-footprint kernel designed for use on resource-constrained and embedded systems: from simple embedded environmental sensors and LED wearables to sophisticated embedded controllers, smart watches, and IoT wireless applications.
|
- [rauc-hawkbit](https://github.com/rauc/rauc-hawkbit) which is a python-based hawkBit client demo application and
|
||||||
- [ChirpStack](https://www.chirpstack.io/docs/chirpstack-gateway-os/use/software-update.html): ChirpStack Gateway OS uses [SWUpdate](https://github.com/sbabic/swupdate) for handling updates which can be integrated with Eclipse hawkBit. ChirpStack is an open-source LoRaWAN Network Server which can be used to to setup private or public LoRaWAN networks.
|
library for the [RAUC](https://github.com/rauc/rauc) update framework.
|
||||||
|
- [hawkbit-rs](https://github.com/collabora/hawkbit-rs) provides a couple of [Rust](https://www.rust-lang.org) crates to
|
||||||
|
help [implement](https://crates.io/crates/hawkbit) and [test](https://crates.io/crates/hawkbit_mock) hawkBit clients.
|
||||||
|
- [Zephyr-RTOS](https://docs.zephyrproject.org/apidoc/latest/group__hawkbit.html#details): The Zephyr OS is a
|
||||||
|
small-footprint kernel designed for use on resource-constrained and embedded systems: from simple embedded
|
||||||
|
environmental sensors and LED wearables to sophisticated embedded controllers, smart watches, and IoT wireless
|
||||||
|
applications.
|
||||||
|
- [ChirpStack](https://www.chirpstack.io/docs/chirpstack-gateway-os/use/software-update.html): ChirpStack Gateway OS
|
||||||
|
uses [SWUpdate](https://github.com/sbabic/swupdate) for handling updates which can be integrated with Eclipse hawkBit.
|
||||||
|
ChirpStack is an open-source LoRaWAN Network Server which can be used to to setup private or public LoRaWAN networks.
|
||||||
|
|
||||||
# Runtime dependencies and support
|
# Runtime dependencies and support
|
||||||
|
|
||||||
@@ -72,20 +93,22 @@ There are clients outside of the Eclipse IoT eco system as well, e.g.:
|
|||||||
|
|
||||||
## SQL database
|
## SQL database
|
||||||
|
|
||||||
| Database | H2 | MySQL/MariaDB | MS SQL Server | PostgreSQL | IBM DB2 |
|
| Database | H2 | MySQL/MariaDB | MS SQL Server | PostgreSQL | IBM DB2 |
|
||||||
| --------------------------------- | :----------------------------------------------------: | :-------------------------------------------------------------------------: | :--------------------------------------------------------------: | :----------------------------------------------------------------: | :----------------: |
|
|-----------------------------------|:------------------------------------------------------:|:---------------------------------------------------------------------------:|:-----------------------------------------------------------------:|:-----------------------------------------------------------------:|:------------------:|
|
||||||
| DDLs maintained by project | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
| DDLs maintained by project | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: |
|
||||||
| Test dependencies defined | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | |
|
| Test dependencies defined | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | |
|
||||||
| Versions tested | 2.1 | MySQL 8.0.23, AWS Aurora | MS SQL Server 2017/2019 | PostgreSQL 12/13 | DB2 Server v11.1 |
|
| Versions tested | 2.1 | MySQL 8.0.23, AWS Aurora | MS SQL Server 2017/2019 | PostgreSQL 12/13 | DB2 Server v11.1 |
|
||||||
| Docker image with driver provided | :white_check_mark: | :white_check_mark: (Tag: "-mysql") | :white_check_mark: | :white_check_mark: | |
|
| Docker image with driver provided | :white_check_mark: | :white_check_mark: (Tag: "-mysql") | :white_check_mark: | :white_check_mark: | |
|
||||||
| JDBC driver | [H2 2.1.214](https://github.com/h2database/h2database) | [MariaDB Connector/J 2.7.8](https://github.com/MariaDB/mariadb-connector-j) | [MSSQL-JDBC 10.2.3.jre8](https://github.com/Microsoft/mssql-jdbc) | [PostgreSQL JDBC Driver 42.3.8](https://github.com/pgjdbc/pgjdbc) | |
|
| JDBC driver | [H2 2.1.214](https://github.com/h2database/h2database) | [MariaDB Connector/J 2.7.8](https://github.com/MariaDB/mariadb-connector-j) | [MSSQL-JDBC 10.2.3.jre8](https://github.com/Microsoft/mssql-jdbc) | [PostgreSQL JDBC Driver 42.3.8](https://github.com/pgjdbc/pgjdbc) | |
|
||||||
| Status | Test, Dev | Production grade | Production grade | Test, Dev | Test, Dev |
|
| Status | Test, Dev | Production grade | Production grade | Test, Dev | Test, Dev |
|
||||||
|
|
||||||
## (Optional) RabbitMQ: 3.6,3.7,3.8
|
## (Optional) RabbitMQ: 3.6,3.7,3.8
|
||||||
|
|
||||||
# Getting Started
|
# Getting Started
|
||||||
|
|
||||||
We are providing a [Spring Boot](https://projects.spring.io/spring-boot/) based reference [Update Server](hawkbit-runtime/hawkbit-update-server) including embedded H2 DB for test and evaluation purposes.
|
We are providing a [Spring Boot](https://projects.spring.io/spring-boot/) based
|
||||||
|
reference [Update Server](hawkbit-runtime/hawkbit-update-server) including embedded H2 DB for test and evaluation
|
||||||
|
purposes.
|
||||||
Run with docker:
|
Run with docker:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -96,13 +119,18 @@ Open the update server in your browser:
|
|||||||
|
|
||||||
[localhost:8080](http://localhost:8080)
|
[localhost:8080](http://localhost:8080)
|
||||||
|
|
||||||
See below for how to build and run the update server on your own. In addition we have a [guide](https://www.eclipse.org/hawkbit/guides/runhawkbit/) for setting up a complete landscape.
|
See below for how to build and run the update server on your own. In addition we have
|
||||||
|
a [guide](https://www.eclipse.org/hawkbit/guides/runhawkbit/) for setting up a complete landscape.
|
||||||
|
|
||||||
**Note**: this docker image supports both DDI and DMF APIs. However, in order to have DMF API working you shall have started additionally RabbitMQ on localhost:5672 with user guest/guest. Then the DMF will use / vhost. See more at [guide](https://www.eclipse.org/hawkbit/guides/runhawkbit/) -> _Configure RabbitMQ connection settings_.
|
**Note**: this docker image supports both DDI and DMF APIs. However, in order to have DMF API working you shall have
|
||||||
|
started additionally RabbitMQ on localhost:5672 with user guest/guest. Then the DMF will use / vhost. See more
|
||||||
|
at [guide](https://www.eclipse.org/hawkbit/guides/runhawkbit/) -> _Configure RabbitMQ connection settings_.
|
||||||
|
|
||||||
# hawkBit (Spring boot) starters
|
# hawkBit (Spring boot) starters
|
||||||
|
|
||||||
Next to the [Update Server](hawkbit-runtime/hawkbit-update-server) we are also providing a set of [Spring Boot Starters](hawkbit-starters) to quick start your own [Spring Boot](https://projects.spring.io/spring-boot/) based application.
|
Next to the [Update Server](hawkbit-runtime/hawkbit-update-server) we are also providing a set
|
||||||
|
of [Spring Boot Starters](hawkbit-starters) to quick start your
|
||||||
|
own [Spring Boot](https://projects.spring.io/spring-boot/) based application.
|
||||||
|
|
||||||
# Clone, build and run hawkBit
|
# Clone, build and run hawkBit
|
||||||
|
|
||||||
@@ -135,8 +163,16 @@ java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator
|
|||||||
|
|
||||||
# Status and API stability
|
# Status and API stability
|
||||||
|
|
||||||
hawkBit is currently in '0.X' semantic version. That is due to the need that there is still content in hawkBit that is in need for refactoring. That includes the maven module structure, Spring Boot Properties, Spring Boot auto configuration as well as internal Java APIs (e.g. the [repository API](https://github.com/eclipse-hawkbit/hawkbit/issues/197) ).
|
hawkBit is currently in '0.X' semantic version. That is due to the need that there is still content in hawkBit that is
|
||||||
|
in need for refactoring. That includes the maven module structure, Spring Boot Properties, Spring Boot auto
|
||||||
|
configuration as well as internal Java APIs (e.g.
|
||||||
|
the [repository API](https://github.com/eclipse-hawkbit/hawkbit/issues/197) ).
|
||||||
|
|
||||||
However, the device facing [DDI API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-rest/hawkbit-ddi-api) is on major version 'v1' and will be kept stable.
|
However, the device
|
||||||
|
facing [DDI API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-rest/hawkbit-ddi-api) is on major
|
||||||
|
version 'v1' and will be kept stable.
|
||||||
|
|
||||||
Server facing and [DMF API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api) are [Management API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-rest/hawkbit-mgmt-api) are on v1 as well. However, we cannot fully guarantee the same stability during hawkBit's 0.X development but we will try as best we can.
|
Server facing and [DMF API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api)
|
||||||
|
are [Management API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-rest/hawkbit-mgmt-api) are on v1 as
|
||||||
|
well. However, we cannot fully guarantee the same stability during hawkBit's 0.X development but we will try as best we
|
||||||
|
can.
|
||||||
|
|||||||
@@ -1,4 +1,7 @@
|
|||||||
# Reporting a Security Vulnerability
|
# Reporting a Security Vulnerability
|
||||||
|
|
||||||
If you find a vulnerability, **DO NOT** disclose it in the public immediately! Instead, give us the possibility to fix it beforehand.
|
If you find a vulnerability, **DO NOT** disclose it in the public immediately! Instead, give us the possibility to fix
|
||||||
So please don’t report your finding using GitHub issues and better head over to [https://eclipse.org/security](https://eclipse.org/security) and learn how to disclose a vulnerability in a safe and responsible manner
|
it beforehand.
|
||||||
|
So please don’t report your finding using GitHub issues and better head over
|
||||||
|
to [https://eclipse.org/security](https://eclipse.org/security) and learn how to disclose a vulnerability in a safe and
|
||||||
|
responsible manner
|
||||||
|
|||||||
@@ -1,380 +1,504 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
<?xml version="1.0" encoding="utf-8"?>
|
||||||
<profiles version="21">
|
<profiles version="21">
|
||||||
<profile kind="CodeFormatterProfile" name="hawkBit" version="21">
|
<profile kind="CodeFormatterProfile" name="hawkBit" version="21">
|
||||||
<setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/>
|
<setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.use_tabs_only_for_leading_indentations" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/>
|
<setting id="org.eclipse.jdt.core.formatter.indentation.size" value="4"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/>
|
<setting id="org.eclipse.jdt.core.formatter.tabulation.size" value="4"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.text_block_indentation" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.text_block_indentation" value="0"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_type_header" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_type_header" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_declaration_header"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header" value="true"/>
|
value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_annotation_declaration_header" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_enum_constant_header"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_record_header" value="true"/>
|
value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_body" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_annotation_declaration_header"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_block" value="true"/>
|
value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_body_declarations_compare_to_record_header" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_cases" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_body" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_breaks_compare_to_cases" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_statements_compare_to_block" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.indent_empty_lines" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_switch" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.align_type_members_on_columns" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_switchstatements_compare_to_cases" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.align_variable_declarations_on_columns" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_breaks_compare_to_cases" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.indent_empty_lines" value="false"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.align_with_spaces" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.align_type_members_on_columns" value="false"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines" value="1"/>
|
<setting id="org.eclipse.jdt.core.formatter.align_variable_declarations_on_columns" value="false"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_type_declaration" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.align_assignment_statements_on_columns" value="false"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_anonymous_type_declaration" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.align_with_spaces" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.align_fields_grouping_blank_lines" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_method_declaration" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_type_declaration" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_anonymous_type_declaration" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_constant" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_constructor_declaration" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_record_declaration" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_method_declaration" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_record_constructor" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_declaration" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_annotation_type_declaration" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_enum_constant" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_block" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_record_declaration" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_block_in_case" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_record_constructor" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_switch" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_annotation_type_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_array_initializer" value="end_of_line"/>
|
value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_empty_array_initializer_on_one_line" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_block" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_lambda_body" value="end_of_line"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_block_in_case" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_method_delcaration" value="preserve_positions"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_switch" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_method_invocation" value="preserve_positions"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_array_initializer" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_enum_constant_declaration" value="preserve_positions"/>
|
<setting id="org.eclipse.jdt.core.formatter.keep_empty_array_initializer_on_one_line" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_record_declaration" value="preserve_positions"/>
|
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_lambda_body" value="end_of_line"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_annotation" value="preserve_positions"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_method_delcaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_lambda_declaration" value="preserve_positions"/>
|
value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_if_while_statement" value="preserve_positions"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_method_invocation"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_for_statment" value="preserve_positions"/>
|
value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_switch_statement" value="preserve_positions"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_enum_constant_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_try_clause" value="preserve_positions"/>
|
value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_catch_clause" value="preserve_positions"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_record_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_type_declaration" value="insert"/>
|
value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_anonymous_type_declaration" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_annotation" value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_superinterfaces" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_lambda_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_superinterfaces" value="insert"/>
|
value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_field_declarations" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_if_while_statement"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_field_declarations" value="insert"/>
|
value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_local_declarations" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_for_statment" value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_local_declarations" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_switch_statement"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_constructor_declaration" value="do not insert"/>
|
value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_constructor_declaration" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_try_clause" value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_constructor_declaration" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.parentheses_positions_in_catch_clause" value="preserve_positions"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_constructor_declaration" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_type_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_constructor_declaration" value="insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_parameters" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_anonymous_type_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_parameters" value="insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_throws" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_superinterfaces"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_throws" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_declaration" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_superinterfaces" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_declaration" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_field_declarations"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_declaration" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_declaration" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_field_declarations"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_method_declaration" value="insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_multiple_local_declarations"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_ellipsis" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_multiple_local_declarations"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_ellipsis" value="insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_throws" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_constructor_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_throws" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_constructor_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_labeled_statement" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_constructor_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_constructor_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_constructor_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_declaration" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_declarations" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_enum_constant" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_enum_constant" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_constructor_declaration_throws"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_enum_constant" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_constant_arguments" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_throws"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_constant_arguments" value="insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_enum_constant" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_constant" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_at_in_annotation_type_declaration" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation_type_declaration" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_annotation_type_declaration" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation_type_member_declaration" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_annotation_type_member_declaration" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_record_declaration" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_record_declaration" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_method_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_record_components" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_record_components" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_record_declaration" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_record_declaration" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_record_constructor" value="insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_lambda_arrow" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_ellipsis" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_lambda_arrow" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_ellipsis" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_declaration_throws"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_brace_in_block" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_if" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_declaration_throws"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_if" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_if" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_labeled_statement"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_for" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_for" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_labeled_statement" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_for" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_inits" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_inits" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_increments" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_annotation"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_increments" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_for" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_annotation" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_for" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_for" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_annotation"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_for" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_arrow_in_switch_case" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_declarations"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_arrow_in_switch_case" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_arrow_in_switch_default" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_declarations" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_arrow_in_switch_default" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_enum_constant"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_case" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_switch_case_expressions" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_enum_constant"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_switch_case_expressions" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_switch" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_enum_constant"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_switch" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_switch" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_enum_constant_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_switch" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_while" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_enum_constant_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_while" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_while" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_enum_constant"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_synchronized" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_synchronized" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_enum_constant" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_synchronized" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_at_in_annotation_type_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_try" value="insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_try" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_at_in_annotation_type_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_try_resources" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_try_resources" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_annotation_type_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_try" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_catch" value="insert"/>
|
<setting
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_catch" value="do not insert"/>
|
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_annotation_type_member_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_catch" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_assert" value="insert"/>
|
<setting
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_assert" value="insert"/>
|
id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_annotation_type_member_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_return" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_throw" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_record_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_invocation" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_record_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_invocation" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_invocation" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_record_components"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_invocation_arguments" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_record_components" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_record_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_allocation_expression" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_allocation_expression" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_record_declaration"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_explicitconstructorcall_arguments" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_explicitconstructorcall_arguments" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_record_constructor"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_postfix_operator" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_postfix_operator" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_lambda_arrow" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_prefix_operator" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_lambda_arrow" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_prefix_operator" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_block" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_unary_operator" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_brace_in_block" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_unary_operator" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_if" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_not_operator" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_if" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_multiplicative_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_if" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_multiplicative_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_for" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_additive_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_for" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_additive_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_for" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_string_concatenation" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_inits" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_string_concatenation" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_inits" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_shift_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_for_increments" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_shift_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_for_increments" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_relational_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_for" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_relational_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_for" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_bitwise_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_for" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_bitwise_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_for" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_logical_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_case" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_logical_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_default" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_conditional" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_arrow_in_switch_case" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_conditional" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_arrow_in_switch_case" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_arrow_in_switch_default" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_conditional" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_arrow_in_switch_default" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_case" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_assignment_operator" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_switch_case_expressions"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_switch_case_expressions"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_cast" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_switch" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_cast" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_switch" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_paren_in_cast" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_switch" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_type_reference" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_switch" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_brackets_in_array_type_reference" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_while" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_allocation_expression" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_while" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_allocation_expression" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_while" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_allocation_expression" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_synchronized" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_brackets_in_array_allocation_expression" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_synchronized"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_array_initializer" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_synchronized"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_array_initializer" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_try" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_array_initializer" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_try" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_braces_in_array_initializer" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon_in_try_resources"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_reference" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_reference" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_try_resources" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_reference" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_try" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_parameterized_type_reference" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_catch" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_parameterized_type_reference" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_catch" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_parameterized_type_reference" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_catch" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_parameterized_type_reference" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_assert" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_parameterized_type_reference" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_assert" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_arguments" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_return"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_arguments" value="do not insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_arguments" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_parenthesized_expression_in_throw"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_arguments" value="insert"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_arguments" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_semicolon" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_method_invocation"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_parameters" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_parameters" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_method_invocation"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_parameters" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_parameters" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_method_invocation"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_parameters" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_parameters" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_parens_in_method_invocation"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter" value="insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_and_in_type_parameter" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_method_invocation_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_wildcard" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_wildcard" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_method_invocation_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.number_of_empty_lines_to_preserve" value="1"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_package" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_allocation_expression"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_package" value="1"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_imports" value="1"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_allocation_expression" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_imports" value="1"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_explicitconstructorcall_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_between_type_declarations" value="1"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_first_class_body_declaration" value="1"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_explicitconstructorcall_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_last_class_body_declaration" value="0"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_new_chunk" value="1"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_postfix_operator" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_member_type" value="1"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_postfix_operator" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_field" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_prefix_operator" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_abstract_method" value="1"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_prefix_operator" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_method" value="1"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_unary_operator" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_unary_operator" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_not_operator" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_multiplicative_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_multiplicative_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_additive_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_additive_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_catch_in_try_statement" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_string_concatenation" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_finally_in_try_statement" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_string_concatenation" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_shift_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_label" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_shift_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_then_statement_on_same_line" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_relational_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_imple_if_on_one_line" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_relational_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_else_statement_on_same_line" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_bitwise_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.compact_else_if" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_bitwise_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_simple_for_body_on_same_line" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_logical_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_simple_while_body_on_same_line" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_logical_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_simple_do_while_body_on_same_line" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_conditional" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_package" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_conditional" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_type" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_colon_in_conditional" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_enum_constant" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_colon_in_conditional" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_assignment_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_method" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_assignment_operator" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_local_variable" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_paren_in_parenthesized_expression"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_type_annotation" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_field" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_parenthesized_expression"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_loop_body_block_on_one_line" value="one_line_never"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_if_then_body_block_on_one_line" value="one_line_never"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_parenthesized_expression"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_lambda_body_block_on_one_line" value="one_line_preserve"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_code_block_on_one_line" value="one_line_never"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_paren_in_cast" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_method_body_on_one_line" value="one_line_never"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_paren_in_cast" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_simple_getter_setter_on_one_line" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_paren_in_cast" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_type_declaration_on_one_line" value="one_line_preserve"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_type_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_anonymous_type_declaration_on_one_line" value="one_line_preserve"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_enum_declaration_on_one_line" value="one_line_preserve"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_brackets_in_array_type_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_enum_constant_declaration_on_one_line" value="one_line_preserve"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_record_declaration_on_one_line" value="one_line_preserve"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_allocation_expression"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_record_constructor_on_one_line" value="one_line_never"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.keep_annotation_declaration_on_one_line" value="one_line_preserve"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_allocation_expression"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.lineSplit" value="144"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.continuation_indentation" value="2"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_allocation_expression"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer" value="2"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_brackets_in_array_allocation_expression"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_outer_expressions_when_nested" value="false"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_brace_in_array_initializer"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration" value="16"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_multiple_fields" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_brace_in_array_initializer"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration" value="16"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_brace_in_array_initializer"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_method_declaration" value="0"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_array_initializer"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration" value="16"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_array_initializer" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_between_empty_braces_in_array_initializer"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration" value="16"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_record_components" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_bracket_in_array_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_record_declaration" value="16"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_bracket_in_array_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation" value="16"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_bracket_in_array_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression" value="16"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression" value="16"/>
|
<setting
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_multiplicative_operator" value="0"/>
|
id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_parameterized_type_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_multiplicative_operator" value="false"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_additive_operator" value="0"/>
|
<setting
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_additive_operator" value="false"/>
|
id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_parameterized_type_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_string_concatenation" value="0"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_string_concatenation" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_parameterized_type_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_shift_operator" value="0"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_shift_operator" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_parameterized_type_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_relational_operator" value="0"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_relational_operator" value="false"/>
|
<setting
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_bitwise_operator" value="0"/>
|
id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_parameterized_type_reference"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_bitwise_operator" value="false"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_logical_operator" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_logical_operator" value="false"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression" value="48"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression_chain" value="0"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_conditional_operator" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_arguments" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_assignment" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_arguments" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_assignment_operator" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer" value="16"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_for_loop_header" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_arguments"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_if" value="16"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_loops" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_opening_angle_bracket_in_type_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_resources_in_try" value="80"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_union_type_in_multicatch" value="16"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_opening_angle_bracket_in_type_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_or_operator_multicatch" value="false"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_assertion_message" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_comma_in_type_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.wrap_before_assertion_message_operator" value="false"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameterized_type_references" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_type_parameters" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_arguments" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_closing_angle_bracket_in_type_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_parameters" value="0"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_package" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_closing_angle_bracket_in_type_parameters"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_type" value="49"/>
|
value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_enum_constant" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_and_in_type_parameter" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_field" value="49"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_and_in_type_parameter" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_method" value="49"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_before_question_in_wildcard" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_local_variable" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_space_after_question_in_wildcard" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_parameter" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.number_of_empty_lines_to_preserve" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_annotations" value="49"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_package" value="0"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_annotation" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_package" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.alignment_for_module_statements" value="0"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_imports" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="144"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_imports" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.count_line_length_from_starting_position" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_between_type_declarations" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_first_class_body_declaration" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_after_last_class_body_declaration" value="0"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_new_chunk" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.format_line_comment_starting_on_first_column" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_member_type" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.format_header" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_field" value="0"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_abstract_method" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.never_indent_line_comments_on_first_column" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.blank_lines_before_method" value="1"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.never_indent_block_comments_on_first_column" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.number_of_blank_lines_at_beginning_of_method_body" value="0"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.join_lines_in_comments" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.put_empty_statement_on_new_line" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.format_html" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_opening_brace_in_array_initializer"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.format_source_code" value="false"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags" value="insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_closing_brace_in_array_initializer"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_between_different_tags" value="do not insert"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.align_tags_names_descriptions" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_at_end_of_file_if_missing" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.align_tags_descriptions_grouped" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_else_in_if_statement" value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter" value="do not insert"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_catch_in_try_statement"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.indent_parameter_description" value="true"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.indent_tag_description" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_finally_in_try_statement"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.indent_root_tags" value="true"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.new_lines_at_javadoc_boundaries" value="true"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_before_while_in_do_statement"
|
||||||
<setting id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment" value="false"/>
|
value="do not insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.use_on_off_tags" value="false"/>
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_label" value="insert"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.enabling_tag" value="@formatter:on"/>
|
<setting id="org.eclipse.jdt.core.formatter.keep_then_statement_on_same_line" value="true"/>
|
||||||
<setting id="org.eclipse.jdt.core.formatter.disabling_tag" value="@formatter:off"/>
|
<setting id="org.eclipse.jdt.core.formatter.keep_imple_if_on_one_line" value="false"/>
|
||||||
</profile>
|
<setting id="org.eclipse.jdt.core.formatter.keep_else_statement_on_same_line" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.compact_else_if" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_simple_for_body_on_same_line" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_simple_while_body_on_same_line" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_simple_do_while_body_on_same_line" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_package" value="insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_type" value="insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_enum_constant"
|
||||||
|
value="do not insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_parameter"
|
||||||
|
value="do not insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_method" value="insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_local_variable"
|
||||||
|
value="do not insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_type_annotation" value="do not insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.insert_new_line_after_annotation_on_field" value="insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_loop_body_block_on_one_line" value="one_line_never"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_if_then_body_block_on_one_line" value="one_line_never"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_lambda_body_block_on_one_line" value="one_line_preserve"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_code_block_on_one_line" value="one_line_never"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_method_body_on_one_line" value="one_line_never"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_simple_getter_setter_on_one_line" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_type_declaration_on_one_line" value="one_line_preserve"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_anonymous_type_declaration_on_one_line"
|
||||||
|
value="one_line_preserve"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_enum_declaration_on_one_line" value="one_line_preserve"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_enum_constant_declaration_on_one_line"
|
||||||
|
value="one_line_preserve"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_record_declaration_on_one_line" value="one_line_preserve"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_record_constructor_on_one_line" value="one_line_never"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.keep_annotation_declaration_on_one_line" value="one_line_preserve"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.lineSplit" value="144"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.continuation_indentation" value="2"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.continuation_indentation_for_array_initializer" value="2"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.join_wrapped_lines" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_outer_expressions_when_nested" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_type_declaration" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_multiple_fields" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_constructor_declaration" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_constructor_declaration" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_method_declaration" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_throws_clause_in_method_declaration" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameters_in_method_declaration" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_enum_constants" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_enum_constant" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_enum_declaration" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_record_components" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_superinterfaces_in_record_declaration" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_method_invocation" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_selector_in_method_invocation" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_explicit_constructor_call" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_allocation_expression" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_qualified_allocation_expression"
|
||||||
|
value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_multiplicative_operator" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_multiplicative_operator" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_additive_operator" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_additive_operator" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_string_concatenation" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_string_concatenation" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_shift_operator" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_shift_operator" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_relational_operator" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_relational_operator" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_bitwise_operator" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_bitwise_operator" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_logical_operator" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_logical_operator" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression" value="48"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_conditional_expression_chain" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_conditional_operator" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_assignment" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_assignment_operator" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_array_initializer" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_expressions_in_for_loop_header" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_if" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_compact_loops" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_resources_in_try" value="80"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_union_type_in_multicatch" value="16"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_or_operator_multicatch" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_assertion_message" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.wrap_before_assertion_message_operator" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_parameterized_type_references" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_arguments" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_parameters" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_package" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_type" value="49"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_enum_constant" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_field" value="49"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_method" value="49"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_local_variable" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_annotations_on_parameter" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_type_annotations" value="49"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_arguments_in_annotation" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.alignment_for_module_statements" value="0"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="144"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.count_line_length_from_starting_position" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.format_line_comment_starting_on_first_column" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.format_header" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.preserve_white_space_between_code_and_line_comments"
|
||||||
|
value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.never_indent_line_comments_on_first_column" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.never_indent_block_comments_on_first_column" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.join_lines_in_comments" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.format_html" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.format_source_code" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags" value="insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_between_different_tags"
|
||||||
|
value="do not insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.align_tags_names_descriptions" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.align_tags_descriptions_grouped" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter" value="do not insert"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.indent_parameter_description" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.indent_tag_description" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.indent_root_tags" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.new_lines_at_javadoc_boundaries" value="true"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines_in_javadoc_comment" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.use_on_off_tags" value="false"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.enabling_tag" value="@formatter:on"/>
|
||||||
|
<setting id="org.eclipse.jdt.core.formatter.disabling_tag" value="@formatter:off"/>
|
||||||
|
</profile>
|
||||||
</profiles>
|
</profiles>
|
||||||
@@ -25,7 +25,8 @@ When starting a rollout, for all targets within this rollout deployment actions
|
|||||||
of the first group will be started immediately all other deployment actions will be scheduled.
|
of the first group will be started immediately all other deployment actions will be scheduled.
|
||||||
|
|
||||||
> Due rollouts might include a large number of targets and deployment group, creation as well as starting a rollout
|
> Due rollouts might include a large number of targets and deployment group, creation as well as starting a rollout
|
||||||
> might take some time and therefore the creation and starting of an rollout is executed asynchronously. The creation and
|
> might take some time and therefore the creation and starting of an rollout is executed asynchronously. The creation
|
||||||
|
> and
|
||||||
> starting progress is reflected by the rollout's status attribute
|
> starting progress is reflected by the rollout's status attribute
|
||||||
|
|
||||||
### Rollout Creation
|
### Rollout Creation
|
||||||
|
|||||||
@@ -41,6 +41,11 @@ public abstract class AbstractRolloutGroupEvent extends RemoteEntityEvent<Rollou
|
|||||||
return rolloutId;
|
return rolloutId;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public int hashCode() {
|
||||||
|
return Objects.hash(super.hashCode(), rolloutId);
|
||||||
|
}
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public boolean equals(final Object o) {
|
public boolean equals(final Object o) {
|
||||||
if (this == o)
|
if (this == o)
|
||||||
@@ -52,9 +57,4 @@ public abstract class AbstractRolloutGroupEvent extends RemoteEntityEvent<Rollou
|
|||||||
final AbstractRolloutGroupEvent that = (AbstractRolloutGroupEvent) o;
|
final AbstractRolloutGroupEvent that = (AbstractRolloutGroupEvent) o;
|
||||||
return Objects.equals(rolloutId, that.rolloutId);
|
return Objects.equals(rolloutId, that.rolloutId);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override
|
|
||||||
public int hashCode() {
|
|
||||||
return Objects.hash(super.hashCode(), rolloutId);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -82,6 +82,7 @@ public final class MgmtRestConstants {
|
|||||||
* The basic authentication validation mapping
|
* The basic authentication validation mapping
|
||||||
*/
|
*/
|
||||||
public static final String AUTH_V1_REQUEST_MAPPING = BASE_V1_REQUEST_MAPPING + "/userinfo";
|
public static final String AUTH_V1_REQUEST_MAPPING = BASE_V1_REQUEST_MAPPING + "/userinfo";
|
||||||
|
public static final String SYSTEM_V1_REQUEST_MAPPING = BASE_V1_REQUEST_MAPPING + BASE_SYSTEM_MAPPING;
|
||||||
/**
|
/**
|
||||||
* String representation of
|
* String representation of
|
||||||
* {@link #REQUEST_PARAMETER_PAGING_DEFAULT_LIMIT_VALUE}.
|
* {@link #REQUEST_PARAMETER_PAGING_DEFAULT_LIMIT_VALUE}.
|
||||||
@@ -99,7 +100,6 @@ public final class MgmtRestConstants {
|
|||||||
* The base URL mapping for the spring acuator management context path.
|
* The base URL mapping for the spring acuator management context path.
|
||||||
*/
|
*/
|
||||||
public static final String BASE_SYSTEM_MAPPING = "/system";
|
public static final String BASE_SYSTEM_MAPPING = "/system";
|
||||||
public static final String SYSTEM_V1_REQUEST_MAPPING = BASE_V1_REQUEST_MAPPING + BASE_SYSTEM_MAPPING;
|
|
||||||
/**
|
/**
|
||||||
* URL mapping for system admin operations.
|
* URL mapping for system admin operations.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -10,35 +10,34 @@
|
|||||||
|
|
||||||
-->
|
-->
|
||||||
<project
|
<project
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk</artifactId>
|
<artifactId>hawkbit-sdk</artifactId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>hawkbit-sdk-commons</artifactId>
|
<artifactId>hawkbit-sdk-commons</artifactId>
|
||||||
<name>hawkBit :: SDK :: Commons</name>
|
<name>hawkBit :: SDK :: Commons</name>
|
||||||
<description>SDK commons</description>
|
<description>SDK commons</description>
|
||||||
|
|
||||||
|
|
||||||
|
<dependencies>
|
||||||
<dependencies>
|
<dependency>
|
||||||
<dependency>
|
<groupId>org.springframework.cloud</groupId>
|
||||||
<groupId>org.springframework.cloud</groupId>
|
<artifactId>spring-cloud-starter-openfeign</artifactId>
|
||||||
<artifactId>spring-cloud-starter-openfeign</artifactId>
|
<version>${spring-cloud-starter-openfeign.version}</version>
|
||||||
<version>${spring-cloud-starter-openfeign.version}</version>
|
</dependency>
|
||||||
</dependency>
|
<dependency>
|
||||||
<dependency>
|
<groupId>io.github.openfeign</groupId>
|
||||||
<groupId>io.github.openfeign</groupId>
|
<artifactId>feign-hc5</artifactId>
|
||||||
<artifactId>feign-hc5</artifactId>
|
<version>${openfeign-hc5.version}</version>
|
||||||
<version>${openfeign-hc5.version}</version>
|
</dependency>
|
||||||
</dependency>
|
<dependency>
|
||||||
<dependency>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<groupId>org.springframework.boot</groupId>
|
<artifactId>spring-boot-starter-hateoas</artifactId>
|
||||||
<artifactId>spring-boot-starter-hateoas</artifactId>
|
</dependency>
|
||||||
</dependency>
|
</dependencies>
|
||||||
</dependencies>
|
|
||||||
</project>
|
</project>
|
||||||
|
|||||||
@@ -11,8 +11,6 @@ package org.eclipse.hawkbit.sdk;
|
|||||||
|
|
||||||
import lombok.Builder;
|
import lombok.Builder;
|
||||||
import lombok.Data;
|
import lombok.Data;
|
||||||
import lombok.ToString;
|
|
||||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
|
||||||
import org.springframework.lang.NonNull;
|
import org.springframework.lang.NonNull;
|
||||||
import org.springframework.lang.Nullable;
|
import org.springframework.lang.Nullable;
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,11 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk;
|
package org.eclipse.hawkbit.sdk;
|
||||||
|
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.util.Base64;
|
||||||
|
import java.util.Objects;
|
||||||
|
import java.util.function.BiFunction;
|
||||||
|
|
||||||
import feign.Client;
|
import feign.Client;
|
||||||
import feign.Contract;
|
import feign.Contract;
|
||||||
import feign.Feign;
|
import feign.Feign;
|
||||||
@@ -20,49 +25,42 @@ import lombok.Builder;
|
|||||||
import lombok.extern.slf4j.Slf4j;
|
import lombok.extern.slf4j.Slf4j;
|
||||||
import org.springframework.util.ObjectUtils;
|
import org.springframework.util.ObjectUtils;
|
||||||
|
|
||||||
import java.nio.charset.StandardCharsets;
|
|
||||||
import java.util.Base64;
|
|
||||||
import java.util.Objects;
|
|
||||||
import java.util.function.BiFunction;
|
|
||||||
|
|
||||||
@Slf4j
|
@Slf4j
|
||||||
@Builder
|
@Builder
|
||||||
public class HawkbitClient {
|
public class HawkbitClient {
|
||||||
|
|
||||||
private static final String AUTHORIZATION = "Authorization";
|
private static final String AUTHORIZATION = "Authorization";
|
||||||
private static final ErrorDecoder DEFAULT_ERROR_DECODER_0 = new ErrorDecoder.Default();
|
public static final BiFunction<Tenant, Controller, RequestInterceptor> DEFAULT_REQUEST_INTERCEPTOR_FN =
|
||||||
|
(tenant, controller) ->
|
||||||
|
controller == null ?
|
||||||
|
template -> {
|
||||||
|
template.header(
|
||||||
|
AUTHORIZATION,
|
||||||
|
|
||||||
|
"Basic " +
|
||||||
|
Base64.getEncoder()
|
||||||
|
.encodeToString(
|
||||||
|
(Objects.requireNonNull(tenant.getUsername(), "User is null!") +
|
||||||
|
":" +
|
||||||
|
Objects.requireNonNull(tenant.getPassword(),
|
||||||
|
"Password is not available!"))
|
||||||
|
.getBytes(StandardCharsets.ISO_8859_1)));
|
||||||
|
} :
|
||||||
|
template -> {
|
||||||
|
if (ObjectUtils.isEmpty(tenant.getGatewayToken())) {
|
||||||
|
if (!ObjectUtils.isEmpty(controller.getSecurityToken())) {
|
||||||
|
template.header(AUTHORIZATION, "TargetToken " + controller.getSecurityToken());
|
||||||
|
} // else do not sent authentication
|
||||||
|
} else {
|
||||||
|
template.header(AUTHORIZATION, "GatewayToken " + tenant.getGatewayToken());
|
||||||
|
}
|
||||||
|
};
|
||||||
|
private static final ErrorDecoder DEFAULT_ERROR_DECODER_0 = new ErrorDecoder.Default();
|
||||||
public static final ErrorDecoder DEFAULT_ERROR_DECODER = (methodKey, response) -> {
|
public static final ErrorDecoder DEFAULT_ERROR_DECODER = (methodKey, response) -> {
|
||||||
final Exception e = DEFAULT_ERROR_DECODER_0.decode(methodKey, response);
|
final Exception e = DEFAULT_ERROR_DECODER_0.decode(methodKey, response);
|
||||||
log.trace("REST API call failed!", e);
|
log.trace("REST API call failed!", e);
|
||||||
return e;
|
return e;
|
||||||
};
|
};
|
||||||
|
|
||||||
public static final BiFunction<Tenant, Controller, RequestInterceptor> DEFAULT_REQUEST_INTERCEPTOR_FN =
|
|
||||||
(tenant, controller) ->
|
|
||||||
controller == null ?
|
|
||||||
template -> {
|
|
||||||
template.header(
|
|
||||||
AUTHORIZATION,
|
|
||||||
|
|
||||||
"Basic " +
|
|
||||||
Base64.getEncoder()
|
|
||||||
.encodeToString(
|
|
||||||
(Objects.requireNonNull(tenant.getUsername(), "User is null!") +
|
|
||||||
":" +
|
|
||||||
Objects.requireNonNull(tenant.getPassword(),"Password is not available!"))
|
|
||||||
.getBytes(StandardCharsets.ISO_8859_1)));
|
|
||||||
} :
|
|
||||||
template -> {
|
|
||||||
if (ObjectUtils.isEmpty(tenant.getGatewayToken())) {
|
|
||||||
if (!ObjectUtils.isEmpty(controller.getSecurityToken())) {
|
|
||||||
template.header(AUTHORIZATION, "TargetToken " + controller.getSecurityToken());
|
|
||||||
} // else do not sent authentication
|
|
||||||
} else {
|
|
||||||
template.header(AUTHORIZATION, "GatewayToken " + tenant.getGatewayToken());
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
private final HawkbitServer hawkBitServerProperties;
|
private final HawkbitServer hawkBitServerProperties;
|
||||||
|
|
||||||
private final Client client;
|
private final Client client;
|
||||||
@@ -100,6 +98,7 @@ public class HawkbitClient {
|
|||||||
public <T> T mgmtService(final Class<T> serviceType, final Tenant tenantProperties) {
|
public <T> T mgmtService(final Class<T> serviceType, final Tenant tenantProperties) {
|
||||||
return service(serviceType, tenantProperties, null);
|
return service(serviceType, tenantProperties, null);
|
||||||
}
|
}
|
||||||
|
|
||||||
public <T> T ddiService(final Class<T> serviceType, final Tenant tenantProperties, final Controller controller) {
|
public <T> T ddiService(final Class<T> serviceType, final Tenant tenantProperties, final Controller controller) {
|
||||||
return service(serviceType, tenantProperties, controller);
|
return service(serviceType, tenantProperties, controller);
|
||||||
}
|
}
|
||||||
@@ -113,7 +112,7 @@ public class HawkbitClient {
|
|||||||
.requestInterceptor(requestInterceptorFn.apply(tenant, controller))
|
.requestInterceptor(requestInterceptorFn.apply(tenant, controller))
|
||||||
.target(serviceType,
|
.target(serviceType,
|
||||||
controller == null ?
|
controller == null ?
|
||||||
hawkBitServerProperties.getMgmtUrl() :
|
hawkBitServerProperties.getMgmtUrl() :
|
||||||
hawkBitServerProperties.getDdiUrl());
|
hawkBitServerProperties.getDdiUrl());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -9,6 +9,10 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk;
|
package org.eclipse.hawkbit.sdk;
|
||||||
|
|
||||||
|
import java.lang.annotation.Annotation;
|
||||||
|
import java.lang.reflect.Method;
|
||||||
|
import java.util.LinkedHashMap;
|
||||||
|
|
||||||
import feign.Contract;
|
import feign.Contract;
|
||||||
import feign.MethodMetadata;
|
import feign.MethodMetadata;
|
||||||
import feign.RequestInterceptor;
|
import feign.RequestInterceptor;
|
||||||
@@ -30,13 +34,9 @@ import org.springframework.hateoas.config.EnableHypermediaSupport;
|
|||||||
import org.springframework.hateoas.config.WebConverters;
|
import org.springframework.hateoas.config.WebConverters;
|
||||||
import org.springframework.http.MediaType;
|
import org.springframework.http.MediaType;
|
||||||
|
|
||||||
import java.lang.annotation.Annotation;
|
|
||||||
import java.lang.reflect.Method;
|
|
||||||
import java.util.LinkedHashMap;
|
|
||||||
|
|
||||||
@Slf4j
|
@Slf4j
|
||||||
@Configuration
|
@Configuration
|
||||||
@EnableConfigurationProperties({ HawkbitServer.class, Tenant.class})
|
@EnableConfigurationProperties({ HawkbitServer.class, Tenant.class })
|
||||||
@EnableHypermediaSupport(type = EnableHypermediaSupport.HypermediaType.HAL)
|
@EnableHypermediaSupport(type = EnableHypermediaSupport.HypermediaType.HAL)
|
||||||
@Import(FeignClientsConfiguration.class)
|
@Import(FeignClientsConfiguration.class)
|
||||||
@PropertySource("classpath:/hawkbit-sdk-defaults.properties")
|
@PropertySource("classpath:/hawkbit-sdk-defaults.properties")
|
||||||
@@ -62,7 +62,7 @@ public class HawkbitSDKConfigurtion {
|
|||||||
@Bean
|
@Bean
|
||||||
@ConditionalOnMissingBean
|
@ConditionalOnMissingBean
|
||||||
@ConditionalOnNotWebApplication
|
@ConditionalOnNotWebApplication
|
||||||
@ConditionalOnClass({ WebConverters.class})
|
@ConditionalOnClass({ WebConverters.class })
|
||||||
public HttpMessageConverterCustomizer webConvertersCustomizerOverrider(WebConverters webConverters) {
|
public HttpMessageConverterCustomizer webConvertersCustomizerOverrider(WebConverters webConverters) {
|
||||||
return new WebConvertersCustomizer(webConverters);
|
return new WebConvertersCustomizer(webConverters);
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ import lombok.Data;
|
|||||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||||
import org.springframework.lang.NonNull;
|
import org.springframework.lang.NonNull;
|
||||||
|
|
||||||
@ConfigurationProperties(prefix="hawkbit.server")
|
@ConfigurationProperties(prefix = "hawkbit.server")
|
||||||
@Data
|
@Data
|
||||||
public class HawkbitServer {
|
public class HawkbitServer {
|
||||||
|
|
||||||
|
|||||||
@@ -25,11 +25,8 @@ public interface ArtifactHandler {
|
|||||||
|
|
||||||
interface DownloadHandler {
|
interface DownloadHandler {
|
||||||
|
|
||||||
enum Status {
|
|
||||||
SUCCESS, ERROR
|
|
||||||
}
|
|
||||||
|
|
||||||
DownloadHandler SKIP = new DownloadHandler() {
|
DownloadHandler SKIP = new DownloadHandler() {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void read(byte[] buff, int off, int len) {
|
public void read(byte[] buff, int off, int len) {
|
||||||
// skip
|
// skip
|
||||||
@@ -69,5 +66,9 @@ public interface ArtifactHandler {
|
|||||||
* @return the path to the download
|
* @return the path to the download
|
||||||
*/
|
*/
|
||||||
Optional<Path> download();
|
Optional<Path> download();
|
||||||
|
|
||||||
|
enum Status {
|
||||||
|
SUCCESS, ERROR
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,72 +10,72 @@
|
|||||||
|
|
||||||
-->
|
-->
|
||||||
<project
|
<project
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk</artifactId>
|
<artifactId>hawkbit-sdk</artifactId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>hawkbit-sdk-demo</artifactId>
|
<artifactId>hawkbit-sdk-demo</artifactId>
|
||||||
<name>hawkBit :: SDK :: Test / Example</name>
|
<name>hawkBit :: SDK :: Test / Example</name>
|
||||||
<description>Test / Example of how SDK could be used to for devices and for Mgmt API access</description>
|
<description>Test / Example of how SDK could be used to for devices and for Mgmt API access</description>
|
||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
<spring-shell.version>3.1.5</spring-shell.version>
|
<spring-shell.version>3.1.5</spring-shell.version>
|
||||||
<spring.app.class>org.eclipse.hawkbit.sdk.demo.multidevice.MultiDeviceApp</spring.app.class>
|
<spring.app.class>org.eclipse.hawkbit.sdk.demo.multidevice.MultiDeviceApp</spring.app.class>
|
||||||
<start-class>${spring.app.class}</start-class>
|
<start-class>${spring.app.class}</start-class>
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk-device</artifactId>
|
<artifactId>hawkbit-sdk-device</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk-dmf</artifactId>
|
<artifactId>hawkbit-sdk-dmf</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk-mgmt</artifactId>
|
<artifactId>hawkbit-sdk-mgmt</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.shell</groupId>
|
<groupId>org.springframework.shell</groupId>
|
||||||
<artifactId>spring-shell-starter</artifactId>
|
<artifactId>spring-shell-starter</artifactId>
|
||||||
<version>${spring-shell.version}</version>
|
<version>${spring-shell.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
|
||||||
<build>
|
<build>
|
||||||
<plugins>
|
<plugins>
|
||||||
<plugin>
|
<plugin>
|
||||||
<groupId>org.springframework.boot</groupId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<artifactId>spring-boot-maven-plugin</artifactId>
|
<artifactId>spring-boot-maven-plugin</artifactId>
|
||||||
<executions>
|
<executions>
|
||||||
<execution>
|
<execution>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>repackage</goal>
|
<goal>repackage</goal>
|
||||||
</goals>
|
</goals>
|
||||||
<configuration>
|
<configuration>
|
||||||
<outputDirectory>${baseDir}</outputDirectory>
|
<outputDirectory>${baseDir}</outputDirectory>
|
||||||
<layout>JAR</layout>
|
<layout>JAR</layout>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
</executions>
|
</executions>
|
||||||
</plugin>
|
</plugin>
|
||||||
</plugins>
|
</plugins>
|
||||||
|
|
||||||
<resources>
|
<resources>
|
||||||
<resource>
|
<resource>
|
||||||
<directory>src/main/resources</directory>
|
<directory>src/main/resources</directory>
|
||||||
</resource>
|
</resource>
|
||||||
</resources>
|
</resources>
|
||||||
</build>
|
</build>
|
||||||
</project>
|
</project>
|
||||||
|
|||||||
@@ -9,6 +9,9 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.demo.device;
|
package org.eclipse.hawkbit.sdk.demo.device;
|
||||||
|
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.concurrent.Executors;
|
||||||
|
|
||||||
import feign.Client;
|
import feign.Client;
|
||||||
import feign.Contract;
|
import feign.Contract;
|
||||||
import feign.codec.Decoder;
|
import feign.codec.Decoder;
|
||||||
@@ -29,9 +32,6 @@ import org.springframework.shell.standard.ShellComponent;
|
|||||||
import org.springframework.shell.standard.ShellMethod;
|
import org.springframework.shell.standard.ShellMethod;
|
||||||
import org.springframework.util.ObjectUtils;
|
import org.springframework.util.ObjectUtils;
|
||||||
|
|
||||||
import java.util.Optional;
|
|
||||||
import java.util.concurrent.Executors;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Abstract class representing DDI device connecting directly to hawkVit.
|
* Abstract class representing DDI device connecting directly to hawkVit.
|
||||||
*/
|
*/
|
||||||
@@ -52,7 +52,7 @@ public class DeviceApp {
|
|||||||
|
|
||||||
@Bean
|
@Bean
|
||||||
DdiTenant ddiTenant(final Tenant defaultTenant,
|
DdiTenant ddiTenant(final Tenant defaultTenant,
|
||||||
final HawkbitClient hawkbitClient) {
|
final HawkbitClient hawkbitClient) {
|
||||||
return new DdiTenant(defaultTenant, hawkbitClient);
|
return new DdiTenant(defaultTenant, hawkbitClient);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -69,7 +69,6 @@ public class DeviceApp {
|
|||||||
private final DdiController device;
|
private final DdiController device;
|
||||||
private final MgmtApi mgmtApi;
|
private final MgmtApi mgmtApi;
|
||||||
|
|
||||||
|
|
||||||
Shell(final DdiTenant ddiTenant, final MgmtApi mgmtApi, final Optional<UpdateHandler> updateHandler) {
|
Shell(final DdiTenant ddiTenant, final MgmtApi mgmtApi, final Optional<UpdateHandler> updateHandler) {
|
||||||
this.ddiTenant = ddiTenant;
|
this.ddiTenant = ddiTenant;
|
||||||
this.mgmtApi = mgmtApi;
|
this.mgmtApi = mgmtApi;
|
||||||
@@ -88,7 +87,7 @@ public class DeviceApp {
|
|||||||
@ShellMethod(key = "setup")
|
@ShellMethod(key = "setup")
|
||||||
public void setup() {
|
public void setup() {
|
||||||
mgmtApi.setupTargetAuthentication();
|
mgmtApi.setupTargetAuthentication();
|
||||||
mgmtApi.setupTargetToken(device.getControllerId(),device.getTargetSecurityToken());
|
mgmtApi.setupTargetToken(device.getControllerId(), device.getTargetSecurityToken());
|
||||||
}
|
}
|
||||||
|
|
||||||
@ShellMethod(key = "start")
|
@ShellMethod(key = "start")
|
||||||
|
|||||||
@@ -9,6 +9,9 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.demo.dmf;
|
package org.eclipse.hawkbit.sdk.demo.dmf;
|
||||||
|
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.concurrent.Executors;
|
||||||
|
|
||||||
import lombok.extern.slf4j.Slf4j;
|
import lombok.extern.slf4j.Slf4j;
|
||||||
import org.eclipse.hawkbit.sdk.Controller;
|
import org.eclipse.hawkbit.sdk.Controller;
|
||||||
import org.eclipse.hawkbit.sdk.Tenant;
|
import org.eclipse.hawkbit.sdk.Tenant;
|
||||||
@@ -26,9 +29,6 @@ import org.springframework.shell.standard.ShellComponent;
|
|||||||
import org.springframework.shell.standard.ShellMethod;
|
import org.springframework.shell.standard.ShellMethod;
|
||||||
import org.springframework.shell.standard.ShellOption;
|
import org.springframework.shell.standard.ShellOption;
|
||||||
|
|
||||||
import java.util.Optional;
|
|
||||||
import java.util.concurrent.Executors;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Abstract class representing DDI device connecting directly to hawkVit.
|
* Abstract class representing DDI device connecting directly to hawkVit.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -9,6 +9,9 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.demo.multidevice;
|
package org.eclipse.hawkbit.sdk.demo.multidevice;
|
||||||
|
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.concurrent.Executors;
|
||||||
|
|
||||||
import feign.Client;
|
import feign.Client;
|
||||||
import feign.Contract;
|
import feign.Contract;
|
||||||
import feign.codec.Decoder;
|
import feign.codec.Decoder;
|
||||||
@@ -29,9 +32,6 @@ import org.springframework.shell.standard.ShellComponent;
|
|||||||
import org.springframework.shell.standard.ShellMethod;
|
import org.springframework.shell.standard.ShellMethod;
|
||||||
import org.springframework.shell.standard.ShellOption;
|
import org.springframework.shell.standard.ShellOption;
|
||||||
|
|
||||||
import java.util.Optional;
|
|
||||||
import java.util.concurrent.Executors;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Abstract class representing DDI device connecting directly to hawkVit.
|
* Abstract class representing DDI device connecting directly to hawkVit.
|
||||||
*/
|
*/
|
||||||
@@ -52,7 +52,7 @@ public class MultiDeviceApp {
|
|||||||
|
|
||||||
@Bean
|
@Bean
|
||||||
DdiTenant ddiTenant(final Tenant defaultTenant,
|
DdiTenant ddiTenant(final Tenant defaultTenant,
|
||||||
final HawkbitClient hawkbitClient) {
|
final HawkbitClient hawkbitClient) {
|
||||||
return new DdiTenant(defaultTenant, hawkbitClient);
|
return new DdiTenant(defaultTenant, hawkbitClient);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -86,7 +86,7 @@ public class MultiDeviceApp {
|
|||||||
public void startOne(@ShellOption("--id") final String controllerId) {
|
public void startOne(@ShellOption("--id") final String controllerId) {
|
||||||
final String securityTargetToken;
|
final String securityTargetToken;
|
||||||
if (setup) {
|
if (setup) {
|
||||||
securityTargetToken = mgmtApi.setupTargetToken(controllerId,null);
|
securityTargetToken = mgmtApi.setupTargetToken(controllerId, null);
|
||||||
} else {
|
} else {
|
||||||
securityTargetToken = null;
|
securityTargetToken = null;
|
||||||
}
|
}
|
||||||
@@ -96,12 +96,12 @@ public class MultiDeviceApp {
|
|||||||
ddiTenant.getController(controllerId).ifPresentOrElse(
|
ddiTenant.getController(controllerId).ifPresentOrElse(
|
||||||
ddiController -> ddiController.start(Executors.newSingleThreadScheduledExecutor()),
|
ddiController -> ddiController.start(Executors.newSingleThreadScheduledExecutor()),
|
||||||
() -> ddiTenant.createController(Controller.builder()
|
() -> ddiTenant.createController(Controller.builder()
|
||||||
.controllerId(controllerId)
|
.controllerId(controllerId)
|
||||||
.securityToken(securityTargetToken)
|
.securityToken(securityTargetToken)
|
||||||
.build(),updateHandler)
|
.build(), updateHandler)
|
||||||
.setOverridePollMillis(10_000)
|
.setOverridePollMillis(10_000)
|
||||||
.start(Executors.newSingleThreadScheduledExecutor())
|
.start(Executors.newSingleThreadScheduledExecutor())
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ShellMethod(key = "stop-one")
|
@ShellMethod(key = "stop-one")
|
||||||
|
|||||||
@@ -10,31 +10,31 @@
|
|||||||
|
|
||||||
-->
|
-->
|
||||||
<project
|
<project
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk</artifactId>
|
<artifactId>hawkbit-sdk</artifactId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>hawkbit-sdk-device</artifactId>
|
<artifactId>hawkbit-sdk-device</artifactId>
|
||||||
<name>hawkBit :: SDK :: Device SDK</name>
|
<name>hawkBit :: SDK :: Device SDK</name>
|
||||||
<description>Device SDK that could be used for development of devices on JVM based languages</description>
|
<description>Device SDK that could be used for development of devices on JVM based languages</description>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk-commons</artifactId>
|
<artifactId>hawkbit-sdk-commons</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-ddi-api</artifactId>
|
<artifactId>hawkbit-ddi-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
</dependencies>
|
</dependencies>
|
||||||
</project>
|
</project>
|
||||||
@@ -9,6 +9,17 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.device;
|
package org.eclipse.hawkbit.sdk.device;
|
||||||
|
|
||||||
|
import java.time.LocalTime;
|
||||||
|
import java.time.temporal.ChronoField;
|
||||||
|
import java.util.AbstractMap;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Objects;
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.concurrent.ScheduledExecutorService;
|
||||||
|
import java.util.concurrent.TimeUnit;
|
||||||
|
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import lombok.Setter;
|
import lombok.Setter;
|
||||||
import lombok.experimental.Accessors;
|
import lombok.experimental.Accessors;
|
||||||
@@ -28,17 +39,6 @@ import org.springframework.hateoas.Link;
|
|||||||
import org.springframework.http.HttpStatus;
|
import org.springframework.http.HttpStatus;
|
||||||
import org.springframework.http.ResponseEntity;
|
import org.springframework.http.ResponseEntity;
|
||||||
|
|
||||||
import java.time.LocalTime;
|
|
||||||
import java.time.temporal.ChronoField;
|
|
||||||
import java.util.AbstractMap;
|
|
||||||
import java.util.Collections;
|
|
||||||
import java.util.List;
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.Objects;
|
|
||||||
import java.util.Optional;
|
|
||||||
import java.util.concurrent.ScheduledExecutorService;
|
|
||||||
import java.util.concurrent.TimeUnit;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class representing DDI device connecting directly to hawkBit.
|
* Class representing DDI device connecting directly to hawkBit.
|
||||||
*/
|
*/
|
||||||
@@ -81,10 +81,10 @@ public class DdiController {
|
|||||||
* @param tenant the tenant of the device belongs to
|
* @param tenant the tenant of the device belongs to
|
||||||
* @param controller the controller
|
* @param controller the controller
|
||||||
* @param hawkbitClient a factory for creating to {@link DdiRootControllerRestApi} (and used)
|
* @param hawkbitClient a factory for creating to {@link DdiRootControllerRestApi} (and used)
|
||||||
* for communication to hawkBit
|
* for communication to hawkBit
|
||||||
*/
|
*/
|
||||||
public DdiController(final Tenant tenant, final Controller controller,
|
public DdiController(final Tenant tenant, final Controller controller,
|
||||||
final UpdateHandler updateHandler, final HawkbitClient hawkbitClient) {
|
final UpdateHandler updateHandler, final HawkbitClient hawkbitClient) {
|
||||||
this.tenantId = tenant.getTenantId();
|
this.tenantId = tenant.getTenantId();
|
||||||
gatewayToken = tenant.getGatewayToken();
|
gatewayToken = tenant.getGatewayToken();
|
||||||
downloadAuthenticationEnabled = tenant.isDownloadAuthenticationEnabled();
|
downloadAuthenticationEnabled = tenant.isDownloadAuthenticationEnabled();
|
||||||
@@ -112,58 +112,88 @@ public class DdiController {
|
|||||||
currentActionId = null;
|
currentActionId = null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public void updateAttribute(final String mode, final String key, final String value) {
|
||||||
|
final DdiUpdateMode updateMode = switch (mode.toLowerCase()) {
|
||||||
|
case "replace" -> DdiUpdateMode.REPLACE;
|
||||||
|
case "remove" -> DdiUpdateMode.REMOVE;
|
||||||
|
default -> DdiUpdateMode.MERGE;
|
||||||
|
};
|
||||||
|
|
||||||
|
final DdiConfigData configData = new DdiConfigData(Collections.singletonMap(key, value), updateMode);
|
||||||
|
|
||||||
|
getDdiApi().putConfigData(configData, getTenantId(), getControllerId());
|
||||||
|
}
|
||||||
|
|
||||||
|
void sendFeedback(final UpdateStatus updateStatus) {
|
||||||
|
log.debug(LOG_PREFIX + "Send feedback {} -> {}", getTenantId(), getControllerId(), currentActionId, updateStatus);
|
||||||
|
try {
|
||||||
|
getDdiApi().postDeploymentBaseActionFeedback(updateStatus.feedback(), getTenantId(), getControllerId(),
|
||||||
|
currentActionId);
|
||||||
|
} catch (final RuntimeException e) {
|
||||||
|
log.error(LOG_PREFIX + "Failed to send feedback {} -> {}", getTenantId(), getControllerId(),
|
||||||
|
currentActionId, updateStatus, e);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (updateStatus.status() == UpdateStatus.Status.SUCCESSFUL ||
|
||||||
|
updateStatus.status() == UpdateStatus.Status.FAILURE) {
|
||||||
|
lastActionId = currentActionId;
|
||||||
|
currentActionId = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
private void poll() {
|
private void poll() {
|
||||||
log.debug(LOG_PREFIX + " Polling ...", tenantId, controllerId);
|
log.debug(LOG_PREFIX + " Polling ...", tenantId, controllerId);
|
||||||
Optional.ofNullable(executorService).ifPresent(executor ->
|
Optional.ofNullable(executorService).ifPresent(executor ->
|
||||||
getControllerBase().ifPresentOrElse(
|
getControllerBase().ifPresentOrElse(
|
||||||
controllerBase -> {
|
controllerBase -> {
|
||||||
final Optional<Link> confirmationBaseLink = getRequiredLink(controllerBase, CONFIRMATION_BASE_LINK);
|
final Optional<Link> confirmationBaseLink = getRequiredLink(controllerBase, CONFIRMATION_BASE_LINK);
|
||||||
if (confirmationBaseLink.isPresent()) {
|
if (confirmationBaseLink.isPresent()) {
|
||||||
final long actionId = getActionId(confirmationBaseLink.get());
|
final long actionId = getActionId(confirmationBaseLink.get());
|
||||||
log.info(LOG_PREFIX + "Confirmation is required for action {}!", getTenantId(),
|
log.info(LOG_PREFIX + "Confirmation is required for action {}!", getTenantId(),
|
||||||
getControllerId(), actionId);
|
getControllerId(), actionId);
|
||||||
// TODO - confirmation handler
|
// TODO - confirmation handler
|
||||||
sendConfirmationFeedback(actionId);
|
sendConfirmationFeedback(actionId);
|
||||||
executor.schedule(this::poll, IMMEDIATE_MS, TimeUnit.MILLISECONDS);
|
executor.schedule(this::poll, IMMEDIATE_MS, TimeUnit.MILLISECONDS);
|
||||||
} else {
|
} else {
|
||||||
getRequiredLink(controllerBase, DEPLOYMENT_BASE_LINK).flatMap(this::getActionWithDeployment).ifPresentOrElse(actionWithDeployment -> {
|
getRequiredLink(controllerBase, DEPLOYMENT_BASE_LINK).flatMap(this::getActionWithDeployment)
|
||||||
final long actionId = actionWithDeployment.getKey();
|
.ifPresentOrElse(actionWithDeployment -> {
|
||||||
if (currentActionId == null) {
|
final long actionId = actionWithDeployment.getKey();
|
||||||
if (lastActionId != null && lastActionId == actionId) {
|
if (currentActionId == null) {
|
||||||
log.info(LOG_PREFIX + "Still receive the last action {}",
|
if (lastActionId != null && lastActionId == actionId) {
|
||||||
getTenantId(), getControllerId(), actionId);
|
log.info(LOG_PREFIX + "Still receive the last action {}",
|
||||||
return;
|
getTenantId(), getControllerId(), actionId);
|
||||||
}
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
log.info(LOG_PREFIX + "Process action {}", getTenantId(), getControllerId(),
|
log.info(LOG_PREFIX + "Process action {}", getTenantId(), getControllerId(),
|
||||||
actionId);
|
actionId);
|
||||||
final DdiDeployment deployment = actionWithDeployment.getValue().getDeployment();
|
final DdiDeployment deployment = actionWithDeployment.getValue().getDeployment();
|
||||||
final DdiDeployment.HandlingType updateType = deployment.getUpdate();
|
final DdiDeployment.HandlingType updateType = deployment.getUpdate();
|
||||||
final List<DdiChunk> modules = deployment.getChunks();
|
final List<DdiChunk> modules = deployment.getChunks();
|
||||||
|
|
||||||
currentActionId = actionId;
|
currentActionId = actionId;
|
||||||
executor.submit(
|
executor.submit(
|
||||||
updateHandler.getUpdateProcessor(this, updateType, modules));
|
updateHandler.getUpdateProcessor(this, updateType, modules));
|
||||||
} else if (currentActionId != actionId) {
|
} else if (currentActionId != actionId) {
|
||||||
// TODO - cancel and start new one?
|
// TODO - cancel and start new one?
|
||||||
log.info(LOG_PREFIX + "Action {} is canceled while in process (new {})!", getTenantId(),
|
log.info(LOG_PREFIX + "Action {} is canceled while in process (new {})!", getTenantId(),
|
||||||
getControllerId(), currentActionId, actionId);
|
getControllerId(), currentActionId, actionId);
|
||||||
} // else same action - already processing
|
} // else same action - already processing
|
||||||
}, () -> {
|
}, () -> {
|
||||||
if (currentActionId != null) {
|
if (currentActionId != null) {
|
||||||
// TODO - cancel current?
|
// TODO - cancel current?
|
||||||
log.info(LOG_PREFIX + "Action {} is canceled while in process (not returned)!", getTenantId(),
|
log.info(LOG_PREFIX + "Action {} is canceled while in process (not returned)!", getTenantId(),
|
||||||
getControllerId(), getCurrentActionId());
|
getControllerId(), getCurrentActionId());
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
executor.schedule(this::poll, getPollMillis(controllerBase), TimeUnit.MILLISECONDS);
|
executor.schedule(this::poll, getPollMillis(controllerBase), TimeUnit.MILLISECONDS);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
() -> {
|
||||||
|
// error has occurred or no controller base hasn't been acquired
|
||||||
|
executor.schedule(this::poll, DEFAULT_POLL_MS, TimeUnit.MILLISECONDS);
|
||||||
}
|
}
|
||||||
},
|
));
|
||||||
() -> {
|
|
||||||
// error has occurred or no controller base hasn't been acquired
|
|
||||||
executor.schedule(this::poll, DEFAULT_POLL_MS, TimeUnit.MILLISECONDS);
|
|
||||||
}
|
|
||||||
));
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private Optional<DdiControllerBase> getControllerBase() {
|
private Optional<DdiControllerBase> getControllerBase() {
|
||||||
@@ -211,42 +241,14 @@ public class DdiController {
|
|||||||
final ResponseEntity<DdiDeploymentBase> action = getDdiApi()
|
final ResponseEntity<DdiDeploymentBase> action = getDdiApi()
|
||||||
.getControllerDeploymentBaseAction(getTenantId(), getControllerId(), actionId, -1, null);
|
.getControllerDeploymentBaseAction(getTenantId(), getControllerId(), actionId, -1, null);
|
||||||
if (action.getStatusCode() != HttpStatus.OK) {
|
if (action.getStatusCode() != HttpStatus.OK) {
|
||||||
log.warn(LOG_PREFIX + "Fail to get deployment action: {} -> {}", getTenantId(), getControllerId(), actionId, action.getStatusCode());
|
log.warn(LOG_PREFIX + "Fail to get deployment action: {} -> {}", getTenantId(), getControllerId(), actionId,
|
||||||
|
action.getStatusCode());
|
||||||
return Optional.empty();
|
return Optional.empty();
|
||||||
}
|
}
|
||||||
|
|
||||||
return Optional.ofNullable(action.getBody() == null ? null : new AbstractMap.SimpleEntry<>(actionId, action.getBody()));
|
return Optional.ofNullable(action.getBody() == null ? null : new AbstractMap.SimpleEntry<>(actionId, action.getBody()));
|
||||||
}
|
}
|
||||||
|
|
||||||
public void updateAttribute(final String mode, final String key, final String value) {
|
|
||||||
final DdiUpdateMode updateMode = switch (mode.toLowerCase()) {
|
|
||||||
case "replace" -> DdiUpdateMode.REPLACE;
|
|
||||||
case "remove" -> DdiUpdateMode.REMOVE;
|
|
||||||
default -> DdiUpdateMode.MERGE;
|
|
||||||
};
|
|
||||||
|
|
||||||
final DdiConfigData configData = new DdiConfigData(Collections.singletonMap(key, value), updateMode);
|
|
||||||
|
|
||||||
getDdiApi().putConfigData(configData, getTenantId(), getControllerId());
|
|
||||||
}
|
|
||||||
|
|
||||||
void sendFeedback(final UpdateStatus updateStatus) {
|
|
||||||
log.debug(LOG_PREFIX + "Send feedback {} -> {}", getTenantId(), getControllerId(), currentActionId, updateStatus);
|
|
||||||
try {
|
|
||||||
getDdiApi().postDeploymentBaseActionFeedback(updateStatus.feedback(), getTenantId(), getControllerId(),
|
|
||||||
currentActionId);
|
|
||||||
} catch (final RuntimeException e) {
|
|
||||||
log.error(LOG_PREFIX + "Failed to send feedback {} -> {}", getTenantId(), getControllerId(),
|
|
||||||
currentActionId, updateStatus, e);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (updateStatus.status() == UpdateStatus.Status.SUCCESSFUL ||
|
|
||||||
updateStatus.status() == UpdateStatus.Status.FAILURE) {
|
|
||||||
lastActionId = currentActionId;
|
|
||||||
currentActionId = null;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private void sendConfirmationFeedback(final long actionId) {
|
private void sendConfirmationFeedback(final long actionId) {
|
||||||
final DdiConfirmationFeedback ddiConfirmationFeedback = new DdiConfirmationFeedback(
|
final DdiConfirmationFeedback ddiConfirmationFeedback = new DdiConfirmationFeedback(
|
||||||
DdiConfirmationFeedback.Confirmation.CONFIRMED, 0, Collections.singletonList(
|
DdiConfirmationFeedback.Confirmation.CONFIRMED, 0, Collections.singletonList(
|
||||||
|
|||||||
@@ -9,15 +9,15 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.device;
|
package org.eclipse.hawkbit.sdk.device;
|
||||||
|
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.concurrent.ConcurrentHashMap;
|
||||||
|
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.eclipse.hawkbit.sdk.Controller;
|
import org.eclipse.hawkbit.sdk.Controller;
|
||||||
import org.eclipse.hawkbit.sdk.HawkbitClient;
|
import org.eclipse.hawkbit.sdk.HawkbitClient;
|
||||||
import org.eclipse.hawkbit.sdk.Tenant;
|
import org.eclipse.hawkbit.sdk.Tenant;
|
||||||
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.Optional;
|
|
||||||
import java.util.concurrent.ConcurrentHashMap;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An in-memory simulated DDI Tenant to hold the controller twins in
|
* An in-memory simulated DDI Tenant to hold the controller twins in
|
||||||
* memory and be able to retrieve them again.
|
* memory and be able to retrieve them again.
|
||||||
|
|||||||
@@ -9,6 +9,22 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.device;
|
package org.eclipse.hawkbit.sdk.device;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
import java.nio.file.Path;
|
||||||
|
import java.security.KeyManagementException;
|
||||||
|
import java.security.KeyStoreException;
|
||||||
|
import java.security.MessageDigest;
|
||||||
|
import java.security.NoSuchAlgorithmException;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.HexFormat;
|
||||||
|
import java.util.LinkedList;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
import lombok.extern.slf4j.Slf4j;
|
import lombok.extern.slf4j.Slf4j;
|
||||||
import org.apache.hc.client5.http.classic.methods.HttpGet;
|
import org.apache.hc.client5.http.classic.methods.HttpGet;
|
||||||
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
|
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
|
||||||
@@ -28,22 +44,6 @@ import org.springframework.util.CollectionUtils;
|
|||||||
import org.springframework.util.ObjectUtils;
|
import org.springframework.util.ObjectUtils;
|
||||||
import org.springframework.util.StringUtils;
|
import org.springframework.util.StringUtils;
|
||||||
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.InputStream;
|
|
||||||
import java.nio.file.Files;
|
|
||||||
import java.nio.file.Path;
|
|
||||||
import java.security.KeyManagementException;
|
|
||||||
import java.security.KeyStoreException;
|
|
||||||
import java.security.MessageDigest;
|
|
||||||
import java.security.NoSuchAlgorithmException;
|
|
||||||
import java.util.ArrayList;
|
|
||||||
import java.util.HashMap;
|
|
||||||
import java.util.HexFormat;
|
|
||||||
import java.util.LinkedList;
|
|
||||||
import java.util.List;
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.stream.Collectors;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update handler provide plug-in endpoint allowing for customization of the update processing.
|
* Update handler provide plug-in endpoint allowing for customization of the update processing.
|
||||||
*/
|
*/
|
||||||
@@ -67,20 +67,16 @@ public interface UpdateHandler {
|
|||||||
@Slf4j
|
@Slf4j
|
||||||
class UpdateProcessor implements Runnable {
|
class UpdateProcessor implements Runnable {
|
||||||
|
|
||||||
|
protected final Map<String, Path> downloads = new HashMap<>();
|
||||||
private static final String LOG_PREFIX = "[{}:{}] ";
|
private static final String LOG_PREFIX = "[{}:{}] ";
|
||||||
|
|
||||||
private static final String DOWNLOAD_LOG_MESSAGE = "Download ";
|
private static final String DOWNLOAD_LOG_MESSAGE = "Download ";
|
||||||
private static final String EXPECTED = "(Expected: ";
|
private static final String EXPECTED = "(Expected: ";
|
||||||
private static final String BUT_GOT_LOG_MESSAGE = " but got: ";
|
private static final String BUT_GOT_LOG_MESSAGE = " but got: ";
|
||||||
private static final int MINIMUM_TOKEN_LENGTH_FOR_HINT = 6;
|
private static final int MINIMUM_TOKEN_LENGTH_FOR_HINT = 6;
|
||||||
|
|
||||||
private final DdiController ddiController;
|
private final DdiController ddiController;
|
||||||
|
|
||||||
private final DdiDeployment.HandlingType updateType;
|
private final DdiDeployment.HandlingType updateType;
|
||||||
private final List<DdiChunk> modules;
|
private final List<DdiChunk> modules;
|
||||||
|
|
||||||
private final ArtifactHandler artifactHandler;
|
private final ArtifactHandler artifactHandler;
|
||||||
protected final Map<String, Path> downloads = new HashMap<>();
|
|
||||||
|
|
||||||
public UpdateProcessor(
|
public UpdateProcessor(
|
||||||
final DdiController ddiController,
|
final DdiController ddiController,
|
||||||
@@ -186,101 +182,6 @@ public interface UpdateHandler {
|
|||||||
log.debug(LOG_PREFIX + "Cleaned up", ddiController.getTenantId(), ddiController.getControllerId());
|
log.debug(LOG_PREFIX + "Cleaned up", ddiController.getTenantId(), ddiController.getControllerId());
|
||||||
}
|
}
|
||||||
|
|
||||||
private void handleArtifact(
|
|
||||||
final String targetToken, final String gatewayToken,
|
|
||||||
final List<UpdateStatus> status, final DdiArtifact artifact) {
|
|
||||||
artifact.getLink("download").ifPresentOrElse(
|
|
||||||
// HTTPS
|
|
||||||
link -> status.add(downloadUrl(link.getHref(), gatewayToken, targetToken,
|
|
||||||
artifact.getHashes(), artifact.getSize())),
|
|
||||||
// HTTP
|
|
||||||
() -> status.add(downloadUrl(
|
|
||||||
artifact.getLink("download-http")
|
|
||||||
.map(Link::getHref)
|
|
||||||
.orElseThrow(() -> new IllegalArgumentException("Nor https nor http found!")),
|
|
||||||
gatewayToken, targetToken,
|
|
||||||
artifact.getHashes(), artifact.getSize()))
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
private UpdateStatus downloadUrl(
|
|
||||||
final String url, final String gatewayToken, final String targetToken,
|
|
||||||
final DdiArtifactHash hash, final long size) {
|
|
||||||
if (log.isDebugEnabled()) {
|
|
||||||
log.debug(LOG_PREFIX + "Downloading {} with token {}, expected hash {} and size {}",
|
|
||||||
ddiController.getTenantId(), ddiController.getControllerId(), url,
|
|
||||||
hideTokenDetails(targetToken), hash, size);
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
return readAndCheckDownloadUrl(url, gatewayToken, targetToken, hash, size);
|
|
||||||
} catch (final IOException | KeyManagementException | NoSuchAlgorithmException | KeyStoreException e) {
|
|
||||||
log.error(LOG_PREFIX + "Failed to download {}",
|
|
||||||
ddiController.getTenantId(), ddiController.getControllerId(), url, e);
|
|
||||||
return new UpdateStatus(
|
|
||||||
UpdateStatus.Status.FAILURE,
|
|
||||||
List.of("Failed to download " + url + ": " + e.getMessage()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private UpdateStatus readAndCheckDownloadUrl(final String url, final String gatewayToken,
|
|
||||||
final String targetToken, final DdiArtifactHash hash, final long size)
|
|
||||||
throws NoSuchAlgorithmException, KeyStoreException, KeyManagementException, IOException {
|
|
||||||
final Validator sizeValidator = sizeValidator(size);
|
|
||||||
final Validator hashValidator = hashValidator(hash);
|
|
||||||
final ArtifactHandler.DownloadHandler downloadHandler = artifactHandler.getDownloadHandler(url);
|
|
||||||
|
|
||||||
try (final CloseableHttpClient httpclient = createHttpClientThatAcceptsAllServerCerts()) {
|
|
||||||
final HttpGet request = new HttpGet(url);
|
|
||||||
if (StringUtils.hasLength(targetToken)) {
|
|
||||||
request.addHeader(HttpHeaders.AUTHORIZATION, "TargetToken " + targetToken);
|
|
||||||
} else if (StringUtils.hasLength(gatewayToken)) {
|
|
||||||
request.addHeader(HttpHeaders.AUTHORIZATION, "GatewayToken " + gatewayToken);
|
|
||||||
}
|
|
||||||
|
|
||||||
return httpclient.execute(request, response -> {
|
|
||||||
try {
|
|
||||||
if (response.getCode() != HttpStatus.OK.value()) {
|
|
||||||
throw new IllegalStateException("Unexpected status code: " + response.getCode());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (response.getEntity().getContentLength() != size) {
|
|
||||||
throw new IllegalArgumentException("Wrong content length " + EXPECTED + size + BUT_GOT_LOG_MESSAGE + response.getEntity()
|
|
||||||
.getContentLength() + ")!");
|
|
||||||
}
|
|
||||||
|
|
||||||
final byte[] buff = new byte[32 * 1024];
|
|
||||||
try (final InputStream is = response.getEntity().getContent()) {
|
|
||||||
for (int read; (read = is.read(buff)) != -1; ) {
|
|
||||||
sizeValidator.read(buff, read);
|
|
||||||
hashValidator.read(buff, read);
|
|
||||||
downloadHandler.read(buff, 0, read);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
sizeValidator.validate();
|
|
||||||
hashValidator.validate();
|
|
||||||
|
|
||||||
final String message = "Downloaded " + url + " (" + size + " bytes)";
|
|
||||||
log.debug(LOG_PREFIX + message, ddiController.getTenantId(), ddiController.getControllerId());
|
|
||||||
downloadHandler.finished(ArtifactHandler.DownloadHandler.Status.SUCCESS);
|
|
||||||
downloadHandler.download().ifPresent(path -> downloads.put(url, path));
|
|
||||||
return new UpdateStatus(UpdateStatus.Status.SUCCESSFUL, List.of(message));
|
|
||||||
} catch (final Exception e) {
|
|
||||||
final String message = e.getMessage();
|
|
||||||
if (log.isTraceEnabled()) {
|
|
||||||
log.error(LOG_PREFIX + DOWNLOAD_LOG_MESSAGE + url + " failed: " + message,
|
|
||||||
ddiController.getTenantId(), ddiController.getControllerId(), e);
|
|
||||||
} else {
|
|
||||||
log.error(LOG_PREFIX + DOWNLOAD_LOG_MESSAGE + url + " failed: " + message,
|
|
||||||
ddiController.getTenantId(), ddiController.getControllerId());
|
|
||||||
}
|
|
||||||
downloadHandler.finished(ArtifactHandler.DownloadHandler.Status.ERROR);
|
|
||||||
return new UpdateStatus(UpdateStatus.Status.FAILURE, List.of(message));
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private static String hideTokenDetails(final String targetToken) {
|
private static String hideTokenDetails(final String targetToken) {
|
||||||
if (targetToken == null) {
|
if (targetToken == null) {
|
||||||
return "<NULL!>";
|
return "<NULL!>";
|
||||||
@@ -314,14 +215,6 @@ public interface UpdateHandler {
|
|||||||
.build();
|
.build();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
private interface Validator {
|
|
||||||
|
|
||||||
void read(final byte[] buff, final int len);
|
|
||||||
|
|
||||||
void validate();
|
|
||||||
}
|
|
||||||
|
|
||||||
private static Validator sizeValidator(final long size) {
|
private static Validator sizeValidator(final long size) {
|
||||||
return new Validator() {
|
return new Validator() {
|
||||||
|
|
||||||
@@ -384,6 +277,7 @@ public interface UpdateHandler {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return new Validator() {
|
return new Validator() {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void read(final byte[] buff, final int len) {
|
public void read(final byte[] buff, final int len) {
|
||||||
hashValidators.forEach(hashValidator -> hashValidator.update(buff, len));
|
hashValidators.forEach(hashValidator -> hashValidator.update(buff, len));
|
||||||
@@ -395,5 +289,108 @@ public interface UpdateHandler {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private void handleArtifact(
|
||||||
|
final String targetToken, final String gatewayToken,
|
||||||
|
final List<UpdateStatus> status, final DdiArtifact artifact) {
|
||||||
|
artifact.getLink("download").ifPresentOrElse(
|
||||||
|
// HTTPS
|
||||||
|
link -> status.add(downloadUrl(link.getHref(), gatewayToken, targetToken,
|
||||||
|
artifact.getHashes(), artifact.getSize())),
|
||||||
|
// HTTP
|
||||||
|
() -> status.add(downloadUrl(
|
||||||
|
artifact.getLink("download-http")
|
||||||
|
.map(Link::getHref)
|
||||||
|
.orElseThrow(() -> new IllegalArgumentException("Nor https nor http found!")),
|
||||||
|
gatewayToken, targetToken,
|
||||||
|
artifact.getHashes(), artifact.getSize()))
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
private UpdateStatus downloadUrl(
|
||||||
|
final String url, final String gatewayToken, final String targetToken,
|
||||||
|
final DdiArtifactHash hash, final long size) {
|
||||||
|
if (log.isDebugEnabled()) {
|
||||||
|
log.debug(LOG_PREFIX + "Downloading {} with token {}, expected hash {} and size {}",
|
||||||
|
ddiController.getTenantId(), ddiController.getControllerId(), url,
|
||||||
|
hideTokenDetails(targetToken), hash, size);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return readAndCheckDownloadUrl(url, gatewayToken, targetToken, hash, size);
|
||||||
|
} catch (final IOException | KeyManagementException | NoSuchAlgorithmException | KeyStoreException e) {
|
||||||
|
log.error(LOG_PREFIX + "Failed to download {}",
|
||||||
|
ddiController.getTenantId(), ddiController.getControllerId(), url, e);
|
||||||
|
return new UpdateStatus(
|
||||||
|
UpdateStatus.Status.FAILURE,
|
||||||
|
List.of("Failed to download " + url + ": " + e.getMessage()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private UpdateStatus readAndCheckDownloadUrl(final String url, final String gatewayToken,
|
||||||
|
final String targetToken, final DdiArtifactHash hash, final long size)
|
||||||
|
throws NoSuchAlgorithmException, KeyStoreException, KeyManagementException, IOException {
|
||||||
|
final Validator sizeValidator = sizeValidator(size);
|
||||||
|
final Validator hashValidator = hashValidator(hash);
|
||||||
|
final ArtifactHandler.DownloadHandler downloadHandler = artifactHandler.getDownloadHandler(url);
|
||||||
|
|
||||||
|
try (final CloseableHttpClient httpclient = createHttpClientThatAcceptsAllServerCerts()) {
|
||||||
|
final HttpGet request = new HttpGet(url);
|
||||||
|
if (StringUtils.hasLength(targetToken)) {
|
||||||
|
request.addHeader(HttpHeaders.AUTHORIZATION, "TargetToken " + targetToken);
|
||||||
|
} else if (StringUtils.hasLength(gatewayToken)) {
|
||||||
|
request.addHeader(HttpHeaders.AUTHORIZATION, "GatewayToken " + gatewayToken);
|
||||||
|
}
|
||||||
|
|
||||||
|
return httpclient.execute(request, response -> {
|
||||||
|
try {
|
||||||
|
if (response.getCode() != HttpStatus.OK.value()) {
|
||||||
|
throw new IllegalStateException("Unexpected status code: " + response.getCode());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (response.getEntity().getContentLength() != size) {
|
||||||
|
throw new IllegalArgumentException(
|
||||||
|
"Wrong content length " + EXPECTED + size + BUT_GOT_LOG_MESSAGE + response.getEntity()
|
||||||
|
.getContentLength() + ")!");
|
||||||
|
}
|
||||||
|
|
||||||
|
final byte[] buff = new byte[32 * 1024];
|
||||||
|
try (final InputStream is = response.getEntity().getContent()) {
|
||||||
|
for (int read; (read = is.read(buff)) != -1; ) {
|
||||||
|
sizeValidator.read(buff, read);
|
||||||
|
hashValidator.read(buff, read);
|
||||||
|
downloadHandler.read(buff, 0, read);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sizeValidator.validate();
|
||||||
|
hashValidator.validate();
|
||||||
|
|
||||||
|
final String message = "Downloaded " + url + " (" + size + " bytes)";
|
||||||
|
log.debug(LOG_PREFIX + message, ddiController.getTenantId(), ddiController.getControllerId());
|
||||||
|
downloadHandler.finished(ArtifactHandler.DownloadHandler.Status.SUCCESS);
|
||||||
|
downloadHandler.download().ifPresent(path -> downloads.put(url, path));
|
||||||
|
return new UpdateStatus(UpdateStatus.Status.SUCCESSFUL, List.of(message));
|
||||||
|
} catch (final Exception e) {
|
||||||
|
final String message = e.getMessage();
|
||||||
|
if (log.isTraceEnabled()) {
|
||||||
|
log.error(LOG_PREFIX + DOWNLOAD_LOG_MESSAGE + url + " failed: " + message,
|
||||||
|
ddiController.getTenantId(), ddiController.getControllerId(), e);
|
||||||
|
} else {
|
||||||
|
log.error(LOG_PREFIX + DOWNLOAD_LOG_MESSAGE + url + " failed: " + message,
|
||||||
|
ddiController.getTenantId(), ddiController.getControllerId());
|
||||||
|
}
|
||||||
|
downloadHandler.finished(ArtifactHandler.DownloadHandler.Status.ERROR);
|
||||||
|
return new UpdateStatus(UpdateStatus.Status.FAILURE, List.of(message));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private interface Validator {
|
||||||
|
|
||||||
|
void read(final byte[] buff, final int len);
|
||||||
|
|
||||||
|
void validate();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -9,14 +9,19 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.device;
|
package org.eclipse.hawkbit.sdk.device;
|
||||||
|
|
||||||
|
import java.util.List;
|
||||||
|
|
||||||
import org.eclipse.hawkbit.ddi.json.model.DdiActionFeedback;
|
import org.eclipse.hawkbit.ddi.json.model.DdiActionFeedback;
|
||||||
import org.eclipse.hawkbit.ddi.json.model.DdiResult;
|
import org.eclipse.hawkbit.ddi.json.model.DdiResult;
|
||||||
import org.eclipse.hawkbit.ddi.json.model.DdiStatus;
|
import org.eclipse.hawkbit.ddi.json.model.DdiStatus;
|
||||||
|
|
||||||
import java.util.List;
|
|
||||||
|
|
||||||
public record UpdateStatus(Status status, List<String> messages) {
|
public record UpdateStatus(Status status, List<String> messages) {
|
||||||
|
|
||||||
|
DdiActionFeedback feedback() {
|
||||||
|
return new DdiActionFeedback(null,
|
||||||
|
new DdiStatus(status.executionStatus, new DdiResult(status.finalResult, null), status.code, messages));
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The status to response to the hawkBit update server if an simulated update process should be respond with
|
* The status to response to the hawkBit update server if an simulated update process should be respond with
|
||||||
* successful or failure update.
|
* successful or failure update.
|
||||||
@@ -59,9 +64,4 @@ public record UpdateStatus(Status status, List<String> messages) {
|
|||||||
this.code = code;
|
this.code = code;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
DdiActionFeedback feedback() {
|
|
||||||
return new DdiActionFeedback(null,
|
|
||||||
new DdiStatus(status.executionStatus, new DdiResult(status.finalResult, null), status.code, messages));
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,35 +10,35 @@
|
|||||||
|
|
||||||
-->
|
-->
|
||||||
<project
|
<project
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk</artifactId>
|
<artifactId>hawkbit-sdk</artifactId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
|
|
||||||
<artifactId>hawkbit-sdk-dmf</artifactId>
|
<artifactId>hawkbit-sdk-dmf</artifactId>
|
||||||
<name>hawkBit :: SDK :: DMF SDK</name>
|
<name>hawkBit :: SDK :: DMF SDK</name>
|
||||||
<description>DMF SDK that could be used for development of DMF integrations on JVM based languages</description>
|
<description>DMF SDK that could be used for development of DMF integrations on JVM based languages</description>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-sdk-commons</artifactId>
|
<artifactId>hawkbit-sdk-commons</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-dmf-api</artifactId>
|
<artifactId>hawkbit-dmf-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.amqp</groupId>
|
<groupId>org.springframework.amqp</groupId>
|
||||||
<artifactId>spring-rabbit</artifactId>
|
<artifactId>spring-rabbit</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
</project>
|
</project>
|
||||||
@@ -9,6 +9,10 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.dmf;
|
package org.eclipse.hawkbit.sdk.dmf;
|
||||||
|
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.concurrent.ScheduledExecutorService;
|
||||||
|
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import lombok.Setter;
|
import lombok.Setter;
|
||||||
import lombok.extern.slf4j.Slf4j;
|
import lombok.extern.slf4j.Slf4j;
|
||||||
@@ -19,10 +23,6 @@ import org.eclipse.hawkbit.sdk.Controller;
|
|||||||
import org.eclipse.hawkbit.sdk.Tenant;
|
import org.eclipse.hawkbit.sdk.Tenant;
|
||||||
import org.eclipse.hawkbit.sdk.dmf.amqp.DmfSender;
|
import org.eclipse.hawkbit.sdk.dmf.amqp.DmfSender;
|
||||||
|
|
||||||
import java.util.HashMap;
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.concurrent.ScheduledExecutorService;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class representing DMF device twin connecting to hawkBit via DMF.
|
* Class representing DMF device twin connecting to hawkBit via DMF.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -9,6 +9,11 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.dmf;
|
package org.eclipse.hawkbit.sdk.dmf;
|
||||||
|
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.concurrent.ConcurrentHashMap;
|
||||||
|
import java.util.function.BiConsumer;
|
||||||
|
|
||||||
import lombok.Getter;
|
import lombok.Getter;
|
||||||
import org.eclipse.hawkbit.sdk.Controller;
|
import org.eclipse.hawkbit.sdk.Controller;
|
||||||
import org.eclipse.hawkbit.sdk.Tenant;
|
import org.eclipse.hawkbit.sdk.Tenant;
|
||||||
@@ -16,11 +21,6 @@ import org.eclipse.hawkbit.sdk.dmf.amqp.Amqp;
|
|||||||
import org.eclipse.hawkbit.sdk.dmf.amqp.VHost;
|
import org.eclipse.hawkbit.sdk.dmf.amqp.VHost;
|
||||||
import org.springframework.amqp.core.Message;
|
import org.springframework.amqp.core.Message;
|
||||||
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.Optional;
|
|
||||||
import java.util.concurrent.ConcurrentHashMap;
|
|
||||||
import java.util.function.BiConsumer;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* An in-memory simulated DMF Tenant to hold the controller twins in
|
* An in-memory simulated DMF Tenant to hold the controller twins in
|
||||||
* memory and be able to retrieve them again.
|
* memory and be able to retrieve them again.
|
||||||
|
|||||||
@@ -9,6 +9,22 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.dmf;
|
package org.eclipse.hawkbit.sdk.dmf;
|
||||||
|
|
||||||
|
import java.io.IOException;
|
||||||
|
import java.io.InputStream;
|
||||||
|
import java.nio.file.Files;
|
||||||
|
import java.nio.file.Path;
|
||||||
|
import java.security.KeyManagementException;
|
||||||
|
import java.security.KeyStoreException;
|
||||||
|
import java.security.MessageDigest;
|
||||||
|
import java.security.NoSuchAlgorithmException;
|
||||||
|
import java.util.ArrayList;
|
||||||
|
import java.util.HashMap;
|
||||||
|
import java.util.HexFormat;
|
||||||
|
import java.util.LinkedList;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.stream.Collectors;
|
||||||
|
|
||||||
import lombok.extern.slf4j.Slf4j;
|
import lombok.extern.slf4j.Slf4j;
|
||||||
import org.apache.hc.client5.http.classic.methods.HttpGet;
|
import org.apache.hc.client5.http.classic.methods.HttpGet;
|
||||||
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
|
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
|
||||||
@@ -29,22 +45,6 @@ import org.springframework.util.CollectionUtils;
|
|||||||
import org.springframework.util.ObjectUtils;
|
import org.springframework.util.ObjectUtils;
|
||||||
import org.springframework.util.StringUtils;
|
import org.springframework.util.StringUtils;
|
||||||
|
|
||||||
import java.io.IOException;
|
|
||||||
import java.io.InputStream;
|
|
||||||
import java.nio.file.Files;
|
|
||||||
import java.nio.file.Path;
|
|
||||||
import java.security.KeyManagementException;
|
|
||||||
import java.security.KeyStoreException;
|
|
||||||
import java.security.MessageDigest;
|
|
||||||
import java.security.NoSuchAlgorithmException;
|
|
||||||
import java.util.ArrayList;
|
|
||||||
import java.util.HashMap;
|
|
||||||
import java.util.HexFormat;
|
|
||||||
import java.util.LinkedList;
|
|
||||||
import java.util.List;
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.stream.Collectors;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update handler provide plug-in endpoint allowing for customization of the update processing.
|
* Update handler provide plug-in endpoint allowing for customization of the update processing.
|
||||||
*/
|
*/
|
||||||
@@ -68,20 +68,16 @@ public interface UpdateHandler {
|
|||||||
@Slf4j
|
@Slf4j
|
||||||
class UpdateProcessor implements Runnable {
|
class UpdateProcessor implements Runnable {
|
||||||
|
|
||||||
|
protected final Map<String, Path> downloads = new HashMap<>();
|
||||||
private static final String LOG_PREFIX = "[{}:{}] ";
|
private static final String LOG_PREFIX = "[{}:{}] ";
|
||||||
|
|
||||||
private static final String DOWNLOAD_LOG_MESSAGE = "Download ";
|
private static final String DOWNLOAD_LOG_MESSAGE = "Download ";
|
||||||
private static final String EXPECTED = "(Expected: ";
|
private static final String EXPECTED = "(Expected: ";
|
||||||
private static final String BUT_GOT_LOG_MESSAGE = " but got: ";
|
private static final String BUT_GOT_LOG_MESSAGE = " but got: ";
|
||||||
private static final int MINIMUM_TOKEN_LENGTH_FOR_HINT = 6;
|
private static final int MINIMUM_TOKEN_LENGTH_FOR_HINT = 6;
|
||||||
|
|
||||||
private final DmfController dmfController;
|
private final DmfController dmfController;
|
||||||
|
|
||||||
private final DmfDownloadAndUpdateRequest updateRequest;
|
private final DmfDownloadAndUpdateRequest updateRequest;
|
||||||
private final EventTopic eventTopic;
|
private final EventTopic eventTopic;
|
||||||
|
|
||||||
private final ArtifactHandler artifactHandler;
|
private final ArtifactHandler artifactHandler;
|
||||||
protected final Map<String, Path> downloads = new HashMap<>();
|
|
||||||
|
|
||||||
public UpdateProcessor(
|
public UpdateProcessor(
|
||||||
final DmfController dmfController,
|
final DmfController dmfController,
|
||||||
@@ -189,94 +185,6 @@ public interface UpdateHandler {
|
|||||||
log.debug(LOG_PREFIX + "Cleaned up", dmfController.getTenantId(), dmfController.getControllerId());
|
log.debug(LOG_PREFIX + "Cleaned up", dmfController.getTenantId(), dmfController.getControllerId());
|
||||||
}
|
}
|
||||||
|
|
||||||
private void handleArtifact(
|
|
||||||
final String targetToken,
|
|
||||||
final List<UpdateStatus> status, final DmfArtifact artifact) {
|
|
||||||
if (artifact.getUrls().containsKey("HTTPS")) {
|
|
||||||
status.add(downloadUrl(artifact.getUrls().get("HTTPS"), targetToken,
|
|
||||||
artifact.getHashes(), artifact.getSize()));
|
|
||||||
} else if (artifact.getUrls().containsKey("HTTP")) {
|
|
||||||
status.add(downloadUrl(artifact.getUrls().get("HTTP"), targetToken,
|
|
||||||
artifact.getHashes(), artifact.getSize()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private UpdateStatus downloadUrl(
|
|
||||||
final String url, final String targetToken,
|
|
||||||
final DmfArtifactHash hash, final long size) {
|
|
||||||
if (log.isDebugEnabled()) {
|
|
||||||
log.debug(LOG_PREFIX + "Downloading {} with token {}, expected hash {} and size {}",
|
|
||||||
dmfController.getTenantId(), dmfController.getControllerId(), url,
|
|
||||||
hideTokenDetails(targetToken), hash, size);
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
return readAndCheckDownloadUrl(url, targetToken, hash, size);
|
|
||||||
} catch (final IOException | KeyManagementException | NoSuchAlgorithmException | KeyStoreException e) {
|
|
||||||
log.error(LOG_PREFIX + "Failed to download {}",
|
|
||||||
dmfController.getTenantId(), dmfController.getControllerId(), url, e);
|
|
||||||
return new UpdateStatus(
|
|
||||||
DmfActionStatus.ERROR,
|
|
||||||
List.of("Failed to download " + url + ": " + e.getMessage()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private UpdateStatus readAndCheckDownloadUrl(final String url,
|
|
||||||
final String targetToken, final DmfArtifactHash hash, final long size)
|
|
||||||
throws NoSuchAlgorithmException, KeyStoreException, KeyManagementException, IOException {
|
|
||||||
final Validator sizeValidator = sizeValidator(size);
|
|
||||||
final Validator hashValidator = hashValidator(hash);
|
|
||||||
final ArtifactHandler.DownloadHandler downloadHandler = artifactHandler.getDownloadHandler(url);
|
|
||||||
|
|
||||||
try (final CloseableHttpClient httpclient = createHttpClientThatAcceptsAllServerCerts()) {
|
|
||||||
final HttpGet request = new HttpGet(url);
|
|
||||||
if (StringUtils.hasLength(targetToken)) {
|
|
||||||
request.addHeader(HttpHeaders.AUTHORIZATION, "TargetToken " + targetToken);
|
|
||||||
}
|
|
||||||
|
|
||||||
return httpclient.execute(request, response -> {
|
|
||||||
try {
|
|
||||||
if (response.getCode() != HttpStatus.OK.value()) {
|
|
||||||
throw new IllegalStateException("Unexpected status code: " + response.getCode());
|
|
||||||
}
|
|
||||||
|
|
||||||
if (response.getEntity().getContentLength() != size) {
|
|
||||||
throw new IllegalArgumentException("Wrong content length " + EXPECTED + size + BUT_GOT_LOG_MESSAGE + response.getEntity()
|
|
||||||
.getContentLength() + ")!");
|
|
||||||
}
|
|
||||||
|
|
||||||
final byte[] buff = new byte[32 * 1024];
|
|
||||||
try (final InputStream is = response.getEntity().getContent()) {
|
|
||||||
for (int read; (read = is.read(buff)) != -1; ) {
|
|
||||||
sizeValidator.read(buff, read);
|
|
||||||
hashValidator.read(buff, read);
|
|
||||||
downloadHandler.read(buff, 0, read);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
sizeValidator.validate();
|
|
||||||
hashValidator.validate();
|
|
||||||
|
|
||||||
final String message = "Downloaded " + url + " (" + size + " bytes)";
|
|
||||||
log.debug(LOG_PREFIX + message, dmfController.getTenantId(), dmfController.getControllerId());
|
|
||||||
downloadHandler.finished(ArtifactHandler.DownloadHandler.Status.SUCCESS);
|
|
||||||
downloadHandler.download().ifPresent(path -> downloads.put(url, path));
|
|
||||||
return new UpdateStatus(DmfActionStatus.FINISHED, List.of(message));
|
|
||||||
} catch (final Exception e) {
|
|
||||||
final String message = e.getMessage();
|
|
||||||
if (log.isTraceEnabled()) {
|
|
||||||
log.error(LOG_PREFIX + DOWNLOAD_LOG_MESSAGE + url + " failed: " + message,
|
|
||||||
dmfController.getTenantId(), dmfController.getControllerId(), e);
|
|
||||||
} else {
|
|
||||||
log.error(LOG_PREFIX + DOWNLOAD_LOG_MESSAGE + url + " failed: " + message,
|
|
||||||
dmfController.getTenantId(), dmfController.getControllerId());
|
|
||||||
}
|
|
||||||
downloadHandler.finished(ArtifactHandler.DownloadHandler.Status.ERROR);
|
|
||||||
return new UpdateStatus(DmfActionStatus.ERROR, List.of(message));
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private static String hideTokenDetails(final String targetToken) {
|
private static String hideTokenDetails(final String targetToken) {
|
||||||
if (targetToken == null) {
|
if (targetToken == null) {
|
||||||
return "<NULL!>";
|
return "<NULL!>";
|
||||||
@@ -310,14 +218,6 @@ public interface UpdateHandler {
|
|||||||
.build();
|
.build();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
private interface Validator {
|
|
||||||
|
|
||||||
void read(final byte[] buff, final int len);
|
|
||||||
|
|
||||||
void validate();
|
|
||||||
}
|
|
||||||
|
|
||||||
private static Validator sizeValidator(final long size) {
|
private static Validator sizeValidator(final long size) {
|
||||||
return new Validator() {
|
return new Validator() {
|
||||||
|
|
||||||
@@ -377,6 +277,7 @@ public interface UpdateHandler {
|
|||||||
}
|
}
|
||||||
|
|
||||||
return new Validator() {
|
return new Validator() {
|
||||||
|
|
||||||
@Override
|
@Override
|
||||||
public void read(final byte[] buff, final int len) {
|
public void read(final byte[] buff, final int len) {
|
||||||
hashValidators.forEach(hashValidator -> hashValidator.update(buff, len));
|
hashValidators.forEach(hashValidator -> hashValidator.update(buff, len));
|
||||||
@@ -388,5 +289,101 @@ public interface UpdateHandler {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private void handleArtifact(
|
||||||
|
final String targetToken,
|
||||||
|
final List<UpdateStatus> status, final DmfArtifact artifact) {
|
||||||
|
if (artifact.getUrls().containsKey("HTTPS")) {
|
||||||
|
status.add(downloadUrl(artifact.getUrls().get("HTTPS"), targetToken,
|
||||||
|
artifact.getHashes(), artifact.getSize()));
|
||||||
|
} else if (artifact.getUrls().containsKey("HTTP")) {
|
||||||
|
status.add(downloadUrl(artifact.getUrls().get("HTTP"), targetToken,
|
||||||
|
artifact.getHashes(), artifact.getSize()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private UpdateStatus downloadUrl(
|
||||||
|
final String url, final String targetToken,
|
||||||
|
final DmfArtifactHash hash, final long size) {
|
||||||
|
if (log.isDebugEnabled()) {
|
||||||
|
log.debug(LOG_PREFIX + "Downloading {} with token {}, expected hash {} and size {}",
|
||||||
|
dmfController.getTenantId(), dmfController.getControllerId(), url,
|
||||||
|
hideTokenDetails(targetToken), hash, size);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
return readAndCheckDownloadUrl(url, targetToken, hash, size);
|
||||||
|
} catch (final IOException | KeyManagementException | NoSuchAlgorithmException | KeyStoreException e) {
|
||||||
|
log.error(LOG_PREFIX + "Failed to download {}",
|
||||||
|
dmfController.getTenantId(), dmfController.getControllerId(), url, e);
|
||||||
|
return new UpdateStatus(
|
||||||
|
DmfActionStatus.ERROR,
|
||||||
|
List.of("Failed to download " + url + ": " + e.getMessage()));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private UpdateStatus readAndCheckDownloadUrl(final String url,
|
||||||
|
final String targetToken, final DmfArtifactHash hash, final long size)
|
||||||
|
throws NoSuchAlgorithmException, KeyStoreException, KeyManagementException, IOException {
|
||||||
|
final Validator sizeValidator = sizeValidator(size);
|
||||||
|
final Validator hashValidator = hashValidator(hash);
|
||||||
|
final ArtifactHandler.DownloadHandler downloadHandler = artifactHandler.getDownloadHandler(url);
|
||||||
|
|
||||||
|
try (final CloseableHttpClient httpclient = createHttpClientThatAcceptsAllServerCerts()) {
|
||||||
|
final HttpGet request = new HttpGet(url);
|
||||||
|
if (StringUtils.hasLength(targetToken)) {
|
||||||
|
request.addHeader(HttpHeaders.AUTHORIZATION, "TargetToken " + targetToken);
|
||||||
|
}
|
||||||
|
|
||||||
|
return httpclient.execute(request, response -> {
|
||||||
|
try {
|
||||||
|
if (response.getCode() != HttpStatus.OK.value()) {
|
||||||
|
throw new IllegalStateException("Unexpected status code: " + response.getCode());
|
||||||
|
}
|
||||||
|
|
||||||
|
if (response.getEntity().getContentLength() != size) {
|
||||||
|
throw new IllegalArgumentException(
|
||||||
|
"Wrong content length " + EXPECTED + size + BUT_GOT_LOG_MESSAGE + response.getEntity()
|
||||||
|
.getContentLength() + ")!");
|
||||||
|
}
|
||||||
|
|
||||||
|
final byte[] buff = new byte[32 * 1024];
|
||||||
|
try (final InputStream is = response.getEntity().getContent()) {
|
||||||
|
for (int read; (read = is.read(buff)) != -1; ) {
|
||||||
|
sizeValidator.read(buff, read);
|
||||||
|
hashValidator.read(buff, read);
|
||||||
|
downloadHandler.read(buff, 0, read);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sizeValidator.validate();
|
||||||
|
hashValidator.validate();
|
||||||
|
|
||||||
|
final String message = "Downloaded " + url + " (" + size + " bytes)";
|
||||||
|
log.debug(LOG_PREFIX + message, dmfController.getTenantId(), dmfController.getControllerId());
|
||||||
|
downloadHandler.finished(ArtifactHandler.DownloadHandler.Status.SUCCESS);
|
||||||
|
downloadHandler.download().ifPresent(path -> downloads.put(url, path));
|
||||||
|
return new UpdateStatus(DmfActionStatus.FINISHED, List.of(message));
|
||||||
|
} catch (final Exception e) {
|
||||||
|
final String message = e.getMessage();
|
||||||
|
if (log.isTraceEnabled()) {
|
||||||
|
log.error(LOG_PREFIX + DOWNLOAD_LOG_MESSAGE + url + " failed: " + message,
|
||||||
|
dmfController.getTenantId(), dmfController.getControllerId(), e);
|
||||||
|
} else {
|
||||||
|
log.error(LOG_PREFIX + DOWNLOAD_LOG_MESSAGE + url + " failed: " + message,
|
||||||
|
dmfController.getTenantId(), dmfController.getControllerId());
|
||||||
|
}
|
||||||
|
downloadHandler.finished(ArtifactHandler.DownloadHandler.Status.ERROR);
|
||||||
|
return new UpdateStatus(DmfActionStatus.ERROR, List.of(message));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private interface Validator {
|
||||||
|
|
||||||
|
void read(final byte[] buff, final int len);
|
||||||
|
|
||||||
|
void validate();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -9,8 +9,8 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.dmf;
|
package org.eclipse.hawkbit.sdk.dmf;
|
||||||
|
|
||||||
import org.eclipse.hawkbit.dmf.json.model.DmfActionStatus;
|
|
||||||
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
|
|
||||||
|
import org.eclipse.hawkbit.dmf.json.model.DmfActionStatus;
|
||||||
|
|
||||||
public record UpdateStatus(DmfActionStatus status, List<String> messages) {}
|
public record UpdateStatus(DmfActionStatus status, List<String> messages) {}
|
||||||
@@ -9,6 +9,10 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.dmf.amqp;
|
package org.eclipse.hawkbit.sdk.dmf.amqp;
|
||||||
|
|
||||||
|
import java.security.KeyManagementException;
|
||||||
|
import java.security.NoSuchAlgorithmException;
|
||||||
|
import java.util.concurrent.ConcurrentHashMap;
|
||||||
|
|
||||||
import lombok.extern.slf4j.Slf4j;
|
import lombok.extern.slf4j.Slf4j;
|
||||||
import org.eclipse.hawkbit.sdk.Tenant.DMF;
|
import org.eclipse.hawkbit.sdk.Tenant.DMF;
|
||||||
import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
|
import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
|
||||||
@@ -16,10 +20,6 @@ import org.springframework.amqp.rabbit.connection.ConnectionFactory;
|
|||||||
import org.springframework.boot.autoconfigure.amqp.RabbitProperties;
|
import org.springframework.boot.autoconfigure.amqp.RabbitProperties;
|
||||||
import org.springframework.util.ObjectUtils;
|
import org.springframework.util.ObjectUtils;
|
||||||
|
|
||||||
import java.security.KeyManagementException;
|
|
||||||
import java.security.NoSuchAlgorithmException;
|
|
||||||
import java.util.concurrent.ConcurrentHashMap;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Abstract class for connecting to AMQP host.
|
* Abstract class for connecting to AMQP host.
|
||||||
*/
|
*/
|
||||||
@@ -41,7 +41,7 @@ public class Amqp {
|
|||||||
|
|
||||||
public VHost getVhost(final DMF dmf, final boolean initVHost) {
|
public VHost getVhost(final DMF dmf, final boolean initVHost) {
|
||||||
final String vHost = dmf == null || ObjectUtils.isEmpty(dmf.getVirtualHost()) ?
|
final String vHost = dmf == null || ObjectUtils.isEmpty(dmf.getVirtualHost()) ?
|
||||||
(rabbitProperties.getVirtualHost() == null ? "/" :rabbitProperties.getVirtualHost()) :
|
(rabbitProperties.getVirtualHost() == null ? "/" : rabbitProperties.getVirtualHost()) :
|
||||||
dmf.getVirtualHost();
|
dmf.getVirtualHost();
|
||||||
return vHosts.computeIfAbsent(vHost, vh -> new VHost(getConnectionFactory(dmf, vHost), amqpProperties, initVHost));
|
return vHosts.computeIfAbsent(vHost, vh -> new VHost(getConnectionFactory(dmf, vHost), amqpProperties, initVHost));
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -12,7 +12,6 @@ package org.eclipse.hawkbit.sdk.dmf.amqp;
|
|||||||
import lombok.Data;
|
import lombok.Data;
|
||||||
import lombok.ToString;
|
import lombok.ToString;
|
||||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||||
import org.springframework.stereotype.Component;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Bean which holds the necessary properties for configuring the AMQP connection.
|
* Bean which holds the necessary properties for configuring the AMQP connection.
|
||||||
|
|||||||
@@ -9,6 +9,8 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.dmf.amqp;
|
package org.eclipse.hawkbit.sdk.dmf.amqp;
|
||||||
|
|
||||||
|
import static org.eclipse.hawkbit.dmf.amqp.api.AmqpSettings.DMF_EXCHANGE;
|
||||||
|
|
||||||
import java.util.List;
|
import java.util.List;
|
||||||
import java.util.Map;
|
import java.util.Map;
|
||||||
import java.util.UUID;
|
import java.util.UUID;
|
||||||
@@ -31,17 +33,14 @@ import org.springframework.amqp.rabbit.core.RabbitTemplate;
|
|||||||
import org.springframework.amqp.support.converter.AbstractJavaTypeMapper;
|
import org.springframework.amqp.support.converter.AbstractJavaTypeMapper;
|
||||||
import org.springframework.util.ObjectUtils;
|
import org.springframework.util.ObjectUtils;
|
||||||
|
|
||||||
import static org.eclipse.hawkbit.dmf.amqp.api.AmqpSettings.DMF_EXCHANGE;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sender service to send messages to update server.
|
* Sender service to send messages to update server.
|
||||||
*/
|
*/
|
||||||
@Slf4j
|
@Slf4j
|
||||||
public class DmfSender {
|
public class DmfSender {
|
||||||
|
|
||||||
private static final byte[] EMPTY_BODY = new byte[0];
|
|
||||||
|
|
||||||
protected final RabbitTemplate rabbitTemplate;
|
protected final RabbitTemplate rabbitTemplate;
|
||||||
|
private static final byte[] EMPTY_BODY = new byte[0];
|
||||||
private final AmqpProperties amqpProperties;
|
private final AmqpProperties amqpProperties;
|
||||||
private final ConcurrentHashMap<String, BiConsumer<String, Message>> pingListeners = new ConcurrentHashMap<>();
|
private final ConcurrentHashMap<String, BiConsumer<String, Message>> pingListeners = new ConcurrentHashMap<>();
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,15 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.dmf.amqp;
|
package org.eclipse.hawkbit.sdk.dmf.amqp;
|
||||||
|
|
||||||
|
import java.nio.charset.StandardCharsets;
|
||||||
|
import java.time.Duration;
|
||||||
|
import java.util.Collections;
|
||||||
|
import java.util.HashSet;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Optional;
|
||||||
|
import java.util.Set;
|
||||||
|
import java.util.concurrent.ConcurrentHashMap;
|
||||||
|
|
||||||
import lombok.extern.slf4j.Slf4j;
|
import lombok.extern.slf4j.Slf4j;
|
||||||
import org.eclipse.hawkbit.dmf.amqp.api.EventTopic;
|
import org.eclipse.hawkbit.dmf.amqp.api.EventTopic;
|
||||||
import org.eclipse.hawkbit.dmf.amqp.api.MessageHeaderKey;
|
import org.eclipse.hawkbit.dmf.amqp.api.MessageHeaderKey;
|
||||||
@@ -33,24 +42,15 @@ import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer;
|
|||||||
import org.springframework.amqp.support.converter.AbstractJavaTypeMapper;
|
import org.springframework.amqp.support.converter.AbstractJavaTypeMapper;
|
||||||
import org.springframework.amqp.support.converter.Jackson2JsonMessageConverter;
|
import org.springframework.amqp.support.converter.Jackson2JsonMessageConverter;
|
||||||
|
|
||||||
import java.nio.charset.StandardCharsets;
|
|
||||||
import java.time.Duration;
|
|
||||||
import java.util.Collections;
|
|
||||||
import java.util.HashSet;
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.Optional;
|
|
||||||
import java.util.Set;
|
|
||||||
import java.util.concurrent.ConcurrentHashMap;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Abstract class for sender and receiver service.
|
* Abstract class for sender and receiver service.
|
||||||
*/
|
*/
|
||||||
@Slf4j
|
@Slf4j
|
||||||
public class VHost extends DmfSender implements MessageListener {
|
public class VHost extends DmfSender implements MessageListener {
|
||||||
|
|
||||||
|
private static final String REGEX_EXTRACT_ACTION_ID = "[^0-9]";
|
||||||
private final SimpleMessageListenerContainer container;
|
private final SimpleMessageListenerContainer container;
|
||||||
private final ConcurrentHashMap<String, DmfTenant> dmfTenants = new ConcurrentHashMap<>();
|
private final ConcurrentHashMap<String, DmfTenant> dmfTenants = new ConcurrentHashMap<>();
|
||||||
|
|
||||||
private final Set<Long> openActions = Collections.synchronizedSet(new HashSet<>());
|
private final Set<Long> openActions = Collections.synchronizedSet(new HashSet<>());
|
||||||
|
|
||||||
public VHost(final ConnectionFactory connectionFactory, final AmqpProperties amqpProperties) {
|
public VHost(final ConnectionFactory connectionFactory, final AmqpProperties amqpProperties) {
|
||||||
@@ -80,7 +80,7 @@ public class VHost extends DmfSender implements MessageListener {
|
|||||||
rabbitAdmin.declareExchange(exchange);
|
rabbitAdmin.declareExchange(exchange);
|
||||||
rabbitAdmin.declareBinding(BindingBuilder.bind(queue).to(exchange));
|
rabbitAdmin.declareBinding(BindingBuilder.bind(queue).to(exchange));
|
||||||
}
|
}
|
||||||
|
|
||||||
container = new SimpleMessageListenerContainer();
|
container = new SimpleMessageListenerContainer();
|
||||||
container.setConnectionFactory(connectionFactory);
|
container.setConnectionFactory(connectionFactory);
|
||||||
container.setQueueNames(amqpProperties.getReceiverConnectorQueueFromSp());
|
container.setQueueNames(amqpProperties.getReceiverConnectorQueueFromSp());
|
||||||
@@ -88,11 +88,6 @@ public class VHost extends DmfSender implements MessageListener {
|
|||||||
container.start();
|
container.start();
|
||||||
}
|
}
|
||||||
|
|
||||||
void stop() {
|
|
||||||
container.stop();
|
|
||||||
rabbitTemplate.destroy();
|
|
||||||
}
|
|
||||||
|
|
||||||
public void register(final DmfTenant dmfTenant) {
|
public void register(final DmfTenant dmfTenant) {
|
||||||
dmfTenants.put(dmfTenant.getTenant().getTenantId(), dmfTenant);
|
dmfTenants.put(dmfTenant.getTenant().getTenantId(), dmfTenant);
|
||||||
}
|
}
|
||||||
@@ -100,8 +95,8 @@ public class VHost extends DmfSender implements MessageListener {
|
|||||||
@Override
|
@Override
|
||||||
public void onMessage(final Message message) {
|
public void onMessage(final Message message) {
|
||||||
final String tenantId = getTenant(message);
|
final String tenantId = getTenant(message);
|
||||||
final String controllerId = (String)message.getMessageProperties().getHeaders().get(MessageHeaderKey.THING_ID);
|
final String controllerId = (String) message.getMessageProperties().getHeaders().get(MessageHeaderKey.THING_ID);
|
||||||
final String type = (String)message.getMessageProperties().getHeaders().get(MessageHeaderKey.TYPE);
|
final String type = (String) message.getMessageProperties().getHeaders().get(MessageHeaderKey.TYPE);
|
||||||
|
|
||||||
log.info("Message received for target {}, value : {}", controllerId, message);
|
log.info("Message received for target {}, value : {}", controllerId, message);
|
||||||
switch (MessageType.valueOf(type)) {
|
switch (MessageType.valueOf(type)) {
|
||||||
@@ -130,6 +125,62 @@ public class VHost extends DmfSender implements MessageListener {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
protected void handleAttributeUpdateRequest(final Message message, final String controllerId) {
|
||||||
|
final String tenantId = getTenant(message);
|
||||||
|
Optional.ofNullable(dmfTenants.get(tenantId))
|
||||||
|
.flatMap(dmfTenant -> dmfTenant.getController(controllerId))
|
||||||
|
.ifPresent(controller ->
|
||||||
|
updateAttributes(tenantId, controllerId, DmfUpdateMode.MERGE, controller.getAttributes()));
|
||||||
|
}
|
||||||
|
|
||||||
|
protected void handleCancelDownloadAction(final Message message, final String thingId) {
|
||||||
|
final String tenant = getTenant(message);
|
||||||
|
final Long actionId = extractActionIdFrom(message);
|
||||||
|
|
||||||
|
processCancelDownloadAction(thingId, tenant, actionId);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected void handleUpdateProcess(final Message message, final String controllerId, final EventTopic actionType) {
|
||||||
|
final String tenant = getTenant(message);
|
||||||
|
final DmfDownloadAndUpdateRequest downloadAndUpdateRequest = convertMessage(message,
|
||||||
|
DmfDownloadAndUpdateRequest.class);
|
||||||
|
dmfTenants.get(tenant).getController(controllerId)
|
||||||
|
.ifPresent(controller -> controller.setCurrentActionId(downloadAndUpdateRequest.getActionId()));
|
||||||
|
processUpdate(tenant, controllerId, actionType, downloadAndUpdateRequest);
|
||||||
|
}
|
||||||
|
|
||||||
|
void stop() {
|
||||||
|
container.stop();
|
||||||
|
rabbitTemplate.destroy();
|
||||||
|
}
|
||||||
|
|
||||||
|
private static String getTenant(final Message message) {
|
||||||
|
final MessageProperties messageProperties = message.getMessageProperties();
|
||||||
|
final Map<String, Object> headers = messageProperties.getHeaders();
|
||||||
|
return (String) headers.get(MessageHeaderKey.TENANT);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Method to validate if content type is set in the message properties.
|
||||||
|
*
|
||||||
|
* @param message the message to get validated
|
||||||
|
*/
|
||||||
|
private static void checkContentTypeJson(final Message message) {
|
||||||
|
if (message.getBody().length == 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
final MessageProperties messageProperties = message.getMessageProperties();
|
||||||
|
final String headerContentType = (String) messageProperties.getHeaders().get("content-type");
|
||||||
|
if (null != headerContentType) {
|
||||||
|
messageProperties.setContentType(headerContentType);
|
||||||
|
}
|
||||||
|
final String contentType = messageProperties.getContentType();
|
||||||
|
if (contentType != null && contentType.contains("json")) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
throw new AmqpRejectAndDontRequeueException("Content-Type is not JSON compatible");
|
||||||
|
}
|
||||||
|
|
||||||
private void handleEventMessage(final Message message, final String thingId) {
|
private void handleEventMessage(final Message message, final String thingId) {
|
||||||
final Object eventHeader = message.getMessageProperties().getHeaders().get(MessageHeaderKey.TOPIC);
|
final Object eventHeader = message.getMessageProperties().getHeaders().get(MessageHeaderKey.TOPIC);
|
||||||
if (eventHeader == null) {
|
if (eventHeader == null) {
|
||||||
@@ -138,27 +189,26 @@ public class VHost extends DmfSender implements MessageListener {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Exception squid:S2259 - Checked before
|
// Exception squid:S2259 - Checked before
|
||||||
@SuppressWarnings({ "squid:S2259" })
|
@SuppressWarnings({ "squid:S2259" }) final EventTopic eventTopic = EventTopic.valueOf(eventHeader.toString());
|
||||||
final EventTopic eventTopic = EventTopic.valueOf(eventHeader.toString());
|
|
||||||
switch (eventTopic) {
|
switch (eventTopic) {
|
||||||
case CONFIRM:
|
case CONFIRM:
|
||||||
handleConfirmation(message, thingId);
|
handleConfirmation(message, thingId);
|
||||||
break;
|
break;
|
||||||
case DOWNLOAD_AND_INSTALL, DOWNLOAD:
|
case DOWNLOAD_AND_INSTALL, DOWNLOAD:
|
||||||
handleUpdateProcess(message, thingId, eventTopic);
|
handleUpdateProcess(message, thingId, eventTopic);
|
||||||
break;
|
break;
|
||||||
case CANCEL_DOWNLOAD:
|
case CANCEL_DOWNLOAD:
|
||||||
handleCancelDownloadAction(message, thingId);
|
handleCancelDownloadAction(message, thingId);
|
||||||
break;
|
break;
|
||||||
case REQUEST_ATTRIBUTES_UPDATE:
|
case REQUEST_ATTRIBUTES_UPDATE:
|
||||||
handleAttributeUpdateRequest(message, thingId);
|
handleAttributeUpdateRequest(message, thingId);
|
||||||
break;
|
break;
|
||||||
case MULTI_ACTION:
|
case MULTI_ACTION:
|
||||||
handleMultiActionRequest(message, thingId);
|
handleMultiActionRequest(message, thingId);
|
||||||
break;
|
break;
|
||||||
default:
|
default:
|
||||||
log.info("No valid event property: {}", eventTopic);
|
log.info("No valid event property: {}", eventTopic);
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -166,7 +216,6 @@ public class VHost extends DmfSender implements MessageListener {
|
|||||||
log.warn("Handle confirmed received for {}! Skip it!", controllerId);
|
log.warn("Handle confirmed received for {}! Skip it!", controllerId);
|
||||||
}
|
}
|
||||||
|
|
||||||
private static final String REGEX_EXTRACT_ACTION_ID = "[^0-9]";
|
|
||||||
private long extractActionIdFrom(final Message message) {
|
private long extractActionIdFrom(final Message message) {
|
||||||
final String messageAsString = message.toString();
|
final String messageAsString = message.toString();
|
||||||
final String requiredMessageContent = messageAsString
|
final String requiredMessageContent = messageAsString
|
||||||
@@ -191,57 +240,29 @@ public class VHost extends DmfSender implements MessageListener {
|
|||||||
openActions.add(actionId);
|
openActions.add(actionId);
|
||||||
|
|
||||||
switch (eventTopic) {
|
switch (eventTopic) {
|
||||||
case DOWNLOAD:
|
case DOWNLOAD:
|
||||||
case DOWNLOAD_AND_INSTALL:
|
case DOWNLOAD_AND_INSTALL:
|
||||||
if (action instanceof DmfDownloadAndUpdateRequest) {
|
if (action instanceof DmfDownloadAndUpdateRequest) {
|
||||||
processUpdate(tenant, controllerId, eventTopic, (DmfDownloadAndUpdateRequest) action);
|
processUpdate(tenant, controllerId, eventTopic, (DmfDownloadAndUpdateRequest) action);
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
case CANCEL_DOWNLOAD:
|
case CANCEL_DOWNLOAD:
|
||||||
processCancelDownloadAction(controllerId, tenant, action.getActionId());
|
processCancelDownloadAction(controllerId, tenant, action.getActionId());
|
||||||
break;
|
break;
|
||||||
default:
|
default:
|
||||||
openActions.remove(actionId);
|
openActions.remove(actionId);
|
||||||
log.info("No valid event property in MULTI_ACTION.");
|
log.info("No valid event property in MULTI_ACTION.");
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
protected void handleAttributeUpdateRequest(final Message message, final String controllerId) {
|
|
||||||
final String tenantId = getTenant(message);
|
|
||||||
Optional.ofNullable(dmfTenants.get(tenantId))
|
|
||||||
.flatMap(dmfTenant -> dmfTenant.getController(controllerId))
|
|
||||||
.ifPresent(controller ->
|
|
||||||
updateAttributes(tenantId, controllerId, DmfUpdateMode.MERGE, controller.getAttributes()));
|
|
||||||
}
|
|
||||||
|
|
||||||
private static String getTenant(final Message message) {
|
|
||||||
final MessageProperties messageProperties = message.getMessageProperties();
|
|
||||||
final Map<String, Object> headers = messageProperties.getHeaders();
|
|
||||||
return (String) headers.get(MessageHeaderKey.TENANT);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected void handleCancelDownloadAction(final Message message, final String thingId) {
|
|
||||||
final String tenant = getTenant(message);
|
|
||||||
final Long actionId = extractActionIdFrom(message);
|
|
||||||
|
|
||||||
processCancelDownloadAction(thingId, tenant, actionId);
|
|
||||||
}
|
|
||||||
|
|
||||||
private void processCancelDownloadAction(final String thingId, final String tenant, final Long actionId) {
|
private void processCancelDownloadAction(final String thingId, final String tenant, final Long actionId) {
|
||||||
finishUpdateProcess(thingId, actionId, Collections.singletonList("Simulation canceled"));
|
finishUpdateProcess(thingId, actionId, Collections.singletonList("Simulation canceled"));
|
||||||
openActions.remove(actionId);
|
openActions.remove(actionId);
|
||||||
}
|
}
|
||||||
|
|
||||||
protected void handleUpdateProcess(final Message message, final String controllerId, final EventTopic actionType) {
|
private void processUpdate(final String tenantId, final String controllerId, final EventTopic actionType,
|
||||||
final String tenant = getTenant(message);
|
final DmfDownloadAndUpdateRequest updateRequest) {
|
||||||
final DmfDownloadAndUpdateRequest downloadAndUpdateRequest = convertMessage(message,
|
|
||||||
DmfDownloadAndUpdateRequest.class);
|
|
||||||
dmfTenants.get(tenant).getController(controllerId).ifPresent(controller -> controller.setCurrentActionId(downloadAndUpdateRequest.getActionId()));
|
|
||||||
processUpdate(tenant, controllerId, actionType, downloadAndUpdateRequest);
|
|
||||||
}
|
|
||||||
|
|
||||||
private void processUpdate(final String tenantId, final String controllerId, final EventTopic actionType, final DmfDownloadAndUpdateRequest updateRequest) {
|
|
||||||
Optional.ofNullable(dmfTenants.get(tenantId))
|
Optional.ofNullable(dmfTenants.get(tenantId))
|
||||||
.flatMap(dmfTenant -> dmfTenant.getController(controllerId))
|
.flatMap(dmfTenant -> dmfTenant.getController(controllerId))
|
||||||
.ifPresent(controller -> controller.processUpdate(actionType, updateRequest));
|
.ifPresent(controller -> controller.processUpdate(actionType, updateRequest));
|
||||||
@@ -257,26 +278,4 @@ public class VHost extends DmfSender implements MessageListener {
|
|||||||
clazz.getTypeName());
|
clazz.getTypeName());
|
||||||
return (T) rabbitTemplate.getMessageConverter().fromMessage(message);
|
return (T) rabbitTemplate.getMessageConverter().fromMessage(message);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Method to validate if content type is set in the message properties.
|
|
||||||
*
|
|
||||||
* @param message
|
|
||||||
* the message to get validated
|
|
||||||
*/
|
|
||||||
private static void checkContentTypeJson(final Message message) {
|
|
||||||
if (message.getBody().length == 0) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
final MessageProperties messageProperties = message.getMessageProperties();
|
|
||||||
final String headerContentType = (String) messageProperties.getHeaders().get("content-type");
|
|
||||||
if (null != headerContentType) {
|
|
||||||
messageProperties.setContentType(headerContentType);
|
|
||||||
}
|
|
||||||
final String contentType = messageProperties.getContentType();
|
|
||||||
if (contentType != null && contentType.contains("json")) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
throw new AmqpRejectAndDontRequeueException("Content-Type is not JSON compatible");
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -9,18 +9,18 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.dmf.health;
|
package org.eclipse.hawkbit.sdk.dmf.health;
|
||||||
|
|
||||||
import org.eclipse.hawkbit.sdk.dmf.DmfTenant;
|
|
||||||
import org.slf4j.Logger;
|
|
||||||
import org.slf4j.LoggerFactory;
|
|
||||||
import org.springframework.amqp.core.Message;
|
|
||||||
import org.springframework.scheduling.annotation.Scheduled;
|
|
||||||
|
|
||||||
import java.util.Collection;
|
import java.util.Collection;
|
||||||
import java.util.Collections;
|
import java.util.Collections;
|
||||||
import java.util.HashSet;
|
import java.util.HashSet;
|
||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
import java.util.UUID;
|
import java.util.UUID;
|
||||||
|
|
||||||
|
import org.eclipse.hawkbit.sdk.dmf.DmfTenant;
|
||||||
|
import org.slf4j.Logger;
|
||||||
|
import org.slf4j.LoggerFactory;
|
||||||
|
import org.springframework.amqp.core.Message;
|
||||||
|
import org.springframework.scheduling.annotation.Scheduled;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle all incoming Messages from hawkBit update server.
|
* Handle all incoming Messages from hawkBit update server.
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -10,8 +10,8 @@
|
|||||||
|
|
||||||
-->
|
-->
|
||||||
<project
|
<project
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"
|
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
|
|
||||||
<parent>
|
<parent>
|
||||||
|
|||||||
@@ -9,6 +9,12 @@
|
|||||||
*/
|
*/
|
||||||
package org.eclipse.hawkbit.sdk.mgmt;
|
package org.eclipse.hawkbit.sdk.mgmt;
|
||||||
|
|
||||||
|
import java.security.SecureRandom;
|
||||||
|
import java.util.Base64;
|
||||||
|
import java.util.List;
|
||||||
|
import java.util.Map;
|
||||||
|
import java.util.Objects;
|
||||||
|
import java.util.Random;
|
||||||
|
|
||||||
import feign.FeignException;
|
import feign.FeignException;
|
||||||
import lombok.AllArgsConstructor;
|
import lombok.AllArgsConstructor;
|
||||||
@@ -22,13 +28,6 @@ import org.eclipse.hawkbit.sdk.HawkbitClient;
|
|||||||
import org.eclipse.hawkbit.sdk.Tenant;
|
import org.eclipse.hawkbit.sdk.Tenant;
|
||||||
import org.springframework.util.ObjectUtils;
|
import org.springframework.util.ObjectUtils;
|
||||||
|
|
||||||
import java.security.SecureRandom;
|
|
||||||
import java.util.Base64;
|
|
||||||
import java.util.List;
|
|
||||||
import java.util.Map;
|
|
||||||
import java.util.Objects;
|
|
||||||
import java.util.Random;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Management Api Interface
|
* Management Api Interface
|
||||||
*/
|
*/
|
||||||
@@ -39,13 +38,17 @@ public class MgmtApi {
|
|||||||
private static final String AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_KEY = "authentication.gatewaytoken.key";
|
private static final String AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_KEY = "authentication.gatewaytoken.key";
|
||||||
private static final String AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_ENABLED = "authentication.gatewaytoken.enabled";
|
private static final String AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_ENABLED = "authentication.gatewaytoken.enabled";
|
||||||
private static final String AUTHENTICATION_MODE_TARGET_SECURITY_TOKEN_ENABLED = "authentication.targettoken.enabled";
|
private static final String AUTHENTICATION_MODE_TARGET_SECURITY_TOKEN_ENABLED = "authentication.targettoken.enabled";
|
||||||
|
private static final Random RND = new SecureRandom();
|
||||||
|
|
||||||
@NonNull
|
@NonNull
|
||||||
private final Tenant tenant;
|
private final Tenant tenant;
|
||||||
@NonNull
|
@NonNull
|
||||||
private final HawkbitClient hawkbitClient;
|
private final HawkbitClient hawkbitClient;
|
||||||
|
|
||||||
|
public static String randomToken() {
|
||||||
|
final byte[] rnd = new byte[24];
|
||||||
|
RND.nextBytes(rnd);
|
||||||
|
return Base64.getEncoder().encodeToString(rnd);
|
||||||
|
}
|
||||||
|
|
||||||
// if gateway toke is configured then the gateway auth is enabled key is set
|
// if gateway toke is configured then the gateway auth is enabled key is set
|
||||||
// so all devices use gateway token authentication
|
// so all devices use gateway token authentication
|
||||||
@@ -73,8 +76,8 @@ public class MgmtApi {
|
|||||||
}
|
}
|
||||||
if (!gatewayToken.equals(
|
if (!gatewayToken.equals(
|
||||||
Objects.requireNonNull(mgmtTenantManagementRestApi
|
Objects.requireNonNull(mgmtTenantManagementRestApi
|
||||||
.getTenantConfigurationValue(AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_KEY)
|
.getTenantConfigurationValue(AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_KEY)
|
||||||
.getBody()).getValue())) {
|
.getBody()).getValue())) {
|
||||||
mgmtTenantManagementRestApi.updateTenantConfiguration(
|
mgmtTenantManagementRestApi.updateTenantConfiguration(
|
||||||
Map.of(AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_KEY, gatewayToken)
|
Map.of(AUTHENTICATION_MODE_GATEWAY_SECURITY_TOKEN_KEY, gatewayToken)
|
||||||
);
|
);
|
||||||
@@ -121,11 +124,4 @@ public class MgmtApi {
|
|||||||
public void deleteController(final String controllerId) {
|
public void deleteController(final String controllerId) {
|
||||||
hawkbitClient.mgmtService(MgmtTargetRestApi.class, tenant).deleteTarget(controllerId);
|
hawkbitClient.mgmtService(MgmtTargetRestApi.class, tenant).deleteTarget(controllerId);
|
||||||
}
|
}
|
||||||
|
|
||||||
private static final Random RND = new SecureRandom();
|
|
||||||
public static String randomToken() {
|
|
||||||
final byte[] rnd = new byte[24];
|
|
||||||
RND.nextBytes(rnd);
|
|
||||||
return Base64.getEncoder().encodeToString(rnd);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -9,8 +9,8 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
|
|||||||
@@ -198,16 +198,6 @@ public final class SpPermission {
|
|||||||
public static final String BRACKET_CLOSE = ")";
|
public static final String BRACKET_CLOSE = ")";
|
||||||
public static final String HAS_AUTH_PREFIX = "hasAuthority" + BRACKET_OPEN + "'";
|
public static final String HAS_AUTH_PREFIX = "hasAuthority" + BRACKET_OPEN + "'";
|
||||||
public static final String HAS_AUTH_SUFFIX = "'" + BRACKET_CLOSE;
|
public static final String HAS_AUTH_SUFFIX = "'" + BRACKET_CLOSE;
|
||||||
public static final String HAS_AUTH_AND = " and ";
|
|
||||||
/**
|
|
||||||
* The role which contains the spring security context in case the
|
|
||||||
* system is executing code which is necessary to be privileged.
|
|
||||||
*/
|
|
||||||
public static final String SYSTEM_ROLE = "ROLE_SYSTEM_CODE";
|
|
||||||
/**
|
|
||||||
* The spring security eval expression operator {@code or}.
|
|
||||||
*/
|
|
||||||
public static final String HAS_AUTH_OR = " or ";
|
|
||||||
/**
|
/**
|
||||||
* Spring security eval hasAnyRole expression to check if the spring
|
* Spring security eval hasAnyRole expression to check if the spring
|
||||||
* context contains system code role
|
* context contains system code role
|
||||||
@@ -387,6 +377,16 @@ public final class SpPermission {
|
|||||||
*/
|
*/
|
||||||
public static final String HAS_AUTH_TENANT_CONFIGURATION = HAS_AUTH_PREFIX + TENANT_CONFIGURATION
|
public static final String HAS_AUTH_TENANT_CONFIGURATION = HAS_AUTH_PREFIX + TENANT_CONFIGURATION
|
||||||
+ HAS_AUTH_SUFFIX + HAS_AUTH_OR + IS_SYSTEM_CODE;
|
+ HAS_AUTH_SUFFIX + HAS_AUTH_OR + IS_SYSTEM_CODE;
|
||||||
|
public static final String HAS_AUTH_AND = " and ";
|
||||||
|
/**
|
||||||
|
* The role which contains the spring security context in case the
|
||||||
|
* system is executing code which is necessary to be privileged.
|
||||||
|
*/
|
||||||
|
public static final String SYSTEM_ROLE = "ROLE_SYSTEM_CODE";
|
||||||
|
/**
|
||||||
|
* The spring security eval expression operator {@code or}.
|
||||||
|
*/
|
||||||
|
public static final String HAS_AUTH_OR = " or ";
|
||||||
/**
|
/**
|
||||||
* The role which contains in the spring security context in case an
|
* The role which contains in the spring security context in case an
|
||||||
* controller is authenticated.
|
* controller is authenticated.
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
This is a set of [Spring Boot Starters](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) that allows to quick start a spring boot based application with hawkBit's core functionality.
|
This is a set
|
||||||
|
of [Spring Boot Starters](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) that
|
||||||
|
allows to quick start a spring boot based application with hawkBit's core functionality.
|
||||||
|
|
||||||
The [all in one](hawkbit-boot-starter) starter contains the complete feature set in addition we provide four starters for the hawkBit interfaces. They can be combined in any order.
|
The [all in one](hawkbit-boot-starter) starter contains the complete feature set in addition we provide four starters
|
||||||
|
for the hawkBit interfaces. They can be combined in any order.
|
||||||
|
|
||||||
Check out the hawkBit [update server](../hawkbit-runtime/hawkbit-update-server) as a reference.
|
Check out the hawkBit [update server](../hawkbit-runtime/hawkbit-update-server) as a reference.
|
||||||
@@ -1 +1,2 @@
|
|||||||
[Spring Boot Starter](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) for the [Direct Device Integration API](https://www.eclipse.org/hawkbit/documentation/interfaces/ddi-api.html).
|
[Spring Boot Starter](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) for
|
||||||
|
the [Direct Device Integration API](https://www.eclipse.org/hawkbit/documentation/interfaces/ddi-api.html).
|
||||||
@@ -9,68 +9,68 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-starters</artifactId>
|
<artifactId>hawkbit-starters</artifactId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
<artifactId>hawkbit-boot-starter-ddi-api</artifactId>
|
<artifactId>hawkbit-boot-starter-ddi-api</artifactId>
|
||||||
<name>hawkBit :: Spring Boot Starter DDI API</name>
|
<name>hawkBit :: Spring Boot Starter DDI API</name>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<!-- Spring - START -->
|
<!-- Spring - START -->
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.boot</groupId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<artifactId>spring-boot-starter-web</artifactId>
|
<artifactId>spring-boot-starter-web</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.boot</groupId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<artifactId>spring-boot-starter</artifactId>
|
<artifactId>spring-boot-starter</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.security</groupId>
|
<groupId>org.springframework.security</groupId>
|
||||||
<artifactId>spring-security-web</artifactId>
|
<artifactId>spring-security-web</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.security</groupId>
|
<groupId>org.springframework.security</groupId>
|
||||||
<artifactId>spring-security-config</artifactId>
|
<artifactId>spring-security-config</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.security</groupId>
|
<groupId>org.springframework.security</groupId>
|
||||||
<artifactId>spring-security-aspects</artifactId>
|
<artifactId>spring-security-aspects</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
<!-- Spring - END -->
|
<!-- Spring - END -->
|
||||||
|
|
||||||
<!-- hawkBit - START -->
|
<!-- hawkBit - START -->
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-ddi-resource</artifactId>
|
<artifactId>hawkbit-ddi-resource</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-security-integration</artifactId>
|
<artifactId>hawkbit-security-integration</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-http-security</artifactId>
|
<artifactId>hawkbit-http-security</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-repository-jpa</artifactId>
|
<artifactId>hawkbit-repository-jpa</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-autoconfigure</artifactId>
|
<artifactId>hawkbit-autoconfigure</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<!-- hawkBit - END -->
|
<!-- hawkBit - END -->
|
||||||
|
|
||||||
</dependencies>
|
</dependencies>
|
||||||
</project>
|
</project>
|
||||||
@@ -1 +1,2 @@
|
|||||||
[Spring Boot Starter](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) for the [Device Management Federation API (AMQP 0.9)](https://www.eclipse.org/hawkbit/documentation/interfaces/dmf-api.html).
|
[Spring Boot Starter](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) for
|
||||||
|
the [Device Management Federation API (AMQP 0.9)](https://www.eclipse.org/hawkbit/documentation/interfaces/dmf-api.html).
|
||||||
@@ -9,49 +9,50 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
<modelVersion>4.0.0</modelVersion>
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<parent>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<parent>
|
||||||
<artifactId>hawkbit-starters</artifactId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<version>${revision}</version>
|
<artifactId>hawkbit-starters</artifactId>
|
||||||
</parent>
|
<version>${revision}</version>
|
||||||
<artifactId>hawkbit-boot-starter-dmf-api</artifactId>
|
</parent>
|
||||||
<name>hawkBit :: Spring Boot Starter DMF API</name>
|
<artifactId>hawkbit-boot-starter-dmf-api</artifactId>
|
||||||
|
<name>hawkBit :: Spring Boot Starter DMF API</name>
|
||||||
<dependencies>
|
|
||||||
<!-- Spring - START -->
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.boot</groupId>
|
|
||||||
<artifactId>spring-boot-starter</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.security</groupId>
|
|
||||||
<artifactId>spring-security-config</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.security</groupId>
|
|
||||||
<artifactId>spring-security-aspects</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<!-- Spring - END -->
|
|
||||||
|
|
||||||
<!-- hawkBit - START -->
|
<dependencies>
|
||||||
<dependency>
|
<!-- Spring - START -->
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<dependency>
|
||||||
<artifactId>hawkbit-dmf-amqp</artifactId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<version>${project.version}</version>
|
<artifactId>spring-boot-starter</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.springframework.security</groupId>
|
||||||
<artifactId>hawkbit-repository-jpa</artifactId>
|
<artifactId>spring-security-config</artifactId>
|
||||||
<version>${project.version}</version>
|
</dependency>
|
||||||
</dependency>
|
<dependency>
|
||||||
<dependency>
|
<groupId>org.springframework.security</groupId>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<artifactId>spring-security-aspects</artifactId>
|
||||||
<artifactId>hawkbit-autoconfigure</artifactId>
|
</dependency>
|
||||||
<version>${project.version}</version>
|
<!-- Spring - END -->
|
||||||
</dependency>
|
|
||||||
<!-- hawkBit - END -->
|
|
||||||
|
|
||||||
</dependencies>
|
<!-- hawkBit - START -->
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
|
<artifactId>hawkbit-dmf-amqp</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
|
<artifactId>hawkbit-repository-jpa</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
|
<artifactId>hawkbit-autoconfigure</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<!-- hawkBit - END -->
|
||||||
|
|
||||||
|
</dependencies>
|
||||||
</project>
|
</project>
|
||||||
@@ -1 +1,2 @@
|
|||||||
[Spring Boot Starter](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) for the [Management API](https://www.eclipse.org/hawkbit/documentation/interfaces/management-api.html).
|
[Spring Boot Starter](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) for
|
||||||
|
the [Management API](https://www.eclipse.org/hawkbit/documentation/interfaces/management-api.html).
|
||||||
@@ -9,68 +9,69 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
<modelVersion>4.0.0</modelVersion>
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<parent>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<parent>
|
||||||
<artifactId>hawkbit-starters</artifactId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<version>${revision}</version>
|
<artifactId>hawkbit-starters</artifactId>
|
||||||
</parent>
|
<version>${revision}</version>
|
||||||
<artifactId>hawkbit-boot-starter-mgmt-api</artifactId>
|
</parent>
|
||||||
<name>hawkBit :: Spring Boot Starter Management API</name>
|
<artifactId>hawkbit-boot-starter-mgmt-api</artifactId>
|
||||||
|
<name>hawkBit :: Spring Boot Starter Management API</name>
|
||||||
<dependencies>
|
|
||||||
<!-- Spring - START -->
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.boot</groupId>
|
|
||||||
<artifactId>spring-boot-starter-web</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.boot</groupId>
|
|
||||||
<artifactId>spring-boot-starter</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.security</groupId>
|
|
||||||
<artifactId>spring-security-web</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.security</groupId>
|
|
||||||
<artifactId>spring-security-config</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<dependency>
|
|
||||||
<groupId>org.springframework.security</groupId>
|
|
||||||
<artifactId>spring-security-aspects</artifactId>
|
|
||||||
</dependency>
|
|
||||||
<!-- Spring - END -->
|
|
||||||
|
|
||||||
<!-- hawkBit - START -->
|
<dependencies>
|
||||||
<dependency>
|
<!-- Spring - START -->
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<dependency>
|
||||||
<artifactId>hawkbit-mgmt-resource</artifactId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<version>${project.version}</version>
|
<artifactId>spring-boot-starter-web</artifactId>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<artifactId>hawkbit-security-integration</artifactId>
|
<artifactId>spring-boot-starter</artifactId>
|
||||||
<version>${project.version}</version>
|
</dependency>
|
||||||
</dependency>
|
<dependency>
|
||||||
<dependency>
|
<groupId>org.springframework.security</groupId>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<artifactId>spring-security-web</artifactId>
|
||||||
<artifactId>hawkbit-http-security</artifactId>
|
</dependency>
|
||||||
<version>${project.version}</version>
|
<dependency>
|
||||||
</dependency>
|
<groupId>org.springframework.security</groupId>
|
||||||
<dependency>
|
<artifactId>spring-security-config</artifactId>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
</dependency>
|
||||||
<artifactId>hawkbit-repository-jpa</artifactId>
|
<dependency>
|
||||||
<version>${project.version}</version>
|
<groupId>org.springframework.security</groupId>
|
||||||
</dependency>
|
<artifactId>spring-security-aspects</artifactId>
|
||||||
<dependency>
|
</dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<!-- Spring - END -->
|
||||||
<artifactId>hawkbit-autoconfigure</artifactId>
|
|
||||||
<version>${project.version}</version>
|
<!-- hawkBit - START -->
|
||||||
</dependency>
|
<dependency>
|
||||||
<!-- hawkBit - END -->
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
|
<artifactId>hawkbit-mgmt-resource</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
|
<artifactId>hawkbit-security-integration</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
|
<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>
|
||||||
|
<dependency>
|
||||||
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
|
<artifactId>hawkbit-autoconfigure</artifactId>
|
||||||
|
<version>${project.version}</version>
|
||||||
|
</dependency>
|
||||||
|
<!-- hawkBit - END -->
|
||||||
|
|
||||||
|
</dependencies>
|
||||||
|
|
||||||
</dependencies>
|
|
||||||
|
|
||||||
</project>
|
</project>
|
||||||
@@ -1,4 +1,5 @@
|
|||||||
[Spring Boot Starter](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) including all four interfaces:
|
[Spring Boot Starter](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using-boot-starter) including
|
||||||
|
all four interfaces:
|
||||||
|
|
||||||
* [Management API](https://www.eclipse.org/hawkbit/documentation/interfaces/management-api.html)
|
* [Management API](https://www.eclipse.org/hawkbit/documentation/interfaces/management-api.html)
|
||||||
* [Direct Device Integration API](https://www.eclipse.org/hawkbit/documentation/interfaces/ddi-api.html)
|
* [Direct Device Integration API](https://www.eclipse.org/hawkbit/documentation/interfaces/ddi-api.html)
|
||||||
|
|||||||
@@ -9,33 +9,33 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-starters</artifactId>
|
<artifactId>hawkbit-starters</artifactId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
<artifactId>hawkbit-boot-starter</artifactId>
|
<artifactId>hawkbit-boot-starter</artifactId>
|
||||||
<name>hawkBit :: Spring Boot Starter</name>
|
<name>hawkBit :: Spring Boot Starter</name>
|
||||||
<description>Complete starter, including auto-configuration, logging and all hawkBit interfaces</description>
|
<description>Complete starter, including auto-configuration, logging and all hawkBit interfaces</description>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-boot-starter-ddi-api</artifactId>
|
<artifactId>hawkbit-boot-starter-ddi-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-boot-starter-dmf-api</artifactId>
|
<artifactId>hawkbit-boot-starter-dmf-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-boot-starter-mgmt-api</artifactId>
|
<artifactId>hawkbit-boot-starter-mgmt-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
</project>
|
</project>
|
||||||
@@ -9,21 +9,21 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-parent</artifactId>
|
<artifactId>hawkbit-parent</artifactId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
<artifactId>hawkbit-starters</artifactId>
|
<artifactId>hawkbit-starters</artifactId>
|
||||||
<name>hawkBit :: Spring Boot Starters</name>
|
<name>hawkBit :: Spring Boot Starters</name>
|
||||||
<packaging>pom</packaging>
|
<packaging>pom</packaging>
|
||||||
<modules>
|
<modules>
|
||||||
<module>hawkbit-boot-starter</module>
|
<module>hawkbit-boot-starter</module>
|
||||||
<module>hawkbit-boot-starter-mgmt-api</module>
|
<module>hawkbit-boot-starter-mgmt-api</module>
|
||||||
<module>hawkbit-boot-starter-ddi-api</module>
|
<module>hawkbit-boot-starter-ddi-api</module>
|
||||||
<module>hawkbit-boot-starter-dmf-api</module>
|
<module>hawkbit-boot-starter-dmf-api</module>
|
||||||
</modules>
|
</modules>
|
||||||
</project>
|
</project>
|
||||||
@@ -9,185 +9,185 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<modelVersion>4.0.0</modelVersion>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<parent>
|
<parent>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-parent</artifactId>
|
<artifactId>hawkbit-parent</artifactId>
|
||||||
<version>${revision}</version>
|
<version>${revision}</version>
|
||||||
</parent>
|
</parent>
|
||||||
<artifactId>hawkbit-test-report</artifactId>
|
<artifactId>hawkbit-test-report</artifactId>
|
||||||
<name>hawkBit :: Test Report</name>
|
<name>hawkBit :: Test Report</name>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-core</artifactId>
|
<artifactId>hawkbit-core</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-security-core</artifactId>
|
<artifactId>hawkbit-security-core</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-security-integration</artifactId>
|
<artifactId>hawkbit-security-integration</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-http-security</artifactId>
|
<artifactId>hawkbit-http-security</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-repository-api</artifactId>
|
<artifactId>hawkbit-repository-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-repository-core</artifactId>
|
<artifactId>hawkbit-repository-core</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-repository-jpa</artifactId>
|
<artifactId>hawkbit-repository-jpa</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-artifact-repository-filesystem</artifactId>
|
<artifactId>hawkbit-artifact-repository-filesystem</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-autoconfigure</artifactId>
|
<artifactId>hawkbit-autoconfigure</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-ddi-api</artifactId>
|
<artifactId>hawkbit-ddi-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-ddi-resource</artifactId>
|
<artifactId>hawkbit-ddi-resource</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-mgmt-api</artifactId>
|
<artifactId>hawkbit-mgmt-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-mgmt-resource</artifactId>
|
<artifactId>hawkbit-mgmt-resource</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-rest-core</artifactId>
|
<artifactId>hawkbit-rest-core</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-dmf-amqp</artifactId>
|
<artifactId>hawkbit-dmf-amqp</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-dmf-api</artifactId>
|
<artifactId>hawkbit-dmf-api</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-update-server</artifactId>
|
<artifactId>hawkbit-update-server</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
|
|
||||||
<build>
|
<build>
|
||||||
<plugins>
|
<plugins>
|
||||||
|
|
||||||
<plugin>
|
<plugin>
|
||||||
<groupId>org.jacoco</groupId>
|
<groupId>org.jacoco</groupId>
|
||||||
<artifactId>jacoco-maven-plugin</artifactId>
|
<artifactId>jacoco-maven-plugin</artifactId>
|
||||||
<executions>
|
<executions>
|
||||||
<execution>
|
<execution>
|
||||||
<id>aggregate-reports</id>
|
<id>aggregate-reports</id>
|
||||||
<phase>verify</phase>
|
|
||||||
<goals>
|
|
||||||
<goal>report-aggregate</goal>
|
|
||||||
</goals>
|
|
||||||
<configuration>
|
|
||||||
<outputDirectory>${jacoco.outputDir}/jacoco-aggregate</outputDirectory>
|
|
||||||
</configuration>
|
|
||||||
</execution>
|
|
||||||
</executions>
|
|
||||||
</plugin>
|
|
||||||
|
|
||||||
</plugins>
|
|
||||||
</build>
|
|
||||||
|
|
||||||
<profiles>
|
|
||||||
<profile>
|
|
||||||
<id>generateTestReport</id>
|
|
||||||
<build>
|
|
||||||
<plugins>
|
|
||||||
<plugin>
|
|
||||||
<artifactId>maven-resources-plugin</artifactId>
|
|
||||||
<executions>
|
|
||||||
<execution>
|
|
||||||
<id>copy-resources</id>
|
|
||||||
<phase>verify</phase>
|
<phase>verify</phase>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>copy-resources</goal>
|
<goal>report-aggregate</goal>
|
||||||
</goals>
|
</goals>
|
||||||
<configuration>
|
<configuration>
|
||||||
<outputDirectory>${basedir}/target/allure-results</outputDirectory>
|
<outputDirectory>${jacoco.outputDir}/jacoco-aggregate</outputDirectory>
|
||||||
<resources>
|
|
||||||
<resource>
|
|
||||||
<directory>${basedir}/..</directory>
|
|
||||||
<filtering>false</filtering>
|
|
||||||
<includes>
|
|
||||||
<include>**/target/allure-results/*.json</include>
|
|
||||||
</includes>
|
|
||||||
</resource>
|
|
||||||
<resource>
|
|
||||||
<directory>${basedir}</directory>
|
|
||||||
<filtering>false</filtering>
|
|
||||||
<includes>
|
|
||||||
<include>placeholder.txt</include>
|
|
||||||
</includes>
|
|
||||||
</resource>
|
|
||||||
</resources>
|
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
</executions>
|
</executions>
|
||||||
</plugin>
|
</plugin>
|
||||||
<plugin>
|
|
||||||
<groupId>org.apache.maven.plugins</groupId>
|
</plugins>
|
||||||
<artifactId>maven-assembly-plugin</artifactId>
|
</build>
|
||||||
<configuration>
|
|
||||||
<descriptors>
|
<profiles>
|
||||||
<descriptor>src/main/resources/assemblies/test-report.xml</descriptor>
|
<profile>
|
||||||
</descriptors>
|
<id>generateTestReport</id>
|
||||||
<appendAssemblyId>true</appendAssemblyId>
|
<build>
|
||||||
</configuration>
|
<plugins>
|
||||||
<executions>
|
<plugin>
|
||||||
<execution>
|
<artifactId>maven-resources-plugin</artifactId>
|
||||||
<id>create-report-zip-assembly</id>
|
<executions>
|
||||||
<phase>verify</phase>
|
<execution>
|
||||||
<goals>
|
<id>copy-resources</id>
|
||||||
<goal>single</goal>
|
<phase>verify</phase>
|
||||||
</goals>
|
<goals>
|
||||||
</execution>
|
<goal>copy-resources</goal>
|
||||||
</executions>
|
</goals>
|
||||||
</plugin>
|
<configuration>
|
||||||
</plugins>
|
<outputDirectory>${basedir}/target/allure-results</outputDirectory>
|
||||||
</build>
|
<resources>
|
||||||
</profile>
|
<resource>
|
||||||
</profiles>
|
<directory>${basedir}/..</directory>
|
||||||
|
<filtering>false</filtering>
|
||||||
|
<includes>
|
||||||
|
<include>**/target/allure-results/*.json</include>
|
||||||
|
</includes>
|
||||||
|
</resource>
|
||||||
|
<resource>
|
||||||
|
<directory>${basedir}</directory>
|
||||||
|
<filtering>false</filtering>
|
||||||
|
<includes>
|
||||||
|
<include>placeholder.txt</include>
|
||||||
|
</includes>
|
||||||
|
</resource>
|
||||||
|
</resources>
|
||||||
|
</configuration>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
<plugin>
|
||||||
|
<groupId>org.apache.maven.plugins</groupId>
|
||||||
|
<artifactId>maven-assembly-plugin</artifactId>
|
||||||
|
<configuration>
|
||||||
|
<descriptors>
|
||||||
|
<descriptor>src/main/resources/assemblies/test-report.xml</descriptor>
|
||||||
|
</descriptors>
|
||||||
|
<appendAssemblyId>true</appendAssemblyId>
|
||||||
|
</configuration>
|
||||||
|
<executions>
|
||||||
|
<execution>
|
||||||
|
<id>create-report-zip-assembly</id>
|
||||||
|
<phase>verify</phase>
|
||||||
|
<goals>
|
||||||
|
<goal>single</goal>
|
||||||
|
</goals>
|
||||||
|
</execution>
|
||||||
|
</executions>
|
||||||
|
</plugin>
|
||||||
|
</plugins>
|
||||||
|
</build>
|
||||||
|
</profile>
|
||||||
|
</profiles>
|
||||||
</project>
|
</project>
|
||||||
|
|||||||
@@ -9,18 +9,19 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
<assembly xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||||
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
|
xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
|
||||||
<id>testReport</id>
|
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
|
||||||
<baseDirectory>/</baseDirectory>
|
<id>testReport</id>
|
||||||
<includeBaseDirectory>false</includeBaseDirectory>
|
<baseDirectory>/</baseDirectory>
|
||||||
<formats>
|
<includeBaseDirectory>false</includeBaseDirectory>
|
||||||
<format>zip</format>
|
<formats>
|
||||||
</formats>
|
<format>zip</format>
|
||||||
<fileSets>
|
</formats>
|
||||||
<fileSet>
|
<fileSets>
|
||||||
<directory>${project.build.directory}/allure-results</directory>
|
<fileSet>
|
||||||
<outputDirectory>/</outputDirectory>
|
<directory>${project.build.directory}/allure-results</directory>
|
||||||
</fileSet>
|
<outputDirectory>/</outputDirectory>
|
||||||
</fileSets>
|
</fileSet>
|
||||||
|
</fileSets>
|
||||||
</assembly>
|
</assembly>
|
||||||
|
|||||||
@@ -1,421 +1,421 @@
|
|||||||
<code_scheme name="hawkBit" version="173">
|
<code_scheme name="hawkBit" version="173">
|
||||||
<option name="FORMATTER_TAGS_ENABLED" value="false" />
|
<option name="FORMATTER_TAGS_ENABLED" value="false"/>
|
||||||
<JavaCodeStyleSettings>
|
<JavaCodeStyleSettings>
|
||||||
<option name="GENERATE_FINAL_LOCALS" value="true" />
|
<option name="GENERATE_FINAL_LOCALS" value="true"/>
|
||||||
<option name="GENERATE_FINAL_PARAMETERS" value="true" />
|
<option name="GENERATE_FINAL_PARAMETERS" value="true"/>
|
||||||
<option name="VISIBILITY" value="private" />
|
<option name="VISIBILITY" value="private"/>
|
||||||
<option name="REPLACE_INSTANCEOF_AND_CAST" value="true" />
|
<option name="REPLACE_INSTANCEOF_AND_CAST" value="true"/>
|
||||||
<option name="SPACE_AFTER_CLOSING_ANGLE_BRACKET_IN_TYPE_ARGUMENT" value="true" />
|
<option name="SPACE_AFTER_CLOSING_ANGLE_BRACKET_IN_TYPE_ARGUMENT" value="true"/>
|
||||||
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="99999" />
|
<option name="CLASS_COUNT_TO_USE_IMPORT_ON_DEMAND" value="99999"/>
|
||||||
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="99999" />
|
<option name="NAMES_COUNT_TO_USE_IMPORT_ON_DEMAND" value="99999"/>
|
||||||
<option name="PACKAGES_TO_USE_IMPORT_ON_DEMAND">
|
<option name="PACKAGES_TO_USE_IMPORT_ON_DEMAND">
|
||||||
<value />
|
<value/>
|
||||||
</option>
|
</option>
|
||||||
<option name="IMPORT_LAYOUT_TABLE">
|
<option name="IMPORT_LAYOUT_TABLE">
|
||||||
<value>
|
<value>
|
||||||
<package name="" withSubpackages="true" static="true" />
|
<package name="" withSubpackages="true" static="true"/>
|
||||||
<emptyLine />
|
<emptyLine/>
|
||||||
<package name="java" withSubpackages="true" static="false" />
|
<package name="java" withSubpackages="true" static="false"/>
|
||||||
<emptyLine />
|
<emptyLine/>
|
||||||
<package name="javax" withSubpackages="true" static="false" />
|
<package name="javax" withSubpackages="true" static="false"/>
|
||||||
<emptyLine />
|
<emptyLine/>
|
||||||
<package name="jakarta" withSubpackages="true" static="false" />
|
<package name="jakarta" withSubpackages="true" static="false"/>
|
||||||
<emptyLine />
|
<emptyLine/>
|
||||||
<package name="" withSubpackages="true" static="false" />
|
<package name="" withSubpackages="true" static="false"/>
|
||||||
</value>
|
</value>
|
||||||
</option>
|
</option>
|
||||||
<option name="ALIGN_MULTILINE_RECORDS" value="false" />
|
<option name="ALIGN_MULTILINE_RECORDS" value="false"/>
|
||||||
<option name="ALIGN_MULTILINE_DECONSTRUCTION_LIST_COMPONENTS" value="false" />
|
<option name="ALIGN_MULTILINE_DECONSTRUCTION_LIST_COMPONENTS" value="false"/>
|
||||||
<option name="NEW_LINE_AFTER_LPAREN_IN_DECONSTRUCTION_PATTERN" value="false" />
|
<option name="NEW_LINE_AFTER_LPAREN_IN_DECONSTRUCTION_PATTERN" value="false"/>
|
||||||
<option name="RPAREN_ON_NEW_LINE_IN_DECONSTRUCTION_PATTERN" value="false" />
|
<option name="RPAREN_ON_NEW_LINE_IN_DECONSTRUCTION_PATTERN" value="false"/>
|
||||||
<option name="ALIGN_TYPES_IN_MULTI_CATCH" value="false" />
|
<option name="ALIGN_TYPES_IN_MULTI_CATCH" value="false"/>
|
||||||
<option name="JD_ALIGN_PARAM_COMMENTS" value="false" />
|
<option name="JD_ALIGN_PARAM_COMMENTS" value="false"/>
|
||||||
<option name="JD_ALIGN_EXCEPTION_COMMENTS" value="false" />
|
<option name="JD_ALIGN_EXCEPTION_COMMENTS" value="false"/>
|
||||||
<option name="JD_P_AT_EMPTY_LINES" value="false" />
|
<option name="JD_P_AT_EMPTY_LINES" value="false"/>
|
||||||
<option name="JD_DO_NOT_WRAP_ONE_LINE_COMMENTS" value="true" />
|
<option name="JD_DO_NOT_WRAP_ONE_LINE_COMMENTS" value="true"/>
|
||||||
<option name="JD_INDENT_ON_CONTINUATION" value="true" />
|
<option name="JD_INDENT_ON_CONTINUATION" value="true"/>
|
||||||
</JavaCodeStyleSettings>
|
</JavaCodeStyleSettings>
|
||||||
<Properties>
|
<Properties>
|
||||||
<option name="KEEP_BLANK_LINES" value="true" />
|
<option name="KEEP_BLANK_LINES" value="true"/>
|
||||||
</Properties>
|
</Properties>
|
||||||
<codeStyleSettings language="JAVA">
|
<codeStyleSettings language="JAVA">
|
||||||
<option name="RIGHT_MARGIN" value="144" />
|
<option name="RIGHT_MARGIN" value="144"/>
|
||||||
<option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1" />
|
<option name="KEEP_BLANK_LINES_IN_DECLARATIONS" value="1"/>
|
||||||
<option name="KEEP_BLANK_LINES_IN_CODE" value="1" />
|
<option name="KEEP_BLANK_LINES_IN_CODE" value="1"/>
|
||||||
<option name="KEEP_BLANK_LINES_BETWEEN_PACKAGE_DECLARATION_AND_HEADER" value="1" />
|
<option name="KEEP_BLANK_LINES_BETWEEN_PACKAGE_DECLARATION_AND_HEADER" value="1"/>
|
||||||
<option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1" />
|
<option name="KEEP_BLANK_LINES_BEFORE_RBRACE" value="1"/>
|
||||||
<option name="BLANK_LINES_AFTER_CLASS_HEADER" value="1" />
|
<option name="BLANK_LINES_AFTER_CLASS_HEADER" value="1"/>
|
||||||
<option name="BLANK_LINES_AFTER_ANONYMOUS_CLASS_HEADER" value="1" />
|
<option name="BLANK_LINES_AFTER_ANONYMOUS_CLASS_HEADER" value="1"/>
|
||||||
<option name="ALIGN_MULTILINE_PARAMETERS" value="false" />
|
<option name="ALIGN_MULTILINE_PARAMETERS" value="false"/>
|
||||||
<option name="ALIGN_MULTILINE_RESOURCES" value="false" />
|
<option name="ALIGN_MULTILINE_RESOURCES" value="false"/>
|
||||||
<option name="ALIGN_MULTILINE_FOR" value="false" />
|
<option name="ALIGN_MULTILINE_FOR" value="false"/>
|
||||||
<option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACES" value="true" />
|
<option name="SPACE_WITHIN_ARRAY_INITIALIZER_BRACES" value="true"/>
|
||||||
<option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true" />
|
<option name="SPACE_BEFORE_ARRAY_INITIALIZER_LBRACE" value="true"/>
|
||||||
<option name="CALL_PARAMETERS_WRAP" value="1" />
|
<option name="CALL_PARAMETERS_WRAP" value="1"/>
|
||||||
<option name="METHOD_PARAMETERS_WRAP" value="1" />
|
<option name="METHOD_PARAMETERS_WRAP" value="1"/>
|
||||||
<option name="RESOURCE_LIST_WRAP" value="5" />
|
<option name="RESOURCE_LIST_WRAP" value="5"/>
|
||||||
<option name="EXTENDS_LIST_WRAP" value="1" />
|
<option name="EXTENDS_LIST_WRAP" value="1"/>
|
||||||
<option name="THROWS_LIST_WRAP" value="1" />
|
<option name="THROWS_LIST_WRAP" value="1"/>
|
||||||
<option name="EXTENDS_KEYWORD_WRAP" value="1" />
|
<option name="EXTENDS_KEYWORD_WRAP" value="1"/>
|
||||||
<option name="THROWS_KEYWORD_WRAP" value="1" />
|
<option name="THROWS_KEYWORD_WRAP" value="1"/>
|
||||||
<option name="METHOD_CALL_CHAIN_WRAP" value="1" />
|
<option name="METHOD_CALL_CHAIN_WRAP" value="1"/>
|
||||||
<option name="TERNARY_OPERATION_WRAP" value="5" />
|
<option name="TERNARY_OPERATION_WRAP" value="5"/>
|
||||||
<option name="TERNARY_OPERATION_SIGNS_ON_NEXT_LINE" value="true" />
|
<option name="TERNARY_OPERATION_SIGNS_ON_NEXT_LINE" value="true"/>
|
||||||
<option name="KEEP_SIMPLE_LAMBDAS_IN_ONE_LINE" value="true" />
|
<option name="KEEP_SIMPLE_LAMBDAS_IN_ONE_LINE" value="true"/>
|
||||||
<option name="KEEP_SIMPLE_CLASSES_IN_ONE_LINE" value="true" />
|
<option name="KEEP_SIMPLE_CLASSES_IN_ONE_LINE" value="true"/>
|
||||||
<option name="ARRAY_INITIALIZER_WRAP" value="1" />
|
<option name="ARRAY_INITIALIZER_WRAP" value="1"/>
|
||||||
<indentOptions>
|
<indentOptions>
|
||||||
<option name="SMART_TABS" value="true" />
|
<option name="SMART_TABS" value="true"/>
|
||||||
<option name="LABEL_INDENT_SIZE" value="4" />
|
<option name="LABEL_INDENT_SIZE" value="4"/>
|
||||||
<option name="LABEL_INDENT_ABSOLUTE" value="true" />
|
<option name="LABEL_INDENT_ABSOLUTE" value="true"/>
|
||||||
</indentOptions>
|
</indentOptions>
|
||||||
<arrangement>
|
<arrangement>
|
||||||
<groups>
|
<groups>
|
||||||
<group>
|
<group>
|
||||||
<type>GETTERS_AND_SETTERS</type>
|
<type>GETTERS_AND_SETTERS</type>
|
||||||
<order>KEEP</order>
|
<order>KEEP</order>
|
||||||
</group>
|
</group>
|
||||||
<group>
|
<group>
|
||||||
<type>OVERRIDDEN_METHODS</type>
|
<type>OVERRIDDEN_METHODS</type>
|
||||||
<order>KEEP</order>
|
<order>KEEP</order>
|
||||||
</group>
|
</group>
|
||||||
</groups>
|
</groups>
|
||||||
<rules>
|
<rules>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<FINAL>true</FINAL>
|
<FINAL>true</FINAL>
|
||||||
<PUBLIC>true</PUBLIC>
|
<PUBLIC>true</PUBLIC>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<PUBLIC>true</PUBLIC>
|
<PUBLIC>true</PUBLIC>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<FINAL>true</FINAL>
|
<FINAL>true</FINAL>
|
||||||
<PUBLIC>true</PUBLIC>
|
<PUBLIC>true</PUBLIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<PUBLIC>true</PUBLIC>
|
<PUBLIC>true</PUBLIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<FINAL>true</FINAL>
|
<FINAL>true</FINAL>
|
||||||
<PROTECTED>true</PROTECTED>
|
<PROTECTED>true</PROTECTED>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<PROTECTED>true</PROTECTED>
|
<PROTECTED>true</PROTECTED>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<FINAL>true</FINAL>
|
<FINAL>true</FINAL>
|
||||||
<PROTECTED>true</PROTECTED>
|
<PROTECTED>true</PROTECTED>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<PROTECTED>true</PROTECTED>
|
<PROTECTED>true</PROTECTED>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<FINAL>true</FINAL>
|
<FINAL>true</FINAL>
|
||||||
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<FINAL>true</FINAL>
|
<FINAL>true</FINAL>
|
||||||
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<FINAL>true</FINAL>
|
<FINAL>true</FINAL>
|
||||||
<PRIVATE>true</PRIVATE>
|
<PRIVATE>true</PRIVATE>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<PRIVATE>true</PRIVATE>
|
<PRIVATE>true</PRIVATE>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<FINAL>true</FINAL>
|
<FINAL>true</FINAL>
|
||||||
<PRIVATE>true</PRIVATE>
|
<PRIVATE>true</PRIVATE>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
<PRIVATE>true</PRIVATE>
|
<PRIVATE>true</PRIVATE>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<INITIALIZER_BLOCK>true</INITIALIZER_BLOCK>
|
<INITIALIZER_BLOCK>true</INITIALIZER_BLOCK>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<FIELD>true</FIELD>
|
<FIELD>true</FIELD>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<INITIALIZER_BLOCK>true</INITIALIZER_BLOCK>
|
<INITIALIZER_BLOCK>true</INITIALIZER_BLOCK>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<CONSTRUCTOR>true</CONSTRUCTOR>
|
<CONSTRUCTOR>true</CONSTRUCTOR>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<PUBLIC>true</PUBLIC>
|
<PUBLIC>true</PUBLIC>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<PUBLIC>true</PUBLIC>
|
<PUBLIC>true</PUBLIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<PROTECTED>true</PROTECTED>
|
<PROTECTED>true</PROTECTED>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<PROTECTED>true</PROTECTED>
|
<PROTECTED>true</PROTECTED>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
<PACKAGE_PRIVATE>true</PACKAGE_PRIVATE>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<PRIVATE>true</PRIVATE>
|
<PRIVATE>true</PRIVATE>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<PRIVATE>true</PRIVATE>
|
<PRIVATE>true</PRIVATE>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<METHOD>true</METHOD>
|
<METHOD>true</METHOD>
|
||||||
<NAME>method</NAME>
|
<NAME>method</NAME>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
<visibility />
|
<visibility/>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<ENUM>true</ENUM>
|
<ENUM>true</ENUM>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<INTERFACE>true</INTERFACE>
|
<INTERFACE>true</INTERFACE>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<AND>
|
<AND>
|
||||||
<CLASS>true</CLASS>
|
<CLASS>true</CLASS>
|
||||||
<STATIC>true</STATIC>
|
<STATIC>true</STATIC>
|
||||||
</AND>
|
</AND>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<rule>
|
<rule>
|
||||||
<match>
|
<match>
|
||||||
<CLASS>true</CLASS>
|
<CLASS>true</CLASS>
|
||||||
</match>
|
</match>
|
||||||
</rule>
|
</rule>
|
||||||
</section>
|
</section>
|
||||||
</rules>
|
</rules>
|
||||||
</arrangement>
|
</arrangement>
|
||||||
</codeStyleSettings>
|
</codeStyleSettings>
|
||||||
</code_scheme>
|
</code_scheme>
|
||||||
@@ -1,15 +1,22 @@
|
|||||||
# Eclipse hawkBit Documentation
|
# Eclipse hawkBit Documentation
|
||||||
The hawkBit documentation is built with [Hugo](https://www.gohugo.io/) using the [Material](http://github.com/digitalcraftsman/hugo-material-docs)
|
|
||||||
|
The hawkBit documentation is built with [Hugo](https://www.gohugo.io/) using
|
||||||
|
the [Material](http://github.com/digitalcraftsman/hugo-material-docs)
|
||||||
theme. Compiling the documentation is not included within the regular Maven build.
|
theme. Compiling the documentation is not included within the regular Maven build.
|
||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
1. **Install Hugo**: see [installing Hugo](https://gohugo.io/getting-started/installing/) documentation on how to install Hugo.
|
|
||||||
2. **Install NODE.js and npm** see [installing Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) documentation on how to install Node.js and npm
|
1. **Install Hugo**: see [installing Hugo](https://gohugo.io/getting-started/installing/) documentation on how to
|
||||||
3. **Install Redocly CLI** see [installing Redocly CLI](https://redocly.com/docs/cli/installation/) documentation on how to install Redocly CLI
|
install Hugo.
|
||||||
|
2. **Install NODE.js and npm**
|
||||||
|
see [installing Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) documentation on
|
||||||
|
how to install Node.js and npm
|
||||||
|
3. **Install Redocly CLI** see [installing Redocly CLI](https://redocly.com/docs/cli/installation/) documentation on how
|
||||||
|
to install Redocly CLI
|
||||||
4. **Install hawkBit**: run `mvn install` in the parent directory to generate the latest REST docs for hawkBit.
|
4. **Install hawkBit**: run `mvn install` in the parent directory to generate the latest REST docs for hawkBit.
|
||||||
|
|
||||||
|
|
||||||
## Build and Serve documentation
|
## Build and Serve documentation
|
||||||
|
|
||||||
The following Maven targets are available in order to build and serve the documentation:
|
The following Maven targets are available in order to build and serve the documentation:
|
||||||
|
|
||||||
* `mvn install`: _i._ Copies the generated REST docs to `content/rest-api/` and _ii._ downloads the required Hugo theme
|
* `mvn install`: _i._ Copies the generated REST docs to `content/rest-api/` and _ii._ downloads the required Hugo theme
|
||||||
@@ -19,6 +26,7 @@ The following Maven targets are available in order to build and serve the docume
|
|||||||
* `mvn clean`: Delete generated artifacts (REST docs, Hugo theme)
|
* `mvn clean`: Delete generated artifacts (REST docs, Hugo theme)
|
||||||
|
|
||||||
## Generate /public folder
|
## Generate /public folder
|
||||||
|
|
||||||
In order to generate the `/public` folder, which can be put on a web-server, run the following command:
|
In order to generate the `/public` folder, which can be put on a web-server, run the following command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|||||||
116
site/config.toml
116
site/config.toml
@@ -16,95 +16,95 @@ metadataformat = "toml"
|
|||||||
canonifyurls = false
|
canonifyurls = false
|
||||||
|
|
||||||
[markup]
|
[markup]
|
||||||
[markup.goldmark]
|
[markup.goldmark]
|
||||||
[markup.goldmark.extensions]
|
[markup.goldmark.extensions]
|
||||||
typographer = true
|
typographer = true
|
||||||
[markup.goldmark.renderer]
|
[markup.goldmark.renderer]
|
||||||
unsafe = true
|
unsafe = true
|
||||||
|
|
||||||
[markup.highlight]
|
[markup.highlight]
|
||||||
codeFences = false
|
codeFences = false
|
||||||
|
|
||||||
[params]
|
[params]
|
||||||
# General information
|
# General information
|
||||||
author = "The Eclipse hawkBit Project"
|
author = "The Eclipse hawkBit Project"
|
||||||
description = "IoT. Update. Device."
|
description = "IoT. Update. Device."
|
||||||
copyright = "The Eclipse hawkBit Project"
|
copyright = "The Eclipse hawkBit Project"
|
||||||
logo = "images/hawkbit_icon.png"
|
logo = "images/hawkbit_icon.png"
|
||||||
favicon = "images/favicon.ico"
|
favicon = "images/favicon.ico"
|
||||||
|
|
||||||
# Repository
|
# Repository
|
||||||
provider = "GitHub"
|
provider = "GitHub"
|
||||||
repo_url = "https://github.com/eclipse-hawkbit/hawkbit"
|
repo_url = "https://github.com/eclipse-hawkbit/hawkbit"
|
||||||
|
|
||||||
permalink = "#"
|
permalink = "#"
|
||||||
|
|
||||||
# Custom assets
|
# Custom assets
|
||||||
custom_css = ["css/hawkbit.css","//www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css"]
|
custom_css = ["css/hawkbit.css", "//www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css"]
|
||||||
custom_js = []
|
custom_js = []
|
||||||
|
|
||||||
# Syntax highlighting theme
|
# Syntax highlighting theme
|
||||||
highlight_css = ""
|
highlight_css = ""
|
||||||
|
|
||||||
[params.palette]
|
[params.palette]
|
||||||
primary = "deep-purple"
|
primary = "deep-purple"
|
||||||
accent = "light-green"
|
accent = "light-green"
|
||||||
|
|
||||||
[params.font]
|
[params.font]
|
||||||
text = "Ubuntu"
|
text = "Ubuntu"
|
||||||
code = "Ubuntu Mono"
|
code = "Ubuntu Mono"
|
||||||
|
|
||||||
[social]
|
[social]
|
||||||
github = "eclipse/hawkbit"
|
github = "eclipse/hawkbit"
|
||||||
gitter = "eclipse/hawkbit"
|
gitter = "eclipse/hawkbit"
|
||||||
docker = "hawkbit"
|
docker = "hawkbit"
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "What is hawkBit"
|
name = "What is hawkBit"
|
||||||
url = "/whatishawkbit/"
|
url = "/whatishawkbit/"
|
||||||
weight = 10
|
weight = 10
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "Getting started"
|
name = "Getting started"
|
||||||
url = "/gettingstarted/"
|
url = "/gettingstarted/"
|
||||||
weight = 20
|
weight = 20
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "Guides"
|
name = "Guides"
|
||||||
url = "/guides/"
|
url = "/guides/"
|
||||||
weight = 30
|
weight = 30
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "Features"
|
name = "Features"
|
||||||
url = "/features/"
|
url = "/features/"
|
||||||
weight = 40
|
weight = 40
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "Concepts"
|
name = "Concepts"
|
||||||
url = "/concepts/"
|
url = "/concepts/"
|
||||||
weight = 50
|
weight = 50
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "Architecture"
|
name = "Architecture"
|
||||||
url = "/architecture/"
|
url = "/architecture/"
|
||||||
weight = 60
|
weight = 60
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "APIs"
|
name = "APIs"
|
||||||
url = "/apis/"
|
url = "/apis/"
|
||||||
weight = 80
|
weight = 80
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "Release notes"
|
name = "Release notes"
|
||||||
url = "/release-notes/"
|
url = "/release-notes/"
|
||||||
weight = 90
|
weight = 90
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "Blog"
|
name = "Blog"
|
||||||
url = "/blog/"
|
url = "/blog/"
|
||||||
weight = 100
|
weight = 100
|
||||||
|
|
||||||
[[menu.main]]
|
[[menu.main]]
|
||||||
name = "Community"
|
name = "Community"
|
||||||
url = "/community/"
|
url = "/community/"
|
||||||
weight = 110
|
weight = 110
|
||||||
|
|||||||
@@ -4,32 +4,39 @@ parent: APIs
|
|||||||
weight: 82
|
weight: 82
|
||||||
---
|
---
|
||||||
|
|
||||||
The hawkBit [update server](https://github.com/eclipse-hawkbit/hawkbit) provides REST resources which are consumed by the device to retrieve software update tasks.
|
The hawkBit [update server](https://github.com/eclipse-hawkbit/hawkbit) provides REST resources which are consumed by
|
||||||
|
the device to retrieve software update tasks.
|
||||||
This API is based on HTTP standards and a polling mechanism.
|
This API is based on HTTP standards and a polling mechanism.
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
In DDI the target is identified using a **controllerId**. Controller is used as a term for the actual service/client on the device. That allows users to have in some cases even multiple clients on the same target for different tasks, e.g. Firmware update and App management.
|
In DDI the target is identified using a **controllerId**. Controller is used as a term for the actual service/client on
|
||||||
|
the device. That allows users to have in some cases even multiple clients on the same target for different tasks, e.g.
|
||||||
|
Firmware update and App management.
|
||||||
{{% /note %}}
|
{{% /note %}}
|
||||||
|
|
||||||
## State Machine Mapping
|
## State Machine Mapping
|
||||||
|
|
||||||
For historical reasons the DDI has a different state machine and status messages than the [Target State Machine](../../concepts/targetstate/) of the hawkBit update server.
|
For historical reasons the DDI has a different state machine and status messages than
|
||||||
|
the [Target State Machine](../../concepts/targetstate/) of the hawkBit update server.
|
||||||
|
|
||||||
This is kept in order to ensure that _DDI_ stays compatible for devices out there in the field. A future version "2" of _DDI_ might change that. _DDI_ also defines more states than the update server, e.g. multiple DDI states are currently mapped by the _DDI_ implementation to _RUNNING_ state. It is possible that in the future hawkBit will fully leverage these additional states.
|
This is kept in order to ensure that _DDI_ stays compatible for devices out there in the field. A future version "2" of
|
||||||
|
_DDI_ might change that. _DDI_ also defines more states than the update server, e.g. multiple DDI states are currently
|
||||||
|
mapped by the _DDI_ implementation to _RUNNING_ state. It is possible that in the future hawkBit will fully leverage
|
||||||
|
these additional states.
|
||||||
|
|
||||||
The _DDI_ API allows the device to provide the following feedback messages:
|
The _DDI_ API allows the device to provide the following feedback messages:
|
||||||
|
|
||||||
DDI `status.execution` type | handling by update server | Mapped ActionStatus type
|
DDI `status.execution` type | handling by update server | Mapped ActionStatus type
|
||||||
--------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -----------------------------------------------------
|
-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------
|
||||||
CANCELED | This is send by the target as confirmation of a cancellation request by the update server. | CANCELED
|
CANCELED | This is send by the target as confirmation of a cancellation request by the update server. | CANCELED
|
||||||
REJECTED | This is send by the target in case an update of a cancellation is rejected, i.e. cannot be fulfilled at this point in time. Note: the target should send a CLOSED->ERROR if it believes it will not be able to proceed the action at all. | WARNING
|
REJECTED | This is send by the target in case an update of a cancellation is rejected, i.e. cannot be fulfilled at this point in time. Note: the target should send a CLOSED->ERROR if it believes it will not be able to proceed the action at all. | WARNING
|
||||||
CLOSED | Target completes the action either with `status.result.finished` SUCCESS or FAILURE as result. Note: DDI defines also a status NONE which will not be interpreted by the update server and handled like SUCCESS. | ERROR (DDI FAILURE) or FINISHED (DDI SUCCESS or NONE)
|
CLOSED | Target completes the action either with `status.result.finished` SUCCESS or FAILURE as result. Note: DDI defines also a status NONE which will not be interpreted by the update server and handled like SUCCESS. | ERROR (DDI FAILURE) or FINISHED (DDI SUCCESS or NONE)
|
||||||
DOWNLOAD | This can be used by the target to inform that it is downloading artifacts of the action. | DOWNLOAD
|
DOWNLOAD | This can be used by the target to inform that it is downloading artifacts of the action. | DOWNLOAD
|
||||||
DOWNLOADED | This can be used by the target to inform that it has downloaded artifacts of the action. | DOWNLOADED
|
DOWNLOADED | This can be used by the target to inform that it has downloaded artifacts of the action. | DOWNLOADED
|
||||||
PROCEEDING | This can be used by the target to inform that it is working on the action. | RUNNING
|
PROCEEDING | This can be used by the target to inform that it is working on the action. | RUNNING
|
||||||
SCHEDULED | This can be used by the target to inform that it scheduled on the action. | RUNNING
|
SCHEDULED | This can be used by the target to inform that it scheduled on the action. | RUNNING
|
||||||
RESUMED | This can be used by the target to inform that it continued to work on the action. | RUNNING
|
RESUMED | This can be used by the target to inform that it continued to work on the action. | RUNNING
|
||||||
|
|
||||||
## DDI APIs
|
## DDI APIs
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,8 @@ parent: API
|
|||||||
weight: 83
|
weight: 83
|
||||||
---
|
---
|
||||||
|
|
||||||
The DMF API provides Java classes which allows that the message body can be deserialized at runtime into a Java object. Also Java classes can be used to serialize Java objects into JSON bodies to send a message to hawkBit.
|
The DMF API provides Java classes which allows that the message body can be deserialized at runtime into a Java object.
|
||||||
|
Also Java classes can be used to serialize Java objects into JSON bodies to send a message to hawkBit.
|
||||||
Currently, bodies of messages are based on JSON.
|
Currently, bodies of messages are based on JSON.
|
||||||
|
|
||||||
<!--more-->
|
<!--more-->
|
||||||
@@ -22,20 +23,22 @@ Bindings determine how messages get put in this place
|
|||||||
Queues can also be bound to multiple exchanges.
|
Queues can also be bound to multiple exchanges.
|
||||||
|
|
||||||
**Exchanges** are just publish messages.
|
**Exchanges** are just publish messages.
|
||||||
The user decides who can produce on an exchange and who can create bindings on that exchange for delivery to a specific queue.
|
The user decides who can produce on an exchange and who can create bindings on that exchange for delivery to a specific
|
||||||
|
queue.
|
||||||
|
|
||||||
hawkBit will create all necessary queues, exchanges and bindings for the user, making it easy to get started.
|
hawkBit will create all necessary queues, exchanges and bindings for the user, making it easy to get started.
|
||||||
The exchange name for outgoing messages is **dmf.exchange**.
|
The exchange name for outgoing messages is **dmf.exchange**.
|
||||||
|
|
||||||
The user has to set a `reply_to` header (see chapter below), in order to specify the exchange to which hawkBit should reply to.
|
The user has to set a `reply_to` header (see chapter below), in order to specify the exchange to which hawkBit should
|
||||||
|
reply to.
|
||||||
|
|
||||||
The following chapter describes the message body, header and properties.
|
The following chapter describes the message body, header and properties.
|
||||||
|
|
||||||
Note: the DMF protocol was intended to be compatible to other use cases by design. As a result, DMF uses the term **thing** and not **target** but they are actually synonyms in this case.
|
Note: the DMF protocol was intended to be compatible to other use cases by design. As a result, DMF uses the term *
|
||||||
|
*thing** and not **target** but they are actually synonyms in this case.
|
||||||
|
|
||||||
## Messages sent to hawkBit (Client -> hawkBit)
|
## Messages sent to hawkBit (Client -> hawkBit)
|
||||||
|
|
||||||
|
|
||||||
### THING_CREATED
|
### THING_CREATED
|
||||||
|
|
||||||
Message to register and update a provisioning target.
|
Message to register and update a provisioning target.
|
||||||
@@ -76,9 +79,10 @@ Payload Template (optional):
|
|||||||
|
|
||||||
The "name" property specifies the name of the thing, which by default is the thing ID. This property is optional.<br />
|
The "name" property specifies the name of the thing, which by default is the thing ID. This property is optional.<br />
|
||||||
<br />
|
<br />
|
||||||
The "type" property specifies name of a target type which should be assigned to the created/updated target. The
|
The "type" property specifies name of a target type which should be assigned to the created/updated target. The
|
||||||
target type with the specified name should be created in advance, otherwise it can't be assigned to the target,
|
target type with the specified name should be created in advance, otherwise it can't be assigned to the target,
|
||||||
resulting in:
|
resulting in:
|
||||||
|
|
||||||
* error is logged
|
* error is logged
|
||||||
* if the target does not exist then it is created without any target type assigned
|
* if the target does not exist then it is created without any target type assigned
|
||||||
* if it exists already then no changes to its target type assignment are made.
|
* if it exists already then no changes to its target type assignment are made.
|
||||||
@@ -87,8 +91,8 @@ If the "type" property is set to a blank string while updating an existing targe
|
|||||||
assignment is removed from the target. This property is optional and if omitted then no changes to the target type
|
assignment is removed from the target. This property is optional and if omitted then no changes to the target type
|
||||||
assignment are made.<br />
|
assignment are made.<br />
|
||||||
<br />
|
<br />
|
||||||
The "attributeUpdate" property provides the attributes of the thing, for details see UPDATE_ATTRIBUTES message. This property is optional.
|
The "attributeUpdate" property provides the attributes of the thing, for details see UPDATE_ATTRIBUTES message. This
|
||||||
|
property is optional.
|
||||||
|
|
||||||
### THING_REMOVED
|
### THING_REMOVED
|
||||||
|
|
||||||
@@ -112,7 +116,8 @@ Example headers
|
|||||||
|
|
||||||
### UPDATE_ATTRIBUTES
|
### UPDATE_ATTRIBUTES
|
||||||
|
|
||||||
Message to update target attributes. This message can be send in response to a REQUEST_ATTRIBUTES_UPDATE event, sent by hawkBit.
|
Message to update target attributes. This message can be send in response to a REQUEST_ATTRIBUTES_UPDATE event, sent by
|
||||||
|
hawkBit.
|
||||||
|
|
||||||
| Header | Description | Type | Mandatory |
|
| Header | Description | Type | Mandatory |
|
||||||
|---------|----------------------------------|----------------------------------|-----------|
|
|---------|----------------------------------|----------------------------------|-----------|
|
||||||
@@ -121,9 +126,9 @@ Message to update target attributes. This message can be send in response to a R
|
|||||||
| thingId | The ID of the registered thing | String | true |
|
| thingId | The ID of the registered thing | String | true |
|
||||||
| tenant | The tenant this thing belongs to | String | false |
|
| tenant | The tenant this thing belongs to | String | false |
|
||||||
|
|
||||||
| Message Properties | Description | Type | Mandatory |
|
| Message Properties | Description | Type | Mandatory |
|
||||||
|-----------------------------|----------------------------------|--------|-----------|
|
|--------------------|---------------------------------|--------|-----------|
|
||||||
| content_type | The content type of the payload | String | true |
|
| content_type | The content type of the payload | String | true |
|
||||||
|
|
||||||
Example header and payload:
|
Example header and payload:
|
||||||
|
|
||||||
@@ -143,7 +148,9 @@ Payload Template:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
The "mode" property specifies the update mode that should be applied. This property is optional. Possible [mode](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfUpdateMode.java) values:
|
The "mode" property specifies the update mode that should be applied. This property is optional.
|
||||||
|
Possible [mode](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfUpdateMode.java)
|
||||||
|
values:
|
||||||
|
|
||||||
| Value | Description |
|
| Value | Description |
|
||||||
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||||
@@ -165,7 +172,8 @@ Message to send an action status event to hawkBit.
|
|||||||
|--------------------|---------------------------------|--------|-----------|
|
|--------------------|---------------------------------|--------|-----------|
|
||||||
| content_type | The content type of the payload | String | true |
|
| content_type | The content type of the payload | String | true |
|
||||||
|
|
||||||
Payload Template (the Java representation is [ActionUpdateStatus](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfActionUpdateStatus.java)):
|
Payload Template (the Java representation
|
||||||
|
is [ActionUpdateStatus](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfActionUpdateStatus.java)):
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -176,7 +184,8 @@ Payload Template (the Java representation is [ActionUpdateStatus](https://github
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Possible [actionStatus](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfActionStatus.java) values:
|
Possible [actionStatus](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfActionStatus.java)
|
||||||
|
values:
|
||||||
|
|
||||||
| Value | Description |
|
| Value | Description |
|
||||||
|-----------------|-----------------------------------------|
|
|-----------------|-----------------------------------------|
|
||||||
@@ -207,7 +216,8 @@ Example header and payload:
|
|||||||
|
|
||||||
### PING
|
### PING
|
||||||
|
|
||||||
hawkBit allows DMF clients to check the availability of the DMF service. For this scenario DMF specifies a PING message that can be sent by the client:
|
hawkBit allows DMF clients to check the availability of the DMF service. For this scenario DMF specifies a PING message
|
||||||
|
that can be sent by the client:
|
||||||
|
|
||||||
| Header | Description | Type | Mandatory |
|
| Header | Description | Type | Mandatory |
|
||||||
|--------|--------------------------------|---------------------|-----------|
|
|--------|--------------------------------|---------------------|-----------|
|
||||||
@@ -255,7 +265,8 @@ Example Headers and Payload:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
After sending this message, an action status event with either actionStatus=CANCELED or actionStatus=CANCEL_REJECTED has to be returned.
|
After sending this message, an action status event with either actionStatus=CANCELED or actionStatus=CANCEL_REJECTED has
|
||||||
|
to be returned.
|
||||||
|
|
||||||
Example header and payload when cancellation is successful:
|
Example header and payload when cancellation is successful:
|
||||||
|
|
||||||
@@ -287,10 +298,10 @@ Example header and payload when cancellation is rejected:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### DOWNLOAD_AND_INSTALL or DOWNLOAD
|
### DOWNLOAD_AND_INSTALL or DOWNLOAD
|
||||||
|
|
||||||
Message sent by hawkBit to initialize an update or download task. Note: in case of a maintenance window configured but not yet active the message will have the topic _DOWNLOAD_ instead of _DOWNLOAD_AND_INSTALL_.
|
Message sent by hawkBit to initialize an update or download task. Note: in case of a maintenance window configured but
|
||||||
|
not yet active the message will have the topic _DOWNLOAD_ instead of _DOWNLOAD_AND_INSTALL_.
|
||||||
|
|
||||||
| Header | Description | Type | Mandatory |
|
| Header | Description | Type | Mandatory |
|
||||||
|---------|------------------------------------------------|---------------------------------------------------|-----------|
|
|---------|------------------------------------------------|---------------------------------------------------|-----------|
|
||||||
@@ -303,7 +314,8 @@ Message sent by hawkBit to initialize an update or download task. Note: in case
|
|||||||
|--------------------|---------------------------------|--------|-----------|
|
|--------------------|---------------------------------|--------|-----------|
|
||||||
| content_type | The content type of the payload | String | true |
|
| content_type | The content type of the payload | String | true |
|
||||||
|
|
||||||
Payload Template (the Java representation is [DmfDownloadAndUpdateRequest](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfDownloadAndUpdateRequest.java)):
|
Payload Template (the Java representation
|
||||||
|
is [DmfDownloadAndUpdateRequest](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfDownloadAndUpdateRequest.java)):
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
@@ -375,13 +387,13 @@ Example header and payload:
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### MULTI_ACTION
|
### MULTI_ACTION
|
||||||
|
|
||||||
If `multi.assignments.enabled` is enabled, this message is sent instead of DOWNLOAD_AND_INSTALL, DOWNLOAD, or CANCEL_DOWNLOAD
|
If `multi.assignments.enabled` is enabled, this message is sent instead of DOWNLOAD_AND_INSTALL, DOWNLOAD, or
|
||||||
by hawkBit to initialize update, download, or cancel task(s).
|
CANCEL_DOWNLOAD
|
||||||
|
by hawkBit to initialize update, download, or cancel task(s).
|
||||||
|
|
||||||
With weight, one can set the priority to the action. The higher the weight, the higher is the priority of an action.
|
With weight, one can set the priority to the action. The higher the weight, the higher is the priority of an action.
|
||||||
|
|
||||||
| Header | Description | Type | Mandatory |
|
| Header | Description | Type | Mandatory |
|
||||||
|---------|------------------------------------------------|-----------------------------|-----------|
|
|---------|------------------------------------------------|-----------------------------|-----------|
|
||||||
@@ -394,7 +406,8 @@ If `multi.assignments.enabled` is enabled, this message is sent instead of DOWNL
|
|||||||
|--------------------|---------------------------------|--------|-----------|
|
|--------------------|---------------------------------|--------|-----------|
|
||||||
| content_type | The content type of the payload | String | true |
|
| content_type | The content type of the payload | String | true |
|
||||||
|
|
||||||
Payload Template (the Java representation is [DmfMultiActionRequest](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfMultiActionRequest.java)):
|
Payload Template (the Java representation
|
||||||
|
is [DmfMultiActionRequest](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-dmf/hawkbit-dmf-api/src/main/java/org/eclipse/hawkbit/dmf/json/model/DmfMultiActionRequest.java)):
|
||||||
|
|
||||||
```json
|
```json
|
||||||
[{
|
[{
|
||||||
@@ -540,7 +553,6 @@ Example header and payload:
|
|||||||
}]
|
}]
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
### THING_DELETED
|
### THING_DELETED
|
||||||
|
|
||||||
Message sent by hawkBit when a target has been deleted.
|
Message sent by hawkBit when a target has been deleted.
|
||||||
@@ -557,7 +569,6 @@ Example header:
|
|||||||
|--------------------------------------------------------------|-------------------|
|
|--------------------------------------------------------------|-------------------|
|
||||||
| type=THING\_DELETED <br /> tenant=default <br /> thingId=abc | |
|
| type=THING\_DELETED <br /> tenant=default <br /> thingId=abc | |
|
||||||
|
|
||||||
|
|
||||||
### REQUEST_ATTRIBUTES_UPDATE
|
### REQUEST_ATTRIBUTES_UPDATE
|
||||||
|
|
||||||
Message sent by Eclipse hawkBit when a re-transmission of target attributes is requested.
|
Message sent by Eclipse hawkBit when a re-transmission of target attributes is requested.
|
||||||
@@ -575,10 +586,10 @@ Example headers:
|
|||||||
|----------------------------------------------------------------------------------------------|-------------------|
|
|----------------------------------------------------------------------------------------------|-------------------|
|
||||||
| type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=REQUEST\_ATTRIBUTES\_UPDATE | |
|
| type=EVENT <br /> tenant=default <br /> thingId=abc <br /> topic=REQUEST\_ATTRIBUTES\_UPDATE | |
|
||||||
|
|
||||||
|
|
||||||
### PING_RESPONSE
|
### PING_RESPONSE
|
||||||
|
|
||||||
_hawkBit_ will respond to the PING message with a PING_RESPONSE type message that has the same correlationId as the original PING message:
|
_hawkBit_ will respond to the PING message with a PING_RESPONSE type message that has the same correlationId as the
|
||||||
|
original PING message:
|
||||||
|
|
||||||
| Header | Description | Type | Mandatory |
|
| Header | Description | Type | Mandatory |
|
||||||
|--------|--------------------------------|------------------------------|-----------|
|
|--------|--------------------------------|------------------------------|-----------|
|
||||||
@@ -590,7 +601,8 @@ _hawkBit_ will respond to the PING message with a PING_RESPONSE type message tha
|
|||||||
| correlationId | CorrelationId of the original PING request | String | true |
|
| correlationId | CorrelationId of the original PING request | String | true |
|
||||||
| content_type | The content type of the payload | String | true |
|
| content_type | The content type of the payload | String | true |
|
||||||
|
|
||||||
The PING_RESPONSE also contains a timestamp (i.e. the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC) as plain text. It is not guaranteed that this timestamp is completely accurate.
|
The PING_RESPONSE also contains a timestamp (i.e. the difference, measured in milliseconds, between the current time and
|
||||||
|
midnight, January 1, 1970 UTC) as plain text. It is not guaranteed that this timestamp is completely accurate.
|
||||||
|
|
||||||
| Header | MessageProperties |
|
| Header | MessageProperties |
|
||||||
|-------------------------------------------|-------------------------|
|
|-------------------------------------------|-------------------------|
|
||||||
|
|||||||
@@ -4,16 +4,20 @@ parent: API
|
|||||||
weight: 81
|
weight: 81
|
||||||
---
|
---
|
||||||
|
|
||||||
The Management API is a RESTful API that enables to perform Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).
|
The Management API is a RESTful API that enables to perform Create/Read/Update/Delete operations for provisioning
|
||||||
|
targets (i.e. devices) and repository content (i.e. software).
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
Based on the Management API you can manage and monitor software update operations via HTTP/HTTPS. The _Management API_ supports JSON payload with hypermedia as well as filtering, sorting and paging. Furthermore the Management API provides permission based access control and standard roles as well as custom role creation.
|
Based on the Management API you can manage and monitor software update operations via HTTP/HTTPS. The _Management API_
|
||||||
|
supports JSON payload with hypermedia as well as filtering, sorting and paging. Furthermore the Management API provides
|
||||||
|
permission based access control and standard roles as well as custom role creation.
|
||||||
|
|
||||||
The API is protected and needs authentication and authorization based on the security concept.
|
The API is protected and needs authentication and authorization based on the security concept.
|
||||||
|
|
||||||
## API Version
|
## API Version
|
||||||
|
|
||||||
hawkBit provides an consistent Management API interface that guarantees backwards compatibility for future releases by version control.
|
hawkBit provides an consistent Management API interface that guarantees backwards compatibility for future releases by
|
||||||
|
version control.
|
||||||
|
|
||||||
The current version of the Management API is `version 1 (v1)` with the URI http://localhost:8080/rest/v1/
|
The current version of the Management API is `version 1 (v1)` with the URI http://localhost:8080/rest/v1/
|
||||||
|
|
||||||
@@ -42,10 +46,11 @@ In addition, for POST and PUT requests the `Content-Type` header has to be set.
|
|||||||
|
|
||||||
## Request Body
|
## Request Body
|
||||||
|
|
||||||
Besides the relevant data (name, description, createdBy etc.) of a resource entity, a resource entity also has URIs (`_links`) to linked resource entities.
|
Besides the relevant data (name, description, createdBy etc.) of a resource entity, a resource entity also has
|
||||||
|
URIs (`_links`) to linked resource entities.
|
||||||
A _Distribution Set_ entity may have for example URIs to artifacts, _Software Modules_, _Software Module Types_ and metadata.
|
|
||||||
|
|
||||||
|
A _Distribution Set_ entity may have for example URIs to artifacts, _Software Modules_, _Software Module Types_ and
|
||||||
|
metadata.
|
||||||
|
|
||||||
```json
|
```json
|
||||||
"_links": {
|
"_links": {
|
||||||
@@ -65,5 +70,4 @@ A _Distribution Set_ entity may have for example URIs to artifacts, _Software Mo
|
|||||||
|
|
||||||
## Management APIs
|
## Management APIs
|
||||||
|
|
||||||
|
|
||||||
<iframe style="padding-top: 20px;" width="100%" height="900px" frameborder="0" src="../../rest-api/mgmt.html"></iframe>
|
<iframe style="padding-top: 20px;" width="100%" height="900px" frameborder="0" src="../../rest-api/mgmt.html"></iframe>
|
||||||
|
|||||||
@@ -4,17 +4,19 @@ parent: Blog
|
|||||||
weight: 200
|
weight: 200
|
||||||
---
|
---
|
||||||
|
|
||||||
hawkBit is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well
|
hawkBit is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well
|
||||||
as more powerful controllers and gateways connected to IP based networking infrastructure. It is part of the Eclipse IoT
|
as more powerful controllers and gateways connected to IP based networking infrastructure. It is part of the Eclipse IoT
|
||||||
since 2015 and with version _0.2.0_ a first release is available.
|
since 2015 and with version _0.2.0_ a first release is available.
|
||||||
|
|
||||||
In this article, we want to give an overview of the latest highlights of hawkBit and let you know how you can get
|
In this article, we want to give an overview of the latest highlights of hawkBit and let you know how you can get
|
||||||
started in seconds.
|
started in seconds.
|
||||||
|
|
||||||
## Finally, it is here!
|
## Finally, it is here!
|
||||||
|
|
||||||
After being around in the Eclipse IoT realm for quite some time now, we are more than happy to announce our first release:
|
After being around in the Eclipse IoT realm for quite some time now, we are more than happy to announce our first
|
||||||
[_Eclipse hawkBit 0.2.0_](https://projects.eclipse.org/projects/iot.hawkbit/releases/0.2.0). The release can be found on [Maven Central](https://mvnrepository.com/artifact/org.eclipse.hawkbit)
|
release:
|
||||||
|
[_Eclipse hawkBit 0.2.0_](https://projects.eclipse.org/projects/iot.hawkbit/releases/0.2.0). The release can be found
|
||||||
|
on [Maven Central](https://mvnrepository.com/artifact/org.eclipse.hawkbit)
|
||||||
and [Docker Hub](https://hub.docker.com/r/hawkbit/hawkbit-update-server/). It includes the following core features:
|
and [Docker Hub](https://hub.docker.com/r/hawkbit/hawkbit-update-server/). It includes the following core features:
|
||||||
|
|
||||||
* Device and Software Repository
|
* Device and Software Repository
|
||||||
@@ -31,63 +33,69 @@ The features are accessible via the following interfaces:
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## What's new?
|
## What's new?
|
||||||
|
|
||||||
Whenever there is a new release, the first question that comes to mind is: What's new? Since this is our first release,
|
Whenever there is a new release, the first question that comes to mind is: What's new? Since this is our first release,
|
||||||
one could argue that everything is new. However, most of the features are already well-established. This holds true, for
|
one could argue that everything is new. However, most of the features are already well-established. This holds true, for
|
||||||
example, for our APIs or the Rollout Management. Nevertheless, there have been some recent updates to hawkBit, which we
|
example, for our APIs or the Rollout Management. Nevertheless, there have been some recent updates to hawkBit, which we
|
||||||
do not want to leave unmentioned:
|
do not want to leave unmentioned:
|
||||||
|
|
||||||
### Streamlined UI
|
### Streamlined UI
|
||||||
|
|
||||||
The probably most noticeable change has been the removal of the two buttons (`Drop here to delete` and `Actions`) at the
|
The probably most noticeable change has been the removal of the two buttons (`Drop here to delete` and `Actions`) at the
|
||||||
bottom of the _Deployment_, _Distributions_, and _Upload_ view. This is a major usability improvement! For example,
|
bottom of the _Deployment_, _Distributions_, and _Upload_ view. This is a major usability improvement! For example,
|
||||||
deleting an item required (1) dragging an item onto the delete button, (2) opening the delete pop-up, and (3) confirming
|
deleting an item required (1) dragging an item onto the delete button, (2) opening the delete pop-up, and (3) confirming
|
||||||
the deletion. Now, an item can be easily removed by clicking on its remove icon and confirming the action. Moreover,
|
the deletion. Now, an item can be easily removed by clicking on its remove icon and confirming the action. Moreover,
|
||||||
multiple (or all `CTRL` + `A`) items can be selected and removed at once using the same mechanism. This is not only
|
multiple (or all `CTRL` + `A`) items can be selected and removed at once using the same mechanism. This is not only
|
||||||
faster and more intuitive, it also saves a lot of display real estate which can now be used to focus on what is important.
|
faster and more intuitive, it also saves a lot of display real estate which can now be used to focus on what is
|
||||||
|
important.
|
||||||
We hope you like this change as much as we do! _(Requires: hawkBit > 0.2.2)_
|
We hope you like this change as much as we do! _(Requires: hawkBit > 0.2.2)_
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### MS SQL Server
|
### MS SQL Server
|
||||||
|
|
||||||
Eclipse hawkBit supports a range of different SQL databases. Up to now, these have been the internal H2 database (which can be
|
Eclipse hawkBit supports a range of different SQL databases. Up to now, these have been the internal H2 database (which
|
||||||
used for testing, development, or trial) and MySQL/MariaDB for production-grade usage. This list is now extended by
|
can be
|
||||||
|
used for testing, development, or trial) and MySQL/MariaDB for production-grade usage. This list is now extended by
|
||||||
Microsoft's SQL Server which is also available in production grade, as well as, IBM's DB2 for testing and development.
|
Microsoft's SQL Server which is also available in production grade, as well as, IBM's DB2 for testing and development.
|
||||||
|
|
||||||
### Open Sourced REST docs
|
### Open Sourced REST docs
|
||||||
|
|
||||||
A huge benefit for the community is the recently open sourced REST docs of hawkBit. This has been an [open request](https://github.com/eclipse-hawkbit/hawkbit/issues/480)
|
A huge benefit for the community is the recently open sourced REST docs of hawkBit. This has been
|
||||||
for some time, which we were happy to meet. The documentation is generated using [Spring REST docs](https://spring.io/projects/spring-restdocs), based on unit-tests. These tests, with the respective documentation, are now available in the [code base](https://github.com/eclipse-hawkbit/hawkbit/pull/688).
|
an [open request](https://github.com/eclipse-hawkbit/hawkbit/issues/480)
|
||||||
Furthermore, the API documentation will be hosted on our new [website](https://www.eclipse.org/hawkbit/) (coming soon).
|
for some time, which we were happy to meet. The documentation is generated
|
||||||
|
using [Spring REST docs](https://spring.io/projects/spring-restdocs), based on unit-tests. These tests, with the
|
||||||
|
respective documentation, are now available in the [code base](https://github.com/eclipse-hawkbit/hawkbit/pull/688).
|
||||||
|
Furthermore, the API documentation will be hosted on our new [website](https://www.eclipse.org/hawkbit/) (coming soon).
|
||||||
|
|
||||||
### Docker Images
|
### Docker Images
|
||||||
|
|
||||||
In order to enable interested parties to get started with hawkBit conveniently, we decided to provide the
|
In order to enable interested parties to get started with hawkBit conveniently, we decided to provide the
|
||||||
[Update Server as a Docker image](https://hub.docker.com/r/hawkbit/hawkbit-update-server/) on Docker Hub. The image comes
|
[Update Server as a Docker image](https://hub.docker.com/r/hawkbit/hawkbit-update-server/) on Docker Hub. The image
|
||||||
in two flavors: The default image uses the internal H2 database, while the images with a `-mysql` suffix contain the MySQL
|
comes
|
||||||
driver to allow connecting a MySQL database. In addition to the Docker image, the hawkBit repository contains a
|
in two flavors: The default image uses the internal H2 database, while the images with a `-mysql` suffix contain the
|
||||||
[docker-compose.yml](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/docker/docker-compose.yml)
|
MySQL
|
||||||
that not only starts the Update Server, but further includes a MySQL database and a RabbitMQ message broker so you're
|
driver to allow connecting a MySQL database. In addition to the Docker image, the hawkBit repository contains a
|
||||||
able to use Device Management Federation (DMF) as well.
|
[docker-compose.yml](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/docker/docker-compose.yml)
|
||||||
|
that not only starts the Update Server, but further includes a MySQL database and a RabbitMQ message broker so you're
|
||||||
|
able to use Device Management Federation (DMF) as well.
|
||||||
|
|
||||||
To start the hawkBit Update Server image, open a terminal and run:
|
To start the hawkBit Update Server image, open a terminal and run:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ docker run -d -p 8080:8080 hawkbit/hawkbit-update-server
|
$ docker run -d -p 8080:8080 hawkbit/hawkbit-update-server
|
||||||
```
|
```
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
_Note: This requires a running [Docker deamon](https://docs.docker.com/install/) on your system._
|
_Note: This requires a running [Docker deamon](https://docs.docker.com/install/) on your system._
|
||||||
{{% /note %}}
|
{{% /note %}}
|
||||||
|
|
||||||
Now, browse to [http://localhost:8080](http://localhost:8080) and log-in with `admin:admin`. There you go!
|
Now, browse to [http://localhost:8080](http://localhost:8080) and log-in with `admin:admin`. There you go!
|
||||||
|
|
||||||
## Community Updates
|
## Community Updates
|
||||||
|
|
||||||
Although features and functionality play a major role in the hawkBit project, there is also some interesting news from
|
Although features and functionality play a major role in the hawkBit project, there is also some interesting news from
|
||||||
the community. As of July 2018, there have been:
|
the community. As of July 2018, there have been:
|
||||||
|
|
||||||
* Pull Requests: 587
|
* Pull Requests: 587
|
||||||
@@ -98,17 +106,19 @@ the community. As of July 2018, there have been:
|
|||||||
|
|
||||||
### New Project Lead and Committers
|
### New Project Lead and Committers
|
||||||
|
|
||||||
We are happy to announce that the hawkBit project got a new project lead. In addition to
|
We are happy to announce that the hawkBit project got a new project lead. In addition to
|
||||||
[Kai Zimmermann](https://projects.eclipse.org/user/6364), project lead from the first hour,
|
[Kai Zimmermann](https://projects.eclipse.org/user/6364), project lead from the first hour,
|
||||||
[Jeroen Laverman](https://projects.eclipse.org/user/10982) joined the lead to support him in this responsibility.
|
[Jeroen Laverman](https://projects.eclipse.org/user/10982) joined the lead to support him in this responsibility.
|
||||||
Moreover, with [Stefan Behl](https://projects.eclipse.org/user/10842) and Jeroen Laverman, two new committers are aboard.
|
Moreover, with [Stefan Behl](https://projects.eclipse.org/user/10842) and Jeroen Laverman, two new committers are
|
||||||
|
aboard.
|
||||||
|
|
||||||
## What's next?
|
## What's next?
|
||||||
|
|
||||||
Looking ahead, there are two major topics that we want to tackle next: First, there is the migration of our UI from Vaadin
|
Looking ahead, there are two major topics that we want to tackle next: First, there is the migration of our UI from
|
||||||
|
Vaadin
|
||||||
7 to Vaadin 8, since Vaadin announced the end-of-life for our current version. Another big topic will be the update
|
7 to Vaadin 8, since Vaadin announced the end-of-life for our current version. Another big topic will be the update
|
||||||
to Spring Boot 2. On the community side, we are in the final stage of updating our [website](https://www.eclipse.org/hawkbit/)
|
to Spring Boot 2. On the community side, we are in the final stage of updating
|
||||||
with a new design, so make sure you stop by in a couple of days to check it out. Finally, the hawkBit team will be
|
our [website](https://www.eclipse.org/hawkbit/)
|
||||||
|
with a new design, so make sure you stop by in a couple of days to check it out. Finally, the hawkBit team will be
|
||||||
present at EclipseCon Europe 2018, so if you are interested in meeting us, that is the place to be.
|
present at EclipseCon Europe 2018, so if you are interested in meeting us, that is the place to be.
|
||||||
|
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ In this article, we want to give an overview of the latest highlights of hawkBit
|
|||||||
Based on the issues
|
Based on the issues
|
||||||
[Switch to EPL 2.0 License](https://github.com/eclipse-hawkbit/hawkbit/issues/1393) and
|
[Switch to EPL 2.0 License](https://github.com/eclipse-hawkbit/hawkbit/issues/1393) and
|
||||||
[Update hawkBit's license to EPL 2.0](https://github.com/eclipse-hawkbit/hawkbit/issues/1008)
|
[Update hawkBit's license to EPL 2.0](https://github.com/eclipse-hawkbit/hawkbit/issues/1008)
|
||||||
the hawkBit license is upgraded from [Eclipse Public License - Version 1.0](http://www.eclipse.org/org/documents/epl-v10.php) to
|
the hawkBit license is upgraded
|
||||||
|
from [Eclipse Public License - Version 1.0](http://www.eclipse.org/org/documents/epl-v10.php) to
|
||||||
[Eclipse Public License - v 2.0](https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt).
|
[Eclipse Public License - v 2.0](https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt).
|
||||||
|
|
||||||
|
|||||||
@@ -8,18 +8,34 @@ In this article, we want to give an overview of the future of the hawkBit UI
|
|||||||
|
|
||||||
## hawkBit Vaadin 8 UI discontinuation
|
## hawkBit Vaadin 8 UI discontinuation
|
||||||
|
|
||||||
The hawkBit UI uses Vaadin as a web UI framework. It uses Vaadin 8 (8.14.3). This major version, according [Vaadin Roadmap](https://vaadin.com/roadmap), has no free support since 21st Feb 2022. There are some version releases after that date (8.15.0 - 8.16.0) that are Apache 2.0 licensed. However, since 8.16.1 ([see here](https://mvnrepository.com/artifact/com.vaadin/vaadin-server)) the license is [Commercial Vaadin Developer License 4.0](https://vaadin.com/license/cvdl-4.0), so they could not be used in hawkBit.
|
The hawkBit UI uses Vaadin as a web UI framework. It uses Vaadin 8 (8.14.3). This major version,
|
||||||
|
according [Vaadin Roadmap](https://vaadin.com/roadmap), has no free support since 21st Feb 2022. There are some version
|
||||||
|
releases after that date (8.15.0 - 8.16.0) that are Apache 2.0 licensed. However, since
|
||||||
|
8.16.1 ([see here](https://mvnrepository.com/artifact/com.vaadin/vaadin-server)) the license
|
||||||
|
is [Commercial Vaadin Developer License 4.0](https://vaadin.com/license/cvdl-4.0), so they could not be used in hawkBit.
|
||||||
|
|
||||||
We believe it is not a good practice to keep an out of free support library in an open source project like hawkBit. And moreover, even if we keep it, if a security vulnerability is discovered - all users shall opt for commercial support or to drop UI.
|
We believe it is not a good practice to keep an out of free support library in an open source project like hawkBit. And
|
||||||
|
moreover, even if we keep it, if a security vulnerability is discovered - all users shall opt for commercial support or
|
||||||
|
to drop UI.
|
||||||
|
|
||||||
There is another critical obstacle with keeping Vaadin 8 UI. At the moment hawkBit uses Spring Boot 2.7. According to [Spring Boot EOL](https://endoflife.date/spring-boot) Spring Boot 2.7 stream will reach end of support 24th Nov 2023. So, hawkBit shall be migrated to Spring Boot 3.0+. Since Vaadin 8 seem to be incompatible with Spring Boot 3 (they added support for Spring Boot 3 in Vaadin 24 ([Vaadin 24 pre release](https://vaadin.com/blog/vaadin-24-pre-release-available-for-spring-boot-3.0)) we shall drop Vaadin UI 8 anyway.
|
There is another critical obstacle with keeping Vaadin 8 UI. At the moment hawkBit uses Spring Boot 2.7. According
|
||||||
|
to [Spring Boot EOL](https://endoflife.date/spring-boot) Spring Boot 2.7 stream will reach end of support 24th Nov 2023.
|
||||||
|
So, hawkBit shall be migrated to Spring Boot 3.0+. Since Vaadin 8 seem to be incompatible with Spring Boot 3 (they added
|
||||||
|
support for Spring Boot 3 in Vaadin
|
||||||
|
24 ([Vaadin 24 pre release](https://vaadin.com/blog/vaadin-24-pre-release-available-for-spring-boot-3.0)) we shall drop
|
||||||
|
Vaadin UI 8 anyway.
|
||||||
|
|
||||||
Many months ago we asked for community help to migrate hawkBit UI to newer Vaadin versions - [Urgent migration needed to a newer Vaadin version
|
Many months ago we asked for community help to migrate hawkBit UI to newer Vaadin
|
||||||
](https://github.com/eclipse-hawkbit/hawkbit/issues/1376) and gitter channel. However, there was no volunteer found to do the migration.
|
versions - [Urgent migration needed to a newer Vaadin version
|
||||||
|
](https://github.com/eclipse-hawkbit/hawkbit/issues/1376) and gitter channel. However, there was no volunteer found to
|
||||||
|
do the migration.
|
||||||
|
|
||||||
All this being said, unfortunately, we've come to the decision to drop the Vaadin 8 UI from the Eclipse hawkBit and the latest hawkBit release 0.3.0 is the last version of hawkBit that includes it. For the next 0.4.0 release we plan to remove this Vaadin 8 UI. Thus the hawkBit may become an UI-less project.
|
All this being said, unfortunately, we've come to the decision to drop the Vaadin 8 UI from the Eclipse hawkBit and the
|
||||||
|
latest hawkBit release 0.3.0 is the last version of hawkBit that includes it. For the next 0.4.0 release we plan to
|
||||||
|
remove this Vaadin 8 UI. Thus the hawkBit may become an UI-less project.
|
||||||
|
|
||||||
|
There were steps taken to mitigate the problem:
|
||||||
|
|
||||||
There were steps taken to mitigate the problem:
|
|
||||||
* extending the REST API
|
* extending the REST API
|
||||||
* introducing Swagger UI which allow easier use of the REST API
|
* introducing Swagger UI which allow easier use of the REST API
|
||||||
|
|
||||||
|
|||||||
@@ -9,19 +9,42 @@ In this article, we want to give an overview of the 0.4.1 hawkBit release (Frida
|
|||||||
## hawkBit [0.4.1](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.4.1) release
|
## hawkBit [0.4.1](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.4.1) release
|
||||||
|
|
||||||
### Steps towards removal of the legacy Vaadin8-based UI
|
### Steps towards removal of the legacy Vaadin8-based UI
|
||||||
As announced at [Vaadin 8 UI discontinuation](2023-11-22-vaadin8_ui_discontinuation.md) the current Vaadin 8 based UI will be removed. This release will likely be the last one including it. Some steps are taken to mitigate this.
|
|
||||||
* First of all, this release introduces [Simple UI](https://github.com/eclipse-hawkbit/hawkbit/tree/0.4.1/hawkbit-runtime/hawkbit-simple-ui) - a demo/PoC level UI. It includes the most essential functionality allowing you to play around with hawkBit. It could not be compared to legacy UI in features and maturity in any case. Some notes for it:
|
As announced at [Vaadin 8 UI discontinuation](2023-11-22-vaadin8_ui_discontinuation.md) the current Vaadin 8 based UI
|
||||||
|
will be removed. This release will likely be the last one including it. Some steps are taken to mitigate this.
|
||||||
|
|
||||||
|
* First of all, this release
|
||||||
|
introduces [Simple UI](https://github.com/eclipse-hawkbit/hawkbit/tree/0.4.1/hawkbit-runtime/hawkbit-simple-ui) - a
|
||||||
|
demo/PoC level UI. It includes the most essential functionality allowing you to play around with hawkBit. It could not
|
||||||
|
be compared to legacy UI in features and maturity in any case. Some notes for it:
|
||||||
* *Status* - as already said - low maturity and very feature-limited, *EXPERIMENTAL*
|
* *Status* - as already said - low maturity and very feature-limited, *EXPERIMENTAL*
|
||||||
* Intended for demo/play-around purposes. It could become an initial version of a new hawkBit UI but currently, there are no resources for further development. Any contribution to this UI in the direction of making it a full-fledged mature UI is welcome!
|
* Intended for demo/play-around purposes. It could become an initial version of a new hawkBit UI but currently,
|
||||||
|
there are no resources for further development. Any contribution to this UI in the direction of making it a
|
||||||
|
full-fledged mature UI is welcome!
|
||||||
* It provides features like - create software modules & distribution sets, targets, and rollouts
|
* It provides features like - create software modules & distribution sets, targets, and rollouts
|
||||||
* In contrast with legacy UI the new UI is a standalone application and uses only REST API to provide functionality to the user.
|
* In contrast with legacy UI the new UI is a standalone application and uses only REST API to provide functionality
|
||||||
* To the legacy monolith update server application there is added a new microservice-based application. As part of this effort, there was introduced an example of [legacy Vaadin 8 UI standalone application](https://github.com/eclipse-hawkbit/hawkbit/tree/0.4.1/hawkbit-runtime/hawkbit-vv8-ui). This legacy UI standalone application could be used together with future hawkBit update server versions as long as it is compatible and on the user's responsibility. Some notes for it:
|
to the user.
|
||||||
* *NOT RECOMMENDED* - it might contain security vulnerabilities and bugs. It could be hard to verify its compatibility with the new hawkBit versions.
|
* To the legacy monolith update server application there is added a new microservice-based application. As part of this
|
||||||
* *ON USER's RESPONSIBILITY* - no guarantees of any kind are provided for that application. It is entirely the user's responsibility to test, scan for vulnerabilities, and use it.
|
effort, there was introduced an example
|
||||||
|
of [legacy Vaadin 8 UI standalone application](https://github.com/eclipse-hawkbit/hawkbit/tree/0.4.1/hawkbit-runtime/hawkbit-vv8-ui).
|
||||||
|
This legacy UI standalone application could be used together with future hawkBit update server versions as long as it
|
||||||
|
is compatible and on the user's responsibility. Some notes for it:
|
||||||
|
* *NOT RECOMMENDED* - it might contain security vulnerabilities and bugs. It could be hard to verify its
|
||||||
|
compatibility with the new hawkBit versions.
|
||||||
|
* *ON USER's RESPONSIBILITY* - no guarantees of any kind are provided for that application. It is entirely the
|
||||||
|
user's responsibility to test, scan for vulnerabilities, and use it.
|
||||||
* Provides an option to use the legacy Vaadin 8 UI with the new hawkBit versions under the conditions above
|
* Provides an option to use the legacy Vaadin 8 UI with the new hawkBit versions under the conditions above
|
||||||
* It uses directly the database and legacy update server code
|
* It uses directly the database and legacy update server code
|
||||||
* It includes the outdated Spring Boot 2.7 which is after its end of support
|
* It includes the outdated Spring Boot 2.7 which is after its end of support
|
||||||
* It will not be developed any further and new features won't be available
|
* It will not be developed any further and new features won't be available
|
||||||
* No bugfixes would be provided for it
|
* No bugfixes would be provided for it
|
||||||
|
|
||||||
### Extended access control management - entity-based
|
### Extended access control management - entity-based
|
||||||
There is a new feature implemented in access control management. Up until now, permissions (e.g. CREATE_TARGET) were assigned to the users, and based on that users were able to execute some action or not. Now there is added a pluggable mechanism via [AccessController](https://github.com/eclipse-hawkbit/hawkbit/blob/0.4.1/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/acm/AccessController.java) that allows to further restrict the access based on the entity. For instance, a developer could implement its custom access controller for targets that, depending on the user, could grant or reject permissions for accessing targets of certain target types.
|
|
||||||
|
There is a new feature implemented in access control management. Up until now, permissions (e.g. CREATE_TARGET) were
|
||||||
|
assigned to the users, and based on that users were able to execute some action or not. Now there is added a pluggable
|
||||||
|
mechanism
|
||||||
|
via [AccessController](https://github.com/eclipse-hawkbit/hawkbit/blob/0.4.1/hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/acm/AccessController.java)
|
||||||
|
that allows to further restrict the access based on the entity. For instance, a developer could implement its custom
|
||||||
|
access controller for targets that, depending on the user, could grant or reject permissions for accessing targets of
|
||||||
|
certain target types.
|
||||||
@@ -5,41 +5,59 @@ weight: 90
|
|||||||
|
|
||||||
## Presentations
|
## Presentations
|
||||||
|
|
||||||
Here you can find links to arbitrary material covering Eclipse hawkBit which has been presented at events, conferences and meet-ups.
|
Here you can find links to arbitrary material covering Eclipse hawkBit which has been presented at events, conferences
|
||||||
|
and meet-ups.
|
||||||
|
|
||||||
- 09/23/2015 - Eclipse IoT Working Group meeting - [slides](https://docs.bosch-iot-rollouts.com/slides/hawkBitProposal20150923.html)
|
- 09/23/2015 - Eclipse IoT Working Group
|
||||||
|
meeting - [slides](https://docs.bosch-iot-rollouts.com/slides/hawkBitProposal20150923.html)
|
||||||
- 04/11/2015 - EclipseCon Europe 2015 - [slides](https://docs.bosch-iot-rollouts.com/slides/eclipseCon2015.html)
|
- 04/11/2015 - EclipseCon Europe 2015 - [slides](https://docs.bosch-iot-rollouts.com/slides/eclipseCon2015.html)
|
||||||
- 03/09/2016 - EclipseCon North America 2016 - [slides](https://docs.bosch-iot-rollouts.com/slides/eclipseConNA2016.html)
|
- 03/09/2016 - EclipseCon North America
|
||||||
- 05/16/2016 - Eclipse Virtual IoT Meetup - [video](https://www.youtube.com/watch?v=g-dhKMaaanE) - [slides](https://docs.bosch-iot-rollouts.com/slides/virtualIoTMeetup2016.html)
|
2016 - [slides](https://docs.bosch-iot-rollouts.com/slides/eclipseConNA2016.html)
|
||||||
- 03/20/2017 - Eclipse IoT Day SanJose, CA - [video](https://www.youtube.com/watch?v=x5OfBgnYW44) - [slides](https://docs.bosch-iot-rollouts.com/slides/iotDaySanJose2017.pdf)
|
- 05/16/2016 - Eclipse Virtual IoT
|
||||||
|
Meetup - [video](https://www.youtube.com/watch?v=g-dhKMaaanE) - [slides](https://docs.bosch-iot-rollouts.com/slides/virtualIoTMeetup2016.html)
|
||||||
|
- 03/20/2017 - Eclipse IoT Day SanJose,
|
||||||
|
CA - [video](https://www.youtube.com/watch?v=x5OfBgnYW44) - [slides](https://docs.bosch-iot-rollouts.com/slides/iotDaySanJose2017.pdf)
|
||||||
- 09/12/2017 - Eclipse IoT Day ThingMonk 2017 - [video](https://www.youtube.com/watch?v=7hK-kiQjKGA)
|
- 09/12/2017 - Eclipse IoT Day ThingMonk 2017 - [video](https://www.youtube.com/watch?v=7hK-kiQjKGA)
|
||||||
- 01/10/2018 - Eclipse Virtual IoT Meetup - [video](https://www.youtube.com/watch?v=8vcLXs9lc-4) - [slides](https://docs.bosch-iot-rollouts.com/slides/hawkBitIntroduction.html)
|
- 01/10/2018 - Eclipse Virtual IoT
|
||||||
- 10/22/2018 - Community Day EclipseCon Europe 2018 - [slides](https://www.eclipse.org/hawkbit/slides/community-day-2018.html)
|
Meetup - [video](https://www.youtube.com/watch?v=8vcLXs9lc-4) - [slides](https://docs.bosch-iot-rollouts.com/slides/hawkBitIntroduction.html)
|
||||||
- 10/21/2019 - Community Day EclipseCon Europe 2019 - [slides](https://www.eclipse.org/hawkbit/slides/community-day-2019.html)
|
- 10/22/2018 - Community Day EclipseCon Europe
|
||||||
- 10/19/2020 - Community Day EclipseCon Europe 2020 - [slides](https://www.eclipse.org/hawkbit/slides/community-day-2020.html)
|
2018 - [slides](https://www.eclipse.org/hawkbit/slides/community-day-2018.html)
|
||||||
|
- 10/21/2019 - Community Day EclipseCon Europe
|
||||||
|
2019 - [slides](https://www.eclipse.org/hawkbit/slides/community-day-2019.html)
|
||||||
|
- 10/19/2020 - Community Day EclipseCon Europe
|
||||||
|
2020 - [slides](https://www.eclipse.org/hawkbit/slides/community-day-2020.html)
|
||||||
|
|
||||||
## Articles
|
## Articles
|
||||||
|
|
||||||
- 10/27/2015 - Why software provisioning goes open source - [article](http://blog.bosch-si.com/categories/technology/2015/10/software-provisioning-goes-open-source-find/)
|
- 10/27/2015 - Why software provisioning goes open
|
||||||
- 05/25/2016 - jaxenter: Eclipse hawkBit - [english](https://jaxenter.com/eclipse-hawkbit-126445.html) - [german](https://jaxenter.de/eclipse-hawkbit-46372)
|
source - [article](http://blog.bosch-si.com/categories/technology/2015/10/software-provisioning-goes-open-source-find/)
|
||||||
- 09/27/2016 - Eclipse Newsletter - 'IoT is the new black' - [article](http://www.eclipse.org/community/eclipse_newsletter/2016/september/article2.php)
|
- 05/25/2016 - jaxenter: Eclipse
|
||||||
|
hawkBit - [english](https://jaxenter.com/eclipse-hawkbit-126445.html) - [german](https://jaxenter.de/eclipse-hawkbit-46372)
|
||||||
|
- 09/27/2016 - Eclipse Newsletter - 'IoT is the new
|
||||||
|
black' - [article](http://www.eclipse.org/community/eclipse_newsletter/2016/september/article2.php)
|
||||||
|
|
||||||
## Ask a question
|
## Ask a question
|
||||||
|
|
||||||
Visit [stackoverflow.com](https://stackoverflow.com/questions/tagged/eclipse-hawkbit) to find questions or raise your own tagged with `eclipse-hawkbit`.
|
Visit [stackoverflow.com](https://stackoverflow.com/questions/tagged/eclipse-hawkbit) to find questions or raise your
|
||||||
|
own tagged with `eclipse-hawkbit`.
|
||||||
|
|
||||||
## Chat
|
## Chat
|
||||||
|
|
||||||
Searching for a quick response from the team behind hawkBit and the hawkBit community, join the [Gitter Chat](https://gitter.im/eclipse/hawkbit).
|
Searching for a quick response from the team behind hawkBit and the hawkBit community, join
|
||||||
|
the [Gitter Chat](https://gitter.im/eclipse/hawkbit).
|
||||||
|
|
||||||
## Mailing List
|
## Mailing List
|
||||||
|
|
||||||
A great way to stay up to date with hawkBit activity is to subscribe to the Mailing list provided by Eclipse. Sign up for the mailing list [here](https://dev.eclipse.org/mailman/listinfo/hawkbit-dev).
|
A great way to stay up to date with hawkBit activity is to subscribe to the Mailing list provided by Eclipse. Sign up
|
||||||
|
for the mailing list [here](https://dev.eclipse.org/mailman/listinfo/hawkbit-dev).
|
||||||
|
|
||||||
## Issue Tracker
|
## Issue Tracker
|
||||||
|
|
||||||
Issues and bugs related to hawkBit are tracked with the Github Issue tracking system. If you find any issues, please report them [here](https://github.com/eclipse-hawkbit/hawkbit/issues).
|
Issues and bugs related to hawkBit are tracked with the Github Issue tracking system. If you find any issues, please
|
||||||
|
report them [here](https://github.com/eclipse-hawkbit/hawkbit/issues).
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
An overview of the contribution process is [here](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git). Checkout the [Contribution Guidelines](https://github.com/eclipse-hawkbit/hawkbit/blob/master/CONTRIBUTING.md) on the Eclipse hawkBit GitHub Repository.
|
An overview of the contribution process is [here](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git).
|
||||||
|
Checkout the [Contribution Guidelines](https://github.com/eclipse-hawkbit/hawkbit/blob/master/CONTRIBUTING.md) on the
|
||||||
|
Eclipse hawkBit GitHub Repository.
|
||||||
|
|||||||
@@ -9,17 +9,21 @@ A hawkBit update server can be accessed in four different ways:
|
|||||||
- _Direct Device Integration (DDI) API_ by **targets**.
|
- _Direct Device Integration (DDI) API_ by **targets**.
|
||||||
- _Management API_ by 3rd party **applications**.
|
- _Management API_ by 3rd party **applications**.
|
||||||
- _Device Management Federation (DMF) API_ by 3rd party **applications** through AMQP.
|
- _Device Management Federation (DMF) API_ by 3rd party **applications** through AMQP.
|
||||||
<!--more-->
|
|
||||||
|
|
||||||
|
<!--more-->
|
||||||
|
|
||||||
## DDI API Authentication Modes
|
## DDI API Authentication Modes
|
||||||
|
|
||||||
### Security Token
|
### Security Token
|
||||||
|
|
||||||
hawkBit supports multiple ways to authenticate a target against the server. The different authentication modes can be individual enabled and disabled within hawkBit. Both on system level (with Spring Boot properties) as per individual tenant.
|
hawkBit supports multiple ways to authenticate a target against the server. The different authentication modes can be
|
||||||
|
individual enabled and disabled within hawkBit. Both on system level (with Spring Boot properties) as per individual
|
||||||
|
tenant.
|
||||||
|
|
||||||
#### Target Security Token Authentication
|
#### Target Security Token Authentication
|
||||||
There is a 32 alphanumeric character security-token for each created target within IoT hawkBit. This token can be used to authenticate the target at hawkBit through the HTTP-Authorization header with the custom scheme _TargetToken_.
|
|
||||||
|
There is a 32 alphanumeric character security-token for each created target within IoT hawkBit. This token can be used
|
||||||
|
to authenticate the target at hawkBit through the HTTP-Authorization header with the custom scheme _TargetToken_.
|
||||||
|
|
||||||
```
|
```
|
||||||
GET /SPDEMO/controller/v1/0e945f95-9117-4500-9b0a-9c6d72fa6c07 HTTP/1.1
|
GET /SPDEMO/controller/v1/0e945f95-9117-4500-9b0a-9c6d72fa6c07 HTTP/1.1
|
||||||
@@ -27,18 +31,28 @@ Host: your.hawkBit.server
|
|||||||
Authorization: TargetToken bH7XXAprK1ChnLfKSdtlsp7NOlPnZAYY
|
Authorization: TargetToken bH7XXAprK1ChnLfKSdtlsp7NOlPnZAYY
|
||||||
```
|
```
|
||||||
|
|
||||||
The target security token is provided in [DMF API](../../apis/dmf_api/) as part of the update message in order to allow DMF clients to leverage the feature or can it be manually retrieved per target by [Management API](../../apis/management_api/) or in the [Management UI](../../ui) in the target details.
|
The target security token is provided in [DMF API](../../apis/dmf_api/) as part of the update message in order to allow
|
||||||
|
DMF clients to leverage the feature or can it be manually retrieved per target
|
||||||
|
by [Management API](../../apis/management_api/) or in the [Management UI](../../ui) in the target details.
|
||||||
|
|
||||||
Note: needs to be enabled in your hawkBit installation **and** in the tenant configuration. That allows both the operator as well as the individual customer (if run in a multi-tenant setup) to enable this access method. See [DdiSecurityProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java) for system wide enablement.
|
Note: needs to be enabled in your hawkBit installation **and** in the tenant configuration. That allows both the
|
||||||
|
operator as well as the individual customer (if run in a multi-tenant setup) to enable this access method.
|
||||||
|
See [DdiSecurityProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java)
|
||||||
|
for system wide enablement.
|
||||||
|
|
||||||
The additional activation for the individual tenant:
|
The additional activation for the individual tenant:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Gateway Security Token Authentication
|
#### Gateway Security Token Authentication
|
||||||
Often the targets are connected through a gateway which manages the targets directly and as a result are indirectly connected to the hawkBit update server.
|
|
||||||
|
|
||||||
To authenticate this gateway and allow it to manage all target instances under its tenant there is a _GatewayToken_ to authenticate this gateway through the HTTP-Authorization header with a custom scheme _GatewayToken_. This is of course also handy during development or for testing purposes. However, we generally recommend to use this token with care as it allows to act _in the name of_ any device.
|
Often the targets are connected through a gateway which manages the targets directly and as a result are indirectly
|
||||||
|
connected to the hawkBit update server.
|
||||||
|
|
||||||
|
To authenticate this gateway and allow it to manage all target instances under its tenant there is a _GatewayToken_ to
|
||||||
|
authenticate this gateway through the HTTP-Authorization header with a custom scheme _GatewayToken_. This is of course
|
||||||
|
also handy during development or for testing purposes. However, we generally recommend to use this token with care as it
|
||||||
|
allows to act _in the name of_ any device.
|
||||||
|
|
||||||
```
|
```
|
||||||
GET /SPDEMO/controller/v1/0e945f95-9117-4500-9b0a-9c6d72fa6c07 HTTP/1.1
|
GET /SPDEMO/controller/v1/0e945f95-9117-4500-9b0a-9c6d72fa6c07 HTTP/1.1
|
||||||
@@ -46,16 +60,24 @@ Host: your.hawkBit.server
|
|||||||
Authorization: GatewayToken 3nkswAZhX81oDtktq0FF9Pn0Tc0UGXPW
|
Authorization: GatewayToken 3nkswAZhX81oDtktq0FF9Pn0Tc0UGXPW
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: needs to be enabled in your hawkBit installation **and** in the tenant configuration. That allows both the operator as well as the individual customer (if run in a multi-tenant setup) to enable this access method. See [DdiSecurityProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java) for system wide enablement.
|
Note: needs to be enabled in your hawkBit installation **and** in the tenant configuration. That allows both the
|
||||||
|
operator as well as the individual customer (if run in a multi-tenant setup) to enable this access method.
|
||||||
|
See [DdiSecurityProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java)
|
||||||
|
for system wide enablement.
|
||||||
|
|
||||||
The additional activation for the individual tenant:
|
The additional activation for the individual tenant:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Anonymous access
|
#### Anonymous access
|
||||||
Here we offer general anonymous access for all targets (see [DdiSecurityProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java)) which we consider not really sufficient for a production system but it might come in handy to get a project started in the beginning.
|
|
||||||
|
|
||||||
However, anonymous download on the other side might be interesting even in production for scenarios where the artifact itself is already encrypted.
|
Here we offer general anonymous access for all targets (
|
||||||
|
see [DdiSecurityProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/security/DdiSecurityProperties.java))
|
||||||
|
which we consider not really sufficient for a production system but it might come in handy to get a project started in
|
||||||
|
the beginning.
|
||||||
|
|
||||||
|
However, anonymous download on the other side might be interesting even in production for scenarios where the artifact
|
||||||
|
itself is already encrypted.
|
||||||
|
|
||||||
The activation for the individual tenant:
|
The activation for the individual tenant:
|
||||||
|
|
||||||
@@ -63,15 +85,24 @@ The activation for the individual tenant:
|
|||||||
|
|
||||||
### Certificate Authentication by Reverse Proxy
|
### Certificate Authentication by Reverse Proxy
|
||||||
|
|
||||||
hawkBit offers a certificate-based authentication mechanism, also known as mutual TLS (mTLS), which eliminates the need to share a security token with the server. To implement this, you'll require a reverse proxy deployed in front of the hawkBit server to handle authentication. This process involves obtaining certificates (and keys) for both the client and the reverse proxy and configuring hawkBit accordingly.
|
hawkBit offers a certificate-based authentication mechanism, also known as mutual TLS (mTLS), which eliminates the need
|
||||||
|
to share a security token with the server. To implement this, you'll require a reverse proxy deployed in front of the
|
||||||
|
hawkBit server to handle authentication. This process involves obtaining certificates (and keys) for both the client and
|
||||||
|
the reverse proxy and configuring hawkBit accordingly.
|
||||||
|
|
||||||
Initially, you'll need to obtain certificates (and keys) for these components from the same or different Certificate Authorities (CAs). Once you have acquired certificates you have to set them up to both the client and the hawkBit server.
|
Initially, you'll need to obtain certificates (and keys) for these components from the same or different Certificate
|
||||||
|
Authorities (CAs). Once you have acquired certificates you have to set them up to both the client and the hawkBit
|
||||||
|
server.
|
||||||
|
|
||||||
Then you shall enable *Allow targets to authenticate via a certificate authenticated by a reverse proxy* and set the fingerprint of the client certificate issuer(s) (as a comma separated list).
|
Then you shall enable *Allow targets to authenticate via a certificate authenticated by a reverse proxy* and set the
|
||||||
|
fingerprint of the client certificate issuer(s) (as a comma separated list).
|
||||||
|
|
||||||
To authenticate the request to hawBit the following condition shall be met:
|
To authenticate the request to hawBit the following condition shall be met:
|
||||||
|
|
||||||
- the common name of the client certificate shall match the controller/client id
|
- the common name of the client certificate shall match the controller/client id
|
||||||
- the SSL Issuer(s) hash of the presented client certificate shall be set for the tenant. For that, in Hawkbit's UI section, under system configuration, you shall enable 'Allow targets to authenticate via a certificate by an reverse proxy' and set the hash of the client certificate issuer(s) (as a comma separated list).
|
- the SSL Issuer(s) hash of the presented client certificate shall be set for the tenant. For that, in Hawkbit's UI
|
||||||
|
section, under system configuration, you shall enable 'Allow targets to authenticate via a certificate by an reverse
|
||||||
|
proxy' and set the hash of the client certificate issuer(s) (as a comma separated list).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -81,7 +112,8 @@ You can use the following command to get the issuer hash:
|
|||||||
openssl x509 -in client_certificate.crt -issuer_hash -noout`
|
openssl x509 -in client_certificate.crt -issuer_hash -noout`
|
||||||
```
|
```
|
||||||
|
|
||||||
Here is an example diagram that shows all the communication between the hawkBit, reverse proxy and client. For the sake of simplification we assume that there are not intermediate certificates and the certificate and key are as follows:
|
Here is an example diagram that shows all the communication between the hawkBit, reverse proxy and client. For the sake
|
||||||
|
of simplification we assume that there are not intermediate certificates and the certificate and key are as follows:
|
||||||
|
|
||||||
- client_ca.crt signs client.crt
|
- client_ca.crt signs client.crt
|
||||||
- server_ca.crt signs server.crt
|
- server_ca.crt signs server.crt
|
||||||
@@ -93,25 +125,37 @@ Here is an example diagram that shows all the communication between the hawkBit,
|
|||||||
|
|
||||||
#### Example - Nginx Reverse Proxy Configurations
|
#### Example - Nginx Reverse Proxy Configurations
|
||||||
|
|
||||||
Nginx doesn't support obtaining the issuer hash without addons. Therefore, in this example we bypass sending real SSL Issuer hash to hawhBit but do certificate issuer validation at Nginx and then supply shared (between Nginx and hawkBit) fixed hash "Hawkbit". You could use any value here as long as it is matched with the *Allow targets to authenticate via a certificate authenticated by a reverse proxy* setting in the hawkBit UI. Note that for multi-tenant scenarios with different trusted CAs this example won't work.
|
Nginx doesn't support obtaining the issuer hash without addons. Therefore, in this example we bypass sending real SSL
|
||||||
|
Issuer hash to hawhBit but do certificate issuer validation at Nginx and then supply shared (between Nginx and hawkBit)
|
||||||
|
fixed hash "Hawkbit". You could use any value here as long as it is matched with the *Allow targets to authenticate via
|
||||||
|
a certificate authenticated by a reverse proxy* setting in the hawkBit UI. Note that for multi-tenant scenarios with
|
||||||
|
different trusted CAs this example won't work.
|
||||||
|
|
||||||
1. Hawkbit Configurations
|
1. Hawkbit Configurations
|
||||||
|
|
||||||
There are also some configurations that you need update when you deployed your hawkbit service.
|
There are also some configurations that you need update when you deployed your hawkbit service.
|
||||||
|
|
||||||
You need to add the given setting to your hawkBit configurations so that hawkBit can generate the URLs according to the https that the client will use to download. If you're deploying hawkBit as a Docker container, add these configurations as environmental values in the docker-compose.yml file.
|
You need to add the given setting to your hawkBit configurations so that hawkBit can generate the URLs according to
|
||||||
|
the https that the client will use to download. If you're deploying hawkBit as a Docker container, add these
|
||||||
|
configurations as environmental values in the docker-compose.yml file.
|
||||||
|
|
||||||
```
|
```
|
||||||
server.forward-headers-strategy=NATIVE
|
server.forward-headers-strategy=NATIVE
|
||||||
```
|
```
|
||||||
|
|
||||||
2. In Hawkbit's UI section, under system configuration, make sure to select *Allow targets to authenticate via a certificate authenticated by a reverse proxy* and input the fixed issuer hash as "Hawkbit". This can be whetever you have configured in the nginx configuration in `proxy_set_header X-Ssl-Issuer-Hash-1` below.
|
2. In Hawkbit's UI section, under system configuration, make sure to select *Allow targets to authenticate via a
|
||||||
|
certificate authenticated by a reverse proxy* and input the fixed issuer hash as "Hawkbit". This can be whetever you
|
||||||
|
have configured in the nginx configuration in `proxy_set_header X-Ssl-Issuer-Hash-1` below.
|
||||||
|
|
||||||
3. After placing your certificates and keys, you need to deploy your proxy server and apply the provided configurations. You can apply mutual TLS specifically to the URL given below to implement the process only for devices using the Device Integration API:
|
3. After placing your certificates and keys, you need to deploy your proxy server and apply the provided configurations.
|
||||||
|
You can apply mutual TLS specifically to the URL given below to implement the process only for devices using the
|
||||||
|
Device Integration API:
|
||||||
|
|
||||||
`hawkbit.dev.example.com/default/controller/`
|
`hawkbit.dev.example.com/default/controller/`
|
||||||
|
|
||||||
This ensures that other clients, like UI users, can connect to hawkBit without requiring client certificates. They can use Username and Password in the Management API, eliminating the need for authentication and making it more user-friendly.
|
This ensures that other clients, like UI users, can connect to hawkBit without requiring client certificates. They
|
||||||
|
can use Username and Password in the Management API, eliminating the need for authentication and making it more
|
||||||
|
user-friendly.
|
||||||
|
|
||||||
```nginx
|
```nginx
|
||||||
# Nginx Hawkbit Configurations
|
# Nginx Hawkbit Configurations
|
||||||
@@ -185,7 +229,7 @@ server {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
4. To deploy Nginx, you could use a `.yml` file. Here's an example `docker-compose.yml` file for Nginx Docker.
|
4. To deploy Nginx, you could use a `.yml` file. Here's an example `docker-compose.yml` file for Nginx Docker.
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
@@ -210,14 +254,21 @@ services:
|
|||||||
- ./certbot/www/:/var/www/certbot/:rw
|
- ./certbot/www/:/var/www/certbot/:rw
|
||||||
- ./certbot/conf/:/etc/letsencrypt/:rw
|
- ./certbot/conf/:/etc/letsencrypt/:rw
|
||||||
```
|
```
|
||||||
`/client-cer/:/etc/nginx/client-cer/` is the designated location for the certificate authority that has signed the client certificate. The presented client certificate will be verified against this CA.
|
|
||||||
|
|
||||||
5. After successfully generating your certificates with the correct chain, deploying your Nginx and Hawkbit services with appropriate configurations, and updating the settings on the device side, you will be able to establish a certificate-based authentication mechanism. This will eliminate the necessity of sharing a security token with the server.
|
`/client-cer/:/etc/nginx/client-cer/` is the designated location for the certificate authority that has signed the
|
||||||
|
client certificate. The presented client certificate will be verified against this CA.
|
||||||
|
|
||||||
|
5. After successfully generating your certificates with the correct chain, deploying your Nginx and Hawkbit services
|
||||||
|
with appropriate configurations, and updating the settings on the device side, you will be able to establish a
|
||||||
|
certificate-based authentication mechanism. This will eliminate the necessity of sharing a security token with the
|
||||||
|
server.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Swupdate Suricatta Configurations
|
##### Swupdate Suricatta Configurations
|
||||||
|
|
||||||
If the client is utilizing the SWUpdate Suricatta service, the configurations on the device or client side should also be adjusted as follows. Remember to change id, url and certificate names to your needs.
|
If the client is utilizing the SWUpdate Suricatta service, the configurations on the device or client side should also
|
||||||
|
be adjusted as follows. Remember to change id, url and certificate names to your needs.
|
||||||
|
|
||||||
The location of the config file is `/etc/swupdate/swupdate.conf`
|
The location of the config file is `/etc/swupdate/swupdate.conf`
|
||||||
|
|
||||||
@@ -241,6 +292,7 @@ journalctl --follow -u swupdate
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### Testing
|
##### Testing
|
||||||
|
|
||||||
You can test the communication by using the Curl command below to see if you successfully implemented mutual TLS:
|
You can test the communication by using the Curl command below to see if you successfully implemented mutual TLS:
|
||||||
@@ -249,14 +301,18 @@ You can test the communication by using the Curl command below to see if you suc
|
|||||||
curl -L -v --cert client.crt --key client.key --cacert server_ca.crt https://hawkbit.dev.example.com/default/controller/v1/{device-id}
|
curl -L -v --cert client.crt --key client.key --cacert server_ca.crt https://hawkbit.dev.example.com/default/controller/v1/{device-id}
|
||||||
```
|
```
|
||||||
|
|
||||||
In the UI, after uploading an SWU package and requesting a firmware update, you can use the link below to attempt to install the software package.
|
In the UI, after uploading an SWU package and requesting a firmware update, you can use the link below to attempt to
|
||||||
|
install the software package.
|
||||||
|
|
||||||
```
|
```
|
||||||
curl -L -v --cert client.crt --key client.key --cacert server_ca.crt https://hawkbit.dev.example.com/default/controller/v1/{device-id}/softwaremodules/{artifact-id}/artifacts/hawkbit_updated_5.swu --output outputfile
|
curl -L -v --cert client.crt --key client.key --cacert server_ca.crt https://hawkbit.dev.example.com/default/controller/v1/{device-id}/softwaremodules/{artifact-id}/artifacts/hawkbit_updated_5.swu --output outputfile
|
||||||
```
|
```
|
||||||
|
|
||||||
## DMF API
|
## DMF API
|
||||||
Authentication is provided by _RabbitMQ_ [vhost and user credentials](https://www.rabbitmq.com/access-control.html) that is used for the integration.
|
|
||||||
|
Authentication is provided by _RabbitMQ_ [vhost and user credentials](https://www.rabbitmq.com/access-control.html) that
|
||||||
|
is used for the integration.
|
||||||
|
|
||||||
## Management API
|
## Management API
|
||||||
|
|
||||||
- Basic Auth
|
- Basic Auth
|
||||||
|
|||||||
@@ -4,12 +4,22 @@ parent: Concepts
|
|||||||
weight: 52
|
weight: 52
|
||||||
---
|
---
|
||||||
|
|
||||||
Authorization is handled separately for _Direct Device Integration (DDI) API_ and _Device Management Federation (DMF) API_ (where successful authentication includes full authorization) and _Management API_ and _UI_ which is based on Spring security [authorities](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/im/authentication/SpPermission.java).
|
Authorization is handled separately for _Direct Device Integration (DDI) API_ and _Device Management Federation (DMF)
|
||||||
|
API_ (where successful authentication includes full authorization) and _Management API_ and _UI_ which is based on
|
||||||
|
Spring
|
||||||
|
security [authorities](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-security-core/src/main/java/org/eclipse/hawkbit/im/authentication/SpPermission.java).
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
However, keep in mind that hawkBit does not offer an off the shelf authentication provider to leverage these permissions and the underlying multi user/tenant capabilities of hawkBit but it supports authentication providers offering an OpenID Connect interface. Check out [Spring security documentation](http://projects.spring.io/spring-security/) for further information. In hawkBit [SecurityAutoConfiguration](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/security/SecurityAutoConfiguration.java) is a good starting point for integration.
|
However, keep in mind that hawkBit does not offer an off the shelf authentication provider to leverage these permissions
|
||||||
|
and the underlying multi user/tenant capabilities of hawkBit but it supports authentication providers offering an OpenID
|
||||||
|
Connect interface. Check out [Spring security documentation](http://projects.spring.io/spring-security/) for further
|
||||||
|
information. In
|
||||||
|
hawkBit [SecurityAutoConfiguration](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/security/SecurityAutoConfiguration.java)
|
||||||
|
is a good starting point for integration.
|
||||||
|
|
||||||
The default implementation is single user/tenant with basic auth and the logged in user is provided with all permissions. Additionally, the application properties may be configured for multiple static users; see [Multiple Users](#multiple-users) for details.
|
The default implementation is single user/tenant with basic auth and the logged in user is provided with all
|
||||||
|
permissions. Additionally, the application properties may be configured for multiple static users;
|
||||||
|
see [Multiple Users](#multiple-users) for details.
|
||||||
|
|
||||||
## DDI API
|
## DDI API
|
||||||
|
|
||||||
@@ -19,13 +29,16 @@ An authenticated target is permitted to:
|
|||||||
- provide feedback to the the server
|
- provide feedback to the the server
|
||||||
- download artifacts that are assigned to it
|
- download artifacts that are assigned to it
|
||||||
|
|
||||||
A target might be permitted to download artifacts without authentication (if enabled, see above). Only the download can be permitted to disable the authentication. This can be used in scenarios where the artifacts itself are e.g. signed and secured.
|
A target might be permitted to download artifacts without authentication (if enabled, see above). Only the download can
|
||||||
|
be permitted to disable the authentication. This can be used in scenarios where the artifacts itself are e.g. signed and
|
||||||
|
secured.
|
||||||
|
|
||||||
## Management API and UI
|
## Management API and UI
|
||||||
|
|
||||||
### Multiple Users
|
### Multiple Users
|
||||||
|
|
||||||
hawkBit optionally supports configuring multiple static users through the application properties. In this case, the user and password Spring security properties are ignored.
|
hawkBit optionally supports configuring multiple static users through the application properties. In this case, the user
|
||||||
|
and password Spring security properties are ignored.
|
||||||
An example configuration is given below.
|
An example configuration is given below.
|
||||||
|
|
||||||
hawkbit.server.im.users[0].username=admin
|
hawkbit.server.im.users[0].username=admin
|
||||||
@@ -42,46 +55,54 @@ An example configuration is given below.
|
|||||||
hawkbit.server.im.users[1].email=test@tester.com
|
hawkbit.server.im.users[1].email=test@tester.com
|
||||||
hawkbit.server.im.users[1].permissions=READ_TARGET,UPDATE_TARGET,CREATE_TARGET,DELETE_TARGET
|
hawkbit.server.im.users[1].permissions=READ_TARGET,UPDATE_TARGET,CREATE_TARGET,DELETE_TARGET
|
||||||
|
|
||||||
A permissions value of `ALL` will provide that user with all possible permissions. Passwords need to be specified with the used password encoder in brackets. In this example, `noop` is used as the plaintext encoder. For production use, it is recommended to use a hash function designed for passwords such as *bcrypt*. See this [blog post](https://spring.io/blog/2017/11/01/spring-security-5-0-0-rc1-released#password-storage-format) for more information on password encoders in Spring Security.
|
A permissions value of `ALL` will provide that user with all possible permissions. Passwords need to be specified with
|
||||||
|
the used password encoder in brackets. In this example, `noop` is used as the plaintext encoder. For production use, it
|
||||||
|
is recommended to use a hash function designed for passwords such as *bcrypt*. See
|
||||||
|
this [blog post](https://spring.io/blog/2017/11/01/spring-security-5-0-0-rc1-released#password-storage-format) for more
|
||||||
|
information on password encoders in Spring Security.
|
||||||
|
|
||||||
### OpenID Connect
|
### OpenID Connect
|
||||||
|
|
||||||
hawkbit supports authentication providers which use the OpenID Connect standard, an authentication layer built on top of the OAuth 2.0 protocol.
|
hawkbit supports authentication providers which use the OpenID Connect standard, an authentication layer built on top of
|
||||||
|
the OAuth 2.0 protocol.
|
||||||
An example configuration is given below.
|
An example configuration is given below.
|
||||||
|
|
||||||
spring.security.oauth2.client.registration.oidc.client-id=clientID
|
spring.security.oauth2.client.registration.oidc.client-id=clientID
|
||||||
spring.security.oauth2.client.provider.oidc.issuer-uri=https://oidc-provider/issuer-uri
|
spring.security.oauth2.client.provider.oidc.issuer-uri=https://oidc-provider/issuer-uri
|
||||||
spring.security.oauth2.client.provider.oidc.jwk-set-uri=https://oidc-provider/jwk-set-uri
|
spring.security.oauth2.client.provider.oidc.jwk-set-uri=https://oidc-provider/jwk-set-uri
|
||||||
|
|
||||||
Note: at the moment only DEFAULT tenant is supported. By default the resource_access/<client id>/roles claim is mapped to hawkBit permissions. However, by registering a Spring bean _org.eclipse.hawkbit.autoconfigure.security.OidcUserManagementAutoConfiguration.JwtAuthoritiesExtractor_ a custom extractor permission mapper could be registered.
|
Note: at the moment only DEFAULT tenant is supported. By default the resource_access/<client id>/roles claim is mapped
|
||||||
|
to hawkBit permissions. However, by registering a Spring bean
|
||||||
|
_org.eclipse.hawkbit.autoconfigure.security.OidcUserManagementAutoConfiguration.JwtAuthoritiesExtractor_ a custom
|
||||||
|
extractor permission mapper could be registered.
|
||||||
|
|
||||||
### Delivered Permissions
|
### Delivered Permissions
|
||||||
|
|
||||||
- READ_/UPDATE_/CREATE_/DELETE_TARGET for:
|
- READ_/UPDATE_/CREATE_/DELETE_TARGET for:
|
||||||
- Target entities including metadata (that includes also the installed and assigned distribution sets)
|
- Target entities including metadata (that includes also the installed and assigned distribution sets)
|
||||||
- Target tags
|
- Target tags
|
||||||
- Target actions
|
- Target actions
|
||||||
- Target registration rules
|
- Target registration rules
|
||||||
- Bulk operations
|
- Bulk operations
|
||||||
- Target filters
|
- Target filters
|
||||||
|
|
||||||
- READ_/UPDATE_/CREATE_/DELETE_REPOSITORY for:
|
- READ_/UPDATE_/CREATE_/DELETE_REPOSITORY for:
|
||||||
- Distribution sets
|
- Distribution sets
|
||||||
- Software Modules
|
- Software Modules
|
||||||
- Artifacts
|
- Artifacts
|
||||||
- DS tags
|
- DS tags
|
||||||
|
|
||||||
- READ_TARGET_SECURITY_TOKEN
|
- READ_TARGET_SECURITY_TOKEN
|
||||||
- Permission to read the target security token. The security token is security concerned and should be protected.
|
- Permission to read the target security token. The security token is security concerned and should be protected.
|
||||||
|
|
||||||
- DOWNLOAD_REPOSITORY_ARTIFACT
|
- DOWNLOAD_REPOSITORY_ARTIFACT
|
||||||
- Permission to download artifacts of a software module (Note: READ_REPOSITORY allows only to read the metadata).
|
- Permission to download artifacts of a software module (Note: READ_REPOSITORY allows only to read the metadata).
|
||||||
|
|
||||||
- TENANT_CONFIGURATION
|
- TENANT_CONFIGURATION
|
||||||
- Permission to administrate the tenant settings.
|
- Permission to administrate the tenant settings.
|
||||||
|
|
||||||
- READ_/UPDATE_/CREATE_/DELETE_/HANDLE_/APPROVE_ROLLOUT for:
|
- READ_/UPDATE_/CREATE_/DELETE_/HANDLE_/APPROVE_ROLLOUT for:
|
||||||
- Managing rollouts and provision targets through a rollout.
|
- Managing rollouts and provision targets through a rollout.
|
||||||
|
|
||||||
### Permission Matrix for example uses cases that need more than one permission
|
### Permission Matrix for example uses cases that need more than one permission
|
||||||
|
|
||||||
@@ -95,4 +116,6 @@ Note: at the moment only DEFAULT tenant is supported. By default the resource_ac
|
|||||||
|
|
||||||
## Device Management Federation API
|
## Device Management Federation API
|
||||||
|
|
||||||
The provided _RabbitMQ_ [vhost and user](https://www.rabbitmq.com/access-control.html) should be provided with the necessary permissions to send messages to hawkBit through the exchange and receive messages from it through the specified queue.
|
The provided _RabbitMQ_ [vhost and user](https://www.rabbitmq.com/access-control.html) should be provided with the
|
||||||
|
necessary permissions to send messages to hawkBit through the exchange and receive messages from it through the
|
||||||
|
specified queue.
|
||||||
|
|||||||
@@ -4,18 +4,30 @@ parent: Concepts
|
|||||||
weight: 53
|
weight: 53
|
||||||
---
|
---
|
||||||
|
|
||||||
The hawkBit data model was designed to have enough flexibility to define complex software structures (e.g. operating system, runtimes, apps, different kind of artifacts) on one side and simplicity compared to the capabilities of a full blown configuration management on the other.
|
The hawkBit data model was designed to have enough flexibility to define complex software structures (e.g. operating
|
||||||
|
system, runtimes, apps, different kind of artifacts) on one side and simplicity compared to the capabilities of a full
|
||||||
|
blown configuration management on the other.
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
It does define a hierarchy of software that starts with a distribution, which can have (sub-)modules and these may have multiple artifacts. However, it does not consider any kind of dependency definitions between modules or artifacts. As a result, dependency checks - if necessary - have to be done outside hawkBit, i.e. on the device itself or before the entity creation in hawkBit by the origin.
|
It does define a hierarchy of software that starts with a distribution, which can have (sub-)modules and these may have
|
||||||
|
multiple artifacts. However, it does not consider any kind of dependency definitions between modules or artifacts. As a
|
||||||
|
result, dependency checks - if necessary - have to be done outside hawkBit, i.e. on the device itself or before the
|
||||||
|
entity creation in hawkBit by the origin.
|
||||||
|
|
||||||
## Provisioning Target Definition
|
## Provisioning Target Definition
|
||||||
|
|
||||||
A Provisioning Target is a neutral definition that may be an actual real device (e.g. gateway, embedded sensor) or a virtual device (e.g. vehicle, smart home).
|
A Provisioning Target is a neutral definition that may be an actual real device (e.g. gateway, embedded sensor) or a
|
||||||
|
virtual device (e.g. vehicle, smart home).
|
||||||
|
|
||||||
The definition in hawkBit might reflect the transactional behavior if necessary on the device side. A vehicle might be updated device by device or as a whole. As a result one way of defining a vehicle in hawkBit could be to have one all inclusive Software Module or one module per (sub-) device.
|
The definition in hawkBit might reflect the transactional behavior if necessary on the device side. A vehicle might be
|
||||||
|
updated device by device or as a whole. As a result one way of defining a vehicle in hawkBit could be to have one all
|
||||||
|
inclusive Software Module or one module per (sub-) device.
|
||||||
|
|
||||||
A Target can have, next to its defined properties (e.g. controller ID, target type, name, description, security token), a generic set of attributes and meta data, both in key:value format. Target attributes are owned and managed by the device whereas target meta data are managed by the operator. If a target is defined to be of a certain target type, then during the assignment of a distribution set, a compatibility check will be performed between the target type and distribution set type.
|
A Target can have, next to its defined properties (e.g. controller ID, target type, name, description, security token),
|
||||||
|
a generic set of attributes and meta data, both in key:value format. Target attributes are owned and managed by the
|
||||||
|
device whereas target meta data are managed by the operator. If a target is defined to be of a certain target type, then
|
||||||
|
during the assignment of a distribution set, a compatibility check will be performed between the target type and
|
||||||
|
distribution set type.
|
||||||
|
|
||||||
## Software Structure Definition
|
## Software Structure Definition
|
||||||
|
|
||||||
@@ -23,28 +35,38 @@ The structure defines the model of the supported software by the provisioning ta
|
|||||||
|
|
||||||
- Distribution Set Type:defines a package structure that is supported by certain devices
|
- Distribution Set Type:defines a package structure that is supported by certain devices
|
||||||
- Consists of Software Module Types both for
|
- Consists of Software Module Types both for
|
||||||
- Firmware - device can have only one module of that type (e.g. the operating system)
|
- Firmware - device can have only one module of that type (e.g. the operating system)
|
||||||
- Software - device can have multiple modules of that type (e.g. "Apps")
|
- Software - device can have multiple modules of that type (e.g. "Apps")
|
||||||
|
|
||||||
Software Content Definition:
|
Software Content Definition:
|
||||||
|
|
||||||
- Distribution Set: can be deployed to a provisioning target
|
- Distribution Set: can be deployed to a provisioning target
|
||||||
- Software Module: is a sub element of the distribution, e.g. OS, application, firmware X, firmware Y
|
- Software Module: is a sub element of the distribution, e.g. OS, application, firmware X, firmware Y
|
||||||
- Artifact: binaries for a software module. Note: the decision which artifacts have to be downloaded are done on the device side, e.g. Full package, signatures, binary deltas
|
- Artifact: binaries for a software module. Note: the decision which artifacts have to be downloaded are done on the
|
||||||
|
device side, e.g. Full package, signatures, binary deltas
|
||||||
|
|
||||||
## Entity Relationships
|
## Entity Relationships
|
||||||
|
|
||||||
The public defined entities and their relation which are reflected by the Management API.
|
The public defined entities and their relation which are reflected by the Management API.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Deleting and Archiving Software Modules
|
## Deleting and Archiving Software Modules
|
||||||
When a user deletes a Software Module, the update server cannot simply remove all the corresponding data. Because when the Software Module is already assigned to a Distribution Set or was assigned to a Target in the past, the hawkBit server has to make sure that remains a clean and full update history for every target. The history contains all information (e.g. name, version) of the software, which was assigned to a specific Target. Obviously storing the binary data of the artifacts is not necessary for the history purpose.
|
|
||||||
|
|
||||||
The delete process which is performed, when there are historical connections to targets is called SoftDelete. This process marks the Software Module as deleted and removes the artifact, but it won't delete the meta data, which describes the SoftwareModule and the associated Artifacts. SoftwareModules, which are marked as delete won't be visible for the user, when he is requesting all SoftwareModules.
|
When a user deletes a Software Module, the update server cannot simply remove all the corresponding data. Because when
|
||||||
|
the Software Module is already assigned to a Distribution Set or was assigned to a Target in the past, the hawkBit
|
||||||
|
server has to make sure that remains a clean and full update history for every target. The history contains all
|
||||||
|
information (e.g. name, version) of the software, which was assigned to a specific Target. Obviously storing the binary
|
||||||
|
data of the artifacts is not necessary for the history purpose.
|
||||||
|
|
||||||
Just in case there are no connections to Distribution Sets and targets the server will perform a HardDelete. This process deletes all stored data, including all meta information.
|
The delete process which is performed, when there are historical connections to targets is called SoftDelete. This
|
||||||
|
process marks the Software Module as deleted and removes the artifact, but it won't delete the meta data, which
|
||||||
|
describes the SoftwareModule and the associated Artifacts. SoftwareModules, which are marked as delete won't be visible
|
||||||
|
for the user, when he is requesting all SoftwareModules.
|
||||||
|
|
||||||
|
Just in case there are no connections to Distribution Sets and targets the server will perform a HardDelete. This
|
||||||
|
process deletes all stored data, including all meta information.
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
In case of a SoftDelete the unique constraints are still in place, i.e. you cannot create an entity with the same name/key. This constraint might be removed in future versions because of the impact on the user experience (i.e. he does not see the soft deleted module but cannot create a new one).
|
In case of a SoftDelete the unique constraints are still in place, i.e. you cannot create an entity with the same
|
||||||
|
name/key. This constraint might be removed in future versions because of the impact on the user experience (i.e. he does
|
||||||
|
not see the soft deleted module but cannot create a new one).
|
||||||
{{% /note %}}
|
{{% /note %}}
|
||||||
@@ -12,9 +12,9 @@ That includes:
|
|||||||
- _Technical Scalability_ by means of horizontal scale of the hawkBit server cluster in the cloud.
|
- _Technical Scalability_ by means of horizontal scale of the hawkBit server cluster in the cloud.
|
||||||
- _Global_ artifact _content delivery_ capacities.
|
- _Global_ artifact _content delivery_ capacities.
|
||||||
- _Functional Scalability_ by means of:
|
- _Functional Scalability_ by means of:
|
||||||
- Secure handling of large volumes of devices at rollout creation time.
|
- Secure handling of large volumes of devices at rollout creation time.
|
||||||
- Monitoring of the rollout progress.
|
- Monitoring of the rollout progress.
|
||||||
- Emergency rollout shutdown in case of problems on to many devices.
|
- Emergency rollout shutdown in case of problems on to many devices.
|
||||||
|
|
||||||
- Reporting capabilities for a complete understanding of the rollout progress at each point in time.
|
- Reporting capabilities for a complete understanding of the rollout progress at each point in time.
|
||||||
|
|
||||||
@@ -23,44 +23,58 @@ Eclipse hawkBit sees these capabilities under the term Rollout Management.
|
|||||||
The following capabilities are currently supported by the _Rollout Management_:
|
The following capabilities are currently supported by the _Rollout Management_:
|
||||||
|
|
||||||
- Create, update and start of rollouts.
|
- Create, update and start of rollouts.
|
||||||
- Selection of targets as input for the rollout based on _target filter_ functionality.
|
- Selection of targets as input for the rollout based on _target filter_ functionality.
|
||||||
- Selection of a _DistributionSet_.
|
- Selection of a _DistributionSet_.
|
||||||
- Auto-splitting of the input target list into a defined number deployment groups.
|
- Auto-splitting of the input target list into a defined number deployment groups.
|
||||||
- Approval workflow
|
- Approval workflow
|
||||||
- Has to be enabled explicitly in configuration.
|
- Has to be enabled explicitly in configuration.
|
||||||
- Enables a workflow that requires a user with adequate permissions to review any new or updated rollout before it
|
- Enables a workflow that requires a user with adequate permissions to review any new or updated rollout before it
|
||||||
can be started.
|
can be started.
|
||||||
- Allows integration with 3rd party workflow engines.
|
- Allows integration with 3rd party workflow engines.
|
||||||
|
|
||||||
- Cascading start of the deployment groups based on installation status of the previous group.
|
- Cascading start of the deployment groups based on installation status of the previous group.
|
||||||
- Emergency shutdown of the rollout in case a group exceeds the defined error threshold.
|
- Emergency shutdown of the rollout in case a group exceeds the defined error threshold.
|
||||||
- Rollout progress monitoring for the entire rollout and the individual groups.
|
- Rollout progress monitoring for the entire rollout and the individual groups.
|
||||||
|
|
||||||
|
|
||||||
## Cascading Deployment Group Execution
|
## Cascading Deployment Group Execution
|
||||||
|
|
||||||
The cascading execution of the deployment groups is based on two thresholds that can be defined by the rollout creator.
|
The cascading execution of the deployment groups is based on two thresholds that can be defined by the rollout creator.
|
||||||
|
|
||||||
- success condition by means of percentage of successfully installed targets in the current groups triggers.
|
- success condition by means of percentage of successfully installed targets in the current groups triggers.
|
||||||
- error condition by means of absolute or percentage of failed installations which triggers an emergency shutdown of the entire rollout.
|
- error condition by means of absolute or percentage of failed installations which triggers an emergency shutdown of the
|
||||||
|
entire rollout.
|
||||||
|
|
||||||
## Rollout state machine
|
## Rollout state machine
|
||||||
|
|
||||||
### State Machine on Rollout
|
### State Machine on Rollout
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### State Machine on Rollout Deployment Group
|
### State Machine on Rollout Deployment Group
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Multi-Assignments (beta)
|
## Multi-Assignments (beta)
|
||||||
|
|
||||||
One of the main paradigms of Eclipse hawkBit is, that a Distribution Set represents the currently installed software of a device. Hence, a device can have only one Distribution Set assigned/installed at a time. With _Multi-Assignments_ enabled, this paradigm shifts. Multi-Assignments allows to assign multiple Distribution Sets to a device simultaneously, without cancelling each other. As a consequence, an operator can trigger multiple campaigns addressing the same devices in parallel.
|
One of the main paradigms of Eclipse hawkBit is, that a Distribution Set represents the currently installed software of
|
||||||
|
a device. Hence, a device can have only one Distribution Set assigned/installed at a time. With _Multi-Assignments_
|
||||||
|
enabled, this paradigm shifts. Multi-Assignments allows to assign multiple Distribution Sets to a device simultaneously,
|
||||||
|
without cancelling each other. As a consequence, an operator can trigger multiple campaigns addressing the same devices
|
||||||
|
in parallel.
|
||||||
|
|
||||||
### Action weight
|
### Action weight
|
||||||
|
|
||||||
To differentiate between important and less important updates a property called _weight_ is used. When multi-assignments is enabled every action has a weight value between (and including) 0 and 1000. The higher the weight the more important is the assignment represented by the action. Also when defining a _rollout_ or an _auto-assignment_ and multi-assignments is enabled a weight value has to be provided. This value is passed to the actions created during the execution of these _rollouts_ and _auto-assignments_. If no weight was provided the highest value of 1000 is used instead.
|
To differentiate between important and less important updates a property called _weight_ is used. When multi-assignments
|
||||||
|
is enabled every action has a weight value between (and including) 0 and 1000. The higher the weight the more important
|
||||||
|
is the assignment represented by the action. Also when defining a _rollout_ or an _auto-assignment_ and
|
||||||
|
multi-assignments is enabled a weight value has to be provided. This value is passed to the actions created during the
|
||||||
|
execution of these _rollouts_ and _auto-assignments_. If no weight was provided the highest value of 1000 is used
|
||||||
|
instead.
|
||||||
|
|
||||||
### Consequences
|
### Consequences
|
||||||
|
|
||||||
While this feature provides more flexibility to the user and enables new use-cases, there are also some consequences one should be aware of:
|
While this feature provides more flexibility to the user and enables new use-cases, there are also some consequences one
|
||||||
|
should be aware of:
|
||||||
|
|
||||||
**Critical**
|
**Critical**
|
||||||
|
|
||||||
@@ -69,9 +83,12 @@ While this feature provides more flexibility to the user and enables new use-cas
|
|||||||
|
|
||||||
**Minor**
|
**Minor**
|
||||||
|
|
||||||
* While on DMF-API a MULTI_ACTION request is sent, DDI-API only exposes the next action which has the highest priority in the list of open actions(according to their weight property).
|
* While on DMF-API a MULTI_ACTION request is sent, DDI-API only exposes the next action which has the highest priority
|
||||||
* All information regarding the currently assigned or installed Distribution Set does only respect the last assignment, as well as the last successfully installed Distribution set. This also affects:
|
in the list of open actions(according to their weight property).
|
||||||
|
* All information regarding the currently assigned or installed Distribution Set does only respect the last assignment,
|
||||||
|
as well as the last successfully installed Distribution set. This also affects:
|
||||||
* Pinning a target or Distribution Set in Deployment View.
|
* Pinning a target or Distribution Set in Deployment View.
|
||||||
* Statistics about installed or assigned Distribution Sets.
|
* Statistics about installed or assigned Distribution Sets.
|
||||||
* Auto close running actions, when a new Distribution Set is assigned (`repository.actions.autoclose.enabled`) is deactivated.
|
* Auto close running actions, when a new Distribution Set is assigned (`repository.actions.autoclose.enabled`) is
|
||||||
|
deactivated.
|
||||||
* Marking a Distribution Set to be a *Required Migration Step* is deactivated.
|
* Marking a Distribution Set to be a *Required Migration Step* is deactivated.
|
||||||
@@ -4,7 +4,10 @@ parent: Concepts
|
|||||||
weight: 55
|
weight: 55
|
||||||
---
|
---
|
||||||
|
|
||||||
A target has a current state which reflects the provisioning status of the device at this point in time. State changes are driven either by the update server by means of starting an update or by the controller on the provisioning target that gives feedback to the update server, e.g. "I am here", "I am working on a provisioning", "I have finished a provisioning".
|
A target has a current state which reflects the provisioning status of the device at this point in time. State changes
|
||||||
|
are driven either by the update server by means of starting an update or by the controller on the provisioning target
|
||||||
|
that gives feedback to the update server, e.g. "I am here", "I am working on a provisioning", "I have finished a
|
||||||
|
provisioning".
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
## Defined states
|
## Defined states
|
||||||
@@ -18,4 +21,5 @@ A target has a current state which reflects the provisioning status of the devic
|
|||||||
| REGISTERED | Target registered at the update server but no _Distribution Set_ assigned. Is the initial starting point for plug-and-play devices. |
|
| REGISTERED | Target registered at the update server but no _Distribution Set_ assigned. Is the initial starting point for plug-and-play devices. |
|
||||||
|
|
||||||
## Transitions
|
## Transitions
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -3,30 +3,35 @@ title: Features
|
|||||||
weight: 40
|
weight: 40
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
## Device and Software Repository
|
## Device and Software Repository
|
||||||
|
|
||||||
- Repository that holds the provisioning targets and assignable software distributions.
|
- Repository that holds the provisioning targets and assignable software distributions.
|
||||||
- Targets to be logically grouped by Target Types.
|
- Targets to be logically grouped by Target Types.
|
||||||
- That includes a full software update history for every device.
|
- That includes a full software update history for every device.
|
||||||
- Support for pre-commission devices in the repository and plug and play, i.e. device is created if it is authenticated for the first time.
|
- Support for pre-commission devices in the repository and plug and play, i.e. device is created if it is authenticated
|
||||||
|
for the first time.
|
||||||
|
|
||||||
## Update Management
|
## Update Management
|
||||||
|
|
||||||
- Directly deploy a defined software distribution to a device (by Management API).
|
- Directly deploy a defined software distribution to a device (by Management API).
|
||||||
- Update handling is independent of the device type, integration approach or connectivity.
|
- Update handling is independent of the device type, integration approach or connectivity.
|
||||||
- Optional user consent flow, download and install updates only after respective end user has confirmed it.
|
- Optional user consent flow, download and install updates only after respective end user has confirmed it.
|
||||||
- Mass cancel the distribution of an update by invalidating the distribution set.
|
- Mass cancel the distribution of an update by invalidating the distribution set.
|
||||||
- Use action status codes for easier analysis.
|
- Use action status codes for easier analysis.
|
||||||
|
|
||||||
## Artifact Content Delivery
|
## Artifact Content Delivery
|
||||||
|
|
||||||
- Partial downloads supported.
|
- Partial downloads supported.
|
||||||
- Download resume supported (RFC7233).
|
- Download resume supported (RFC7233).
|
||||||
- Content management by RESTful API and UI (see above).
|
- Content management by RESTful API and UI (see above).
|
||||||
- Authorization based on software assignment, i.e. a device can only download what has been assigned to it in the first place.
|
- Authorization based on software assignment, i.e. a device can only download what has been assigned to it in the first
|
||||||
|
place.
|
||||||
- Delta artifact hosting supported.
|
- Delta artifact hosting supported.
|
||||||
- Artifact signature hosting supported.
|
- Artifact signature hosting supported.
|
||||||
- Plug-point for artifact encryption allowing to encrypt artifacts on upload.
|
- Plug-point for artifact encryption allowing to encrypt artifacts on upload.
|
||||||
|
|
||||||
## Rollout/Campaign Management
|
## Rollout/Campaign Management
|
||||||
|
|
||||||
- Secure handling of large volumes of devices at rollout creation time.
|
- Secure handling of large volumes of devices at rollout creation time.
|
||||||
- Flexible deployment group definition as part of a rollout.
|
- Flexible deployment group definition as part of a rollout.
|
||||||
- Monitoring of the rollout progress.
|
- Monitoring of the rollout progress.
|
||||||
@@ -36,6 +41,7 @@ weight: 40
|
|||||||
## Interfaces
|
## Interfaces
|
||||||
|
|
||||||
### Management API
|
### Management API
|
||||||
|
|
||||||
- RESTful API
|
- RESTful API
|
||||||
- Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).
|
- Create/Read/Update/Delete operations for provisioning targets (i.e. devices) and repository content (i.e. software).
|
||||||
- Manage and monitor software update operations.
|
- Manage and monitor software update operations.
|
||||||
@@ -44,6 +50,7 @@ weight: 40
|
|||||||
- Supports filtering, sorting and paging.
|
- Supports filtering, sorting and paging.
|
||||||
|
|
||||||
### Direct Device Integration API
|
### Direct Device Integration API
|
||||||
|
|
||||||
- RESTful HTTP based API for direct device integration
|
- RESTful HTTP based API for direct device integration
|
||||||
- JSON payload.
|
- JSON payload.
|
||||||
- Traffic optimized (content based Etag generation, not modified).
|
- Traffic optimized (content based Etag generation, not modified).
|
||||||
@@ -51,7 +58,9 @@ weight: 40
|
|||||||
- TLS encryption.
|
- TLS encryption.
|
||||||
|
|
||||||
### Device Management Federation API
|
### Device Management Federation API
|
||||||
|
|
||||||
- Indirect device integration through a device management service or application into hawkBit.
|
- Indirect device integration through a device management service or application into hawkBit.
|
||||||
- Optimized for high service to service throughput with [AMQP](https://www.rabbitmq.com/amqp-0-9-1-reference.html) messaging interface.
|
- Optimized for high service to service throughput with [AMQP](https://www.rabbitmq.com/amqp-0-9-1-reference.html)
|
||||||
|
messaging interface.
|
||||||
- Separate AMQP vHost per tenant for maximum security.
|
- Separate AMQP vHost per tenant for maximum security.
|
||||||
|
|
||||||
|
|||||||
@@ -16,17 +16,20 @@ any personal data.
|
|||||||
|
|
||||||
In addition, the following vendors offer free trial accounts for their Eclipse hawkBit compatible products:
|
In addition, the following vendors offer free trial accounts for their Eclipse hawkBit compatible products:
|
||||||
|
|
||||||
* [Bosch IoT Rollouts](https://bosch-iot-suite.com/service/rollouts/) (by [Bosch Digital](https://www.bosch-digital.com))
|
* [Bosch IoT Rollouts](https://bosch-iot-suite.com/service/rollouts/) (
|
||||||
|
by [Bosch Digital](https://www.bosch-digital.com))
|
||||||
* [Kynetics Update Factory](https://www.kynetics.com/update-factory) (by [Kynetics LLC](https://www.kynetics.com/))
|
* [Kynetics Update Factory](https://www.kynetics.com/update-factory) (by [Kynetics LLC](https://www.kynetics.com/))
|
||||||
|
|
||||||
|
|
||||||
## From Docker Image
|
## From Docker Image
|
||||||
|
|
||||||
### Overview
|
### Overview
|
||||||
|
|
||||||
HawkBit Update Server username/password -> admin/admin as default login credentials. They can be overridden by the environment variables spring.security.user.name and spring.security.user.password which are defined in the corresponding default [application.properties](hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties).
|
HawkBit Update Server username/password -> admin/admin as default login credentials. They can be overridden by the
|
||||||
|
environment variables spring.security.user.name and spring.security.user.password which are defined in the corresponding
|
||||||
|
default [application.properties](hawkbit-runtime/hawkbit-update-server/src/main/resources/application.properties).
|
||||||
|
|
||||||
It supports two configurations:
|
It supports two configurations:
|
||||||
|
|
||||||
* monolith - hawkbit-update-server
|
* monolith - hawkbit-update-server
|
||||||
* micro-service - hawkbit-mgmt-server, hawkbit-ddi-server, hawkbit-dmf-server.
|
* micro-service - hawkbit-mgmt-server, hawkbit-ddi-server, hawkbit-dmf-server.
|
||||||
|
|
||||||
@@ -61,6 +64,7 @@ $ docker-compose -f docker-compose-micro-service-mysql.yml up -d
|
|||||||
## From Sources
|
## From Sources
|
||||||
|
|
||||||
### 1: Clone and build hawkBit
|
### 1: Clone and build hawkBit
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
$ cd hawkbit
|
$ cd hawkbit
|
||||||
@@ -82,6 +86,7 @@ $ mvn clean install
|
|||||||
```
|
```
|
||||||
|
|
||||||
### 4: Start hawkBit [Device Simulator](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-device-simulator)
|
### 4: Start hawkBit [Device Simulator](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-device-simulator)
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
$ java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar
|
$ java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -4,7 +4,9 @@ parent: Guides
|
|||||||
weight: 33
|
weight: 33
|
||||||
---
|
---
|
||||||
|
|
||||||
hawkBit is able to run in a cluster with some constraints. This guide provides insights in the basic concepts and how to setup your own cluster. You can find additional information in the [hawkBit runtimes's README](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/README.md).
|
hawkBit is able to run in a cluster with some constraints. This guide provides insights in the basic concepts and how to
|
||||||
|
setup your own cluster. You can find additional information in
|
||||||
|
the [hawkBit runtimes's README](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/README.md).
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
## Big picture
|
## Big picture
|
||||||
@@ -13,8 +15,13 @@ hawkBit is able to run in a cluster with some constraints. This guide provides i
|
|||||||
|
|
||||||
## Events
|
## Events
|
||||||
|
|
||||||
Event communication between nodes is based on [Spring Cloud Bus](https://cloud.spring.io/spring-cloud-bus/) and [Spring Cloud Stream](http://docs.spring.io/spring-cloud-stream/docs/current/reference/htmlsingle/). There are different [binder implementations](http://docs.spring.io/spring-cloud-stream/docs/current/reference/htmlsingle/#_binders) available. The _hawkbit Update Server_ uses RabbitMQ binder. Every node gets his own queue to receive cluster events, the default payload is JSON.
|
Event communication between nodes is based on [Spring Cloud Bus](https://cloud.spring.io/spring-cloud-bus/)
|
||||||
If an event is thrown locally at one node, it will be automatically delivered to all other available nodes via the Spring Cloud Bus's topic exchange:
|
and [Spring Cloud Stream](http://docs.spring.io/spring-cloud-stream/docs/current/reference/htmlsingle/). There are
|
||||||
|
different [binder implementations](http://docs.spring.io/spring-cloud-stream/docs/current/reference/htmlsingle/#_binders)
|
||||||
|
available. The _hawkbit Update Server_ uses RabbitMQ binder. Every node gets his own queue to receive cluster events,
|
||||||
|
the default payload is JSON.
|
||||||
|
If an event is thrown locally at one node, it will be automatically delivered to all other available nodes via the
|
||||||
|
Spring Cloud Bus's topic exchange:
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@@ -23,16 +30,25 @@ Via the ServiceMatcher you can check whether an event happened locally at one no
|
|||||||
|
|
||||||
## Caching
|
## Caching
|
||||||
|
|
||||||
Every node is maintaining its own caches independent from other nodes. So there is no globally shared/synchronized cache instance within the cluster. In order to keep nodes in sync a TTL (time to live) can be set for all caches to ensure that after some time the cache is refreshed from the database. To enable the TTL just set the property "hawkbit.cache.global.ttl" (value in milliseconds). Of course you can implement a shared cache, e.g. Redis.
|
Every node is maintaining its own caches independent from other nodes. So there is no globally shared/synchronized cache
|
||||||
|
instance within the cluster. In order to keep nodes in sync a TTL (time to live) can be set for all caches to ensure
|
||||||
|
that after some time the cache is refreshed from the database. To enable the TTL just set the property "
|
||||||
|
hawkbit.cache.global.ttl" (value in milliseconds). Of course you can implement a shared cache, e.g. Redis.
|
||||||
See [CacheAutoConfiguration](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/cache/CacheAutoConfiguration.java)
|
See [CacheAutoConfiguration](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-autoconfigure/src/main/java/org/eclipse/hawkbit/autoconfigure/cache/CacheAutoConfiguration.java)
|
||||||
|
|
||||||
## Schedulers
|
## Schedulers
|
||||||
|
|
||||||
Every node has multiple schedulers which run after a defined period of time. All schedulers always run on every node. This has to be kept in mind e.g. if the scheduler executes critical code which has to be executed only once.
|
Every node has multiple schedulers which run after a defined period of time. All schedulers always run on every node.
|
||||||
|
This has to be kept in mind e.g. if the scheduler executes critical code which has to be executed only once.
|
||||||
|
|
||||||
## Known constraints
|
## Known constraints
|
||||||
|
|
||||||
### Denial-of-Service (DoS) filter
|
### Denial-of-Service (DoS) filter
|
||||||
hawkBit owns the feature of guarding itself from DoS attacks, a [DoS filter](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-http-security/src/main/java/org/eclipse/hawkbit/security/DosFilter.java). It reduces the maximum number of requests per seconds which can be configured for read and write requests.
|
|
||||||
This mechanism is only working for every node separately, i.e. in a cluster environment the worst-case behaviour would be that the maximum number of requests per seconds will be increased to its product if every request is handled by a different node.
|
hawkBit owns the feature of guarding itself from DoS attacks,
|
||||||
|
a [DoS filter](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-http-security/src/main/java/org/eclipse/hawkbit/security/DosFilter.java).
|
||||||
|
It reduces the maximum number of requests per seconds which can be configured for read and write requests.
|
||||||
|
This mechanism is only working for every node separately, i.e. in a cluster environment the worst-case behaviour would
|
||||||
|
be that the maximum number of requests per seconds will be increased to its product if every request is handled by a
|
||||||
|
different node.
|
||||||
The same constraint exists with the validator to check if a user tried too many logins within a defined period of time.
|
The same constraint exists with the validator to check if a user tried too many logins within a defined period of time.
|
||||||
|
|||||||
@@ -4,18 +4,31 @@ parent: Guides
|
|||||||
weight: 32
|
weight: 32
|
||||||
---
|
---
|
||||||
|
|
||||||
In this guide we describe how to create a [Feign](https://github.com/Netflix/feign) Rest Client based on a [Spring Boot](http://projects.spring.io/spring-boot/) Application.
|
In this guide we describe how to create a [Feign](https://github.com/Netflix/feign) Rest Client based on
|
||||||
|
a [Spring Boot](http://projects.spring.io/spring-boot/) Application.
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
## Create Feign REST Client
|
## Create Feign REST Client
|
||||||
hawkBit provides REST interfaces for [Management API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-ddi-api) and [DDI API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-ddi-api). Using this interfaces you can create a feign client with the help of the [feign inheritance support](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).
|
|
||||||
Our [example](https://github.com/eclipse-hawkbit/hawkbit-examples) modules demonstrate how to create [Feign](https://github.com/Netflix/feign) client resources. Here you can find the [Management API client resources](hhttps://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-mgmt-feign-client) and the [DDI client resources](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-ddi-feign-client).
|
hawkBit provides REST interfaces
|
||||||
A small [simulator application](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator) demonstrates how you can interact with the hawkBit via the [Management API
|
for [Management API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-ddi-api)
|
||||||
](http://www.eclipse.org/hawkbit/documentation/interfaces/management-api.html).
|
and [DDI API](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkbit-ddi-api). Using this interfaces you can
|
||||||
|
create a feign client with the help of
|
||||||
|
the [feign inheritance support](http://projects.spring.io/spring-cloud/spring-cloud.html#spring-cloud-feign-inheritance).
|
||||||
|
Our [example](https://github.com/eclipse-hawkbit/hawkbit-examples) modules demonstrate how to
|
||||||
|
create [Feign](https://github.com/Netflix/feign) client resources. Here you can find
|
||||||
|
the [Management API client resources](hhttps://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-mgmt-feign-client)
|
||||||
|
and
|
||||||
|
the [DDI client resources](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-ddi-feign-client).
|
||||||
|
A
|
||||||
|
small [simulator application](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator)
|
||||||
|
demonstrates how you can interact with the hawkBit via the [Management API
|
||||||
|
](http://www.eclipse.org/hawkbit/documentation/interfaces/management-api.html).
|
||||||
|
|
||||||
## Example Management API simulator
|
## Example Management API simulator
|
||||||
|
|
||||||
In the follow code section, you can a see a feign client resource example. The interface extend the origin api interface to declare the `@FeignClient`. The `@FeignClient`declares that a REST client with that interface should be created.
|
In the follow code section, you can a see a feign client resource example. The interface extend the origin api interface
|
||||||
|
to declare the `@FeignClient`. The `@FeignClient`declares that a REST client with that interface should be created.
|
||||||
|
|
||||||
```Java
|
```Java
|
||||||
@FeignClient(url = "${hawkbit.url:localhost:8080}/" + MgmtRestConstants.TARGET_V1_REQUEST_MAPPING)
|
@FeignClient(url = "${hawkbit.url:localhost:8080}/" + MgmtRestConstants.TARGET_V1_REQUEST_MAPPING)
|
||||||
@@ -40,7 +53,8 @@ public class CreateStartedRolloutExample {
|
|||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
At [hawkbit-example-core-feign-client](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-core-feign-client) is a spring configuration to auto configure some beans, which can be reused for a own feign client.
|
At [hawkbit-example-core-feign-client](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-core-feign-client)
|
||||||
|
is a spring configuration to auto configure some beans, which can be reused for a own feign client.
|
||||||
|
|
||||||
```Java
|
```Java
|
||||||
@Configuration
|
@Configuration
|
||||||
|
|||||||
@@ -4,12 +4,14 @@ parent: Guides
|
|||||||
weight: 31
|
weight: 31
|
||||||
---
|
---
|
||||||
|
|
||||||
In this guide we describe how to run a full featured hawkBit setup based on a production ready infrastructure. It is based on the hawkBit example modules and update server.
|
In this guide we describe how to run a full featured hawkBit setup based on a production ready infrastructure. It is
|
||||||
|
based on the hawkBit example modules and update server.
|
||||||
|
|
||||||
<!--more-->
|
<!--more-->
|
||||||
|
|
||||||
{{% note %}}
|
{{% note %}}
|
||||||
The update server can in fact be run stand alone. However, only with an embedded H2, no Device Management Federation API and no artifact storage.
|
The update server can in fact be run stand alone. However, only with an embedded H2, no Device Management Federation API
|
||||||
|
and no artifact storage.
|
||||||
{{% /note %}}
|
{{% /note %}}
|
||||||
|
|
||||||
## System Architecture
|
## System Architecture
|
||||||
@@ -30,7 +32,8 @@ This guide describes a target architecture that is more like one that you will e
|
|||||||
|
|
||||||
## Adapt hawkBit Update Server and Device Simulator to your environment.
|
## Adapt hawkBit Update Server and Device Simulator to your environment.
|
||||||
|
|
||||||
As mentioned you can create your own application with hawkBit inside or adapt the existing example app. The second option will be shown here.
|
As mentioned you can create your own application with hawkBit inside or adapt the existing example app. The second
|
||||||
|
option will be shown here.
|
||||||
|
|
||||||
### Set MariaDB dependency to compile in the [update server POM](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/pom.xml)
|
### Set MariaDB dependency to compile in the [update server POM](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-runtime/hawkbit-update-server/pom.xml)
|
||||||
|
|
||||||
@@ -44,7 +47,8 @@ As mentioned you can create your own application with hawkBit inside or adapt th
|
|||||||
|
|
||||||
### Configure MariaDB/MySQL connection settings.
|
### Configure MariaDB/MySQL connection settings.
|
||||||
|
|
||||||
For this you can either edit the existing _application.properties_ or create a [new profile](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-external-config-profile-specific-properties).
|
For this you can either edit the existing _application.properties_ or create
|
||||||
|
a [new profile](http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#boot-features-external-config-profile-specific-properties).
|
||||||
|
|
||||||
```properties
|
```properties
|
||||||
spring.jpa.database=MYSQL
|
spring.jpa.database=MYSQL
|
||||||
@@ -54,12 +58,15 @@ spring.datasource.password=YOUR_PWD
|
|||||||
spring.datasource.driverClassName=org.mariadb.jdbc.Driver
|
spring.datasource.driverClassName=org.mariadb.jdbc.Driver
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: On Ubuntu 18.04 with MariaDB 10.1 installed from the default repository via apt install _COLLATE option_ of database have to be changed manually to "latin1".
|
Note: On Ubuntu 18.04 with MariaDB 10.1 installed from the default repository via apt install _COLLATE option_ of
|
||||||
For recent versions of MariaDB running on Ubuntu this is not required (cf. [system variables](https://mariadb.com/kb/en/differences-in-mariadb-in-debian-and-ubuntu), [issue](https://github.com/eclipse-hawkbit/hawkbit/issues/963))
|
database have to be changed manually to "latin1".
|
||||||
|
For recent versions of MariaDB running on Ubuntu this is not required (
|
||||||
|
cf. [system variables](https://mariadb.com/kb/en/differences-in-mariadb-in-debian-and-ubuntu), [issue](https://github.com/eclipse-hawkbit/hawkbit/issues/963))
|
||||||
|
|
||||||
### Configure RabbitMQ connection settings for update server and device simulator (optional).
|
### Configure RabbitMQ connection settings for update server and device simulator (optional).
|
||||||
|
|
||||||
We provide already defaults that should work with a standard Rabbit installation. Otherwise configure the following in the `application.properties` of the two services:
|
We provide already defaults that should work with a standard Rabbit installation. Otherwise configure the following in
|
||||||
|
the `application.properties` of the two services:
|
||||||
|
|
||||||
```properties
|
```properties
|
||||||
spring.rabbitmq.username=guest
|
spring.rabbitmq.username=guest
|
||||||
@@ -93,9 +100,11 @@ see [update server](https://github.com/eclipse-hawkbit/hawkbit/tree/master/hawkb
|
|||||||
|
|
||||||
### Compile & Run example scenario [creation script](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator) (optional)
|
### Compile & Run example scenario [creation script](https://github.com/eclipse-hawkbit/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator) (optional)
|
||||||
|
|
||||||
This has to be done before the device simulator is started. hawkBit creates the mandatory tenant metadata with first login into either Management API (which is done by this client).
|
This has to be done before the device simulator is started. hawkBit creates the mandatory tenant metadata with first
|
||||||
|
login into either Management API (which is done by this client).
|
||||||
|
|
||||||
However, this is not done by _DMF_ which is in fact used by the device simulator, i.e. without calling _Management API_ first hawkBit would drop all _DMF_ messages as the tenant is unknown.
|
However, this is not done by _DMF_ which is in fact used by the device simulator, i.e. without calling _Management API_
|
||||||
|
first hawkBit would drop all _DMF_ messages as the tenant is unknown.
|
||||||
|
|
||||||
### Compile & Run device simulator (optional)
|
### Compile & Run device simulator (optional)
|
||||||
|
|
||||||
|
|||||||
@@ -28,25 +28,24 @@ Extensions: [Tag](https://github.com/eclipse-hawkbit/hawkbit-extensions/releases
|
|||||||
|
|
||||||
**Release Date:** Thursday, August 24, 2023 <br />
|
**Release Date:** Thursday, August 24, 2023 <br />
|
||||||
Hawkbit: [Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.3.0M9) /
|
Hawkbit: [Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.3.0M9) /
|
||||||
[Release](https://github.com/eclipse-hawkbit/hawkbit/milestone/24) <br />
|
[Release](https://github.com/eclipse-hawkbit/hawkbit/milestone/24) <br />
|
||||||
Extensions: [Tag](https://github.com/eclipse-hawkbit/hawkbit-extensions/releases/tag/0.3.0M9)
|
Extensions: [Tag](https://github.com/eclipse-hawkbit/hawkbit-extensions/releases/tag/0.3.0M9)
|
||||||
|
|
||||||
## 0.3.0M8
|
## 0.3.0M8
|
||||||
|
|
||||||
**Release Date:** Friday, April 21, 2023 <br />
|
**Release Date:** Friday, April 21, 2023 <br />
|
||||||
Hawkbit: [Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.3.0M8) /
|
Hawkbit: [Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.3.0M8) /
|
||||||
[Release](https://github.com/eclipse-hawkbit/hawkbit/milestone/23) <br />
|
[Release](https://github.com/eclipse-hawkbit/hawkbit/milestone/23) <br />
|
||||||
Extensions: [Tag](https://github.com/eclipse-hawkbit/hawkbit-extensions/releases/tag/0.3.0M8) /
|
Extensions: [Tag](https://github.com/eclipse-hawkbit/hawkbit-extensions/releases/tag/0.3.0M8) /
|
||||||
[Release](https://github.com/eclipse-hawkbit/hawkbit-extensions/milestone/2)
|
[Release](https://github.com/eclipse-hawkbit/hawkbit-extensions/milestone/2)
|
||||||
|
|
||||||
|
|
||||||
## 0.3.0M7
|
## 0.3.0M7
|
||||||
|
|
||||||
**Release Date:** Monday, February 15, 2021 <br />
|
**Release Date:** Monday, February 15, 2021 <br />
|
||||||
Hawkbit: [Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.3.0M7) /
|
Hawkbit: [Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.3.0M7) /
|
||||||
[Release](https://github.com/eclipse-hawkbit/hawkbit/milestone/22?closed=1) <br />
|
[Release](https://github.com/eclipse-hawkbit/hawkbit/milestone/22?closed=1) <br />
|
||||||
Extensions: [Tag](https://github.com/eclipse-hawkbit/hawkbit-extensions/releases/tag/0.3.0M7) /
|
Extensions: [Tag](https://github.com/eclipse-hawkbit/hawkbit-extensions/releases/tag/0.3.0M7) /
|
||||||
[Release](https://github.com/eclipse-hawkbit/hawkbit-extensions/milestone/1?closed=1)
|
[Release](https://github.com/eclipse-hawkbit/hawkbit-extensions/milestone/1?closed=1)
|
||||||
|
|
||||||
## 0.3.0M6
|
## 0.3.0M6
|
||||||
|
|
||||||
@@ -114,20 +113,19 @@ Extensions: [Tag](https://github.com/eclipse-hawkbit/hawkbit-extensions/releases
|
|||||||
[Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.2.1) /
|
[Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.2.1) /
|
||||||
[Release](https://github.com/eclipse-hawkbit/hawkbit/milestone/9?closed=1)
|
[Release](https://github.com/eclipse-hawkbit/hawkbit/milestone/9?closed=1)
|
||||||
|
|
||||||
|
|
||||||
## 0.2.0
|
## 0.2.0
|
||||||
|
|
||||||
First Eclipse hawkBit release including:
|
First Eclipse hawkBit release including:
|
||||||
|
|
||||||
* **Core features:**
|
* **Core features:**
|
||||||
* Device and Software Repository
|
* Device and Software Repository
|
||||||
* Artifact Content Delivery
|
* Artifact Content Delivery
|
||||||
* Rollout/Campaign Management
|
* Rollout/Campaign Management
|
||||||
|
|
||||||
* **Interfaces:**
|
* **Interfaces:**
|
||||||
* Management API
|
* Management API
|
||||||
* Direct Device Integration (DDI) API
|
* Direct Device Integration (DDI) API
|
||||||
* Device Management Federation (DMF) API
|
* Device Management Federation (DMF) API
|
||||||
|
|
||||||
**Release Date:** Friday, June 15, 2018 <br />
|
**Release Date:** Friday, June 15, 2018 <br />
|
||||||
[Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.2.0) /
|
[Tag](https://github.com/eclipse-hawkbit/hawkbit/releases/tag/0.2.0) /
|
||||||
|
|||||||
@@ -2,37 +2,73 @@
|
|||||||
title: What is hawkBit?
|
title: What is hawkBit?
|
||||||
weight: 10
|
weight: 10
|
||||||
---
|
---
|
||||||
Eclipse hawkBit™ is a domain-independent back-end framework for rolling out software updates to constrained edge devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.
|
|
||||||
|
Eclipse hawkBit™ is a domain-independent back-end framework for rolling out software updates to constrained edge
|
||||||
|
devices as well as more powerful controllers and gateways connected to IP based networking infrastructure.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Why Software Updates in IoT?
|
## Why Software Updates in IoT?
|
||||||
Having software update capabilities ensures a secure IoT by means that it gives IoT projects a fighting chance against pandora's box that they opened the moment their devices got connected. From that moment on devices are at the forefront of IT security threats many embedded software developers historically never had to face. Shipping for instance a Linux powered device connected to the Internet without any security updates ever applied during its lifetime is kind of a suicidal act these days.
|
|
||||||
|
|
||||||
A more charming argument for software update is that it enables agile development for hardware and hardware near development. Concepts like a minimum viable product can be applied for devices as not all features need to be ready at manufacturing time. Changes on the cloud side of the IoT project can be applied to the devices at runtime as well.
|
Having software update capabilities ensures a secure IoT by means that it gives IoT projects a fighting chance against
|
||||||
|
pandora's box that they opened the moment their devices got connected. From that moment on devices are at the forefront
|
||||||
|
of IT security threats many embedded software developers historically never had to face. Shipping for instance a Linux
|
||||||
|
powered device connected to the Internet without any security updates ever applied during its lifetime is kind of a
|
||||||
|
suicidal act these days.
|
||||||
|
|
||||||
Sometimes Software Update is a business model on its own as it makes devices much more attractive to the customer if they are updatable, i.e. they do not only buy a product because of its current feature set but make also a bet on its future capabilities. In addition new revenue streams may arise from the fact that feature extensions can potentially be monetized (e.g. Apps) without the need to design, manufacture and ship a new device (revision).
|
A more charming argument for software update is that it enables agile development for hardware and hardware near
|
||||||
|
development. Concepts like a minimum viable product can be applied for devices as not all features need to be ready at
|
||||||
|
manufacturing time. Changes on the cloud side of the IoT project can be applied to the devices at runtime as well.
|
||||||
|
|
||||||
|
Sometimes Software Update is a business model on its own as it makes devices much more attractive to the customer if
|
||||||
|
they are updatable, i.e. they do not only buy a product because of its current feature set but make also a bet on its
|
||||||
|
future capabilities. In addition new revenue streams may arise from the fact that feature extensions can potentially be
|
||||||
|
monetized (e.g. Apps) without the need to design, manufacture and ship a new device (revision).
|
||||||
|
|
||||||
## Why hawkBit?
|
## Why hawkBit?
|
||||||
|
|
||||||
**Updating software** (components) on constrained edge devices as well as more powerful controllers and gateways is as mentioned before a **common requirement** in most IoT scenarios.
|
**Updating software** (components) on constrained edge devices as well as more powerful controllers and gateways is as
|
||||||
|
mentioned before a **common requirement** in most IoT scenarios.
|
||||||
|
|
||||||
At the time being, this process is **usually handled by the IoT solution itself**, sometimes backed by a full fledged device management system. We believe that this approach generates unnecessary **duplicate work** in the IoT space, in particular when considering the challenges of implementing a safe and reliable remote software update process: the software update process must never fail and also must never be compromised as, at the one hand, it can be used to fix almost any issue/problem on the device but at the same time also poses the greatest security threat if mis-used to introduce malicious code to the device.
|
At the time being, this process is **usually handled by the IoT solution itself**, sometimes backed by a full fledged
|
||||||
|
device management system. We believe that this approach generates unnecessary **duplicate work** in the IoT space, in
|
||||||
|
particular when considering the challenges of implementing a safe and reliable remote software update process: the
|
||||||
|
software update process must never fail and also must never be compromised as, at the one hand, it can be used to fix
|
||||||
|
almost any issue/problem on the device but at the same time also poses the greatest security threat if mis-used to
|
||||||
|
introduce malicious code to the device.
|
||||||
|
|
||||||
In addition we believe the software update process to be relatively **independent from particular application domains** when seen from the back-end (cloud) perspective. Updating the software for an entire car may differ from updating the firmware of a single sensor with regard to the connectivity of the device to the cloud and also to the complexity of the software package update process on the device. However, the process of rolling out the software, e.g. uploading an artifact to the repository, assigning it to eligible devices, managing the roll out campaign for a large number of devices, orchestrating content delivery networks to distribute the package, monitoring and reporting the progress of the roll-out and last but not least requirements regarding security and reliability are quite similar.
|
In addition we believe the software update process to be relatively **independent from particular application domains**
|
||||||
|
when seen from the back-end (cloud) perspective. Updating the software for an entire car may differ from updating the
|
||||||
|
firmware of a single sensor with regard to the connectivity of the device to the cloud and also to the complexity of the
|
||||||
|
software package update process on the device. However, the process of rolling out the software, e.g. uploading an
|
||||||
|
artifact to the repository, assigning it to eligible devices, managing the roll out campaign for a large number of
|
||||||
|
devices, orchestrating content delivery networks to distribute the package, monitoring and reporting the progress of the
|
||||||
|
roll-out and last but not least requirements regarding security and reliability are quite similar.
|
||||||
|
|
||||||
Software update itself is often seen as a sub process of general device management. In fact, most device management systems include functionality for triggering groups of devices to perform an update, usually accompanied by an artifact repository and basic reporting and monitoring capabilities. This is true for both systems specifically targeting IoT as well as systems originating from the mobile area.
|
Software update itself is often seen as a sub process of general device management. In fact, most device management
|
||||||
|
systems include functionality for triggering groups of devices to perform an update, usually accompanied by an artifact
|
||||||
|
repository and basic reporting and monitoring capabilities. This is true for both systems specifically targeting IoT as
|
||||||
|
well as systems originating from the mobile area.
|
||||||
|
|
||||||
Existing **device management systems** usually **lack** the capability to **efficiently organize roll outs at IoT scale**, e.g. splitting the roll out into sub groups, cascading them, automatically stopping the roll out after a defined error threshold etc. They are also usually restricted to a single device management protocol, either a proprietary one or one of the existing standard protocols like LWM2M, OMA-DM or TR-069. Even if they support more than one such protocol, they are often a result of the device management protocol they started with and restricted in their adoption capabilities to others.
|
Existing **device management systems** usually **lack** the capability to **efficiently organize roll outs at IoT scale
|
||||||
|
**, e.g. splitting the roll out into sub groups, cascading them, automatically stopping the roll out after a defined
|
||||||
|
error threshold etc. They are also usually restricted to a single device management protocol, either a proprietary one
|
||||||
|
or one of the existing standard protocols like LWM2M, OMA-DM or TR-069. Even if they support more than one such
|
||||||
|
protocol, they are often a result of the device management protocol they started with and restricted in their adoption
|
||||||
|
capabilities to others.
|
||||||
|
|
||||||
At the same time the wide functional scope of a full fledged **device management system introduces unnecessary (and unwanted) complexity** to many IoT projects. This is particularly true for IoT solutions working with constrained devices where requirements regarding generic device management are often very limited only but a secure & reliable software update process is still mandatory.
|
At the same time the wide functional scope of a full fledged **device management system introduces unnecessary (and
|
||||||
|
unwanted) complexity** to many IoT projects. This is particularly true for IoT solutions working with constrained
|
||||||
|
devices where requirements regarding generic device management are often very limited only but a secure & reliable
|
||||||
|
software update process is still mandatory.
|
||||||
|
|
||||||
As a result we have the need for a domain independent solution
|
As a result we have the need for a domain independent solution
|
||||||
|
|
||||||
* that works for the majority of IoT projects
|
* that works for the majority of IoT projects
|
||||||
* that goes beyond the pure update and handles more complex **roll out strategies** needed by large scale IoT projects.
|
* that goes beyond the pure update and handles more complex **roll out strategies** needed by large scale IoT projects.
|
||||||
* that at the same time is **focused on software updates** in the IoT space
|
* that at the same time is **focused on software updates** in the IoT space
|
||||||
* and that is able to work on its own for simple scenarios while having the capability to integrate with existing device management systems and protocols.
|
* and that is able to work on its own for simple scenarios while having the capability to integrate with existing device
|
||||||
|
management systems and protocols.
|
||||||
|
|
||||||
## Cloud Ready
|
## Cloud Ready
|
||||||
|
|
||||||
@@ -40,4 +76,5 @@ As a result we have the need for a domain independent solution
|
|||||||
* **Functional Scalability**: rollouts with hundreds of thousands of individual devices in it.
|
* **Functional Scalability**: rollouts with hundreds of thousands of individual devices in it.
|
||||||
* **Reliability**: software update as the last line of defense against device faults and vulnerabilities.
|
* **Reliability**: software update as the last line of defense against device faults and vulnerabilities.
|
||||||
* **Managed device complexity**: device topologies inside each individual provisioning target.
|
* **Managed device complexity**: device topologies inside each individual provisioning target.
|
||||||
* **Integration flexibility**: connect and integrate through various (non-)standardized device management protocols directly or through federated device managements.
|
* **Integration flexibility**: connect and integrate through various (non-)standardized device management protocols
|
||||||
|
directly or through federated device managements.
|
||||||
@@ -1,54 +1,54 @@
|
|||||||
{{ partial "head" . }}
|
{{ partial "head" . }}
|
||||||
|
|
||||||
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
||||||
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
|
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
|
||||||
{{ .Scratch.Set "repo_id" $repo_id }}
|
{{ .Scratch.Set "repo_id" $repo_id }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
<div class="backdrop">
|
<div class="backdrop">
|
||||||
<div class="backdrop-paper"></div>
|
<div class="backdrop-paper"></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<input class="toggle" type="checkbox" id="toggle-drawer">
|
<input class="toggle" id="toggle-drawer" type="checkbox">
|
||||||
<input class="toggle" type="checkbox" id="toggle-search">
|
<input class="toggle" id="toggle-search" type="checkbox">
|
||||||
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
||||||
|
|
||||||
<header class="header">
|
<header class="header">
|
||||||
{{ partial "header" . }}
|
{{ partial "header" . }}
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
<main class="main">
|
<main class="main">
|
||||||
<div class="drawer">
|
<div class="drawer">
|
||||||
{{ partial "drawer" . }}
|
{{ partial "drawer" . }}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article class="article">
|
<article class="article">
|
||||||
<div class="wrapper">
|
<div class="wrapper">
|
||||||
<h1>Pages in {{ .Title }}</h1>
|
<h1>Pages in {{ .Title }}</h1>
|
||||||
|
|
||||||
{{ range .Data.Pages }}
|
{{ range .Data.Pages }}
|
||||||
<a href="{{ .Permalink }}" title="{{ .Title }}">
|
<a href="{{ .Permalink }}" title="{{ .Title }}">
|
||||||
<h2>{{ .Title }}</h2>
|
<h2>{{ .Title }}</h2>
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<br>
|
<br>
|
||||||
{{ printf "%s" .Summary | markdownify }} <br><a href="{{ .Permalink }}">[...]</a>
|
{{ printf "%s" .Summary | markdownify }} <br><a href="{{ .Permalink }}">[...]</a>
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
{{ partial "copyright.html" . }}
|
{{ partial "copyright.html" . }}
|
||||||
</div>
|
</div>
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="results" role="status" aria-live="polite">
|
<div aria-live="polite" class="results" role="status">
|
||||||
<div class="scrollable">
|
<div class="scrollable">
|
||||||
<div class="wrapper">
|
<div class="wrapper">
|
||||||
<div class="meta"></div>
|
<div class="meta"></div>
|
||||||
<div class="list"></div>
|
<div class="list"></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</main>
|
</main>
|
||||||
|
|
||||||
{{ partial "footer_js" . }}
|
{{ partial "footer_js" . }}
|
||||||
@@ -1,49 +1,49 @@
|
|||||||
{{ partial "head" . }}
|
{{ partial "head" . }}
|
||||||
|
|
||||||
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
||||||
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
|
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
|
||||||
{{ .Scratch.Set "repo_id" $repo_id }}
|
{{ .Scratch.Set "repo_id" $repo_id }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
<div class="backdrop">
|
<div class="backdrop">
|
||||||
<div class="backdrop-paper"></div>
|
<div class="backdrop-paper"></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<input class="toggle" type="checkbox" id="toggle-drawer">
|
<input class="toggle" id="toggle-drawer" type="checkbox">
|
||||||
<input class="toggle" type="checkbox" id="toggle-search">
|
<input class="toggle" id="toggle-search" type="checkbox">
|
||||||
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
||||||
|
|
||||||
<header class="header">
|
<header class="header">
|
||||||
{{ partial "header" . }}
|
{{ partial "header" . }}
|
||||||
</header>
|
</header>
|
||||||
|
|
||||||
<main class="main">
|
<main class="main">
|
||||||
<div class="drawer">
|
<div class="drawer">
|
||||||
{{ partial "drawer" . }}
|
{{ partial "drawer" . }}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article class="article">
|
<article class="article">
|
||||||
<div class="wrapper">
|
<div class="wrapper">
|
||||||
<h1>{{ .Title }} {{ if .Draft }} (Draft){{ end }}</h1>
|
<h1>{{ .Title }} {{ if .Draft }} (Draft){{ end }}</h1>
|
||||||
|
|
||||||
{{ .Content }}
|
{{ .Content }}
|
||||||
|
|
||||||
{{ partial "copyright.html" . }}
|
{{ partial "copyright.html" . }}
|
||||||
|
|
||||||
<footer class="footer">
|
<footer class="footer">
|
||||||
{{ partial "footer" . }}
|
{{ partial "footer" . }}
|
||||||
</footer>
|
</footer>
|
||||||
</div>
|
</div>
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="results" role="status" aria-live="polite">
|
<div aria-live="polite" class="results" role="status">
|
||||||
<div class="scrollable">
|
<div class="scrollable">
|
||||||
<div class="wrapper">
|
<div class="wrapper">
|
||||||
<div class="meta"></div>
|
<div class="meta"></div>
|
||||||
<div class="list"></div>
|
<div class="list"></div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</main>
|
</main>
|
||||||
|
|
||||||
{{ partial "footer_js" . }}
|
{{ partial "footer_js" . }}
|
||||||
|
|||||||
@@ -1,16 +1,16 @@
|
|||||||
{{ partial "head" . }}
|
{{ partial "head" . }}
|
||||||
|
|
||||||
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
||||||
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
|
{{ $repo_id := replace .Site.Params.repo_url "https://github.com/" ""}}
|
||||||
{{ .Scratch.Set "repo_id" $repo_id }}
|
{{ .Scratch.Set "repo_id" $repo_id }}
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
<div class="backdrop">
|
<div class="backdrop">
|
||||||
<div class="backdrop-paper"></div>
|
<div class="backdrop-paper"></div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<input class="toggle" type="checkbox" id="toggle-drawer">
|
<input class="toggle" id="toggle-drawer" type="checkbox">
|
||||||
<input class="toggle" type="checkbox" id="toggle-search">
|
<input class="toggle" id="toggle-search" type="checkbox">
|
||||||
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
||||||
|
|
||||||
<header class="header">
|
<header class="header">
|
||||||
@@ -34,7 +34,7 @@
|
|||||||
edge devices as well as more powerful controllers and gateways connected to IP based networking
|
edge devices as well as more powerful controllers and gateways connected to IP based networking
|
||||||
infrastructure.
|
infrastructure.
|
||||||
</p>
|
</p>
|
||||||
<img src="images/hawkBit_overview.jpeg" />
|
<img src="images/hawkBit_overview.jpeg"/>
|
||||||
<h2>Interfaces</h2>
|
<h2>Interfaces</h2>
|
||||||
<p>
|
<p>
|
||||||
hawkBit offers a direct device integration via HTTP or a device management federation API
|
hawkBit offers a direct device integration via HTTP or a device management federation API
|
||||||
@@ -63,7 +63,7 @@
|
|||||||
<div style="margin-left: 50%;">
|
<div style="margin-left: 50%;">
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
<img src="images/rollout.png" />
|
<img src="images/rollout.png"/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
@@ -71,7 +71,7 @@
|
|||||||
<div style="width: 100%; overflow: hidden;">
|
<div style="width: 100%; overflow: hidden;">
|
||||||
<div style="width: 50%; float: left;">
|
<div style="width: 50%; float: left;">
|
||||||
<br/>
|
<br/>
|
||||||
<img src="images/packagemodel.png" />
|
<img src="images/packagemodel.png"/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div style="margin-left: 55%;">
|
<div style="margin-left: 55%;">
|
||||||
@@ -88,7 +88,7 @@
|
|||||||
</div>
|
</div>
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="results" role="status" aria-live="polite">
|
<div aria-live="polite" class="results" role="status">
|
||||||
<div class="scrollable">
|
<div class="scrollable">
|
||||||
<div class="wrapper">
|
<div class="wrapper">
|
||||||
<div class="meta"></div>
|
<div class="meta"></div>
|
||||||
|
|||||||
@@ -1,33 +1,33 @@
|
|||||||
<aside class="copyright" role="note">
|
<aside class="copyright" role="note">
|
||||||
<div class="logo">
|
<div class="logo">
|
||||||
<a href="https://www.eclipse.org" target="_blank">
|
<a href="https://www.eclipse.org" target="_blank">
|
||||||
<img src="/hawkbit/images/eclipse_foundation_logo.png" />
|
<img src="/hawkbit/images/eclipse_foundation_logo.png"/>
|
||||||
</a>
|
</a>
|
||||||
</div>
|
</div>
|
||||||
<p class="notice">
|
<p class="notice">
|
||||||
{{ with .Site.Params.copyright }}
|
{{ with .Site.Params.copyright }}
|
||||||
© {{ now.Year }} {{ . }} –
|
© {{ now.Year }} {{ . }} –
|
||||||
{{ end }}
|
{{ end }}
|
||||||
Documentation built with
|
Documentation built with
|
||||||
<a href="https://www.gohugo.io" target="_blank">Hugo</a>
|
<a href="https://www.gohugo.io" target="_blank">Hugo</a>
|
||||||
using the
|
using the
|
||||||
<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
|
<a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
|
||||||
</p>
|
</p>
|
||||||
<p class="quickLinks">
|
<p class="quickLinks">
|
||||||
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">
|
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">
|
||||||
> Privacy Policy
|
> Privacy Policy
|
||||||
</a>
|
</a>
|
||||||
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">
|
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">
|
||||||
> Terms of Use
|
> Terms of Use
|
||||||
</a>
|
</a>
|
||||||
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">
|
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">
|
||||||
> Copyright Agent
|
> Copyright Agent
|
||||||
</a>
|
</a>
|
||||||
<a href="http://www.eclipse.org/legal" target="_blank">
|
<a href="http://www.eclipse.org/legal" target="_blank">
|
||||||
> Legal
|
> Legal
|
||||||
</a>
|
</a>
|
||||||
<a href="https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt" target="_blank">
|
<a href="https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt" target="_blank">
|
||||||
> License
|
> License
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
</aside>
|
</aside>
|
||||||
|
|||||||
@@ -1,82 +1,89 @@
|
|||||||
<nav aria-label="Navigation">
|
<nav aria-label="Navigation">
|
||||||
<a href="{{ with .Site.BaseURL }}{{ . }}{{ else }}{{ .Site.BaseURL }}{{ end }}" class="project">
|
<a class="project" href="{{ with .Site.BaseURL }}{{ . }}{{ else }}{{ .Site.BaseURL }}{{ end }}">
|
||||||
<div class="banner">
|
<div class="banner">
|
||||||
{{ with .Site.Params.logo }}
|
{{ with .Site.Params.logo }}
|
||||||
<div class="logo">
|
<div class="logo">
|
||||||
<img src="{{ $.Site.BaseURL }}{{ . }}">
|
<img src="{{ $.Site.BaseURL }}{{ . }}">
|
||||||
|
</div>
|
||||||
|
{{ end }}
|
||||||
|
<div class="name">
|
||||||
|
<strong>{{ .Site.Title }}™ {{ with .Site.Params.version }}<span class="version">{{ . }}</span>{{
|
||||||
|
end }}</strong>
|
||||||
|
{{ with .Scratch.Get "repo_id" }}
|
||||||
|
<br>
|
||||||
|
{{ . }}
|
||||||
|
{{ end }}
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</a>
|
||||||
|
|
||||||
|
<div class="scrollable">
|
||||||
|
<div class="wrapper">
|
||||||
|
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
||||||
|
<ul class="repo">
|
||||||
|
<li class="repo-download">
|
||||||
|
<a data-action="sandbox" href="https://hawkbit.eclipseprojects.io" target="_blank"
|
||||||
|
title="hawkBit Sandbox">
|
||||||
|
<i class="fas fa-desktop"></i> Sandbox
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li class="repo-stars">
|
||||||
|
<a data-action="star" href="{{ .Site.Params.repo_url }}/stargazers" target="_blank"
|
||||||
|
title="Stargazers">
|
||||||
|
<i class="icon icon-star"></i> Stars
|
||||||
|
<span class="count">–</span>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
<hr>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
<div class="toc">
|
||||||
|
{{ if gt (len .Site.Menus.main) 0 }}
|
||||||
|
<ul>
|
||||||
|
{{ partial "nav" . }}
|
||||||
|
</ul>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
{{ if isset .Site.Params "author" }}
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>
|
||||||
|
<a href="https://opensource.org/licenses/EPL-2.0" target="_blank" title="License">
|
||||||
|
<img src="https://img.shields.io/badge/License-EPL%202.0-green.svg"/>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="https://github.com/eclipse-hawkbit/hawkbit/actions/workflows/verify.yml"
|
||||||
|
target="_blank" title="License">
|
||||||
|
<img src="https://github.com/eclipse-hawkbit/hawkbit/actions/workflows/verify.yml/badge.svg?branch=master"/>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="https://sonarcloud.io/summary/new_code?id=eclipse-hawkbit_hawkbit"
|
||||||
|
target="_blank" title="Sonarcloud Status">
|
||||||
|
<img src="https://sonarcloud.io/api/project_badges/measure?project=eclipse-hawkbit_hawkbit&metric=alert_status"/>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="https://search.maven.org/search?q=g:org.eclipse.hawkbit" target="_blank"
|
||||||
|
title="Maven Central Status">
|
||||||
|
<img src="https://img.shields.io/maven-central/v/org.eclipse.hawkbit/hawkbit-parent?label=maven-central&color=blue"/>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
|
||||||
|
<li>
|
||||||
|
<a href="https://gitter.im/eclipse/hawkbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"
|
||||||
|
target="_blank" title="Chat on Gitter">
|
||||||
|
<img src="https://badges.gitter.im/eclipse/hawkbit.svg"/>
|
||||||
|
</a>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
{{ end }}
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
{{ end }}
|
|
||||||
<div class="name">
|
|
||||||
<strong>{{ .Site.Title }}™ {{ with .Site.Params.version }}<span class="version">{{ . }}</span>{{ end }}</strong>
|
|
||||||
{{ with .Scratch.Get "repo_id" }}
|
|
||||||
<br>
|
|
||||||
{{ . }}
|
|
||||||
{{ end }}
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</a>
|
|
||||||
|
|
||||||
<div class="scrollable">
|
|
||||||
<div class="wrapper">
|
|
||||||
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
|
||||||
<ul class="repo">
|
|
||||||
<li class="repo-download">
|
|
||||||
<a href="https://hawkbit.eclipseprojects.io" target="_blank" title="hawkBit Sandbox" data-action="sandbox">
|
|
||||||
<i class="fas fa-desktop"></i> Sandbox
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
<li class="repo-stars">
|
|
||||||
<a href="{{ .Site.Params.repo_url }}/stargazers" target="_blank" title="Stargazers" data-action="star">
|
|
||||||
<i class="icon icon-star"></i> Stars
|
|
||||||
<span class="count">–</span>
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
<hr>
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
<div class="toc">
|
|
||||||
{{ if gt (len .Site.Menus.main) 0 }}
|
|
||||||
<ul>
|
|
||||||
{{ partial "nav" . }}
|
|
||||||
</ul>
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
{{ if isset .Site.Params "author" }}
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
<li>
|
|
||||||
<a href="https://opensource.org/licenses/EPL-2.0" title="License" target="_blank">
|
|
||||||
<img src="https://img.shields.io/badge/License-EPL%202.0-green.svg" />
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li>
|
|
||||||
<a href="https://github.com/eclipse-hawkbit/hawkbit/actions/workflows/verify.yml" title="License" target="_blank">
|
|
||||||
<img src="https://github.com/eclipse-hawkbit/hawkbit/actions/workflows/verify.yml/badge.svg?branch=master" />
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
<a href="https://sonarcloud.io/summary/new_code?id=eclipse-hawkbit_hawkbit" title="Sonarcloud Status" target="_blank">
|
|
||||||
<img src="https://sonarcloud.io/api/project_badges/measure?project=eclipse-hawkbit_hawkbit&metric=alert_status" />
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li>
|
|
||||||
<a href="https://search.maven.org/search?q=g:org.eclipse.hawkbit" title="Maven Central Status" target="_blank">
|
|
||||||
<img src="https://img.shields.io/maven-central/v/org.eclipse.hawkbit/hawkbit-parent?label=maven-central&color=blue" />
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
|
|
||||||
<li>
|
|
||||||
<a href="https://gitter.im/eclipse/hawkbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge" title="Chat on Gitter" target="_blank">
|
|
||||||
<img src="https://badges.gitter.im/eclipse/hawkbit.svg" />
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
{{ end }}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</nav>
|
</nav>
|
||||||
|
|||||||
@@ -1,60 +1,87 @@
|
|||||||
<script>
|
<script>
|
||||||
{{ with .Scratch.Get "repo_id" }}
|
{
|
||||||
var base_url = '{{ (printf "%s" $.Site.BaseURL) | safeJS }}';
|
{
|
||||||
var repo_id = '{{ . | safeJS }}';
|
with .
|
||||||
{{ else }}
|
Scratch.Get
|
||||||
var base_url = '';
|
"repo_id"
|
||||||
var repo_id = '';
|
}
|
||||||
{{ end }}
|
}
|
||||||
</script>
|
var base_url = '{{ (printf "%s" $.Site.BaseURL) | safeJS }}';
|
||||||
|
var repo_id = '{{ . | safeJS }}';
|
||||||
|
{
|
||||||
|
{ else
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var base_url = '';
|
||||||
|
var repo_id = '';
|
||||||
|
{
|
||||||
|
{
|
||||||
|
end
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</script>
|
||||||
|
|
||||||
<script src="{{ "javascripts/application.js" | absURL }}"></script>
|
<script javascripts src="{{ "/application.js" | absURL }}"></script>
|
||||||
{{ range .Site.Params.custom_js }}
|
{{ range .Site.Params.custom_js }}
|
||||||
<script src="{{ . | absURL }}"></script>
|
<script src="{{ . | absURL }}"></script>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
{{ "/* Add headers to scrollspy */" | safeJS }}
|
{
|
||||||
var headers = document.getElementsByTagName("h2");
|
{
|
||||||
var scrollspy = document.getElementById('scrollspy');
|
"/* Add headers to scrollspy */" | safeJS
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var headers = document.getElementsByTagName("h2");
|
||||||
|
var scrollspy = document.getElementById('scrollspy');
|
||||||
|
|
||||||
if(scrollspy) {
|
if (scrollspy) {
|
||||||
if(headers.length > 0) {
|
if (headers.length > 0) {
|
||||||
for(var i = 0; i < headers.length; i++) {
|
for (var i = 0; i < headers.length; i++) {
|
||||||
var li = document.createElement("li");
|
var li = document.createElement("li");
|
||||||
li.setAttribute("class", "anchor");
|
li.setAttribute("class", "anchor");
|
||||||
|
|
||||||
var a = document.createElement("a");
|
var a = document.createElement("a");
|
||||||
if(!headers[i].id)
|
if (!headers[i].id)
|
||||||
a.setAttribute("href", headers[i].parentNode.href);
|
a.setAttribute("href", headers[i].parentNode.href);
|
||||||
else
|
else
|
||||||
a.setAttribute("href", "#" + headers[i].id);
|
a.setAttribute("href", "#" + headers[i].id);
|
||||||
a.setAttribute("title", headers[i].innerHTML);
|
a.setAttribute("title", headers[i].innerHTML);
|
||||||
a.innerHTML = headers[i].innerHTML;
|
a.innerHTML = headers[i].innerHTML;
|
||||||
|
|
||||||
li.appendChild(a);
|
li.appendChild(a);
|
||||||
scrollspy.appendChild(li);
|
scrollspy.appendChild(li);
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
scrollspy.parentElement.removeChild(scrollspy)
|
scrollspy.parentElement.removeChild(scrollspy)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
{{ "/* Add permanent link next to the headers */" | safeJS }}
|
{
|
||||||
var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");
|
{
|
||||||
|
"/* Add permanent link next to the headers */" | safeJS
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");
|
||||||
|
|
||||||
for(var i = 0; i < headers.length; i++) {
|
for (var i = 0; i < headers.length; i++) {
|
||||||
var a = document.createElement("a");
|
var a = document.createElement("a");
|
||||||
a.setAttribute("class", "headerlink");
|
a.setAttribute("class", "headerlink");
|
||||||
a.setAttribute("href", "#" + headers[i].id);
|
a.setAttribute("href", "#" + headers[i].id);
|
||||||
a.setAttribute("title", "Permanent link");
|
a.setAttribute("title", "Permanent link");
|
||||||
a.innerHTML = {{ or .Site.Params.permalink "¶" }};
|
a.innerHTML = {
|
||||||
|
{
|
||||||
|
or.Site.Params.permalink
|
||||||
|
"¶"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
;
|
||||||
headers[i].appendChild(a);
|
headers[i].appendChild(a);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
|
<script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
|
||||||
<script>hljs.initHighlightingOnLoad();</script>
|
<script>hljs.initHighlightingOnLoad();</script>
|
||||||
</body>
|
</body>
|
||||||
</html>
|
</html>
|
||||||
|
|||||||
@@ -1,83 +1,103 @@
|
|||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
|
<!--[if lt IE 7 ]>
|
||||||
<!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
|
<html class="no-js ie6"><![endif]-->
|
||||||
<!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
|
<!--[if IE 7 ]>
|
||||||
<!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
|
<html class="no-js ie7"><![endif]-->
|
||||||
<!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
|
<!--[if IE 8 ]>
|
||||||
|
<html class="no-js ie8"><![endif]-->
|
||||||
|
<!--[if IE 9 ]>
|
||||||
|
<html class="no-js ie9"><![endif]-->
|
||||||
|
<!--[if (gt IE 9)|!(IE)]><!-->
|
||||||
|
<html class="no-js"> <!--<![endif]-->
|
||||||
|
|
||||||
<head {{ with .Site.LanguageCode }}lang="{{ . }}"{{ end }}>
|
<head .Site.LanguageCode end with {{ {{ }} }}lang="{{ . }}">
|
||||||
<meta charset="utf-8">
|
<meta charset="utf-8">
|
||||||
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
|
<meta content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1" name="viewport">
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=10" />
|
<meta content="IE=10" http-equiv="X-UA-Compatible"/>
|
||||||
<title>{{ .Title }}{{ if not .IsHome }} - {{ .Site.Title }}{{ end }}</title>
|
<title>{{ .Title }}{{ if not .IsHome }} - {{ .Site.Title }}{{ end }}</title>
|
||||||
{{ hugo.Generator }}
|
{{ hugo.Generator }}
|
||||||
|
|
||||||
{{ with .Site.Params.description }}
|
{{ with .Site.Params.description }}
|
||||||
<meta name="description" content="{{ . }}">
|
<meta content="{{ . }}" name="description">
|
||||||
{{ end }}
|
{{ end }}
|
||||||
<link rel="canonical" href="{{ .Permalink }}">
|
<link href="{{ .Permalink }}" rel="canonical">
|
||||||
{{ with .Site.Params.author }}
|
{{ with .Site.Params.author }}
|
||||||
<meta name="author" content="{{ . }}">
|
<meta content="{{ . }}" name="author">
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
<meta property="og:url" content="{{ .Permalink }}">
|
<meta content="{{ .Permalink }}" property="og:url">
|
||||||
{{ with .Site.Title }}<meta property="og:title" content="{{ . }}">{{ end }}
|
{{ with .Site.Title }}
|
||||||
{{ with .Site.Params.logo }}<meta property="og:image" content="{{ . | absURL }}">{{ end }}
|
<meta content="{{ . }}" property="og:title">
|
||||||
{{ with .Site.Title }}<meta name="apple-mobile-web-app-title" content="{{ . }}">{{ end }}
|
{{ end }}
|
||||||
<meta name="apple-mobile-web-app-capable" content="yes">
|
{{ with .Site.Params.logo }}
|
||||||
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
|
<meta content="{{ . | absURL }}" property="og:image">
|
||||||
|
{{ end }}
|
||||||
|
{{ with .Site.Title }}
|
||||||
|
<meta content="{{ . }}" name="apple-mobile-web-app-title">
|
||||||
|
{{ end }}
|
||||||
|
<meta content="yes" name="apple-mobile-web-app-capable">
|
||||||
|
<meta content="black-translucent" name="apple-mobile-web-app-status-bar-style">
|
||||||
|
|
||||||
{{ if .Params.redirectURL }}<meta http-equiv="refresh" content="1; url={{ .Params.redirectURL }}"/>{{ end }}
|
{{ if .Params.redirectURL }}
|
||||||
|
<meta content="1; url={{ .Params.redirectURL }}" http-equiv="refresh"/>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
<link rel="shortcut icon" type="image/x-icon" href="{{ with .Site.Params.favicon }}{{ . | absURL }}{{ else }}{{ "images/favicon.ico" | absURL }}{{ end }}">
|
<link href="{{ with .Site.Params.favicon }}{{ . | absURL }}{{ else }}{{ " images rel="shortcut icon"
|
||||||
<link rel="icon" type="image/x-icon" href="{{ with .Site.Params.favicon }}{{ . | absURL }}{{ else }}{{ "images/favicon.ico" | absURL }}{{ end }}">
|
type="image/x-icon"
|
||||||
|
/favicon.ico" | absURL }}{{ end }}">
|
||||||
|
<link href="{{ with .Site.Params.favicon }}{{ . | absURL }}{{ else }}{{ " images rel="icon" type="image/x-icon"
|
||||||
|
/favicon.ico" | absURL }}{{ end }}">
|
||||||
|
|
||||||
<style>
|
<style>
|
||||||
@font-face {
|
@font-face {
|
||||||
font-family: 'Icon';
|
font-family: 'Icon';
|
||||||
src: url('{{ "fonts/icon.eot?52m981" | absURL }}');
|
src: url('{{ "fonts/icon.eot?52m981" | absURL }}');
|
||||||
src: url('{{ "fonts/icon.eot?#iefix52m981" | absURL }}')
|
src: url('{{ "fonts/icon.eot?#iefix52m981" | absURL }}') format('embedded-opentype'),
|
||||||
format('embedded-opentype'),
|
url('{{ "fonts/icon.woff?52m981" | absURL }}') format('woff'),
|
||||||
url('{{ "fonts/icon.woff?52m981" | absURL }}')
|
url('{{ "fonts/icon.ttf?52m981" | absURL }}') format('truetype'),
|
||||||
format('woff'),
|
url('{{ "fonts/icon.svg?52m981#icon" | absURL }}') format('svg');
|
||||||
url('{{ "fonts/icon.ttf?52m981" | absURL }}')
|
font-weight: normal;
|
||||||
format('truetype'),
|
font-style: normal;
|
||||||
url('{{ "fonts/icon.svg?52m981#icon" | absURL }}')
|
}
|
||||||
format('svg');
|
|
||||||
font-weight: normal;
|
|
||||||
font-style: normal;
|
|
||||||
}
|
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
<link rel="stylesheet" href="{{ "stylesheets/application.css" | absURL }}">
|
<link href="{{ " rel="stylesheet" stylesheets
|
||||||
<link rel="stylesheet" href="{{ "stylesheets/temporary.css" | absURL }}">
|
/application.css" | absURL }}">
|
||||||
<link rel="stylesheet" href="{{ "stylesheets/palettes.css" | absURL }}">
|
<link href="{{ " rel="stylesheet" stylesheets
|
||||||
<link rel="stylesheet" href="{{ with .Site.Params.highlight_css }}{{ . | absURL }}{{ else }}{{ "stylesheets/highlight/highlight.css" | absURL }}{{ end }}">
|
/temporary.css" | absURL }}">
|
||||||
|
<link href="{{ " rel="stylesheet" stylesheets
|
||||||
|
/palettes.css" | absURL }}">
|
||||||
|
<link href="{{ with .Site.Params.highlight_css }}{{ . | absURL }}{{ else }}{{ " rel="stylesheet" stylesheets
|
||||||
|
/highlight/highlight.css" | absURL }}{{ end }}">
|
||||||
|
|
||||||
{{/* set default values if no custom ones are defined */}}
|
{{/* set default values if no custom ones are defined */}}
|
||||||
{{ $text := or .Site.Params.font.text "Roboto" }}
|
{{ $text := or .Site.Params.font.text "Roboto" }}
|
||||||
{{ $code := or .Site.Params.font.code "Roboto Mono" }}
|
{{ $code := or .Site.Params.font.code "Roboto Mono" }}
|
||||||
<link rel="stylesheet" href="//fonts.googleapis.com/css?family={{ $text }}:400,700|{{ replace $code " " "+" | safeURL }}">
|
<link href="//fonts.googleapis.com/css?family={{ $text }}:400,700|{{ replace $code " rel="stylesheet"
|
||||||
|
" "+" | safeURL }}">
|
||||||
<style>
|
<style>
|
||||||
body, input {
|
body, input {
|
||||||
font-family: '{{ $text }}', Helvetica, Arial, sans-serif;
|
font-family: '{{ $text }}', Helvetica, Arial, sans-serif;
|
||||||
}
|
}
|
||||||
pre, code {
|
|
||||||
font-family: '{{ $code }}', 'Courier New', 'Courier', monospace;
|
pre, code {
|
||||||
}
|
font-family: '{{ $code }}', 'Courier New', 'Courier', monospace;
|
||||||
|
}
|
||||||
</style>
|
</style>
|
||||||
|
|
||||||
{{ range .Site.Params.custom_css }}
|
{{ range .Site.Params.custom_css }}
|
||||||
<link rel="stylesheet" href="{{ . | absURL }}">
|
<link href="{{ . | absURL }}" rel="stylesheet">
|
||||||
{{ end }}
|
{{ end }}
|
||||||
<script src="{{ "javascripts/modernizr.js" | absURL }}"></script>
|
<script javascripts src="{{ "
|
||||||
|
/modernizr.js" | absURL }}"></script>
|
||||||
<script src="//www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
|
<script src="//www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
|
||||||
|
|
||||||
{{ with .OutputFormats.Get "RSS" }}
|
{{ with .OutputFormats.Get "RSS" }}
|
||||||
<link href="{{ . }}" rel="alternate" type="application/rss+xml" title="{{ $.Site.Title }}" />
|
<link href="{{ . }}" rel="alternate" title="{{ $.Site.Title }}" type="application/rss+xml"/>
|
||||||
<link href="{{ . }}" rel="feed" type="application/rss+xml" title="{{ $.Site.Title }}" />
|
<link href="{{ . }}" rel="feed" title="{{ $.Site.Title }}" type="application/rss+xml"/>
|
||||||
{{ end }}
|
{{ end }}
|
||||||
|
|
||||||
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
|
<link crossorigin="anonymous" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css"
|
||||||
</head>
|
integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" rel="stylesheet">
|
||||||
<body class="{{ with .Site.Params.palette.primary }}palette-primary-{{ . }}{{end }} {{ with .Site.Params.palette.accent }}palette-accent-{{ . }}{{ end }}">
|
</head>
|
||||||
|
<body class="{{ with .Site.Params.palette.primary }}palette-primary-{{ . }}{{end }} {{ with .Site.Params.palette.accent }}palette-accent-{{ . }}{{ end }}">
|
||||||
|
|||||||
@@ -1,57 +1,62 @@
|
|||||||
<nav aria-label="Header">
|
<nav aria-label="Header">
|
||||||
<div class="bar default">
|
<div class="bar default">
|
||||||
<div class="button button-menu" role="button" aria-label="Menu">
|
<div aria-label="Menu" class="button button-menu" role="button">
|
||||||
<label class="toggle-button icon icon-menu" for="toggle-drawer">
|
<label class="toggle-button icon icon-menu" for="toggle-drawer">
|
||||||
<span></span>
|
<span></span>
|
||||||
</label>
|
</label>
|
||||||
</div>
|
</div>
|
||||||
<div class="stretch">
|
<div class="stretch">
|
||||||
<div class="title">
|
<div class="title">
|
||||||
{{ .Title | safeHTML }}
|
{{ .Title | safeHTML }}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
{{ with .Site.Social.twitter }}
|
{{ with .Site.Social.twitter }}
|
||||||
<div class="button button-twitter" role="button" aria-label="Twitter">
|
<div aria-label="Twitter" class="button button-twitter" role="button">
|
||||||
<a href="https://twitter.com/{{ . }}" title="@{{ . }} on Twitter" target="_blank" class="toggle-button icon icon-twitter"></a>
|
<a class="toggle-button icon icon-twitter" href="https://twitter.com/{{ . }}" target="_blank"
|
||||||
</div>
|
title="@{{ . }} on Twitter"></a>
|
||||||
{{ end }}
|
</div>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
{{ with .Site.Social.github }}
|
{{ with .Site.Social.github }}
|
||||||
<div class="button button-github" role="button" aria-label="GitHub">
|
<div aria-label="GitHub" class="button button-github" role="button">
|
||||||
<a href="https://github.com/{{ . }}" title="@{{ . }} on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
|
<a class="toggle-button icon icon-github" href="https://github.com/{{ . }}" target="_blank"
|
||||||
</div>
|
title="@{{ . }} on GitHub"></a>
|
||||||
{{ end }}
|
</div>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
{{ with .Site.Social.gitter }}
|
{{ with .Site.Social.gitter }}
|
||||||
<div class="button button-github" role="button" aria-label="Gitter">
|
<div aria-label="Gitter" class="button button-github" role="button">
|
||||||
<a href="https://gitter.im/{{ . }}" title="@{{ . }} on Gitter" target="_blank" class="toggle-button icon fab fa-gitter"></a>
|
<a class="toggle-button icon fab fa-gitter" href="https://gitter.im/{{ . }}" target="_blank"
|
||||||
</div>
|
title="@{{ . }} on Gitter"></a>
|
||||||
{{ end }}
|
</div>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
{{ with .Site.Social.docker }}
|
{{ with .Site.Social.docker }}
|
||||||
<div class="button button-github" role="button" aria-label="Docker">
|
<div aria-label="Docker" class="button button-github" role="button">
|
||||||
<a href="https://hub.docker.com/u/{{ . }}" title="{{ . }} on Docker Hub" target="_blank" class="toggle-button icon fab fa-docker"></a>
|
<a class="toggle-button icon fab fa-docker" href="https://hub.docker.com/u/{{ . }}" target="_blank"
|
||||||
|
title="{{ . }} on Docker Hub"></a>
|
||||||
|
</div>
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
|
<!-- TODO: disabled until Hugo supports the generation of a content index natively
|
||||||
|
<div class="button button-search" role="button" aria-label="Search">
|
||||||
|
<label class="toggle-button icon icon-search" title="Search" for="toggle-search"></label>
|
||||||
|
</div>
|
||||||
|
-->
|
||||||
</div>
|
</div>
|
||||||
{{ end }}
|
<div class="bar search">
|
||||||
|
<div aria-label="Close" class="button button-close" role="button">
|
||||||
<!-- TODO: disabled until Hugo supports the generation of a content index natively
|
<label class="toggle-button icon icon-back" for="toggle-search"></label>
|
||||||
<div class="button button-search" role="button" aria-label="Search">
|
</div>
|
||||||
<label class="toggle-button icon icon-search" title="Search" for="toggle-search"></label>
|
<div class="stretch">
|
||||||
|
<div class="field">
|
||||||
|
<input autocapitalize="off" autocomplete="off" autocorrect="off" class="query" placeholder="Search"
|
||||||
|
spellcheck type="text">
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div aria-label="Search" class="button button-reset" role="button">
|
||||||
|
<button class="toggle-button icon icon-close" id="reset-search"></button>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
-->
|
|
||||||
</div>
|
|
||||||
<div class="bar search">
|
|
||||||
<div class="button button-close" role="button" aria-label="Close">
|
|
||||||
<label class="toggle-button icon icon-back" for="toggle-search"></label>
|
|
||||||
</div>
|
|
||||||
<div class="stretch">
|
|
||||||
<div class="field">
|
|
||||||
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="button button-reset" role="button" aria-label="Search">
|
|
||||||
<button class="toggle-button icon icon-close" id="reset-search"></button>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</nav>
|
</nav>
|
||||||
@@ -2,9 +2,9 @@
|
|||||||
{{ $isCurrent := eq .Permalink ($currentMenuEntry.URL | absURL | printf "%s") }}
|
{{ $isCurrent := eq .Permalink ($currentMenuEntry.URL | absURL | printf "%s") }}
|
||||||
|
|
||||||
|
|
||||||
<a {{ if $isCurrent }}class="current"{{ end }} title="{{ $currentMenuEntry.Name }}" href="{{ $currentMenuEntry.URL }}">
|
<a $isCurrent end href="{{ $currentMenuEntry.URL }}" if title="{{ $currentMenuEntry.Name }}" {{ {{ }} }}class="current">
|
||||||
{{ $currentMenuEntry.Pre }}
|
{{ $currentMenuEntry.Pre }}
|
||||||
{{ $currentMenuEntry.Name }}
|
{{ $currentMenuEntry.Name }}
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
{{ if $isCurrent }}
|
{{ if $isCurrent }}
|
||||||
|
|||||||
271
site/pom.xml
271
site/pom.xml
@@ -9,145 +9,146 @@
|
|||||||
SPDX-License-Identifier: EPL-2.0
|
SPDX-License-Identifier: EPL-2.0
|
||||||
|
|
||||||
-->
|
-->
|
||||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
|
||||||
<modelVersion>4.0.0</modelVersion>
|
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||||
<parent>
|
<modelVersion>4.0.0</modelVersion>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<parent>
|
||||||
<artifactId>hawkbit-parent</artifactId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<version>${revision}</version>
|
<artifactId>hawkbit-parent</artifactId>
|
||||||
</parent>
|
<version>${revision}</version>
|
||||||
|
</parent>
|
||||||
|
|
||||||
<artifactId>site</artifactId>
|
<artifactId>site</artifactId>
|
||||||
<name>hawkBit :: Documentation</name>
|
<name>hawkBit :: Documentation</name>
|
||||||
<description>Documentation for hawkBit</description>
|
<description>Documentation for hawkBit</description>
|
||||||
|
|
||||||
<properties>
|
<properties>
|
||||||
<exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
|
<exec-maven-plugin.version>1.6.0</exec-maven-plugin.version>
|
||||||
</properties>
|
</properties>
|
||||||
|
|
||||||
<profiles>
|
<profiles>
|
||||||
<profile>
|
<profile>
|
||||||
<id>unix</id>
|
<id>unix</id>
|
||||||
<activation>
|
<activation>
|
||||||
<os>
|
<os>
|
||||||
<family>!windows</family>
|
<family>!windows</family>
|
||||||
</os>
|
</os>
|
||||||
</activation>
|
</activation>
|
||||||
<properties>
|
<properties>
|
||||||
<shell>/bin/bash</shell>
|
<shell>/bin/bash</shell>
|
||||||
<shell.option/>
|
<shell.option/>
|
||||||
<batch.ext>sh</batch.ext>
|
<batch.ext>sh</batch.ext>
|
||||||
</properties>
|
</properties>
|
||||||
</profile>
|
</profile>
|
||||||
<profile>
|
<profile>
|
||||||
<id>windows</id>
|
<id>windows</id>
|
||||||
<activation>
|
<activation>
|
||||||
<os>
|
<os>
|
||||||
<family>windows</family>
|
<family>windows</family>
|
||||||
</os>
|
</os>
|
||||||
</activation>
|
</activation>
|
||||||
<properties>
|
<properties>
|
||||||
<shell>cmd</shell>
|
<shell>cmd</shell>
|
||||||
<shell.option>/c</shell.option>
|
<shell.option>/c</shell.option>
|
||||||
<batch.ext>bat</batch.ext>
|
<batch.ext>bat</batch.ext>
|
||||||
</properties>
|
</properties>
|
||||||
</profile>
|
</profile>
|
||||||
</profiles>
|
</profiles>
|
||||||
|
|
||||||
<build>
|
<build>
|
||||||
<plugins>
|
<plugins>
|
||||||
<plugin>
|
<plugin>
|
||||||
<groupId>org.codehaus.mojo</groupId>
|
<groupId>org.codehaus.mojo</groupId>
|
||||||
<artifactId>exec-maven-plugin</artifactId>
|
<artifactId>exec-maven-plugin</artifactId>
|
||||||
<version>${exec-maven-plugin.version}</version>
|
<version>${exec-maven-plugin.version}</version>
|
||||||
<executions>
|
<executions>
|
||||||
<execution>
|
<execution>
|
||||||
<id>build-htmls</id>
|
<id>build-htmls</id>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>exec</goal>
|
<goal>exec</goal>
|
||||||
</goals>
|
</goals>
|
||||||
<phase>install</phase>
|
<phase>install</phase>
|
||||||
<configuration>
|
<configuration>
|
||||||
<executable>${shell}</executable>
|
<executable>${shell}</executable>
|
||||||
<workingDirectory>${project.basedir}</workingDirectory>
|
<workingDirectory>${project.basedir}</workingDirectory>
|
||||||
<arguments>
|
<arguments>
|
||||||
<argument>${shell.option}</argument>
|
<argument>${shell.option}</argument>
|
||||||
<argument>build-htmls.${batch.ext}</argument>
|
<argument>build-htmls.${batch.ext}</argument>
|
||||||
</arguments>
|
</arguments>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
<execution>
|
<execution>
|
||||||
<id>install-hugo-theme</id>
|
<id>install-hugo-theme</id>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>exec</goal>
|
<goal>exec</goal>
|
||||||
</goals>
|
</goals>
|
||||||
<phase>install</phase>
|
<phase>install</phase>
|
||||||
<configuration>
|
<configuration>
|
||||||
<executable>${shell}</executable>
|
<executable>${shell}</executable>
|
||||||
<workingDirectory>${project.basedir}</workingDirectory>
|
<workingDirectory>${project.basedir}</workingDirectory>
|
||||||
<arguments>
|
<arguments>
|
||||||
<argument>${shell.option}</argument>
|
<argument>${shell.option}</argument>
|
||||||
<argument>install-theme.${batch.ext}</argument>
|
<argument>install-theme.${batch.ext}</argument>
|
||||||
</arguments>
|
</arguments>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
<execution>
|
<execution>
|
||||||
<id>serve</id>
|
<id>serve</id>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>exec</goal>
|
<goal>exec</goal>
|
||||||
</goals>
|
</goals>
|
||||||
<phase>site</phase>
|
<phase>site</phase>
|
||||||
<configuration>
|
<configuration>
|
||||||
<executable>hugo</executable>
|
<executable>hugo</executable>
|
||||||
<workingDirectory>${project.basedir}</workingDirectory>
|
<workingDirectory>${project.basedir}</workingDirectory>
|
||||||
<arguments>
|
<arguments>
|
||||||
<argument>server</argument>
|
<argument>server</argument>
|
||||||
</arguments>
|
</arguments>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
<execution>
|
<execution>
|
||||||
<id>cleanup</id>
|
<id>cleanup</id>
|
||||||
<goals>
|
<goals>
|
||||||
<goal>exec</goal>
|
<goal>exec</goal>
|
||||||
</goals>
|
</goals>
|
||||||
<phase>clean</phase>
|
<phase>clean</phase>
|
||||||
<configuration>
|
<configuration>
|
||||||
<executable>${shell}</executable>
|
<executable>${shell}</executable>
|
||||||
<workingDirectory>${project.basedir}</workingDirectory>
|
<workingDirectory>${project.basedir}</workingDirectory>
|
||||||
<arguments>
|
<arguments>
|
||||||
<argument>${shell.option}</argument>
|
<argument>${shell.option}</argument>
|
||||||
<argument>cleanup.${batch.ext}</argument>
|
<argument>cleanup.${batch.ext}</argument>
|
||||||
</arguments>
|
</arguments>
|
||||||
</configuration>
|
</configuration>
|
||||||
</execution>
|
</execution>
|
||||||
</executions>
|
</executions>
|
||||||
</plugin>
|
</plugin>
|
||||||
</plugins>
|
</plugins>
|
||||||
</build>
|
</build>
|
||||||
|
|
||||||
<dependencies>
|
<dependencies>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-boot-starter</artifactId>
|
<artifactId>hawkbit-boot-starter</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
|
|
||||||
<!-- Test -->
|
<!-- Test -->
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>io.qameta.allure</groupId>
|
<groupId>io.qameta.allure</groupId>
|
||||||
<artifactId>allure-junit5</artifactId>
|
<artifactId>allure-junit5</artifactId>
|
||||||
<scope>test</scope>
|
<scope>test</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.springframework.boot</groupId>
|
<groupId>org.springframework.boot</groupId>
|
||||||
<artifactId>spring-boot-starter-test</artifactId>
|
<artifactId>spring-boot-starter-test</artifactId>
|
||||||
<scope>test</scope>
|
<scope>test</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
<dependency>
|
<dependency>
|
||||||
<groupId>org.eclipse.hawkbit</groupId>
|
<groupId>org.eclipse.hawkbit</groupId>
|
||||||
<artifactId>hawkbit-repository-test</artifactId>
|
<artifactId>hawkbit-repository-test</artifactId>
|
||||||
<version>${project.version}</version>
|
<version>${project.version}</version>
|
||||||
<scope>test</scope>
|
<scope>test</scope>
|
||||||
</dependency>
|
</dependency>
|
||||||
</dependencies>
|
</dependencies>
|
||||||
</project>
|
</project>
|
||||||
@@ -16,7 +16,6 @@ import org.springframework.boot.autoconfigure.SpringBootApplication;
|
|||||||
/**
|
/**
|
||||||
* A {@link SpringBootApplication} annotated class with a main method to start.
|
* A {@link SpringBootApplication} annotated class with a main method to start.
|
||||||
* The minimal configuration for the stand alone hawkBit server.
|
* The minimal configuration for the stand alone hawkBit server.
|
||||||
*
|
|
||||||
*/
|
*/
|
||||||
@SpringBootApplication
|
@SpringBootApplication
|
||||||
@EnableHawkbitManagedSecurityConfiguration
|
@EnableHawkbitManagedSecurityConfiguration
|
||||||
@@ -27,8 +26,7 @@ public class Start {
|
|||||||
/**
|
/**
|
||||||
* Main method to start the spring-boot application.
|
* Main method to start the spring-boot application.
|
||||||
*
|
*
|
||||||
* @param args
|
* @param args the VM arguments.
|
||||||
* the VM arguments.
|
|
||||||
*/
|
*/
|
||||||
// Exception squid:S2095 - Spring boot standard behavior
|
// Exception squid:S2095 - Spring boot standard behavior
|
||||||
@SuppressWarnings({ "squid:S2095" })
|
@SuppressWarnings({ "squid:S2095" })
|
||||||
|
|||||||
@@ -34,8 +34,9 @@ import java.util.List;
|
|||||||
import static org.assertj.core.api.Assertions.assertThat;
|
import static org.assertj.core.api.Assertions.assertThat;
|
||||||
|
|
||||||
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
|
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
|
||||||
@ExtendWith({SharedSqlTestDatabaseExtension.class})
|
@ExtendWith({ SharedSqlTestDatabaseExtension.class })
|
||||||
class RestApiDocTest {
|
class RestApiDocTest {
|
||||||
|
|
||||||
private static final String MANAGEMENT_PREFIX = "mgmt";
|
private static final String MANAGEMENT_PREFIX = "mgmt";
|
||||||
private static final String DDI_PREFIX = "ddi";
|
private static final String DDI_PREFIX = "ddi";
|
||||||
private static final String TARGET_DIRECTORY = "content/rest-api/";
|
private static final String TARGET_DIRECTORY = "content/rest-api/";
|
||||||
@@ -87,6 +88,7 @@ class RestApiDocTest {
|
|||||||
|
|
||||||
((ObjectNode) rootNode).set("tags", modifiedTagsNode);
|
((ObjectNode) rootNode).set("tags", modifiedTagsNode);
|
||||||
}
|
}
|
||||||
|
|
||||||
private static void removePaths(final JsonNode rootNode, final boolean isMgmt) {
|
private static void removePaths(final JsonNode rootNode, final boolean isMgmt) {
|
||||||
final ObjectNode pathsNode = (ObjectNode) rootNode.get("paths");
|
final ObjectNode pathsNode = (ObjectNode) rootNode.get("paths");
|
||||||
final List<String> fieldsToRemove = new ArrayList<>();
|
final List<String> fieldsToRemove = new ArrayList<>();
|
||||||
|
|||||||
@@ -6,243 +6,275 @@
|
|||||||
|
|
||||||
<title>Eclipse hawkBit</title>
|
<title>Eclipse hawkBit</title>
|
||||||
|
|
||||||
<meta name="description" content="Eclipse hawkBit - Community Day 2018">
|
<meta content="Eclipse hawkBit - Community Day 2018" name="description">
|
||||||
|
|
||||||
<meta name="apple-mobile-web-app-capable" content="yes" />
|
<meta content="yes" name="apple-mobile-web-app-capable"/>
|
||||||
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
|
<meta content="black-translucent" name="apple-mobile-web-app-status-bar-style"/>
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
|
<meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui"
|
||||||
|
name="viewport">
|
||||||
|
|
||||||
<link rel="stylesheet" href="css/reveal.css">
|
<link href="css/reveal.css" rel="stylesheet">
|
||||||
<link rel="stylesheet" href="css/theme/hawkBit.css" id="theme">
|
<link href="css/theme/hawkBit.css" id="theme" rel="stylesheet">
|
||||||
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css" integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU"
|
<link crossorigin="anonymous" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css"
|
||||||
crossorigin="anonymous">
|
integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU"
|
||||||
|
rel="stylesheet">
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
<div class="reveal">
|
<div class="reveal">
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<img src="resources/images/hawkbit_logo.png" width="120px" align="right" />
|
<img align="right" src="resources/images/hawkbit_logo.png" width="120px"/>
|
||||||
</div>
|
</div>
|
||||||
<div class="slides">
|
<div class="slides">
|
||||||
<section>
|
<section>
|
||||||
<div class="intro">
|
<div class="intro">
|
||||||
<h1>Community Day - Eclipse hawkBit</h1>
|
<h1>Community Day - Eclipse hawkBit</h1>
|
||||||
<h6>EclipseCon Europe 2018</h6>
|
<h6>EclipseCon Europe 2018</h6>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>Welcome...</h1>
|
||||||
|
<div style="font-size: 1.5em; position:absolute; left:2em; width: 100%;">
|
||||||
|
<div style="display: inline-block;">
|
||||||
|
<a href="https://github.com/laverman"><img
|
||||||
|
align="left"
|
||||||
|
src="https://avatars3.githubusercontent.com/u/9153035?s=120&v=4" style="border-radius: 50%;"></a>
|
||||||
|
<p style="margin-left: 5em; margin-top: 0.5em;">Kai Zimmermann</p>
|
||||||
|
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Project Lead - Microsoft</i>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
<br>
|
||||||
<section>
|
<div style="display: inline-block;">
|
||||||
<h1>Welcome...</h1>
|
<a href="https://github.com/schabdo"><img
|
||||||
<div style="font-size: 1.5em; position:absolute; left:2em; width: 100%;">
|
align="left"
|
||||||
<div style="display: inline-block;">
|
src="https://avatars1.githubusercontent.com/u/18215905?s=120&v=4" style="border-radius: 50%;"></a>
|
||||||
<a href="https://github.com/laverman"><img src="https://avatars3.githubusercontent.com/u/9153035?s=120&v=4"
|
<p style="margin-left: 5em; margin-top: 0.5em;">Dominic Schabel</p>
|
||||||
style="border-radius: 50%;" align="left"></a>
|
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Committer - Bosch</i>
|
||||||
<p style="margin-left: 5em; margin-top: 0.5em;">Kai Zimmermann</p>
|
|
||||||
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Project Lead - Microsoft</i>
|
|
||||||
</div>
|
|
||||||
<br>
|
|
||||||
<div style="display: inline-block;">
|
|
||||||
<a href="https://github.com/schabdo"><img src="https://avatars1.githubusercontent.com/u/18215905?s=120&v=4"
|
|
||||||
style="border-radius: 50%;" align="left"></a>
|
|
||||||
<p style="margin-left: 5em; margin-top: 0.5em;">Dominic Schabel</p>
|
|
||||||
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Committer - Bosch</i>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</div>
|
||||||
<section>
|
</section>
|
||||||
<h1>About</h1>
|
<section>
|
||||||
<p>
|
<h1>About</h1>
|
||||||
Eclipse hawkBit aims to create a <b>domain independent</b> back end solution for rolling out <b>software
|
<p>
|
||||||
updates</b>
|
Eclipse hawkBit aims to create a <b>domain independent</b> back end solution for rolling out <b>software
|
||||||
to constrained edge devices as well as more powerful controllers and gateways connected to IP based
|
updates</b>
|
||||||
networking infrastructure
|
to constrained edge devices as well as more powerful controllers and gateways connected to IP based
|
||||||
</p>
|
networking infrastructure
|
||||||
</section>
|
</p>
|
||||||
<section>
|
</section>
|
||||||
<h1>Big picture</h1>
|
<section>
|
||||||
<img src="resources/images/hawkBit_overview.jpg">
|
<h1>Big picture</h1>
|
||||||
</section>
|
<img src="resources/images/hawkBit_overview.jpg">
|
||||||
<section>
|
</section>
|
||||||
<h1>Project update...</h1>
|
<section>
|
||||||
</section>
|
<h1>Project update...</h1>
|
||||||
<section>
|
</section>
|
||||||
<h1>New team members</h1>
|
<section>
|
||||||
<div style="font-size: 1.5em; position:absolute; left:2em; width: 100%;">
|
<h1>New team members</h1>
|
||||||
<div style="display: inline-block;">
|
<div style="font-size: 1.5em; position:absolute; left:2em; width: 100%;">
|
||||||
<a href="https://github.com/laverman"><img src="https://avatars3.githubusercontent.com/u/19288577?s=120&v=4"
|
<div style="display: inline-block;">
|
||||||
style="border-radius: 50%;" align="left"></a>
|
<a href="https://github.com/laverman"><img
|
||||||
<p style="margin-left: 5em; margin-top: 0.5em;">Jeroen Laverman</p>
|
align="left"
|
||||||
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Project Lead - Bosch</i>
|
src="https://avatars3.githubusercontent.com/u/19288577?s=120&v=4" style="border-radius: 50%;"></a>
|
||||||
</div>
|
<p style="margin-left: 5em; margin-top: 0.5em;">Jeroen Laverman</p>
|
||||||
<br>
|
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Project Lead - Bosch</i>
|
||||||
<div style="display: inline-block;">
|
|
||||||
<a href="https://github.com/stefbehl"><img src="https://avatars2.githubusercontent.com/u/16321153?s=120&v=4"
|
|
||||||
style="border-radius: 50%;" align="left"></a>
|
|
||||||
<p style="margin-left: 5em; margin-top: 0.5em;">Stefan Behl</p>
|
|
||||||
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Committer - Bosch</i>
|
|
||||||
</div>
|
|
||||||
<br>
|
|
||||||
<div style="display: inline-block;">
|
|
||||||
<a href="https://github.com/schabdo"><img src="https://avatars1.githubusercontent.com/u/18215905?s=120&v=4"
|
|
||||||
style="border-radius: 50%;" align="left"></a>
|
|
||||||
<p style="margin-left: 5em; margin-top: 0.5em;">Dominic Schabel</p>
|
|
||||||
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Committer - Bosch</i>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</section>
|
<br>
|
||||||
<section>
|
<div style="display: inline-block;">
|
||||||
<h1>Statistics (10/2018)</h1>
|
<a href="https://github.com/stefbehl"><img
|
||||||
<ul style="position:absolute; left:2em;">
|
align="left"
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit">hawkbit Core</a>: 149
|
src="https://avatars2.githubusercontent.com/u/16321153?s=120&v=4" style="border-radius: 50%;"></a>
|
||||||
stars, 622 PRs, 134 issues</li>
|
<p style="margin-left: 5em; margin-top: 0.5em;">Stefan Behl</p>
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-extensions">hawkbit
|
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Committer - Bosch</i>
|
||||||
Extensions</a>: 30 PRs</li>
|
</div>
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-examples">hawkbit
|
<br>
|
||||||
Examples</a>: 25 PRs</li>
|
<div style="display: inline-block;">
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://hub.docker.com/u/hawkbit/">Docker Hub</a>: 3.4K
|
<a href="https://github.com/schabdo"><img
|
||||||
PULLS</li>
|
align="left"
|
||||||
</ul>
|
src="https://avatars1.githubusercontent.com/u/18215905?s=120&v=4" style="border-radius: 50%;"></a>
|
||||||
</section>
|
<p style="margin-left: 5em; margin-top: 0.5em;">Dominic Schabel</p>
|
||||||
<section>
|
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Committer - Bosch</i>
|
||||||
<h1>We have been busy</h1>
|
</div>
|
||||||
<ul style="position:absolute; left:2em;">
|
</div>
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://search.maven.org/search?q=g:org.eclipse.hawkbit%20AND%20v:0.2.0">First
|
</section>
|
||||||
Release<a></li>
|
<section>
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://hawkbit.eclipseprojects.io">New sandbox</a></li>
|
<h1>Statistics (10/2018)</h1>
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://www.eclipse.org/hawkbit">New homepage</a></li>
|
<ul style="position:absolute; left:2em;">
|
||||||
<li style="margin-bottom: 0.5em">Circle CI 2.0 (incl. <a href="https://github.com/eclipse-hawkbit/hawkbit-examples">examples</a>
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit">hawkbit Core</a>:
|
||||||
& <a href="https://github.com/eclipse-hawkbit/hawkbit-extensions">extensions</a>)</li>
|
149
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://hub.docker.com/u/hawkbit">Docker Hub setup</a></li>
|
stars, 622 PRs, 134 issues
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit/pull/688">Open sourced
|
</li>
|
||||||
REST docs</a></li>
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-extensions">hawkbit
|
||||||
</ul>
|
Extensions</a>: 30 PRs
|
||||||
</section>
|
</li>
|
||||||
<section>
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-examples">hawkbit
|
||||||
<h1>Roadmap...</h1>
|
Examples</a>: 25 PRs
|
||||||
</section>
|
</li>
|
||||||
<section>
|
<li style="margin-bottom: 0.5em"><a href="https://hub.docker.com/u/hawkbit/">Docker Hub</a>: 3.4K
|
||||||
<h1>Upgrades, upgrades</h1>
|
PULLS
|
||||||
<ul style="position:absolute; left:2em;">
|
</li>
|
||||||
<li style="margin-bottom: 0.5em">Support JDK 11</li>
|
</ul>
|
||||||
<li style="margin-bottom: 0.5em">Vaadin 8</li>
|
</section>
|
||||||
<li style="margin-bottom: 0.5em">JUnit 5, Java >= 9 </li>
|
<section>
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit/pull/721">Spring Boot
|
<h1>We have been busy</h1>
|
||||||
2</a></li>
|
<ul style="position:absolute; left:2em;">
|
||||||
</ul>
|
<li style="margin-bottom: 0.5em"><a
|
||||||
</section>
|
href="https://search.maven.org/search?q=g:org.eclipse.hawkbit%20AND%20v:0.2.0">First
|
||||||
<section>
|
Release<a></li>
|
||||||
<h1>Version overview</h1>
|
<li style="margin-bottom: 0.5em"><a href="https://hawkbit.eclipseprojects.io">New sandbox</a></li>
|
||||||
<div style="display: grid; grid-template-columns: 8em 5em 8em; grid-template-rows: 1.5em auto 1.5em;
|
<li style="margin-bottom: 0.5em"><a href="https://www.eclipse.org/hawkbit">New homepage</a></li>
|
||||||
|
<li style="margin-bottom: 0.5em">Circle CI 2.0 (incl. <a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit-examples">examples</a>
|
||||||
|
& <a href="https://github.com/eclipse-hawkbit/hawkbit-extensions">extensions</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em"><a href="https://hub.docker.com/u/hawkbit">Docker Hub setup</a></li>
|
||||||
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit/pull/688">Open
|
||||||
|
sourced
|
||||||
|
REST docs</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>Roadmap...</h1>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>Upgrades, upgrades</h1>
|
||||||
|
<ul style="position:absolute; left:2em;">
|
||||||
|
<li style="margin-bottom: 0.5em">Support JDK 11</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Vaadin 8</li>
|
||||||
|
<li style="margin-bottom: 0.5em">JUnit 5, Java >= 9</li>
|
||||||
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit/pull/721">Spring
|
||||||
|
Boot
|
||||||
|
2</a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>Version overview</h1>
|
||||||
|
<div style="display: grid; grid-template-columns: 8em 5em 8em; grid-template-rows: 1.5em auto 1.5em;
|
||||||
grid-gap: 15px 0px; font-size: 1.5em; margin-left: 1.0em; margin-top: 1em;">
|
grid-gap: 15px 0px; font-size: 1.5em; margin-left: 1.0em; margin-top: 1em;">
|
||||||
|
|
||||||
<div style="place-self: center; font-weight:bold;">hawkBit</div>
|
<div style="place-self: center; font-weight:bold;">hawkBit</div>
|
||||||
<div> </div>
|
<div> </div>
|
||||||
<div style="place-self: center; font-weight:bold;">Spring Boot</div>
|
<div style="place-self: center; font-weight:bold;">Spring Boot</div>
|
||||||
<div style="place-self: center;">0.2.x</div>
|
<div style="place-self: center;">0.2.x</div>
|
||||||
<div style="place-self: center;"><i class="fas fa-long-arrow-alt-right"></i></div>
|
<div style="place-self: center;"><i class="fas fa-long-arrow-alt-right"></i></div>
|
||||||
<div style="place-self: center;">1.4</div>
|
<div style="place-self: center;">1.4</div>
|
||||||
<div style="place-self: center;">0.3.0</div>
|
<div style="place-self: center;">0.3.0</div>
|
||||||
<div style="place-self: center;"><i class="fas fa-long-arrow-alt-right"></i></div>
|
<div style="place-self: center;"><i class="fas fa-long-arrow-alt-right"></i></div>
|
||||||
<div style="place-self: center;">2.0</div>
|
<div style="place-self: center;">2.0</div>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<h1>A few features as well</h1>
|
<h1>A few features as well</h1>
|
||||||
<ul style="position:absolute; left:2em;">
|
<ul style="position:absolute; left:2em;">
|
||||||
<li style="margin-bottom: 0.5em">Custom key/value pairs for targets (<a href="https://github.com/eclipse-hawkbit/hawkbit/issues/737">#737</a>)</li>
|
<li style="margin-bottom: 0.5em">Custom key/value pairs for targets (<a
|
||||||
<li style="margin-bottom: 0.5em">Small improvements of rollout management</li>
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/737">#737</a>)
|
||||||
</ul>
|
</li>
|
||||||
</section>
|
<li style="margin-bottom: 0.5em">Small improvements of rollout management</li>
|
||||||
<section>
|
</ul>
|
||||||
<h1>Cloud PaaS extensions...</h1>
|
</section>
|
||||||
<ul style="position:absolute; left:2em;">
|
<section>
|
||||||
<li style="margin-bottom: 0.5em">Inner cluster messaging (<a href="https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about">Azure
|
<h1>Cloud PaaS extensions...</h1>
|
||||||
Event Hubs</a>)</li>
|
<ul style="position:absolute; left:2em;">
|
||||||
<li style="margin-bottom: 0.5em">Multi-user support and role based access with OAuth2 (<a href="https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-whatis">Azure
|
<li style="margin-bottom: 0.5em">Inner cluster messaging (<a
|
||||||
Active Directory</a>)</li>
|
href="https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about">Azure
|
||||||
<li style="margin-bottom: 0.5em">More storage providers (e.g. <a href="https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction">Azure
|
Event Hubs</a>)
|
||||||
Blob Storage</a>)</li>
|
</li>
|
||||||
<li style="margin-bottom: 0.5em">Example k8s deployments (potentially <a href="https://github.com/helm/helm">helm</a>
|
<li style="margin-bottom: 0.5em">Multi-user support and role based access with OAuth2 (<a
|
||||||
templates)</li>
|
href="https://docs.microsoft.com/en-us/azure/active-directory/fundamentals/active-directory-whatis">Azure
|
||||||
<li style="margin-bottom: 0.5em">IoT platform integration (e.g. <a href="https://docs.microsoft.com/en-us/azure/iot-hub/about-iot-hub">Azure
|
Active Directory</a>)
|
||||||
IoT Hub</a>)
|
</li>
|
||||||
</li>
|
<li style="margin-bottom: 0.5em">More storage providers (e.g. <a
|
||||||
</ul>
|
href="https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction">Azure
|
||||||
</section>
|
Blob Storage</a>)
|
||||||
<section>
|
</li>
|
||||||
<h1>Deprecations</h1>
|
<li style="margin-bottom: 0.5em">Example k8s deployments (potentially <a
|
||||||
<div style="position:absolute; left:2em;">We'll drop UAA extension support</div>
|
href="https://github.com/helm/helm">helm</a>
|
||||||
</section>
|
templates)
|
||||||
<section>
|
</li>
|
||||||
<h1>Thank you</h1>
|
<li style="margin-bottom: 0.5em">IoT platform integration (e.g. <a
|
||||||
<div style="font-size: 1.5em; position:absolute; left:2em;">
|
href="https://docs.microsoft.com/en-us/azure/iot-hub/about-iot-hub">Azure
|
||||||
<p><i class="fa fa-bullhorn fa-fw"></i> <a href="https://www.eclipsecon.org/europe2018/sessions/eclipse-hawkbit-101">101
|
IoT Hub</a>)
|
||||||
tutorial</a></p>
|
</li>
|
||||||
<p><i class="fab fa-docker fa-fw"></i> <a href="https://hub.docker.com/u/hawkbit">hawkbit</a></p>
|
</ul>
|
||||||
<p><i class="fab fa-gitter fa-fw"></i> <a href="https://gitter.im/eclipse/hawkbit">eclipse/hawkbit</a></p>
|
</section>
|
||||||
<p><i class="fab fa-github fa-fw"></i> <a href="https://github.com/eclipse-hawkbit/hawkbit">eclipse/hawkbit</a></p>
|
<section>
|
||||||
<p><i class="fa fa-book-open fa-fw"></i> <a href="http://www.eclipse.org/hawkbit">eclipse.org/hawkbit</a></p>
|
<h1>Deprecations</h1>
|
||||||
</div>
|
<div style="position:absolute; left:2em;">We'll drop UAA extension support</div>
|
||||||
</section>
|
</section>
|
||||||
</div>
|
<section>
|
||||||
|
<h1>Thank you</h1>
|
||||||
|
<div style="font-size: 1.5em; position:absolute; left:2em;">
|
||||||
|
<p><i class="fa fa-bullhorn fa-fw"></i> <a
|
||||||
|
href="https://www.eclipsecon.org/europe2018/sessions/eclipse-hawkbit-101">101
|
||||||
|
tutorial</a></p>
|
||||||
|
<p><i class="fab fa-docker fa-fw"></i> <a href="https://hub.docker.com/u/hawkbit">hawkbit</a></p>
|
||||||
|
<p><i class="fab fa-gitter fa-fw"></i> <a
|
||||||
|
href="https://gitter.im/eclipse/hawkbit">eclipse/hawkbit</a></p>
|
||||||
|
<p><i class="fab fa-github fa-fw"></i> <a href="https://github.com/eclipse-hawkbit/hawkbit">eclipse/hawkbit</a>
|
||||||
|
</p>
|
||||||
|
<p><i class="fa fa-book-open fa-fw"></i> <a href="http://www.eclipse.org/hawkbit">eclipse.org/hawkbit</a>
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
</div>
|
</div>
|
||||||
<div class="footer">
|
</div>
|
||||||
<a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a> |
|
<div class="footer">
|
||||||
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> |
|
<a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a> |
|
||||||
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> |
|
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> |
|
||||||
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">Copyright Agent</a> |
|
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> |
|
||||||
<a href="http://www.eclipse.org/legal" target="_blank">Legal</a>
|
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">Copyright Agent</a> |
|
||||||
</div>
|
<a href="http://www.eclipse.org/legal" target="_blank">Legal</a>
|
||||||
<script src="lib/js/head.min.js"></script>
|
</div>
|
||||||
<script src="js/reveal.js"></script>
|
<script src="lib/js/head.min.js"></script>
|
||||||
|
<script src="js/reveal.js"></script>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
// Full list of configuration options available at:
|
// Full list of configuration options available at:
|
||||||
// https://github.com/hakimel/reveal.js#configuration
|
// https://github.com/hakimel/reveal.js#configuration
|
||||||
Reveal.initialize({
|
Reveal.initialize({
|
||||||
controls: false,
|
controls: false,
|
||||||
progress: true,
|
progress: true,
|
||||||
history: true,
|
history: true,
|
||||||
center: true,
|
center: true,
|
||||||
|
|
||||||
transition: 'convex', // none/fade/slide/convex/concave/zoom
|
transition: 'convex', // none/fade/slide/convex/concave/zoom
|
||||||
|
|
||||||
// Optional reveal.js plugins
|
// Optional reveal.js plugins
|
||||||
dependencies: [{
|
dependencies: [{
|
||||||
src: 'lib/js/classList.js',
|
src: 'lib/js/classList.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !document.body.classList;
|
return !document.body.classList;
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/markdown/marked.js',
|
src: 'plugin/markdown/marked.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('[data-markdown]');
|
return !!document.querySelector('[data-markdown]');
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/markdown/markdown.js',
|
src: 'plugin/markdown/markdown.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('[data-markdown]');
|
return !!document.querySelector('[data-markdown]');
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/highlight/highlight.js',
|
src: 'plugin/highlight/highlight.js',
|
||||||
async: true,
|
async: true,
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('pre code');
|
return !!document.querySelector('pre code');
|
||||||
},
|
},
|
||||||
callback: function () {
|
callback: function () {
|
||||||
hljs.initHighlightingOnLoad();
|
hljs.initHighlightingOnLoad();
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/zoom-js/zoom.js',
|
src: 'plugin/zoom-js/zoom.js',
|
||||||
async: true
|
async: true
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/notes/notes.js',
|
src: 'plugin/notes/notes.js',
|
||||||
async: true
|
async: true
|
||||||
}]
|
}]
|
||||||
});
|
});
|
||||||
|
|
||||||
Reveal.configure({
|
Reveal.configure({
|
||||||
slideNumber: true
|
slideNumber: true
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
|
|
||||||
|
|||||||
@@ -16,225 +16,241 @@
|
|||||||
|
|
||||||
<title>Eclipse hawkBit</title>
|
<title>Eclipse hawkBit</title>
|
||||||
|
|
||||||
<meta name="description" content="Eclipse hawkBit - Community Day 2018">
|
<meta content="Eclipse hawkBit - Community Day 2018" name="description">
|
||||||
|
|
||||||
<meta name="apple-mobile-web-app-capable" content="yes" />
|
<meta content="yes" name="apple-mobile-web-app-capable"/>
|
||||||
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
|
<meta content="black-translucent" name="apple-mobile-web-app-status-bar-style"/>
|
||||||
<meta name="viewport"
|
<meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui"
|
||||||
content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
|
name="viewport">
|
||||||
|
|
||||||
<link rel="stylesheet" href="css/reveal.css">
|
<link href="css/reveal.css" rel="stylesheet">
|
||||||
<link rel="stylesheet" href="css/theme/hawkBit.css" id="theme">
|
<link href="css/theme/hawkBit.css" id="theme" rel="stylesheet">
|
||||||
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css"
|
<link crossorigin="anonymous" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css"
|
||||||
integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU" crossorigin="anonymous">
|
integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU" rel="stylesheet">
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
<div class="reveal">
|
<div class="reveal">
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<img src="resources/images/hawkbit_logo.png" width="120px" align="right" />
|
<img align="right" src="resources/images/hawkbit_logo.png" width="120px"/>
|
||||||
</div>
|
</div>
|
||||||
<div class="slides">
|
<div class="slides">
|
||||||
<section>
|
<section>
|
||||||
<div class="intro">
|
<div class="intro">
|
||||||
<h1>Community Day - Eclipse hawkBit</h1>
|
<h1>Community Day - Eclipse hawkBit</h1>
|
||||||
<h6>EclipseCon Europe 2019</h6>
|
<h6>EclipseCon Europe 2019</h6>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>Welcome...</h1>
|
||||||
|
<div style="font-size: 1.5em; position:absolute; left:2em; width: 100%;">
|
||||||
|
<div style="display: inline-block;">
|
||||||
|
<a href="https://github.com/laverman"><img
|
||||||
|
align="left"
|
||||||
|
src="https://avatars3.githubusercontent.com/u/9153035?s=120&v=4" style="border-radius: 50%;"></a>
|
||||||
|
<p style="margin-left: 5em; margin-top: 0.5em;">Kai Zimmermann</p>
|
||||||
|
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Project Lead - Microsoft</i>
|
||||||
</div>
|
</div>
|
||||||
</section>
|
<br>
|
||||||
<section>
|
<div style="display: inline-block;">
|
||||||
<h1>Welcome...</h1>
|
<a href="https://github.com/laverman"><img
|
||||||
<div style="font-size: 1.5em; position:absolute; left:2em; width: 100%;">
|
align="left"
|
||||||
<div style="display: inline-block;">
|
src="https://avatars3.githubusercontent.com/u/19288577?s=120&v=4" style="border-radius: 50%;"></a>
|
||||||
<a href="https://github.com/laverman"><img
|
<p style="margin-left: 5em; margin-top: 0.5em;">Jeroen Laverman</p>
|
||||||
src="https://avatars3.githubusercontent.com/u/9153035?s=120&v=4"
|
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Project Lead - Bosch</i>
|
||||||
style="border-radius: 50%;" align="left"></a>
|
|
||||||
<p style="margin-left: 5em; margin-top: 0.5em;">Kai Zimmermann</p>
|
|
||||||
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Project Lead - Microsoft</i>
|
|
||||||
</div>
|
|
||||||
<br>
|
|
||||||
<div style="display: inline-block;">
|
|
||||||
<a href="https://github.com/laverman"><img
|
|
||||||
src="https://avatars3.githubusercontent.com/u/19288577?s=120&v=4"
|
|
||||||
style="border-radius: 50%;" align="left"></a>
|
|
||||||
<p style="margin-left: 5em; margin-top: 0.5em;">Jeroen Laverman</p>
|
|
||||||
<i style="margin-left: 4em; margin-top: 0.5em; font-size: 0.5em;">Project Lead - Bosch</i>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
</section>
|
</div>
|
||||||
<section>
|
</section>
|
||||||
<h1>About</h1>
|
<section>
|
||||||
<p>
|
<h1>About</h1>
|
||||||
Eclipse hawkBit aims to create a <b>domain independent</b> back end solution for rolling out
|
<p>
|
||||||
<b>software
|
Eclipse hawkBit aims to create a <b>domain independent</b> back end solution for rolling out
|
||||||
updates</b>
|
<b>software
|
||||||
to constrained edge devices as well as more powerful controllers and gateways connected to IP based
|
updates</b>
|
||||||
networking infrastructure
|
to constrained edge devices as well as more powerful controllers and gateways connected to IP based
|
||||||
</p>
|
networking infrastructure
|
||||||
</section>
|
</p>
|
||||||
<section>
|
</section>
|
||||||
<h1>Big picture</h1>
|
<section>
|
||||||
<img src="resources/images/hawkBit_overview.jpg">
|
<h1>Big picture</h1>
|
||||||
</section>
|
<img src="resources/images/hawkBit_overview.jpg">
|
||||||
<section>
|
</section>
|
||||||
<h1>Project update...</h1>
|
<section>
|
||||||
</section>
|
<h1>Project update...</h1>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section>
|
<section>
|
||||||
<h1>Statistics (10/2019)</h1>
|
<h1>Statistics (10/2019)</h1>
|
||||||
<ul style="position:absolute; left:2em;">
|
<ul style="position:absolute; left:2em;">
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit">hawkbit Core</a>: 207
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit">hawkbit Core</a>:
|
||||||
(+58)
|
207
|
||||||
stars, 717 (+95) PRs, 172 (+35) issues</li>
|
(+58)
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-extensions">hawkbit
|
stars, 717 (+95) PRs, 172 (+35) issues
|
||||||
Extensions</a>: 41 (+11) PRs</li>
|
</li>
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-examples">hawkbit
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-extensions">hawkbit
|
||||||
Examples</a>: 35 (+10) PRs</li>
|
Extensions</a>: 41 (+11) PRs
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://hub.docker.com/u/hawkbit/">Docker Hub</a>: 50K+
|
</li>
|
||||||
(+47K)
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-examples">hawkbit
|
||||||
PULLS</li>
|
Examples</a>: 35 (+10) PRs
|
||||||
</ul>
|
</li>
|
||||||
</section>
|
<li style="margin-bottom: 0.5em"><a href="https://hub.docker.com/u/hawkbit/">Docker Hub</a>: 50K+
|
||||||
<section>
|
(+47K)
|
||||||
<h1>We have been busy</h1>
|
PULLS
|
||||||
<ul style="position:absolute; left:2em;">
|
</li>
|
||||||
<li style="margin-bottom: 0.5em">Add Multi-User support (<a
|
</ul>
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/829">#829</a>)</li>
|
</section>
|
||||||
<li style="margin-bottom: 0.5em">Introduce Multi-Assignments (<a
|
<section>
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/833">#833</a>)</li>
|
<h1>We have been busy</h1>
|
||||||
<li style="margin-bottom: 0.5em">Introduce new action-type DOWNLOAD_ONLY (<a
|
<ul style="position:absolute; left:2em;">
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/810">#810</a>)</li>
|
<li style="margin-bottom: 0.5em">Add Multi-User support (<a
|
||||||
<li style="margin-bottom: 0.5em">Execute Auto-Assignments with different action-types (<a
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/829">#829</a>)
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/789">#789</a>)</li>
|
</li>
|
||||||
<li style="margin-bottom: 0.5em">Introduce THING_REMOVED message on DMF-API (<a
|
<li style="margin-bottom: 0.5em">Introduce Multi-Assignments (<a
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/891">#891</a>)</li>
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/833">#833</a>)
|
||||||
<li style="margin-bottom: 0.5em">DDI-API supports SHA256 signature for artifacts (<a
|
</li>
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/869">#869</a>)</li>
|
<li style="margin-bottom: 0.5em">Introduce new action-type DOWNLOAD_ONLY (<a
|
||||||
<li style="margin-bottom: 0.5em">... and <a
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/810">#810</a>)
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pulls?utf8=✓&q=created%3A%3E%3D2018-10-25">many
|
</li>
|
||||||
smaller enhancements and bug fixes </a></li>
|
<li style="margin-bottom: 0.5em">Execute Auto-Assignments with different action-types (<a
|
||||||
</ul>
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/789">#789</a>)
|
||||||
</section>
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Introduce THING_REMOVED message on DMF-API (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/891">#891</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">DDI-API supports SHA256 signature for artifacts (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/869">#869</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">... and <a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pulls?utf8=✓&q=created%3A%3E%3D2018-10-25">many
|
||||||
|
smaller enhancements and bug fixes </a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section>
|
<section>
|
||||||
<h1>Cloud support updates...</h1>
|
<h1>Cloud support updates...</h1>
|
||||||
<ul style="position:absolute; left:2em;">
|
<ul style="position:absolute; left:2em;">
|
||||||
<li style="margin-bottom: 0.5em">Azure: inner cluster messaging (<a
|
<li style="margin-bottom: 0.5em">Azure: inner cluster messaging (<a
|
||||||
href="https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about">with Event
|
href="https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-about">with Event
|
||||||
Hubs</a>)</li>
|
Hubs</a>)
|
||||||
<li style="margin-bottom: 0.5em">Azure: deployment guidance and <a
|
</li>
|
||||||
href="https://github.com/helm/helm">k8s helm</a>
|
<li style="margin-bottom: 0.5em">Azure: deployment guidance and <a
|
||||||
as well as <a
|
href="https://github.com/helm/helm">k8s helm</a>
|
||||||
|
as well as <a
|
||||||
href="https://docs.microsoft.com/en-us/azure/azure-resource-manager/template-deployment-overview">Azure
|
href="https://docs.microsoft.com/en-us/azure/azure-resource-manager/template-deployment-overview">Azure
|
||||||
Resource Manager</a> templates</li>
|
Resource Manager</a> templates
|
||||||
<li style="margin-bottom: 0.5em">More storage providers: <a
|
</li>
|
||||||
href="https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction">Azure
|
<li style="margin-bottom: 0.5em">More storage providers: <a
|
||||||
Blob Storage</a>, <a href="https://cloud.google.com/storage/docs/">Google Cloud Storage</a>
|
href="https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction">Azure
|
||||||
</li>
|
Blob Storage</a>, <a href="https://cloud.google.com/storage/docs/">Google Cloud Storage</a>
|
||||||
</li>
|
</li>
|
||||||
</ul>
|
</li>
|
||||||
</section>
|
</ul>
|
||||||
|
</section>
|
||||||
|
|
||||||
<section>
|
<section>
|
||||||
<h1>Roadmap...</h1>
|
<h1>Roadmap...</h1>
|
||||||
</section>
|
</section>
|
||||||
<section>
|
<section>
|
||||||
<h1>Outlook</h1>
|
<h1>Outlook</h1>
|
||||||
<ul style="position:absolute; left:2em;">
|
<ul style="position:absolute; left:2em;">
|
||||||
<li style="margin-bottom: 0.5em">Vaadin 8 (<a
|
<li style="margin-bottom: 0.5em">Vaadin 8 (<a
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/880">#880</a>)</li>
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/880">#880</a>)
|
||||||
<li style="margin-bottom: 0.5em">Release 0.3.0 (<a
|
</li>
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/784">#784</a>)</li>
|
<li style="margin-bottom: 0.5em">Release 0.3.0 (<a
|
||||||
<li style="margin-bottom: 0.5em">Prioritization of updates (<a
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/784">#784</a>)
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/863">#863</a>)</li>
|
</li>
|
||||||
<li style="margin-bottom: 0.5em">Integration with other device inventories (<a
|
<li style="margin-bottom: 0.5em">Prioritization of updates (<a
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/796">#796</a>)</li>
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/863">#863</a>)
|
||||||
<li style="margin-bottom: 0.5em">Support of new <a
|
</li>
|
||||||
href="https://projects.eclipse.org/projects/iot.packages">Eclipse IoT Packages</a> project
|
<li style="margin-bottom: 0.5em">Integration with other device inventories (<a
|
||||||
</li>
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/796">#796</a>)
|
||||||
</ul>
|
</li>
|
||||||
</section>
|
<li style="margin-bottom: 0.5em">Support of new <a
|
||||||
|
href="https://projects.eclipse.org/projects/iot.packages">Eclipse IoT Packages</a> project
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
<section>
|
||||||
<section>
|
<h1>Thank you</h1>
|
||||||
<h1>Thank you</h1>
|
<div style="font-size: 1.5em; position:absolute; left:2em;">
|
||||||
<div style="font-size: 1.5em; position:absolute; left:2em;">
|
<p><i class="fa fa-bullhorn fa-fw"></i> <a
|
||||||
<p><i class="fa fa-bullhorn fa-fw"></i> <a
|
href="https://www.eclipsecon.org/europe2019/sessions/eclipse-hawkbit-101">101
|
||||||
href="https://www.eclipsecon.org/europe2019/sessions/eclipse-hawkbit-101">101
|
tutorial</a></p>
|
||||||
tutorial</a></p>
|
<p><i class="fa fa-bullhorn fa-fw"></i> <a
|
||||||
<p><i class="fa fa-bullhorn fa-fw"></i> <a
|
href="https://www.eclipsecon.org/europe2019/sessions/eclipse-hawkbit-update-factory-how-take-open-platform-production-sponsored-bosch">From
|
||||||
href="https://www.eclipsecon.org/europe2019/sessions/eclipse-hawkbit-update-factory-how-take-open-platform-production-sponsored-bosch">From
|
Eclipse hawkBit to Update Factory</a></p>
|
||||||
Eclipse hawkBit to Update Factory</a></p>
|
<p><i class="fab fa-docker fa-fw"></i> <a href="https://hub.docker.com/u/hawkbit">hawkbit</a>
|
||||||
<p><i class="fab fa-docker fa-fw"></i> <a href="https://hub.docker.com/u/hawkbit">hawkbit</a>
|
</p>
|
||||||
</p>
|
<p><i class="fab fa-gitter fa-fw"></i> <a
|
||||||
<p><i class="fab fa-gitter fa-fw"></i> <a
|
href="https://gitter.im/eclipse/hawkbit">eclipse/hawkbit</a></p>
|
||||||
href="https://gitter.im/eclipse/hawkbit">eclipse/hawkbit</a></p>
|
<p><i class="fab fa-github fa-fw"></i> <a
|
||||||
<p><i class="fab fa-github fa-fw"></i> <a
|
href="https://github.com/eclipse-hawkbit/hawkbit">eclipse/hawkbit</a></p>
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit">eclipse/hawkbit</a></p>
|
<p><i class="fa fa-book-open fa-fw"></i> <a
|
||||||
<p><i class="fa fa-book-open fa-fw"></i> <a
|
href="http://www.eclipse.org/hawkbit">eclipse.org/hawkbit</a></p>
|
||||||
href="http://www.eclipse.org/hawkbit">eclipse.org/hawkbit</a></p>
|
</div>
|
||||||
</div>
|
</section>
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
<div class="footer">
|
</div>
|
||||||
<a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a> |
|
<div class="footer">
|
||||||
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> |
|
<a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a> |
|
||||||
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> |
|
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> |
|
||||||
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">Copyright Agent</a> |
|
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> |
|
||||||
<a href="http://www.eclipse.org/legal" target="_blank">Legal</a>
|
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">Copyright Agent</a> |
|
||||||
</div>
|
<a href="http://www.eclipse.org/legal" target="_blank">Legal</a>
|
||||||
<script src="lib/js/head.min.js"></script>
|
</div>
|
||||||
<script src="js/reveal.js"></script>
|
<script src="lib/js/head.min.js"></script>
|
||||||
|
<script src="js/reveal.js"></script>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
// Full list of configuration options available at:
|
// Full list of configuration options available at:
|
||||||
// https://github.com/hakimel/reveal.js#configuration
|
// https://github.com/hakimel/reveal.js#configuration
|
||||||
Reveal.initialize({
|
Reveal.initialize({
|
||||||
controls: false,
|
controls: false,
|
||||||
progress: true,
|
progress: true,
|
||||||
history: true,
|
history: true,
|
||||||
center: true,
|
center: true,
|
||||||
|
|
||||||
transition: 'convex', // none/fade/slide/convex/concave/zoom
|
transition: 'convex', // none/fade/slide/convex/concave/zoom
|
||||||
|
|
||||||
// Optional reveal.js plugins
|
// Optional reveal.js plugins
|
||||||
dependencies: [{
|
dependencies: [{
|
||||||
src: 'lib/js/classList.js',
|
src: 'lib/js/classList.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !document.body.classList;
|
return !document.body.classList;
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/markdown/marked.js',
|
src: 'plugin/markdown/marked.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('[data-markdown]');
|
return !!document.querySelector('[data-markdown]');
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/markdown/markdown.js',
|
src: 'plugin/markdown/markdown.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('[data-markdown]');
|
return !!document.querySelector('[data-markdown]');
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/highlight/highlight.js',
|
src: 'plugin/highlight/highlight.js',
|
||||||
async: true,
|
async: true,
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('pre code');
|
return !!document.querySelector('pre code');
|
||||||
},
|
},
|
||||||
callback: function () {
|
callback: function () {
|
||||||
hljs.initHighlightingOnLoad();
|
hljs.initHighlightingOnLoad();
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/zoom-js/zoom.js',
|
src: 'plugin/zoom-js/zoom.js',
|
||||||
async: true
|
async: true
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/notes/notes.js',
|
src: 'plugin/notes/notes.js',
|
||||||
async: true
|
async: true
|
||||||
}]
|
}]
|
||||||
});
|
});
|
||||||
|
|
||||||
Reveal.configure({
|
Reveal.configure({
|
||||||
slideNumber: true
|
slideNumber: true
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
|
|
||||||
|
|||||||
@@ -16,170 +16,185 @@
|
|||||||
|
|
||||||
<title>Eclipse hawkBit</title>
|
<title>Eclipse hawkBit</title>
|
||||||
|
|
||||||
<meta name="description" content="Eclipse hawkBit - Community Day 2020">
|
<meta content="Eclipse hawkBit - Community Day 2020" name="description">
|
||||||
|
|
||||||
<meta name="apple-mobile-web-app-capable" content="yes" />
|
<meta content="yes" name="apple-mobile-web-app-capable"/>
|
||||||
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent" />
|
<meta content="black-translucent" name="apple-mobile-web-app-status-bar-style"/>
|
||||||
<meta name="viewport"
|
<meta content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui"
|
||||||
content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, minimal-ui">
|
name="viewport">
|
||||||
|
|
||||||
<link rel="stylesheet" href="css/reveal.css">
|
<link href="css/reveal.css" rel="stylesheet">
|
||||||
<link rel="stylesheet" href="css/theme/hawkBit.css" id="theme">
|
<link href="css/theme/hawkBit.css" id="theme" rel="stylesheet">
|
||||||
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css"
|
<link crossorigin="anonymous" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css"
|
||||||
integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU" crossorigin="anonymous">
|
integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU" rel="stylesheet">
|
||||||
|
|
||||||
<body>
|
<body>
|
||||||
<div class="reveal">
|
<div class="reveal">
|
||||||
<div class="header">
|
<div class="header">
|
||||||
<img src="resources/images/hawkbit_logo.png" width="120px" align="right" />
|
<img align="right" src="resources/images/hawkbit_logo.png" width="120px"/>
|
||||||
</div>
|
|
||||||
<div class="slides">
|
|
||||||
<section>
|
|
||||||
<div class="intro">
|
|
||||||
<h1>Community Day - Eclipse hawkBit</h1>
|
|
||||||
<h6>EclipseCon Europe 2020</h6>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<h1>About</h1>
|
|
||||||
<p>
|
|
||||||
Eclipse hawkBit aims to create a <b>domain independent</b> back end solution for rolling out
|
|
||||||
<b>software
|
|
||||||
updates</b>
|
|
||||||
to constrained edge devices as well as more powerful controllers and gateways connected to IP based
|
|
||||||
networking infrastructure
|
|
||||||
</p>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<h1>Big picture</h1>
|
|
||||||
<img src="resources/images/hawkBit_overview.jpg">
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<h1>Statistics (10/2020)</h1>
|
|
||||||
<ul style="position:absolute; left:2em;">
|
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit">hawkbit Core</a>: 261
|
|
||||||
(+54)
|
|
||||||
stars, 797 (+80) PRs, 185 (+13) issues</li>
|
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-extensions">hawkbit
|
|
||||||
Extensions</a>: 46 (+5) PRs</li>
|
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-examples">hawkbit
|
|
||||||
Examples</a>: 39 (+4) PRs</li>
|
|
||||||
<li style="margin-bottom: 0.5em"><a href="https://hub.docker.com/u/hawkbit/">Docker Hub</a>: 100K+
|
|
||||||
(+50K)
|
|
||||||
PULLS</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<h1>We have been busy</h1>
|
|
||||||
<ul style="position:absolute; left:2em;">
|
|
||||||
<li style="margin-bottom: 0.5em">Migrate hawkBit UI to VAADIN 8 (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/980">#980</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">Support PostgreSQL (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/932">#932</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">Allowing artifact download from within the UI (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/944">#944</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">Fix XSS Vulnerability (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/924">#924</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">Management API supports SHA256 file hashes of artifacts (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pull/918">#918</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">Add Stackoverflow tag for hawkBit (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/923">#923</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">... and <a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/pulls?utf8=✓&q=created%3A%3E%3D2019-10-25">many
|
|
||||||
smaller enhancements and bug fixes </a></li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<h1>Current challenges and next steps</h1>
|
|
||||||
<ul style="position:absolute; left:2em;">
|
|
||||||
|
|
||||||
<li style="margin-bottom: 0.5em">Release 0.3.0 (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/784">#784</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">Update from EPL-1.0 to EPL-2.0 (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/1008">#1008</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">Migrate hawkBit to Spring Boot 2.3.x (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/999">#999</a>)</li>
|
|
||||||
<li style="margin-bottom: 0.5em">Integration with other device inventories (<a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit/issues/796">#796</a>)</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<h1>Thank you</h1>
|
|
||||||
<div style="font-size: 1.5em; position:absolute; left:2em;">
|
|
||||||
<p><i class="fab fa-gitter fa-fw"></i> <a
|
|
||||||
href="https://gitter.im/eclipse/hawkbit">eclipse/hawkbit</a></p>
|
|
||||||
<p><i class="fab fa-github fa-fw"></i> <a
|
|
||||||
href="https://github.com/eclipse-hawkbit/hawkbit">eclipse/hawkbit</a></p>
|
|
||||||
<p><i class="fa fa-book-open fa-fw"></i> <a
|
|
||||||
href="http://www.eclipse.org/hawkbit">eclipse.org/hawkbit</a></p>
|
|
||||||
<p><i class="fab fa-stack-overflow fa-fw"></i> <a
|
|
||||||
href="https://stackoverflow.com/questions/tagged/eclipse-hawkbit">eclipse-hawkbit</a></p>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
</div>
|
|
||||||
</div>
|
</div>
|
||||||
<div class="footer">
|
<div class="slides">
|
||||||
<a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a> |
|
<section>
|
||||||
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> |
|
<div class="intro">
|
||||||
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> |
|
<h1>Community Day - Eclipse hawkBit</h1>
|
||||||
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">Copyright Agent</a> |
|
<h6>EclipseCon Europe 2020</h6>
|
||||||
<a href="http://www.eclipse.org/legal" target="_blank">Legal</a>
|
</div>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>About</h1>
|
||||||
|
<p>
|
||||||
|
Eclipse hawkBit aims to create a <b>domain independent</b> back end solution for rolling out
|
||||||
|
<b>software
|
||||||
|
updates</b>
|
||||||
|
to constrained edge devices as well as more powerful controllers and gateways connected to IP based
|
||||||
|
networking infrastructure
|
||||||
|
</p>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>Big picture</h1>
|
||||||
|
<img src="resources/images/hawkBit_overview.jpg">
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>Statistics (10/2020)</h1>
|
||||||
|
<ul style="position:absolute; left:2em;">
|
||||||
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit">hawkbit Core</a>:
|
||||||
|
261
|
||||||
|
(+54)
|
||||||
|
stars, 797 (+80) PRs, 185 (+13) issues
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-extensions">hawkbit
|
||||||
|
Extensions</a>: 46 (+5) PRs
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em"><a href="https://github.com/eclipse-hawkbit/hawkbit-examples">hawkbit
|
||||||
|
Examples</a>: 39 (+4) PRs
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em"><a href="https://hub.docker.com/u/hawkbit/">Docker Hub</a>: 100K+
|
||||||
|
(+50K)
|
||||||
|
PULLS
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
<section>
|
||||||
|
<h1>We have been busy</h1>
|
||||||
|
<ul style="position:absolute; left:2em;">
|
||||||
|
<li style="margin-bottom: 0.5em">Migrate hawkBit UI to VAADIN 8 (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/980">#980</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Support PostgreSQL (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/932">#932</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Allowing artifact download from within the UI (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/944">#944</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Fix XSS Vulnerability (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/924">#924</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Management API supports SHA256 file hashes of artifacts (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pull/918">#918</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Add Stackoverflow tag for hawkBit (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/923">#923</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">... and <a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/pulls?utf8=✓&q=created%3A%3E%3D2019-10-25">many
|
||||||
|
smaller enhancements and bug fixes </a></li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<h1>Current challenges and next steps</h1>
|
||||||
|
<ul style="position:absolute; left:2em;">
|
||||||
|
|
||||||
|
<li style="margin-bottom: 0.5em">Release 0.3.0 (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/784">#784</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Update from EPL-1.0 to EPL-2.0 (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/1008">#1008</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Migrate hawkBit to Spring Boot 2.3.x (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/999">#999</a>)
|
||||||
|
</li>
|
||||||
|
<li style="margin-bottom: 0.5em">Integration with other device inventories (<a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit/issues/796">#796</a>)
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</section>
|
||||||
|
|
||||||
|
|
||||||
|
<section>
|
||||||
|
<h1>Thank you</h1>
|
||||||
|
<div style="font-size: 1.5em; position:absolute; left:2em;">
|
||||||
|
<p><i class="fab fa-gitter fa-fw"></i> <a
|
||||||
|
href="https://gitter.im/eclipse/hawkbit">eclipse/hawkbit</a></p>
|
||||||
|
<p><i class="fab fa-github fa-fw"></i> <a
|
||||||
|
href="https://github.com/eclipse-hawkbit/hawkbit">eclipse/hawkbit</a></p>
|
||||||
|
<p><i class="fa fa-book-open fa-fw"></i> <a
|
||||||
|
href="http://www.eclipse.org/hawkbit">eclipse.org/hawkbit</a></p>
|
||||||
|
<p><i class="fab fa-stack-overflow fa-fw"></i> <a
|
||||||
|
href="https://stackoverflow.com/questions/tagged/eclipse-hawkbit">eclipse-hawkbit</a></p>
|
||||||
|
</div>
|
||||||
|
</section>
|
||||||
</div>
|
</div>
|
||||||
<script src="lib/js/head.min.js"></script>
|
</div>
|
||||||
<script src="js/reveal.js"></script>
|
<div class="footer">
|
||||||
|
<a href="http://www.eclipse.org" target="_blank">Eclipse Foundation</a> |
|
||||||
|
<a href="http://www.eclipse.org/legal/privacy.php" target="_blank">Privacy Policy</a> |
|
||||||
|
<a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">Terms of Use</a> |
|
||||||
|
<a href="http://www.eclipse.org/legal/copyright.php" target="_blank">Copyright Agent</a> |
|
||||||
|
<a href="http://www.eclipse.org/legal" target="_blank">Legal</a>
|
||||||
|
</div>
|
||||||
|
<script src="lib/js/head.min.js"></script>
|
||||||
|
<script src="js/reveal.js"></script>
|
||||||
|
|
||||||
<script>
|
<script>
|
||||||
// Full list of configuration options available at:
|
// Full list of configuration options available at:
|
||||||
// https://github.com/hakimel/reveal.js#configuration
|
// https://github.com/hakimel/reveal.js#configuration
|
||||||
Reveal.initialize({
|
Reveal.initialize({
|
||||||
controls: false,
|
controls: false,
|
||||||
progress: true,
|
progress: true,
|
||||||
history: true,
|
history: true,
|
||||||
center: true,
|
center: true,
|
||||||
|
|
||||||
transition: 'convex', // none/fade/slide/convex/concave/zoom
|
transition: 'convex', // none/fade/slide/convex/concave/zoom
|
||||||
|
|
||||||
// Optional reveal.js plugins
|
// Optional reveal.js plugins
|
||||||
dependencies: [{
|
dependencies: [{
|
||||||
src: 'lib/js/classList.js',
|
src: 'lib/js/classList.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !document.body.classList;
|
return !document.body.classList;
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/markdown/marked.js',
|
src: 'plugin/markdown/marked.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('[data-markdown]');
|
return !!document.querySelector('[data-markdown]');
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/markdown/markdown.js',
|
src: 'plugin/markdown/markdown.js',
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('[data-markdown]');
|
return !!document.querySelector('[data-markdown]');
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/highlight/highlight.js',
|
src: 'plugin/highlight/highlight.js',
|
||||||
async: true,
|
async: true,
|
||||||
condition: function () {
|
condition: function () {
|
||||||
return !!document.querySelector('pre code');
|
return !!document.querySelector('pre code');
|
||||||
},
|
},
|
||||||
callback: function () {
|
callback: function () {
|
||||||
hljs.initHighlightingOnLoad();
|
hljs.initHighlightingOnLoad();
|
||||||
}
|
}
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/zoom-js/zoom.js',
|
src: 'plugin/zoom-js/zoom.js',
|
||||||
async: true
|
async: true
|
||||||
}, {
|
}, {
|
||||||
src: 'plugin/notes/notes.js',
|
src: 'plugin/notes/notes.js',
|
||||||
async: true
|
async: true
|
||||||
}]
|
}]
|
||||||
});
|
});
|
||||||
|
|
||||||
Reveal.configure({
|
Reveal.configure({
|
||||||
slideNumber: true
|
slideNumber: true
|
||||||
});
|
});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
</body>
|
</body>
|
||||||
|
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,23 +1,22 @@
|
|||||||
|
|
||||||
/*********************************************
|
/*********************************************
|
||||||
* GLOBAL STYLES
|
* GLOBAL STYLES
|
||||||
*********************************************/
|
*********************************************/
|
||||||
body {
|
body {
|
||||||
border-left: 0px solid #ffffff;
|
border-left: 0px solid #ffffff;
|
||||||
overflow: auto;
|
overflow: auto;
|
||||||
background-color: white;
|
background-color: white;
|
||||||
background-position: center bottom;
|
background-position: center bottom;
|
||||||
background-repeat: no-repeat;
|
background-repeat: no-repeat;
|
||||||
background-size: 100% 17px;
|
background-size: 100% 17px;
|
||||||
font-family: Helvetica, Arial, sans-serif;
|
font-family: Helvetica, Arial, sans-serif;
|
||||||
font-weight: normal;
|
font-weight: normal;
|
||||||
color: #2e3032
|
color: #2e3032
|
||||||
}
|
}
|
||||||
|
|
||||||
.header {
|
.header {
|
||||||
position: relative;
|
position: relative;
|
||||||
top: 5px;
|
top: 5px;
|
||||||
right: 20px;
|
right: 20px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.footer {
|
.footer {
|
||||||
@@ -36,64 +35,65 @@ body {
|
|||||||
}
|
}
|
||||||
|
|
||||||
.reveal {
|
.reveal {
|
||||||
font-family: Helvetica, Arial, sans-serif;
|
font-family: Helvetica, Arial, sans-serif;
|
||||||
font-size: 25px;
|
font-size: 25px;
|
||||||
font-weight: normal;
|
font-weight: normal;
|
||||||
color: #551f62; d
|
color: #551f62;
|
||||||
|
d
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .controls {
|
.reveal .controls {
|
||||||
margin-bottom: 10px
|
margin-bottom: 10px
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .slide-number {
|
.reveal .slide-number {
|
||||||
margin-bottom: 10px
|
margin-bottom: 10px
|
||||||
}
|
}
|
||||||
|
|
||||||
::selection {
|
::selection {
|
||||||
color: #fff;
|
color: #fff;
|
||||||
background: #98bdef;
|
background: #98bdef;
|
||||||
text-shadow: none;
|
text-shadow: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .slides>section, .reveal .slides>section>section {
|
.reveal .slides > section, .reveal .slides > section > section {
|
||||||
line-height: 1.1;
|
line-height: 1.1;
|
||||||
font-weight: inherit;
|
font-weight: inherit;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
/* padding-bottom: 25px; */
|
/* padding-bottom: 25px; */
|
||||||
}
|
}
|
||||||
|
|
||||||
/*********************************************
|
/*********************************************
|
||||||
* HEADERS
|
* HEADERS
|
||||||
*********************************************/
|
*********************************************/
|
||||||
.reveal h1, .reveal h2, .reveal h3, .reveal h4, .reveal h5, .reveal h6 {
|
.reveal h1, .reveal h2, .reveal h3, .reveal h4, .reveal h5, .reveal h6 {
|
||||||
margin: 0 0 20px 0;
|
margin: 0 0 20px 0;
|
||||||
font-family: Helvetica, Arial, sans-serif;
|
font-family: Helvetica, Arial, sans-serif;
|
||||||
font-weight: 100;
|
font-weight: 100;
|
||||||
line-height: 1.0;
|
line-height: 1.0;
|
||||||
padding-bottom: 15px;
|
padding-bottom: 15px;
|
||||||
letter-spacing: normal;
|
letter-spacing: normal;
|
||||||
text-shadow: none;
|
text-shadow: none;
|
||||||
word-wrap: break-word;
|
word-wrap: break-word;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal h1 {
|
.reveal h1 {
|
||||||
font-size: 3.1em;
|
font-size: 3.1em;
|
||||||
text-shadow: none;
|
text-shadow: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal h2 {
|
.reveal h2 {
|
||||||
margin-top: 15px;
|
margin-top: 15px;
|
||||||
font-size: 1.6em;
|
font-size: 1.6em;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal h3 {
|
.reveal h3 {
|
||||||
font-size: 1.2em;
|
font-size: 1.2em;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal h4 {
|
.reveal h4 {
|
||||||
font-size: 1.0em;
|
font-size: 1.0em;
|
||||||
color: #000;
|
color: #000;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*********************************************
|
/*********************************************
|
||||||
@@ -102,7 +102,7 @@ body {
|
|||||||
|
|
||||||
|
|
||||||
.reveal .intro {
|
.reveal .intro {
|
||||||
color: #551f62;
|
color: #551f62;
|
||||||
}
|
}
|
||||||
|
|
||||||
.noborder img {
|
.noborder img {
|
||||||
@@ -119,263 +119,259 @@ body {
|
|||||||
}
|
}
|
||||||
|
|
||||||
.reveal p {
|
.reveal p {
|
||||||
margin: 20px 0;
|
margin: 20px 0;
|
||||||
line-height: 1.3;
|
line-height: 1.3;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* Ensure certain elements are never larger than the slide itself */
|
/* Ensure certain elements are never larger than the slide itself */
|
||||||
.reveal img, .reveal video, .reveal iframe {
|
.reveal img, .reveal video, .reveal iframe {
|
||||||
max-width: 80%;
|
max-width: 80%;
|
||||||
max-height: 80%
|
max-height: 80%
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal strong, .reveal b {
|
.reveal strong, .reveal b {
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal em {
|
.reveal em {
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal ol, .reveal dl, .reveal ul {
|
.reveal ol, .reveal dl, .reveal ul {
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
margin: 0 0 0 1em;
|
margin: 0 0 0 1em;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal ol {
|
.reveal ol {
|
||||||
list-style-type: decimal;
|
list-style-type: decimal;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal ul {
|
.reveal ul {
|
||||||
list-style-type: disc;
|
list-style-type: disc;
|
||||||
/* margin-top: -15px;
|
/* margin-top: -15px;
|
||||||
margin-bottom: 20px; */
|
margin-bottom: 20px; */
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal ul ul {
|
.reveal ul ul {
|
||||||
list-style-type: disc;
|
list-style-type: disc;
|
||||||
margin-top: 0px;
|
margin-top: 0px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal ul ul ul {
|
.reveal ul ul ul {
|
||||||
list-style-type: disc;
|
list-style-type: disc;
|
||||||
margin-top: 0px;
|
margin-top: 0px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal ul ul, .reveal ul ol, .reveal ol ol, .reveal ol ul {
|
.reveal ul ul, .reveal ul ol, .reveal ol ol, .reveal ol ul {
|
||||||
display: block;
|
display: block;
|
||||||
margin-left: 40px;
|
margin-left: 40px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal dt {
|
.reveal dt {
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal dd {
|
.reveal dd {
|
||||||
margin-left: 40px;
|
margin-left: 40px;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal q, .reveal blockquote {
|
.reveal q, .reveal blockquote {
|
||||||
quotes: none;
|
quotes: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal blockquote {
|
.reveal blockquote {
|
||||||
display: block;
|
display: block;
|
||||||
position: relative;
|
position: relative;
|
||||||
width: 70%;
|
width: 70%;
|
||||||
margin: 20px auto;
|
margin: 20px auto;
|
||||||
padding: 5px;
|
padding: 5px;
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
background: rgba(255, 255, 255, 0.05);
|
background: rgba(255, 255, 255, 0.05);
|
||||||
box-shadow: 0px 0px 2px rgba(0, 0, 0, 0.2);
|
box-shadow: 0px 0px 2px rgba(0, 0, 0, 0.2);
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal blockquote p:first-child, .reveal blockquote p:last-child {
|
.reveal blockquote p:first-child, .reveal blockquote p:last-child {
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal q {
|
.reveal q {
|
||||||
font-style: italic;
|
font-style: italic;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal pre {
|
.reveal pre {
|
||||||
display: block;
|
display: block;
|
||||||
position: relative;
|
position: relative;
|
||||||
width: 90%;
|
width: 90%;
|
||||||
margin: 20px auto;
|
margin: 20px auto;
|
||||||
text-align: left;
|
text-align: left;
|
||||||
font-size: 0.55em;
|
font-size: 0.55em;
|
||||||
font-family: monospace;
|
font-family: monospace;
|
||||||
line-height: 1.2em;
|
line-height: 1.2em;
|
||||||
word-wrap: break-word;
|
word-wrap: break-word;
|
||||||
box-shadow: 0px 0px 6px rgba(0, 0, 0, 0.3);
|
box-shadow: 0px 0px 6px rgba(0, 0, 0, 0.3);
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal code {
|
.reveal code {
|
||||||
font-family: monospace;
|
font-family: monospace;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal pre code {
|
.reveal pre code {
|
||||||
display: block;
|
display: block;
|
||||||
padding: 5px;
|
padding: 5px;
|
||||||
overflow: auto;
|
overflow: auto;
|
||||||
max-height: 400px;
|
max-height: 400px;
|
||||||
word-wrap: normal;
|
word-wrap: normal;
|
||||||
background: #3F3F3F;
|
background: #3F3F3F;
|
||||||
color: #DCDCDC;
|
color: #DCDCDC;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal table {
|
.reveal table {
|
||||||
margin: auto;
|
margin: auto;
|
||||||
border-collapse: collapse;
|
border-collapse: collapse;
|
||||||
border-spacing: 0;
|
border-spacing: 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal table th {
|
.reveal table th {
|
||||||
font-weight: bold;
|
font-weight: bold;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal table th, .reveal table td {
|
.reveal table th, .reveal table td {
|
||||||
text-align: left;
|
text-align: left;
|
||||||
padding: 0.2em 0.5em 0.2em 0.5em;
|
padding: 0.2em 0.5em 0.2em 0.5em;
|
||||||
border-bottom: 1px solid;
|
border-bottom: 1px solid;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal table th[align="center"], .reveal table td[align="center"] {
|
.reveal table th[align="center"], .reveal table td[align="center"] {
|
||||||
text-align: center;
|
text-align: center;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal table th[align="right"], .reveal table td[align="right"] {
|
.reveal table th[align="right"], .reveal table td[align="right"] {
|
||||||
text-align: right;
|
text-align: right;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal table tr:last-child td {
|
.reveal table tr:last-child td {
|
||||||
border-bottom: none;
|
border-bottom: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal sup {
|
.reveal sup {
|
||||||
vertical-align: super;
|
vertical-align: super;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal sub {
|
.reveal sub {
|
||||||
vertical-align: sub;
|
vertical-align: sub;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal small {
|
.reveal small {
|
||||||
display: inline-block;
|
display: inline-block;
|
||||||
font-size: 0.6em;
|
font-size: 0.6em;
|
||||||
line-height: 1.2em;
|
line-height: 1.2em;
|
||||||
vertical-align: top;
|
vertical-align: top;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal small * {
|
.reveal small * {
|
||||||
vertical-align: top;
|
vertical-align: top;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*********************************************
|
/*********************************************
|
||||||
* LINKS
|
* LINKS
|
||||||
*********************************************/
|
*********************************************/
|
||||||
.reveal a {
|
.reveal a {
|
||||||
color: #6eb553;
|
color: #6eb553;
|
||||||
text-decoration: none;
|
text-decoration: none;
|
||||||
-webkit-transition: color 0.15s ease;
|
-webkit-transition: color 0.15s ease;
|
||||||
-moz-transition: color 0.15s ease;
|
-moz-transition: color 0.15s ease;
|
||||||
transition: color 0.15s ease;
|
transition: color 0.15s ease;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal a:hover {
|
.reveal a:hover {
|
||||||
color: #6eb553;
|
color: #6eb553;
|
||||||
text-shadow: none;
|
text-shadow: none;
|
||||||
border: none;
|
border: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .roll span:after {
|
.reveal .roll span:after {
|
||||||
color: #fff;
|
color: #fff;
|
||||||
background: #1a54a1;
|
background: #1a54a1;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*********************************************
|
/*********************************************
|
||||||
* IMAGES
|
* IMAGES
|
||||||
*********************************************/
|
*********************************************/
|
||||||
.reveal section img {
|
.reveal section img {
|
||||||
margin: 15px 0px;
|
margin: 15px 0px;
|
||||||
background: rgba(255, 255, 255, 0.12);
|
background: rgba(255, 255, 255, 0.12);
|
||||||
border: 1px solid #fff;
|
border: 1px solid #fff;
|
||||||
box-shadow: 0 0 10px rgba(0, 0, 0, 0.15);
|
box-shadow: 0 0 10px rgba(0, 0, 0, 0.15);
|
||||||
display: block;
|
display: block;
|
||||||
margin-left: auto;
|
margin-left: auto;
|
||||||
margin-right: auto;
|
margin-right: auto;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal a img {
|
.reveal a img {
|
||||||
-webkit-transition: all 0.15s linear;
|
-webkit-transition: all 0.15s linear;
|
||||||
-moz-transition: all 0.15s linear;
|
-moz-transition: all 0.15s linear;
|
||||||
transition: all 0.15s linear;
|
transition: all 0.15s linear;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal a:hover img {
|
.reveal a:hover img {
|
||||||
background: rgba(255, 255, 255, 0.2);
|
background: rgba(255, 255, 255, 0.2);
|
||||||
border-color: #6eb553;
|
border-color: #6eb553;
|
||||||
box-shadow: 0 0 20px rgba(0, 0, 0, 0.55);
|
box-shadow: 0 0 20px rgba(0, 0, 0, 0.55);
|
||||||
}
|
}
|
||||||
|
|
||||||
/*********************************************
|
/*********************************************
|
||||||
* NAVIGATION CONTROLS
|
* NAVIGATION CONTROLS
|
||||||
*********************************************/
|
*********************************************/
|
||||||
.reveal .controls div.navigate-left, .reveal .controls div.navigate-left.enabled
|
.reveal .controls div.navigate-left, .reveal .controls div.navigate-left.enabled {
|
||||||
{
|
border-right-color: #6eb553;
|
||||||
border-right-color: #6eb553;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .controls div.navigate-right, .reveal .controls div.navigate-right.enabled
|
.reveal .controls div.navigate-right, .reveal .controls div.navigate-right.enabled {
|
||||||
{
|
border-left-color: #6eb553;
|
||||||
border-left-color: #6eb553;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .controls div.navigate-up, .reveal .controls div.navigate-up.enabled
|
.reveal .controls div.navigate-up, .reveal .controls div.navigate-up.enabled {
|
||||||
{
|
border-bottom-color: #6eb553;
|
||||||
border-bottom-color: #6eb553;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .controls div.navigate-down, .reveal .controls div.navigate-down.enabled
|
.reveal .controls div.navigate-down, .reveal .controls div.navigate-down.enabled {
|
||||||
{
|
border-top-color: #6eb553;
|
||||||
border-top-color: #6eb553;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .controls div.navigate-left.enabled:hover {
|
.reveal .controls div.navigate-left.enabled:hover {
|
||||||
border-right-color: #6eb553;
|
border-right-color: #6eb553;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .controls div.navigate-right.enabled:hover {
|
.reveal .controls div.navigate-right.enabled:hover {
|
||||||
border-left-color: #6eb553;
|
border-left-color: #6eb553;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .controls div.navigate-up.enabled:hover {
|
.reveal .controls div.navigate-up.enabled:hover {
|
||||||
border-bottom-color: #6eb553;
|
border-bottom-color: #6eb553;
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .controls div.navigate-down.enabled:hover {
|
.reveal .controls div.navigate-down.enabled:hover {
|
||||||
border-top-color: #6eb553;
|
border-top-color: #6eb553;
|
||||||
}
|
}
|
||||||
|
|
||||||
/*********************************************
|
/*********************************************
|
||||||
* PROGRESS BAR
|
* PROGRESS BAR
|
||||||
*********************************************/
|
*********************************************/
|
||||||
.reveal .progress {
|
.reveal .progress {
|
||||||
background: rgba(0, 0, 0, 0.2);
|
background: rgba(0, 0, 0, 0.2);
|
||||||
}
|
}
|
||||||
|
|
||||||
.reveal .progress span {
|
.reveal .progress span {
|
||||||
background: #003b6a;
|
background: #003b6a;
|
||||||
-webkit-transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985);
|
-webkit-transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985);
|
||||||
-moz-transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985);
|
-moz-transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985);
|
||||||
transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985);
|
transition: width 800ms cubic-bezier(0.26, 0.86, 0.44, 0.985);
|
||||||
}
|
}
|
||||||
|
|
||||||
/*********************************************
|
/*********************************************
|
||||||
* SLIDE NUMBER
|
* SLIDE NUMBER
|
||||||
*********************************************/
|
*********************************************/
|
||||||
.reveal .slide-number {
|
.reveal .slide-number {
|
||||||
color: #003b6a;
|
color: #003b6a;
|
||||||
}
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
@@ -3,410 +3,402 @@
|
|||||||
* markdown inside of presentations as well as loading
|
* markdown inside of presentations as well as loading
|
||||||
* of external markdown documents.
|
* of external markdown documents.
|
||||||
*/
|
*/
|
||||||
(function( root, factory ) {
|
(function (root, factory) {
|
||||||
if (typeof define === 'function' && define.amd) {
|
if (typeof define === 'function' && define.amd) {
|
||||||
root.marked = require( './marked' );
|
root.marked = require('./marked');
|
||||||
root.RevealMarkdown = factory( root.marked );
|
root.RevealMarkdown = factory(root.marked);
|
||||||
root.RevealMarkdown.initialize();
|
root.RevealMarkdown.initialize();
|
||||||
} else if( typeof exports === 'object' ) {
|
} else if (typeof exports === 'object') {
|
||||||
module.exports = factory( require( './marked' ) );
|
module.exports = factory(require('./marked'));
|
||||||
} else {
|
} else {
|
||||||
// Browser globals (root is window)
|
// Browser globals (root is window)
|
||||||
root.RevealMarkdown = factory( root.marked );
|
root.RevealMarkdown = factory(root.marked);
|
||||||
root.RevealMarkdown.initialize();
|
root.RevealMarkdown.initialize();
|
||||||
}
|
}
|
||||||
}( this, function( marked ) {
|
}(this, function (marked) {
|
||||||
|
|
||||||
var DEFAULT_SLIDE_SEPARATOR = '^\r?\n---\r?\n$',
|
var DEFAULT_SLIDE_SEPARATOR = '^\r?\n---\r?\n$',
|
||||||
DEFAULT_NOTES_SEPARATOR = 'notes?:',
|
DEFAULT_NOTES_SEPARATOR = 'notes?:',
|
||||||
DEFAULT_ELEMENT_ATTRIBUTES_SEPARATOR = '\\\.element\\\s*?(.+?)$',
|
DEFAULT_ELEMENT_ATTRIBUTES_SEPARATOR = '\\\.element\\\s*?(.+?)$',
|
||||||
DEFAULT_SLIDE_ATTRIBUTES_SEPARATOR = '\\\.slide:\\\s*?(\\\S.+?)$';
|
DEFAULT_SLIDE_ATTRIBUTES_SEPARATOR = '\\\.slide:\\\s*?(\\\S.+?)$';
|
||||||
|
|
||||||
var SCRIPT_END_PLACEHOLDER = '__SCRIPT_END__';
|
var SCRIPT_END_PLACEHOLDER = '__SCRIPT_END__';
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Retrieves the markdown contents of a slide section
|
* Retrieves the markdown contents of a slide section
|
||||||
* element. Normalizes leading tabs/whitespace.
|
* element. Normalizes leading tabs/whitespace.
|
||||||
*/
|
*/
|
||||||
function getMarkdownFromSlide( section ) {
|
function getMarkdownFromSlide(section) {
|
||||||
|
|
||||||
// look for a <script> or <textarea data-template> wrapper
|
// look for a <script> or <textarea data-template> wrapper
|
||||||
var template = section.querySelector( '[data-template]' ) || section.querySelector( 'script' );
|
var template = section.querySelector('[data-template]') || section.querySelector('script');
|
||||||
|
|
||||||
// strip leading whitespace so it isn't evaluated as code
|
// strip leading whitespace so it isn't evaluated as code
|
||||||
var text = ( template || section ).textContent;
|
var text = (template || section).textContent;
|
||||||
|
|
||||||
// restore script end tags
|
// restore script end tags
|
||||||
text = text.replace( new RegExp( SCRIPT_END_PLACEHOLDER, 'g' ), '</script>' );
|
text = text.replace(new RegExp(SCRIPT_END_PLACEHOLDER, 'g'), '</script>');
|
||||||
|
|
||||||
var leadingWs = text.match( /^\n?(\s*)/ )[1].length,
|
var leadingWs = text.match(/^\n?(\s*)/)[1].length,
|
||||||
leadingTabs = text.match( /^\n?(\t*)/ )[1].length;
|
leadingTabs = text.match(/^\n?(\t*)/)[1].length;
|
||||||
|
|
||||||
if( leadingTabs > 0 ) {
|
if (leadingTabs > 0) {
|
||||||
text = text.replace( new RegExp('\\n?\\t{' + leadingTabs + '}','g'), '\n' );
|
text = text.replace(new RegExp('\\n?\\t{' + leadingTabs + '}', 'g'), '\n');
|
||||||
}
|
} else if (leadingWs > 1) {
|
||||||
else if( leadingWs > 1 ) {
|
text = text.replace(new RegExp('\\n? {' + leadingWs + '}', 'g'), '\n');
|
||||||
text = text.replace( new RegExp('\\n? {' + leadingWs + '}', 'g'), '\n' );
|
}
|
||||||
}
|
|
||||||
|
|
||||||
return text;
|
return text;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Given a markdown slide section element, this will
|
* Given a markdown slide section element, this will
|
||||||
* return all arguments that aren't related to markdown
|
* return all arguments that aren't related to markdown
|
||||||
* parsing. Used to forward any other user-defined arguments
|
* parsing. Used to forward any other user-defined arguments
|
||||||
* to the output markdown slide.
|
* to the output markdown slide.
|
||||||
*/
|
*/
|
||||||
function getForwardedAttributes( section ) {
|
function getForwardedAttributes(section) {
|
||||||
|
|
||||||
var attributes = section.attributes;
|
var attributes = section.attributes;
|
||||||
var result = [];
|
var result = [];
|
||||||
|
|
||||||
for( var i = 0, len = attributes.length; i < len; i++ ) {
|
|
||||||
var name = attributes[i].name,
|
|
||||||
value = attributes[i].value;
|
|
||||||
|
|
||||||
// disregard attributes that are used for markdown loading/parsing
|
for (var i = 0, len = attributes.length; i < len; i++) {
|
||||||
if( /data\-(markdown|separator|vertical|notes)/gi.test( name ) ) continue;
|
var name = attributes[i].name,
|
||||||
|
value = attributes[i].value;
|
||||||
|
|
||||||
if( value ) {
|
// disregard attributes that are used for markdown loading/parsing
|
||||||
result.push( name + '="' + value + '"' );
|
if (/data\-(markdown|separator|vertical|notes)/gi.test(name)) continue;
|
||||||
}
|
|
||||||
else {
|
|
||||||
result.push( name );
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return result.join( ' ' );
|
|
||||||
|
|
||||||
}
|
if (value) {
|
||||||
|
result.push(name + '="' + value + '"');
|
||||||
/**
|
} else {
|
||||||
* Inspects the given options and fills out default
|
result.push(name);
|
||||||
* values for what's not defined.
|
}
|
||||||
*/
|
}
|
||||||
function getSlidifyOptions( options ) {
|
|
||||||
|
|
||||||
options = options || {};
|
return result.join(' ');
|
||||||
options.separator = options.separator || DEFAULT_SLIDE_SEPARATOR;
|
|
||||||
options.notesSeparator = options.notesSeparator || DEFAULT_NOTES_SEPARATOR;
|
|
||||||
options.attributes = options.attributes || '';
|
|
||||||
|
|
||||||
return options;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Helper function for constructing a markdown slide.
|
|
||||||
*/
|
|
||||||
function createMarkdownSlide( content, options ) {
|
|
||||||
|
|
||||||
options = getSlidifyOptions( options );
|
}
|
||||||
|
|
||||||
var notesMatch = content.split( new RegExp( options.notesSeparator, 'mgi' ) );
|
/**
|
||||||
|
* Inspects the given options and fills out default
|
||||||
|
* values for what's not defined.
|
||||||
|
*/
|
||||||
|
function getSlidifyOptions(options) {
|
||||||
|
|
||||||
if( notesMatch.length === 2 ) {
|
options = options || {};
|
||||||
content = notesMatch[0] + '<aside class="notes">' + marked(notesMatch[1].trim()) + '</aside>';
|
options.separator = options.separator || DEFAULT_SLIDE_SEPARATOR;
|
||||||
}
|
options.notesSeparator = options.notesSeparator || DEFAULT_NOTES_SEPARATOR;
|
||||||
|
options.attributes = options.attributes || '';
|
||||||
|
|
||||||
// prevent script end tags in the content from interfering
|
return options;
|
||||||
// with parsing
|
|
||||||
content = content.replace( /<\/script>/g, SCRIPT_END_PLACEHOLDER );
|
|
||||||
|
|
||||||
return '<script type="text/template">' + content + '</script>';
|
}
|
||||||
|
|
||||||
}
|
/**
|
||||||
|
* Helper function for constructing a markdown slide.
|
||||||
|
*/
|
||||||
|
function createMarkdownSlide(content, options) {
|
||||||
|
|
||||||
/**
|
options = getSlidifyOptions(options);
|
||||||
* Parses a data string into multiple slides based
|
|
||||||
* on the passed in separator arguments.
|
|
||||||
*/
|
|
||||||
function slidify( markdown, options ) {
|
|
||||||
|
|
||||||
options = getSlidifyOptions( options );
|
var notesMatch = content.split(new RegExp(options.notesSeparator, 'mgi'));
|
||||||
|
|
||||||
var separatorRegex = new RegExp( options.separator + ( options.verticalSeparator ? '|' + options.verticalSeparator : '' ), 'mg' ),
|
if (notesMatch.length === 2) {
|
||||||
horizontalSeparatorRegex = new RegExp( options.separator );
|
content = notesMatch[0] + '<aside class="notes">' + marked(notesMatch[1].trim()) + '</aside>';
|
||||||
|
}
|
||||||
|
|
||||||
var matches,
|
// prevent script end tags in the content from interfering
|
||||||
lastIndex = 0,
|
// with parsing
|
||||||
isHorizontal,
|
content = content.replace(/<\/script>/g, SCRIPT_END_PLACEHOLDER);
|
||||||
wasHorizontal = true,
|
|
||||||
content,
|
|
||||||
sectionStack = [];
|
|
||||||
|
|
||||||
// iterate until all blocks between separators are stacked up
|
return '<script type="text/template">' + content + '</script>';
|
||||||
while( matches = separatorRegex.exec( markdown ) ) {
|
|
||||||
notes = null;
|
|
||||||
|
|
||||||
// determine direction (horizontal by default)
|
}
|
||||||
isHorizontal = horizontalSeparatorRegex.test( matches[0] );
|
|
||||||
|
|
||||||
if( !isHorizontal && wasHorizontal ) {
|
/**
|
||||||
// create vertical stack
|
* Parses a data string into multiple slides based
|
||||||
sectionStack.push( [] );
|
* on the passed in separator arguments.
|
||||||
}
|
*/
|
||||||
|
function slidify(markdown, options) {
|
||||||
|
|
||||||
// pluck slide content from markdown input
|
options = getSlidifyOptions(options);
|
||||||
content = markdown.substring( lastIndex, matches.index );
|
|
||||||
|
|
||||||
if( isHorizontal && wasHorizontal ) {
|
var separatorRegex = new RegExp(options.separator + (options.verticalSeparator ? '|' + options.verticalSeparator : ''), 'mg'),
|
||||||
// add to horizontal stack
|
horizontalSeparatorRegex = new RegExp(options.separator);
|
||||||
sectionStack.push( content );
|
|
||||||
}
|
|
||||||
else {
|
|
||||||
// add to vertical stack
|
|
||||||
sectionStack[sectionStack.length-1].push( content );
|
|
||||||
}
|
|
||||||
|
|
||||||
lastIndex = separatorRegex.lastIndex;
|
var matches,
|
||||||
wasHorizontal = isHorizontal;
|
lastIndex = 0,
|
||||||
}
|
isHorizontal,
|
||||||
|
wasHorizontal = true,
|
||||||
|
content,
|
||||||
|
sectionStack = [];
|
||||||
|
|
||||||
// add the remaining slide
|
// iterate until all blocks between separators are stacked up
|
||||||
( wasHorizontal ? sectionStack : sectionStack[sectionStack.length-1] ).push( markdown.substring( lastIndex ) );
|
while (matches = separatorRegex.exec(markdown)) {
|
||||||
|
notes = null;
|
||||||
|
|
||||||
var markdownSections = '';
|
// determine direction (horizontal by default)
|
||||||
|
isHorizontal = horizontalSeparatorRegex.test(matches[0]);
|
||||||
|
|
||||||
// flatten the hierarchical stack, and insert <section data-markdown> tags
|
if (!isHorizontal && wasHorizontal) {
|
||||||
for( var i = 0, len = sectionStack.length; i < len; i++ ) {
|
// create vertical stack
|
||||||
// vertical
|
sectionStack.push([]);
|
||||||
if( sectionStack[i] instanceof Array ) {
|
}
|
||||||
markdownSections += '<section '+ options.attributes +'>';
|
|
||||||
|
|
||||||
sectionStack[i].forEach( function( child ) {
|
// pluck slide content from markdown input
|
||||||
markdownSections += '<section data-markdown>' + createMarkdownSlide( child, options ) + '</section>';
|
content = markdown.substring(lastIndex, matches.index);
|
||||||
} );
|
|
||||||
|
|
||||||
markdownSections += '</section>';
|
if (isHorizontal && wasHorizontal) {
|
||||||
}
|
// add to horizontal stack
|
||||||
else {
|
sectionStack.push(content);
|
||||||
markdownSections += '<section '+ options.attributes +' data-markdown>' + createMarkdownSlide( sectionStack[i], options ) + '</section>';
|
} else {
|
||||||
}
|
// add to vertical stack
|
||||||
}
|
sectionStack[sectionStack.length - 1].push(content);
|
||||||
|
}
|
||||||
return markdownSections;
|
|
||||||
|
lastIndex = separatorRegex.lastIndex;
|
||||||
}
|
wasHorizontal = isHorizontal;
|
||||||
|
}
|
||||||
/**
|
|
||||||
* Parses any current data-markdown slides, splits
|
// add the remaining slide
|
||||||
* multi-slide markdown into separate sections and
|
(wasHorizontal ? sectionStack : sectionStack[sectionStack.length - 1]).push(markdown.substring(lastIndex));
|
||||||
* handles loading of external markdown.
|
|
||||||
*/
|
var markdownSections = '';
|
||||||
function processSlides() {
|
|
||||||
|
// flatten the hierarchical stack, and insert <section data-markdown> tags
|
||||||
var sections = document.querySelectorAll( '[data-markdown]'),
|
for (var i = 0, len = sectionStack.length; i < len; i++) {
|
||||||
section;
|
// vertical
|
||||||
|
if (sectionStack[i] instanceof Array) {
|
||||||
for( var i = 0, len = sections.length; i < len; i++ ) {
|
markdownSections += '<section ' + options.attributes + '>';
|
||||||
|
|
||||||
section = sections[i];
|
sectionStack[i].forEach(function (child) {
|
||||||
|
markdownSections += '<section data-markdown>' + createMarkdownSlide(child, options) + '</section>';
|
||||||
if( section.getAttribute( 'data-markdown' ).length ) {
|
});
|
||||||
|
|
||||||
var xhr = new XMLHttpRequest(),
|
markdownSections += '</section>';
|
||||||
url = section.getAttribute( 'data-markdown' );
|
} else {
|
||||||
|
markdownSections += '<section ' + options.attributes + ' data-markdown>' + createMarkdownSlide(sectionStack[i], options) + '</section>';
|
||||||
datacharset = section.getAttribute( 'data-charset' );
|
}
|
||||||
|
}
|
||||||
// see https://developer.mozilla.org/en-US/docs/Web/API/element.getAttribute#Notes
|
|
||||||
if( datacharset != null && datacharset != '' ) {
|
return markdownSections;
|
||||||
xhr.overrideMimeType( 'text/html; charset=' + datacharset );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
xhr.onreadystatechange = function() {
|
/**
|
||||||
if( xhr.readyState === 4 ) {
|
* Parses any current data-markdown slides, splits
|
||||||
// file protocol yields status code 0 (useful for local debug, mobile applications etc.)
|
* multi-slide markdown into separate sections and
|
||||||
if ( ( xhr.status >= 200 && xhr.status < 300 ) || xhr.status === 0 ) {
|
* handles loading of external markdown.
|
||||||
|
*/
|
||||||
section.outerHTML = slidify( xhr.responseText, {
|
function processSlides() {
|
||||||
separator: section.getAttribute( 'data-separator' ),
|
|
||||||
verticalSeparator: section.getAttribute( 'data-separator-vertical' ),
|
var sections = document.querySelectorAll('[data-markdown]'),
|
||||||
notesSeparator: section.getAttribute( 'data-separator-notes' ),
|
section;
|
||||||
attributes: getForwardedAttributes( section )
|
|
||||||
});
|
for (var i = 0, len = sections.length; i < len; i++) {
|
||||||
|
|
||||||
}
|
section = sections[i];
|
||||||
else {
|
|
||||||
|
if (section.getAttribute('data-markdown').length) {
|
||||||
section.outerHTML = '<section data-state="alert">' +
|
|
||||||
'ERROR: The attempt to fetch ' + url + ' failed with HTTP status ' + xhr.status + '.' +
|
var xhr = new XMLHttpRequest(),
|
||||||
'Check your browser\'s JavaScript console for more details.' +
|
url = section.getAttribute('data-markdown');
|
||||||
'<p>Remember that you need to serve the presentation HTML from a HTTP server.</p>' +
|
|
||||||
'</section>';
|
datacharset = section.getAttribute('data-charset');
|
||||||
|
|
||||||
}
|
// see https://developer.mozilla.org/en-US/docs/Web/API/element.getAttribute#Notes
|
||||||
}
|
if (datacharset != null && datacharset != '') {
|
||||||
};
|
xhr.overrideMimeType('text/html; charset=' + datacharset);
|
||||||
|
}
|
||||||
xhr.open( 'GET', url, false );
|
|
||||||
|
xhr.onreadystatechange = function () {
|
||||||
try {
|
if (xhr.readyState === 4) {
|
||||||
xhr.send();
|
// file protocol yields status code 0 (useful for local debug, mobile applications etc.)
|
||||||
}
|
if ((xhr.status >= 200 && xhr.status < 300) || xhr.status === 0) {
|
||||||
catch ( e ) {
|
|
||||||
alert( 'Failed to get the Markdown file ' + url + '. Make sure that the presentation and the file are served by a HTTP server and the file can be found there. ' + e );
|
section.outerHTML = slidify(xhr.responseText, {
|
||||||
}
|
separator: section.getAttribute('data-separator'),
|
||||||
|
verticalSeparator: section.getAttribute('data-separator-vertical'),
|
||||||
}
|
notesSeparator: section.getAttribute('data-separator-notes'),
|
||||||
else if( section.getAttribute( 'data-separator' ) || section.getAttribute( 'data-separator-vertical' ) || section.getAttribute( 'data-separator-notes' ) ) {
|
attributes: getForwardedAttributes(section)
|
||||||
|
});
|
||||||
section.outerHTML = slidify( getMarkdownFromSlide( section ), {
|
|
||||||
separator: section.getAttribute( 'data-separator' ),
|
} else {
|
||||||
verticalSeparator: section.getAttribute( 'data-separator-vertical' ),
|
|
||||||
notesSeparator: section.getAttribute( 'data-separator-notes' ),
|
section.outerHTML = '<section data-state="alert">' +
|
||||||
attributes: getForwardedAttributes( section )
|
'ERROR: The attempt to fetch ' + url + ' failed with HTTP status ' + xhr.status + '.' +
|
||||||
});
|
'Check your browser\'s JavaScript console for more details.' +
|
||||||
|
'<p>Remember that you need to serve the presentation HTML from a HTTP server.</p>' +
|
||||||
}
|
'</section>';
|
||||||
else {
|
|
||||||
section.innerHTML = createMarkdownSlide( getMarkdownFromSlide( section ) );
|
}
|
||||||
}
|
}
|
||||||
}
|
};
|
||||||
|
|
||||||
}
|
xhr.open('GET', url, false);
|
||||||
|
|
||||||
/**
|
try {
|
||||||
* Check if a node value has the attributes pattern.
|
xhr.send();
|
||||||
* If yes, extract it and add that value as one or several attributes
|
} catch (e) {
|
||||||
* the the terget element.
|
alert('Failed to get the Markdown file ' + url + '. Make sure that the presentation and the file are served by a HTTP server and the file can be found there. ' + e);
|
||||||
*
|
}
|
||||||
* You need Cache Killer on Chrome to see the effect on any FOM transformation
|
|
||||||
* directly on refresh (F5)
|
} else if (section.getAttribute('data-separator') || section.getAttribute('data-separator-vertical') || section.getAttribute('data-separator-notes')) {
|
||||||
* http://stackoverflow.com/questions/5690269/disabling-chrome-cache-for-website-development/7000899#answer-11786277
|
|
||||||
*/
|
section.outerHTML = slidify(getMarkdownFromSlide(section), {
|
||||||
function addAttributeInElement( node, elementTarget, separator ) {
|
separator: section.getAttribute('data-separator'),
|
||||||
|
verticalSeparator: section.getAttribute('data-separator-vertical'),
|
||||||
var mardownClassesInElementsRegex = new RegExp( separator, 'mg' );
|
notesSeparator: section.getAttribute('data-separator-notes'),
|
||||||
var mardownClassRegex = new RegExp( "([^\"= ]+?)=\"([^\"=]+?)\"", 'mg' );
|
attributes: getForwardedAttributes(section)
|
||||||
var nodeValue = node.nodeValue;
|
});
|
||||||
if( matches = mardownClassesInElementsRegex.exec( nodeValue ) ) {
|
|
||||||
|
} else {
|
||||||
var classes = matches[1];
|
section.innerHTML = createMarkdownSlide(getMarkdownFromSlide(section));
|
||||||
nodeValue = nodeValue.substring( 0, matches.index ) + nodeValue.substring( mardownClassesInElementsRegex.lastIndex );
|
}
|
||||||
node.nodeValue = nodeValue;
|
}
|
||||||
while( matchesClass = mardownClassRegex.exec( classes ) ) {
|
|
||||||
elementTarget.setAttribute( matchesClass[1], matchesClass[2] );
|
}
|
||||||
}
|
|
||||||
return true;
|
/**
|
||||||
}
|
* Check if a node value has the attributes pattern.
|
||||||
return false;
|
* If yes, extract it and add that value as one or several attributes
|
||||||
}
|
* the the terget element.
|
||||||
|
*
|
||||||
/**
|
* You need Cache Killer on Chrome to see the effect on any FOM transformation
|
||||||
* Add attributes to the parent element of a text node,
|
* directly on refresh (F5)
|
||||||
* or the element of an attribute node.
|
* http://stackoverflow.com/questions/5690269/disabling-chrome-cache-for-website-development/7000899#answer-11786277
|
||||||
*/
|
*/
|
||||||
function addAttributes( section, element, previousElement, separatorElementAttributes, separatorSectionAttributes ) {
|
function addAttributeInElement(node, elementTarget, separator) {
|
||||||
|
|
||||||
if ( element != null && element.childNodes != undefined && element.childNodes.length > 0 ) {
|
var mardownClassesInElementsRegex = new RegExp(separator, 'mg');
|
||||||
previousParentElement = element;
|
var mardownClassRegex = new RegExp("([^\"= ]+?)=\"([^\"=]+?)\"", 'mg');
|
||||||
for( var i = 0; i < element.childNodes.length; i++ ) {
|
var nodeValue = node.nodeValue;
|
||||||
childElement = element.childNodes[i];
|
if (matches = mardownClassesInElementsRegex.exec(nodeValue)) {
|
||||||
if ( i > 0 ) {
|
|
||||||
j = i - 1;
|
var classes = matches[1];
|
||||||
while ( j >= 0 ) {
|
nodeValue = nodeValue.substring(0, matches.index) + nodeValue.substring(mardownClassesInElementsRegex.lastIndex);
|
||||||
aPreviousChildElement = element.childNodes[j];
|
node.nodeValue = nodeValue;
|
||||||
if ( typeof aPreviousChildElement.setAttribute == 'function' && aPreviousChildElement.tagName != "BR" ) {
|
while (matchesClass = mardownClassRegex.exec(classes)) {
|
||||||
previousParentElement = aPreviousChildElement;
|
elementTarget.setAttribute(matchesClass[1], matchesClass[2]);
|
||||||
break;
|
}
|
||||||
}
|
return true;
|
||||||
j = j - 1;
|
}
|
||||||
}
|
return false;
|
||||||
}
|
}
|
||||||
parentSection = section;
|
|
||||||
if( childElement.nodeName == "section" ) {
|
/**
|
||||||
parentSection = childElement ;
|
* Add attributes to the parent element of a text node,
|
||||||
previousParentElement = childElement ;
|
* or the element of an attribute node.
|
||||||
}
|
*/
|
||||||
if ( typeof childElement.setAttribute == 'function' || childElement.nodeType == Node.COMMENT_NODE ) {
|
function addAttributes(section, element, previousElement, separatorElementAttributes, separatorSectionAttributes) {
|
||||||
addAttributes( parentSection, childElement, previousParentElement, separatorElementAttributes, separatorSectionAttributes );
|
|
||||||
}
|
if (element != null && element.childNodes != undefined && element.childNodes.length > 0) {
|
||||||
}
|
previousParentElement = element;
|
||||||
}
|
for (var i = 0; i < element.childNodes.length; i++) {
|
||||||
|
childElement = element.childNodes[i];
|
||||||
if ( element.nodeType == Node.COMMENT_NODE ) {
|
if (i > 0) {
|
||||||
if ( addAttributeInElement( element, previousElement, separatorElementAttributes ) == false ) {
|
j = i - 1;
|
||||||
addAttributeInElement( element, section, separatorSectionAttributes );
|
while (j >= 0) {
|
||||||
}
|
aPreviousChildElement = element.childNodes[j];
|
||||||
}
|
if (typeof aPreviousChildElement.setAttribute == 'function' && aPreviousChildElement.tagName != "BR") {
|
||||||
}
|
previousParentElement = aPreviousChildElement;
|
||||||
|
break;
|
||||||
/**
|
}
|
||||||
* Converts any current data-markdown slides in the
|
j = j - 1;
|
||||||
* DOM to HTML.
|
}
|
||||||
*/
|
}
|
||||||
function convertSlides() {
|
parentSection = section;
|
||||||
|
if (childElement.nodeName == "section") {
|
||||||
var sections = document.querySelectorAll( '[data-markdown]');
|
parentSection = childElement;
|
||||||
|
previousParentElement = childElement;
|
||||||
for( var i = 0, len = sections.length; i < len; i++ ) {
|
}
|
||||||
|
if (typeof childElement.setAttribute == 'function' || childElement.nodeType == Node.COMMENT_NODE) {
|
||||||
var section = sections[i];
|
addAttributes(parentSection, childElement, previousParentElement, separatorElementAttributes, separatorSectionAttributes);
|
||||||
|
}
|
||||||
// Only parse the same slide once
|
}
|
||||||
if( !section.getAttribute( 'data-markdown-parsed' ) ) {
|
}
|
||||||
|
|
||||||
section.setAttribute( 'data-markdown-parsed', true )
|
if (element.nodeType == Node.COMMENT_NODE) {
|
||||||
|
if (addAttributeInElement(element, previousElement, separatorElementAttributes) == false) {
|
||||||
var notes = section.querySelector( 'aside.notes' );
|
addAttributeInElement(element, section, separatorSectionAttributes);
|
||||||
var markdown = getMarkdownFromSlide( section );
|
}
|
||||||
|
}
|
||||||
section.innerHTML = marked( markdown );
|
}
|
||||||
addAttributes( section, section, null, section.getAttribute( 'data-element-attributes' ) ||
|
|
||||||
section.parentNode.getAttribute( 'data-element-attributes' ) ||
|
/**
|
||||||
DEFAULT_ELEMENT_ATTRIBUTES_SEPARATOR,
|
* Converts any current data-markdown slides in the
|
||||||
section.getAttribute( 'data-attributes' ) ||
|
* DOM to HTML.
|
||||||
section.parentNode.getAttribute( 'data-attributes' ) ||
|
*/
|
||||||
DEFAULT_SLIDE_ATTRIBUTES_SEPARATOR);
|
function convertSlides() {
|
||||||
|
|
||||||
// If there were notes, we need to re-add them after
|
var sections = document.querySelectorAll('[data-markdown]');
|
||||||
// having overwritten the section's HTML
|
|
||||||
if( notes ) {
|
for (var i = 0, len = sections.length; i < len; i++) {
|
||||||
section.appendChild( notes );
|
|
||||||
}
|
var section = sections[i];
|
||||||
|
|
||||||
}
|
// Only parse the same slide once
|
||||||
|
if (!section.getAttribute('data-markdown-parsed')) {
|
||||||
}
|
|
||||||
|
section.setAttribute('data-markdown-parsed', true)
|
||||||
}
|
|
||||||
|
var notes = section.querySelector('aside.notes');
|
||||||
// API
|
var markdown = getMarkdownFromSlide(section);
|
||||||
return {
|
|
||||||
|
section.innerHTML = marked(markdown);
|
||||||
initialize: function() {
|
addAttributes(section, section, null, section.getAttribute('data-element-attributes') ||
|
||||||
if( typeof marked === 'undefined' ) {
|
section.parentNode.getAttribute('data-element-attributes') ||
|
||||||
throw 'The reveal.js Markdown plugin requires marked to be loaded';
|
DEFAULT_ELEMENT_ATTRIBUTES_SEPARATOR,
|
||||||
}
|
section.getAttribute('data-attributes') ||
|
||||||
|
section.parentNode.getAttribute('data-attributes') ||
|
||||||
if( typeof hljs !== 'undefined' ) {
|
DEFAULT_SLIDE_ATTRIBUTES_SEPARATOR);
|
||||||
marked.setOptions({
|
|
||||||
highlight: function( code, lang ) {
|
// If there were notes, we need to re-add them after
|
||||||
return hljs.highlightAuto( code, [lang] ).value;
|
// having overwritten the section's HTML
|
||||||
}
|
if (notes) {
|
||||||
});
|
section.appendChild(notes);
|
||||||
}
|
}
|
||||||
|
|
||||||
var options = Reveal.getConfig().markdown;
|
}
|
||||||
|
|
||||||
if ( options ) {
|
}
|
||||||
marked.setOptions( options );
|
|
||||||
}
|
}
|
||||||
|
|
||||||
processSlides();
|
// API
|
||||||
convertSlides();
|
return {
|
||||||
},
|
|
||||||
|
initialize: function () {
|
||||||
// TODO: Do these belong in the API?
|
if (typeof marked === 'undefined') {
|
||||||
processSlides: processSlides,
|
throw 'The reveal.js Markdown plugin requires marked to be loaded';
|
||||||
convertSlides: convertSlides,
|
}
|
||||||
slidify: slidify
|
|
||||||
|
if (typeof hljs !== 'undefined') {
|
||||||
};
|
marked.setOptions({
|
||||||
|
highlight: function (code, lang) {
|
||||||
|
return hljs.highlightAuto(code, [lang]).value;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
var options = Reveal.getConfig().markdown;
|
||||||
|
|
||||||
|
if (options) {
|
||||||
|
marked.setOptions(options);
|
||||||
|
}
|
||||||
|
|
||||||
|
processSlides();
|
||||||
|
convertSlides();
|
||||||
|
},
|
||||||
|
|
||||||
|
// TODO: Do these belong in the API?
|
||||||
|
processSlides: processSlides,
|
||||||
|
convertSlides: convertSlides,
|
||||||
|
slidify: slidify
|
||||||
|
|
||||||
|
};
|
||||||
|
|
||||||
}));
|
}));
|
||||||
|
|||||||
@@ -4,64 +4,64 @@
|
|||||||
*
|
*
|
||||||
* @author Hakim El Hattab
|
* @author Hakim El Hattab
|
||||||
*/
|
*/
|
||||||
var RevealMath = window.RevealMath || (function(){
|
var RevealMath = window.RevealMath || (function () {
|
||||||
|
|
||||||
var options = Reveal.getConfig().math || {};
|
var options = Reveal.getConfig().math || {};
|
||||||
options.mathjax = options.mathjax || 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js';
|
options.mathjax = options.mathjax || 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js';
|
||||||
options.config = options.config || 'TeX-AMS_HTML-full';
|
options.config = options.config || 'TeX-AMS_HTML-full';
|
||||||
|
|
||||||
loadScript( options.mathjax + '?config=' + options.config, function() {
|
loadScript(options.mathjax + '?config=' + options.config, function () {
|
||||||
|
|
||||||
MathJax.Hub.Config({
|
MathJax.Hub.Config({
|
||||||
messageStyle: 'none',
|
messageStyle: 'none',
|
||||||
tex2jax: {
|
tex2jax: {
|
||||||
inlineMath: [['$','$'],['\\(','\\)']] ,
|
inlineMath: [['$', '$'], ['\\(', '\\)']],
|
||||||
skipTags: ['script','noscript','style','textarea','pre']
|
skipTags: ['script', 'noscript', 'style', 'textarea', 'pre']
|
||||||
},
|
},
|
||||||
skipStartupTypeset: true
|
skipStartupTypeset: true
|
||||||
});
|
});
|
||||||
|
|
||||||
// Typeset followed by an immediate reveal.js layout since
|
// Typeset followed by an immediate reveal.js layout since
|
||||||
// the typesetting process could affect slide height
|
// the typesetting process could affect slide height
|
||||||
MathJax.Hub.Queue( [ 'Typeset', MathJax.Hub ] );
|
MathJax.Hub.Queue(['Typeset', MathJax.Hub]);
|
||||||
MathJax.Hub.Queue( Reveal.layout );
|
MathJax.Hub.Queue(Reveal.layout);
|
||||||
|
|
||||||
// Reprocess equations in slides when they turn visible
|
// Reprocess equations in slides when they turn visible
|
||||||
Reveal.addEventListener( 'slidechanged', function( event ) {
|
Reveal.addEventListener('slidechanged', function (event) {
|
||||||
|
|
||||||
MathJax.Hub.Queue( [ 'Typeset', MathJax.Hub, event.currentSlide ] );
|
MathJax.Hub.Queue(['Typeset', MathJax.Hub, event.currentSlide]);
|
||||||
|
|
||||||
} );
|
});
|
||||||
|
|
||||||
} );
|
});
|
||||||
|
|
||||||
function loadScript( url, callback ) {
|
function loadScript(url, callback) {
|
||||||
|
|
||||||
var head = document.querySelector( 'head' );
|
var head = document.querySelector('head');
|
||||||
var script = document.createElement( 'script' );
|
var script = document.createElement('script');
|
||||||
script.type = 'text/javascript';
|
script.type = 'text/javascript';
|
||||||
script.src = url;
|
script.src = url;
|
||||||
|
|
||||||
// Wrapper for callback to make sure it only fires once
|
// Wrapper for callback to make sure it only fires once
|
||||||
var finish = function() {
|
var finish = function () {
|
||||||
if( typeof callback === 'function' ) {
|
if (typeof callback === 'function') {
|
||||||
callback.call();
|
callback.call();
|
||||||
callback = null;
|
callback = null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
script.onload = finish;
|
script.onload = finish;
|
||||||
|
|
||||||
// IE
|
// IE
|
||||||
script.onreadystatechange = function() {
|
script.onreadystatechange = function () {
|
||||||
if ( this.readyState === 'loaded' ) {
|
if (this.readyState === 'loaded') {
|
||||||
finish();
|
finish();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// Normal browsers
|
// Normal browsers
|
||||||
head.appendChild( script );
|
head.appendChild(script);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
})();
|
})();
|
||||||
|
|||||||
@@ -1,13 +1,15 @@
|
|||||||
(function() {
|
(function () {
|
||||||
var multiplex = Reveal.getConfig().multiplex;
|
var multiplex = Reveal.getConfig().multiplex;
|
||||||
var socketId = multiplex.id;
|
var socketId = multiplex.id;
|
||||||
var socket = io.connect(multiplex.url);
|
var socket = io.connect(multiplex.url);
|
||||||
|
|
||||||
socket.on(multiplex.id, function(data) {
|
socket.on(multiplex.id, function (data) {
|
||||||
// ignore data from sockets that aren't ours
|
// ignore data from sockets that aren't ours
|
||||||
if (data.socketId !== socketId) { return; }
|
if (data.socketId !== socketId) {
|
||||||
if( window.location.host === 'localhost:1947' ) return;
|
return;
|
||||||
|
}
|
||||||
|
if (window.location.host === 'localhost:1947') return;
|
||||||
|
|
||||||
Reveal.setState(data.state);
|
Reveal.setState(data.state);
|
||||||
});
|
});
|
||||||
}());
|
}());
|
||||||
|
|||||||
@@ -1,64 +1,65 @@
|
|||||||
var http = require('http');
|
var http = require('http');
|
||||||
var express = require('express');
|
var express = require('express');
|
||||||
var fs = require('fs');
|
var fs = require('fs');
|
||||||
var io = require('socket.io');
|
var io = require('socket.io');
|
||||||
var crypto = require('crypto');
|
var crypto = require('crypto');
|
||||||
|
|
||||||
var app = express();
|
var app = express();
|
||||||
var staticDir = express.static;
|
var staticDir = express.static;
|
||||||
var server = http.createServer(app);
|
var server = http.createServer(app);
|
||||||
|
|
||||||
io = io(server);
|
io = io(server);
|
||||||
|
|
||||||
var opts = {
|
var opts = {
|
||||||
port: process.env.PORT || 1948,
|
port: process.env.PORT || 1948,
|
||||||
baseDir : __dirname + '/../../'
|
baseDir: __dirname + '/../../'
|
||||||
};
|
};
|
||||||
|
|
||||||
io.on( 'connection', function( socket ) {
|
io.on('connection', function (socket) {
|
||||||
socket.on('multiplex-statechanged', function(data) {
|
socket.on('multiplex-statechanged', function (data) {
|
||||||
if (typeof data.secret == 'undefined' || data.secret == null || data.secret === '') return;
|
if (typeof data.secret == 'undefined' || data.secret == null || data.secret === '') return;
|
||||||
if (createHash(data.secret) === data.socketId) {
|
if (createHash(data.secret) === data.socketId) {
|
||||||
data.secret = null;
|
data.secret = null;
|
||||||
socket.broadcast.emit(data.socketId, data);
|
socket.broadcast.emit(data.socketId, data);
|
||||||
};
|
}
|
||||||
});
|
;
|
||||||
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
[ 'css', 'js', 'plugin', 'lib' ].forEach(function(dir) {
|
['css', 'js', 'plugin', 'lib'].forEach(function (dir) {
|
||||||
app.use('/' + dir, staticDir(opts.baseDir + dir));
|
app.use('/' + dir, staticDir(opts.baseDir + dir));
|
||||||
});
|
});
|
||||||
|
|
||||||
app.get("/", function(req, res) {
|
app.get("/", function (req, res) {
|
||||||
res.writeHead(200, {'Content-Type': 'text/html'});
|
res.writeHead(200, {'Content-Type': 'text/html'});
|
||||||
|
|
||||||
var stream = fs.createReadStream(opts.baseDir + '/index.html');
|
var stream = fs.createReadStream(opts.baseDir + '/index.html');
|
||||||
stream.on('error', function( error ) {
|
stream.on('error', function (error) {
|
||||||
res.write('<style>body{font-family: sans-serif;}</style><h2>reveal.js multiplex server.</h2><a href="/token">Generate token</a>');
|
res.write('<style>body{font-family: sans-serif;}</style><h2>reveal.js multiplex server.</h2><a href="/token">Generate token</a>');
|
||||||
res.end();
|
res.end();
|
||||||
});
|
});
|
||||||
stream.on('readable', function() {
|
stream.on('readable', function () {
|
||||||
stream.pipe(res);
|
stream.pipe(res);
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
app.get("/token", function(req,res) {
|
app.get("/token", function (req, res) {
|
||||||
var ts = new Date().getTime();
|
var ts = new Date().getTime();
|
||||||
var rand = Math.floor(Math.random()*9999999);
|
var rand = Math.floor(Math.random() * 9999999);
|
||||||
var secret = ts.toString() + rand.toString();
|
var secret = ts.toString() + rand.toString();
|
||||||
res.send({secret: secret, socketId: createHash(secret)});
|
res.send({secret: secret, socketId: createHash(secret)});
|
||||||
});
|
});
|
||||||
|
|
||||||
var createHash = function(secret) {
|
var createHash = function (secret) {
|
||||||
var cipher = crypto.createCipher('blowfish', secret);
|
var cipher = crypto.createCipher('blowfish', secret);
|
||||||
return(cipher.final('hex'));
|
return (cipher.final('hex'));
|
||||||
};
|
};
|
||||||
|
|
||||||
// Actually listen
|
// Actually listen
|
||||||
server.listen( opts.port || null );
|
server.listen(opts.port || null);
|
||||||
|
|
||||||
var brown = '\033[33m',
|
var brown = '\033[33m',
|
||||||
green = '\033[32m',
|
green = '\033[32m',
|
||||||
reset = '\033[0m';
|
reset = '\033[0m';
|
||||||
|
|
||||||
console.log( brown + "reveal.js:" + reset + " Multiplex running on port " + green + opts.port + reset );
|
console.log(brown + "reveal.js:" + reset + " Multiplex running on port " + green + opts.port + reset);
|
||||||
@@ -1,34 +1,36 @@
|
|||||||
(function() {
|
(function () {
|
||||||
|
|
||||||
// Don't emit events from inside of notes windows
|
// Don't emit events from inside of notes windows
|
||||||
if ( window.location.search.match( /receiver/gi ) ) { return; }
|
if (window.location.search.match(/receiver/gi)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
var multiplex = Reveal.getConfig().multiplex;
|
var multiplex = Reveal.getConfig().multiplex;
|
||||||
|
|
||||||
var socket = io.connect( multiplex.url );
|
var socket = io.connect(multiplex.url);
|
||||||
|
|
||||||
function post() {
|
function post() {
|
||||||
|
|
||||||
var messageData = {
|
var messageData = {
|
||||||
state: Reveal.getState(),
|
state: Reveal.getState(),
|
||||||
secret: multiplex.secret,
|
secret: multiplex.secret,
|
||||||
socketId: multiplex.id
|
socketId: multiplex.id
|
||||||
};
|
};
|
||||||
|
|
||||||
socket.emit( 'multiplex-statechanged', messageData );
|
socket.emit('multiplex-statechanged', messageData);
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
// post once the page is loaded, so the client follows also on "open URL".
|
// post once the page is loaded, so the client follows also on "open URL".
|
||||||
window.addEventListener( 'load', post );
|
window.addEventListener('load', post);
|
||||||
|
|
||||||
// Monitor events that trigger a change in state
|
// Monitor events that trigger a change in state
|
||||||
Reveal.addEventListener( 'slidechanged', post );
|
Reveal.addEventListener('slidechanged', post);
|
||||||
Reveal.addEventListener( 'fragmentshown', post );
|
Reveal.addEventListener('fragmentshown', post);
|
||||||
Reveal.addEventListener( 'fragmenthidden', post );
|
Reveal.addEventListener('fragmenthidden', post);
|
||||||
Reveal.addEventListener( 'overviewhidden', post );
|
Reveal.addEventListener('overviewhidden', post);
|
||||||
Reveal.addEventListener( 'overviewshown', post );
|
Reveal.addEventListener('overviewshown', post);
|
||||||
Reveal.addEventListener( 'paused', post );
|
Reveal.addEventListener('paused', post);
|
||||||
Reveal.addEventListener( 'resumed', post );
|
Reveal.addEventListener('resumed', post);
|
||||||
|
|
||||||
}());
|
}());
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user