Merge branch 'master' into feature_target_filtering_supports_overdue

Conflicts:
	hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/JpaTargetManagement.java

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/EntityFactory.java

@@ -11,6 +11,8 @@ package org.eclipse.hawkbit.repository;
 import java.util.Collection;
 import java.util.concurrent.TimeUnit;
 
+import javax.validation.constraints.NotNull;
+
 import org.eclipse.hawkbit.repository.model.Action;
 import org.eclipse.hawkbit.repository.model.Action.Status;
 import org.eclipse.hawkbit.repository.model.ActionStatus;
@@ -64,7 +66,7 @@ public interface EntityFactory {
      * 
      * @return {@link ActionStatus} object
      */
-    ActionStatus generateActionStatus(Action action, Status status, Long occurredAt);
+    ActionStatus generateActionStatus(@NotNull Action action, @NotNull Status status, Long occurredAt);
 
     /**
      * Generates an {@link ActionStatus} object without persisting it.
@@ -81,7 +83,7 @@ public interface EntityFactory {
      * 
      * @return {@link ActionStatus} object
      */
-    ActionStatus generateActionStatus(Action action, final Status status, Long occurredAt,
+    ActionStatus generateActionStatus(@NotNull Action action, @NotNull Status status, Long occurredAt,
             final Collection<String> messages);
 
     /**
@@ -99,7 +101,8 @@ public interface EntityFactory {
      * 
      * @return {@link ActionStatus} object
      */
-    ActionStatus generateActionStatus(Action action, Status status, Long occurredAt, final String message);
+    ActionStatus generateActionStatus(@NotNull Action action, @NotNull Status status, Long occurredAt,
+            final String message);
 
     /**
      * Generates an empty {@link DistributionSet} without persisting it.
@@ -124,8 +127,8 @@ public interface EntityFactory {
      * 
      * @return {@link DistributionSet} object
      */
-    DistributionSet generateDistributionSet(String name, String version, String description, DistributionSetType type,
-            Collection<SoftwareModule> moduleList);
+    DistributionSet generateDistributionSet(@NotNull String name, @NotNull String version, String description,
+            @NotNull DistributionSetType type, Collection<SoftwareModule> moduleList);
 
     /**
      * Generates an empty {@link DistributionSetMetadata} element without
@@ -148,7 +151,8 @@ public interface EntityFactory {
      * 
      * @return {@link DistributionSetMetadata} object
      */
-    DistributionSetMetadata generateDistributionSetMetadata(DistributionSet distributionSet, String key, String value);
+    DistributionSetMetadata generateDistributionSetMetadata(@NotNull DistributionSet distributionSet,
+            @NotNull String key, String value);
 
     /**
      * Generates an empty {@link DistributionSetTag} without persisting it.
@@ -164,7 +168,7 @@ public interface EntityFactory {
      *            of the tag
      * @return {@link DistributionSetTag} object
      */
-    DistributionSetTag generateDistributionSetTag(String name);
+    DistributionSetTag generateDistributionSetTag(@NotNull String name);
 
     /**
      * Generates a {@link DistributionSetTag} without persisting it.
@@ -177,7 +181,7 @@ public interface EntityFactory {
      *            of the tag
      * @return {@link DistributionSetTag} object
      */
-    DistributionSetTag generateDistributionSetTag(String name, String description, String colour);
+    DistributionSetTag generateDistributionSetTag(@NotNull String name, String description, String colour);
 
     /**
      * Generates an empty {@link DistributionSetType} without persisting it.
@@ -198,7 +202,7 @@ public interface EntityFactory {
      * 
      * @return {@link DistributionSetType} object
      */
-    DistributionSetType generateDistributionSetType(String key, String name, String description);
+    DistributionSetType generateDistributionSetType(@NotNull String key, @NotNull String name, String description);
 
     /**
      * Generates an empty {@link Rollout} without persisting it.
@@ -237,8 +241,8 @@ public interface EntityFactory {
      * 
      * @return {@link SoftwareModule} object
      */
-    SoftwareModule generateSoftwareModule(SoftwareModuleType type, String name, String version, String description,
-            String vendor);
+    SoftwareModule generateSoftwareModule(@NotNull SoftwareModuleType type, @NotNull String name,
+            @NotNull String version, String description, String vendor);
 
     /**
      * Generates an empty {@link SoftwareModuleMetadata} pair without persisting
@@ -260,7 +264,8 @@ public interface EntityFactory {
      * 
      * @return {@link SoftwareModuleMetadata} object
      */
-    SoftwareModuleMetadata generateSoftwareModuleMetadata(SoftwareModule softwareModule, String key, String value);
+    SoftwareModuleMetadata generateSoftwareModuleMetadata(@NotNull SoftwareModule softwareModule, @NotNull String key,
+            String value);
 
     /**
      * Generates an empty {@link SoftwareModuleType} without persisting it.
@@ -283,7 +288,8 @@ public interface EntityFactory {
      * 
      * @return {@link SoftwareModuleType} object
      */
-    SoftwareModuleType generateSoftwareModuleType(String key, String name, String description, int maxAssignments);
+    SoftwareModuleType generateSoftwareModuleType(@NotNull String key, @NotNull String name, String description,
+            int maxAssignments);
 
     /**
      * Generates an empty {@link Target} without persisting it.
@@ -307,7 +313,7 @@ public interface EntityFactory {
      * 
      * @return {@link Target} object
      */
-    Target generateTarget(@NotEmpty String controllerID, @NotEmpty String securityToken);
+    Target generateTarget(@NotEmpty String controllerID, String securityToken);
 
     /**
      * Generates an empty {@link TargetFilterQuery} without persisting it.
@@ -330,7 +336,7 @@ public interface EntityFactory {
      *            of the tag
      * @return {@link TargetTag} object
      */
-    TargetTag generateTargetTag(String name);
+    TargetTag generateTargetTag(@NotNull String name);
 
     /**
      * Generates a {@link TargetTag} without persisting it.
@@ -343,7 +349,7 @@ public interface EntityFactory {
      *            of the tag
      * @return {@link TargetTag} object
      */
-    TargetTag generateTargetTag(String name, String description, String colour);
+    TargetTag generateTargetTag(@NotNull String name, String description, String colour);
 
     /**
      * Generates an empty {@link LocalArtifact} without persisting it.

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionStatus.java

@@ -47,10 +47,10 @@ public interface ActionStatus extends TenantAwareBaseEntity {
      * @return current {@link Status#DOWNLOAD} progress if known by the update
      *         server.
      */
-    int getDownloadProgressPercent();
+    short getDownloadProgressPercent();
 
     /**
-     * @return list of message entries that can be added to the
+     * @return immutable list of message entries that in the
      *         {@link ActionStatus}.
      */
     List<String> getMessages();

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Artifact.java

@@ -37,6 +37,6 @@ public interface Artifact extends TenantAwareBaseEntity {
     /**
      * @return size of the artifact in bytes.
      */
-    Long getSize();
+    long getSize();
 
 }

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/BaseEntity.java

@@ -44,6 +44,6 @@ public interface BaseEntity extends Serializable, Identifiable<Long> {
     /**
      * @return version of the {@link BaseEntity}.
      */
-    long getOptLockRevision();
+    int getOptLockRevision();
 
 }

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSet.java

@@ -26,10 +26,25 @@ import org.eclipse.hawkbit.repository.DistributionSetManagement;
 public interface DistributionSet extends NamedVersionedEntity {
 
     /**
-     * @return {@link Set} of assigned {@link DistributionSetTag}s.
+     * @return immutable {@link Set} of assigned {@link DistributionSetTag}s.
      */
     Set<DistributionSetTag> getTags();
 
+    /**
+     * @param tag
+     *            to add
+     * @return <code>true</code> if tag could be added sucessfully (i.e. was not
+     *         already in the list).
+     */
+    boolean addTag(final DistributionSetTag tag);
+
+    /**
+     * @param tag
+     *            to remove
+     * @return <code>true</code> if tag was in the list and removed
+     */
+    boolean removeTag(final DistributionSetTag tag);
+
     /**
      * @return <code>true</code> if the set is deleted and only kept for history
      *         purposes.

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTag.java

@@ -17,8 +17,8 @@ import java.util.List;
 public interface DistributionSetTag extends Tag {
 
     /**
-     * @return {@link List} of {@link DistributionSet}s this {@link Tag} is
-     *         assigned to.
+     * @return immutable {@link List} of {@link DistributionSet}s this
+     *         {@link Tag} is assigned to.
      */
     List<DistributionSet> getAssignedToDistributionSet();
 

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetType.java

@@ -27,15 +27,15 @@ public interface DistributionSetType extends NamedEntity {
     boolean isDeleted();
 
     /**
-     * @return set of {@link SoftwareModuleType}s that need to be in a
+     * @return immutable set of {@link SoftwareModuleType}s that need to be in a
      *         {@link DistributionSet} of this type to be
      *         {@link DistributionSet#isComplete()}.
      */
     Set<SoftwareModuleType> getMandatoryModuleTypes();
 
     /**
-     * @return set of optional {@link SoftwareModuleType}s that can be in a
-     *         {@link DistributionSet} of this type.
+     * @return immutable set of optional {@link SoftwareModuleType}s that can be
+     *         in a {@link DistributionSet} of this type.
      */
     Set<SoftwareModuleType> getOptionalModuleTypes();
 

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Rollout.java

@@ -38,7 +38,7 @@ public interface Rollout extends NamedEntity {
     void setDistributionSet(DistributionSet distributionSet);
 
     /**
-     * @return list of deployment groups of the rollout.
+     * @return immutable list of deployment groups of the rollout.
      */
     List<RolloutGroup> getRolloutGroups();
 

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroup.java

@@ -155,7 +155,7 @@ public interface RolloutGroup extends NamedEntity {
     /**
      * @return the total amount of targets containing in this group
      */
-    long getTotalTargets();
+    int getTotalTargets();
 
     /**
      * @return the totalTargetCountStatus

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModule.java

@@ -11,6 +11,10 @@ package org.eclipse.hawkbit.repository.model;
 import java.util.List;
 import java.util.Optional;
 
+/**
+ * Software package as sub element of a {@link DistributionSet}.
+ *
+ */
 public interface SoftwareModule extends NamedVersionedEntity {
 
     /**
@@ -40,12 +44,12 @@ public interface SoftwareModule extends NamedVersionedEntity {
     Optional<LocalArtifact> getLocalArtifactByFilename(String fileName);
 
     /**
-     * @return the artifacts
+     * @return immutable list of all artifacts
      */
     List<Artifact> getArtifacts();
 
     /**
-     * @return local artifacts only
+     * @return immutable list of local artifacts only
      */
     List<LocalArtifact> getLocalArtifacts();
 
@@ -104,7 +108,8 @@ public interface SoftwareModule extends NamedVersionedEntity {
     List<SoftwareModuleMetadata> getMetadata();
 
     /**
-     * @return the assignedTo
+     * @return immutable list of {@link DistributionSet}s the module is assigned
+     *         to
      */
     List<DistributionSet> getAssignedTo();
 

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Target.java

@@ -32,12 +32,12 @@ public interface Target extends NamedEntity {
     String getControllerId();
 
     /**
-     * @return assigned {@link TargetTag}s.
+     * @return immutable set of assigned {@link TargetTag}s.
      */
     Set<TargetTag> getTags();
 
     /**
-     * @return {@link Action} history of the {@link Target}.
+     * @return immutable {@link Action} history of the {@link Target}.
      */
     List<Action> getActions();
 
@@ -64,4 +64,19 @@ public interface Target extends NamedEntity {
      */
     void setSecurityToken(String token);
 
+    /**
+     * @param tag
+     *            to add
+     * @return <code>true</code> if tag could be added sucessfully (i.e. was not
+     *         already in the list).
+     */
+    public boolean addTag(TargetTag tag);
+
+    /**
+     * @param tag
+     *            to remove
+     * @return <code>true</code> if tag was in the list and removed
+     */
+    public boolean removeTag(TargetTag tag);
+
 }

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetInfo.java

@@ -36,7 +36,8 @@ public interface TargetInfo extends Serializable {
 
     /**
      * @return time in {@link TimeUnit#MILLISECONDS} GMT when the {@link Target}
-     *         polled the server the last time.
+     *         polled the server the last time or <code>null</code> if target
+     *         has never queried yet.
      */
     Long getLastTargetQuery();
 

hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTag.java

@@ -17,7 +17,7 @@ import java.util.List;
 public interface TargetTag extends Tag {
 
     /**
-     * @return {@link List} of targets assigned to this {@link Tag}.
+     * @return immutable {@link List} of targets assigned to this {@link Tag}.
      */
     List<Target> getAssignedToTargets();