Code format hawkbit-dmf (#1938)

Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
This commit is contained in:
Avgustin Marinov
2024-11-05 11:26:09 +02:00
committed by GitHub
parent e18181bd7b
commit 7161b8803a
13 changed files with 69 additions and 64 deletions

View File

@@ -1,8 +1,10 @@
# hawkBit device management federation API - model definition
This API is used for communicating with the hawkBit Update Server through AMQP.
It is used to integrate other device management system through a high throughput protocol optimized for service to service communication.
It is used to integrate other device management system through a high throughput protocol optimized for service to
service communication.
# Version 1
The model follows [semantic versioning](http://semver.org) with MAJOR version, i.e. breaking changes will result in a new MAJOR version.
The model follows [semantic versioning](http://semver.org) with MAJOR version, i.e. breaking changes will result in a
new MAJOR version.

View File

@@ -9,22 +9,22 @@
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">
<modelVersion>4.0.0</modelVersion>
<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">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.eclipse.hawkbit</groupId>
<artifactId>hawkbit-dmf-parent</artifactId>
<version>${revision}</version>
</parent>
<artifactId>hawkbit-dmf-api</artifactId>
<name>hawkBit :: DMF :: API</name>
<parent>
<groupId>org.eclipse.hawkbit</groupId>
<artifactId>hawkbit-dmf-parent</artifactId>
<version>${revision}</version>
</parent>
<artifactId>hawkbit-dmf-api</artifactId>
<name>hawkBit :: DMF :: API</name>
<dependencies>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
</dependency>
</dependencies>
<dependencies>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
</dependency>
</dependencies>
</project>

View File

@@ -11,7 +11,6 @@ package org.eclipse.hawkbit.dmf.amqp.api;
/**
* The amqp message types which can be handled.
*
*/
public enum MessageType {

View File

@@ -26,7 +26,7 @@ public class DmfArtifactHash {
/**
* Constructor.
*
*
* @param sha1 the sha1 hash
* @param md5 the md5 hash
*/

View File

@@ -9,6 +9,10 @@
*/
package org.eclipse.hawkbit.dmf.json.model;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
@@ -16,19 +20,15 @@ import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Getter;
import lombok.Setter;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* JSON representation of batch download and update request.
*
*/
@JsonInclude(Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
public class DmfBatchDownloadAndUpdateRequest {
@Getter @Setter
@Getter
@Setter
@JsonProperty
private Long timestamp;
@@ -70,8 +70,7 @@ public class DmfBatchDownloadAndUpdateRequest {
/**
* Add a Target.
*
* @param target
* the target
* @param target the target
*/
public void addTarget(final DmfTarget target) {
if (targets == null) {

View File

@@ -9,6 +9,10 @@
*/
package org.eclipse.hawkbit.dmf.json.model;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;
@@ -16,10 +20,6 @@ import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Getter;
import lombok.Setter;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* JSON representation of confirm request.
*/
@@ -27,7 +27,8 @@ import java.util.List;
@JsonIgnoreProperties(ignoreUnknown = true)
public class DmfConfirmRequest extends DmfActionRequest {
@Getter @Setter
@Getter
@Setter
@JsonProperty
private String targetSecurityToken;
@@ -45,8 +46,7 @@ public class DmfConfirmRequest extends DmfActionRequest {
/**
* Add a Software module.
*
* @param createSoftwareModule
* the module
* @param createSoftwareModule the module
*/
public void addSoftwareModule(final DmfSoftwareModule createSoftwareModule) {
if (softwareModules == null) {

View File

@@ -48,8 +48,7 @@ public class DmfDownloadAndUpdateRequest extends DmfActionRequest {
/**
* Add a Software module.
*
* @param createSoftwareModule
* the module
* @param createSoftwareModule the module
*/
public void addSoftwareModule(final DmfSoftwareModule createSoftwareModule) {
if (softwareModules == null) {

View File

@@ -23,6 +23,7 @@ import lombok.Data;
@JsonInclude(Include.NON_NULL)
@JsonIgnoreProperties(ignoreUnknown = true)
public class DmfMetadata {
@JsonProperty
private final String key;

View File

@@ -12,10 +12,6 @@ package org.eclipse.hawkbit.dmf.json.model;
import java.util.ArrayList;
import java.util.List;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.eclipse.hawkbit.dmf.amqp.api.EventTopic;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
@@ -25,6 +21,9 @@ import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonSubTypes.Type;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonValue;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.eclipse.hawkbit.dmf.amqp.api.EventTopic;
/**
* JSON representation of a multi-action request.

View File

@@ -12,7 +12,6 @@ package org.eclipse.hawkbit.dmf.json.model;
import java.util.Collections;
import java.util.List;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonInclude.Include;

View File

@@ -12,7 +12,7 @@ package org.eclipse.hawkbit.dmf.json.model;
/**
* Enumerates the supported update modes. Each mode represents an attribute
* update strategy.
*
*
* @see DmfAttributeUpdate
*/
public enum DmfUpdateMode {