Move deprecated repository and mgmt rest methods in separate module (#2177)

Some already deprecated management REST methods are moved in separate module (together with used only for them repository api and impl) in order to have cleanly separate deprecatd REST API.
The new module is hawkbit-mgmt-resource-deprecated. It is inculded, by default, in hawkbit-mgmt-stater.
* when we decide to remove the deprecated REST API implementation completely - will be easily remved - just module and refs
* deprecated REST API could be excluded (by removing the module from runtime) even before that for the runtimes.
* after removal, for some time (untill the usad management and repository APIs are compatible) it will be possible to refer (and include) the deprecated method implementation together with the next hawkBit versions.

The deprecated methods are:
* POST /rest/v1/distributionsettags/{distributionsetTagId}/assigned/toggleTagAssignment
* POST /rest/v1/distributionsettags/{distributionsetTagId}/assigned
* POST /rest/v1/targettags/{targetTagId}/assigned/toggleTagAssignment
* POST /rest/v1/targettags/{targetTagId}/assigned

Signed-off-by: Avgustin Marinov <Avgustin.Marinov@bosch.com>

hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtDistributionSetMapper.java

@@ -129,7 +129,8 @@ public final class MgmtDistributionSetMapper {
         return result;
     }
 
-    static List<MgmtDistributionSet> toResponseDistributionSets(final Collection<DistributionSet> sets) {
+    // TODO - to be made package visible when hawkbit-mgmt-rest-deprecated is removed
+    public static List<MgmtDistributionSet> toResponseDistributionSets(final Collection<DistributionSet> sets) {
         if (sets == null) {
             return Collections.emptyList();
         }

hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtDistributionSetTagResource.java

@@ -10,13 +10,10 @@
 package org.eclipse.hawkbit.mgmt.rest.resource;
 
 import java.util.List;
-import java.util.stream.Collectors;
 
 import lombok.extern.slf4j.Slf4j;
 import org.eclipse.hawkbit.mgmt.json.model.PagedList;
 import org.eclipse.hawkbit.mgmt.json.model.distributionset.MgmtDistributionSet;
-import org.eclipse.hawkbit.mgmt.json.model.tag.MgmtAssignedDistributionSetRequestBody;
-import org.eclipse.hawkbit.mgmt.json.model.tag.MgmtDistributionSetTagAssigmentResult;
 import org.eclipse.hawkbit.mgmt.json.model.tag.MgmtTag;
 import org.eclipse.hawkbit.mgmt.json.model.tag.MgmtTagRequestBodyPut;
 import org.eclipse.hawkbit.mgmt.rest.api.MgmtDistributionSetTagRestApi;
@@ -28,7 +25,6 @@ import org.eclipse.hawkbit.repository.OffsetBasedPageRequest;
 import org.eclipse.hawkbit.repository.exception.EntityNotFoundException;
 import org.eclipse.hawkbit.repository.model.DistributionSet;
 import org.eclipse.hawkbit.repository.model.DistributionSetTag;
-import org.eclipse.hawkbit.repository.model.DistributionSetTagAssignmentResult;
 import org.springframework.data.domain.Page;
 import org.springframework.data.domain.Pageable;
 import org.springframework.data.domain.Slice;
@@ -182,45 +178,6 @@ public class MgmtDistributionSetTagResource implements MgmtDistributionSetTagRes
         return ResponseEntity.ok().build();
     }
 
-    @Override
-    public ResponseEntity<MgmtDistributionSetTagAssigmentResult> toggleTagAssignment(
-            final Long distributionsetTagId,
-            final List<MgmtAssignedDistributionSetRequestBody> assignedDSRequestBodies) {
-        log.debug("Toggle distribution set assignment {} for ds tag {}", assignedDSRequestBodies.size(), distributionsetTagId);
-
-        final DistributionSetTag tag = findDistributionTagById(distributionsetTagId);
-
-        final DistributionSetTagAssignmentResult assigmentResult = this.distributionSetManagement
-                .toggleTagAssignment(findDistributionSetIds(assignedDSRequestBodies), tag.getName());
-
-        final MgmtDistributionSetTagAssigmentResult tagAssigmentResultRest = new MgmtDistributionSetTagAssigmentResult();
-        tagAssigmentResultRest.setAssignedDistributionSets(
-                MgmtDistributionSetMapper.toResponseDistributionSets(assigmentResult.getAssignedEntity()));
-        tagAssigmentResultRest.setUnassignedDistributionSets(
-                MgmtDistributionSetMapper.toResponseDistributionSets(assigmentResult.getUnassignedEntity()));
-
-        log.debug("Toggled assignedDS {} and unassignedDS{}", assigmentResult.getAssigned(), assigmentResult.getUnassigned());
-
-        return ResponseEntity.ok(tagAssigmentResultRest);
-    }
-
-    @Override
-    public ResponseEntity<List<MgmtDistributionSet>> assignDistributionSetsByRequestBody(
-            final Long distributionsetTagId,
-            final List<MgmtAssignedDistributionSetRequestBody> assignedDSRequestBodies) {
-        log.debug("Assign DistributionSet {} for ds tag {}", assignedDSRequestBodies.size(), distributionsetTagId);
-        final List<DistributionSet> assignedDs = this.distributionSetManagement
-                .assignTag(findDistributionSetIds(assignedDSRequestBodies), distributionsetTagId);
-        log.debug("Assigned DistributionSet {}", assignedDs.size());
-        return ResponseEntity.ok(MgmtDistributionSetMapper.toResponseDistributionSets(assignedDs));
-    }
-
-    private static List<Long> findDistributionSetIds(
-            final List<MgmtAssignedDistributionSetRequestBody> assignedDistributionSetRequestBodies) {
-        return assignedDistributionSetRequestBodies.stream()
-                .map(MgmtAssignedDistributionSetRequestBody::getDistributionSetId).collect(Collectors.toList());
-    }
-
     private DistributionSetTag findDistributionTagById(final Long distributionsetTagId) {
         return distributionSetTagManagement.get(distributionsetTagId)
                 .orElseThrow(() -> new EntityNotFoundException(DistributionSetTag.class, distributionsetTagId));

hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtOpenApiConfiguration.java

@@ -36,7 +36,7 @@ public class MgmtOpenApiConfiguration {
         return GroupedOpenApi
                 .builder()
                 .group("Management API")
-                .pathsToMatch("/rest/v1/**")
+                .pathsToMatch("/rest/v*/**")
                 .addOpenApiCustomizer(openApi ->
                         openApi
                                 .addSecurityItem(new SecurityRequirement()

hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtTargetTagResource.java

@@ -12,14 +12,11 @@ package org.eclipse.hawkbit.mgmt.rest.resource;
 import java.util.Collection;
 import java.util.List;
 import java.util.concurrent.atomic.AtomicReference;
-import java.util.stream.Collectors;
 
 import lombok.extern.slf4j.Slf4j;
 import org.eclipse.hawkbit.mgmt.json.model.PagedList;
-import org.eclipse.hawkbit.mgmt.json.model.tag.MgmtAssignedTargetRequestBody;
 import org.eclipse.hawkbit.mgmt.json.model.tag.MgmtTag;
 import org.eclipse.hawkbit.mgmt.json.model.tag.MgmtTagRequestBodyPut;
-import org.eclipse.hawkbit.mgmt.json.model.tag.MgmtTargetTagAssigmentResult;
 import org.eclipse.hawkbit.mgmt.json.model.target.MgmtTarget;
 import org.eclipse.hawkbit.mgmt.rest.api.MgmtTargetTagRestApi;
 import org.eclipse.hawkbit.mgmt.rest.resource.util.PagingUtility;
@@ -31,7 +28,6 @@ import org.eclipse.hawkbit.repository.TenantConfigurationManagement;
 import org.eclipse.hawkbit.repository.exception.EntityNotFoundException;
 import org.eclipse.hawkbit.repository.model.Target;
 import org.eclipse.hawkbit.repository.model.TargetTag;
-import org.eclipse.hawkbit.repository.model.TargetTagAssignmentResult;
 import org.eclipse.hawkbit.security.SystemSecurityContext;
 import org.eclipse.hawkbit.utils.TenantConfigHelper;
 import org.springframework.data.domain.Page;
@@ -55,12 +51,12 @@ public class MgmtTargetTagResource implements MgmtTargetTagRestApi {
 
     MgmtTargetTagResource(
             final TargetTagManagement tagManagement, final TargetManagement targetManagement,
-            final EntityFactory entityFactory, final SystemSecurityContext securityContext,
-            final TenantConfigurationManagement configurationManagement) {
+            final EntityFactory entityFactory,
+            final SystemSecurityContext securityContext, final TenantConfigurationManagement configurationManagement) {
         this.tagManagement = tagManagement;
         this.targetManagement = targetManagement;
         this.entityFactory = entityFactory;
-        this.tenantConfigHelper = TenantConfigHelper.usingContext(securityContext, configurationManagement);
+        tenantConfigHelper = TenantConfigHelper.usingContext(securityContext, configurationManagement);
     }
 
     @Override
@@ -174,7 +170,7 @@ public class MgmtTargetTagResource implements MgmtTargetTagRestApi {
     @Override
     public ResponseEntity<Void> unassignTarget(final Long targetTagId, final String controllerId) {
         log.debug("Unassign target {} for target tag {}", controllerId, targetTagId);
-        this.targetManagement.unassignTag(controllerId, targetTagId);
+        this.targetManagement.unassignTag(List.of(controllerId), targetTagId);
         return ResponseEntity.ok().build();
     }
 
@@ -197,40 +193,8 @@ public class MgmtTargetTagResource implements MgmtTargetTagRestApi {
         return ResponseEntity.ok().build();
     }
 
-    @Override
-    public ResponseEntity<MgmtTargetTagAssigmentResult> toggleTagAssignment(
-            final Long targetTagId, final List<MgmtAssignedTargetRequestBody> assignedTargetRequestBodies) {
-        log.debug("Toggle Target assignment {} for target tag {}", assignedTargetRequestBodies.size(), targetTagId);
-
-        final TargetTag targetTag = findTargetTagById(targetTagId);
-        final TargetTagAssignmentResult assigmentResult = this.targetManagement
-                .toggleTagAssignment(findTargetControllerIds(assignedTargetRequestBodies), targetTag.getName());
-
-        final MgmtTargetTagAssigmentResult tagAssigmentResultRest = new MgmtTargetTagAssigmentResult();
-        tagAssigmentResultRest.setAssignedTargets(
-                MgmtTargetMapper.toResponse(assigmentResult.getAssignedEntity(), tenantConfigHelper));
-        tagAssigmentResultRest.setUnassignedTargets(
-                MgmtTargetMapper.toResponse(assigmentResult.getUnassignedEntity(), tenantConfigHelper));
-        return ResponseEntity.ok(tagAssigmentResultRest);
-    }
-
-    @Override
-    public ResponseEntity<List<MgmtTarget>> assignTargetsByRequestBody(
-            final Long targetTagId, final List<MgmtAssignedTargetRequestBody> assignedTargetRequestBodies) {
-        log.debug("Assign targets {} for target tag {}", assignedTargetRequestBodies, targetTagId);
-        final List<Target> assignedTarget = this.targetManagement
-                .assignTag(findTargetControllerIds(assignedTargetRequestBodies), targetTagId);
-        return ResponseEntity.ok(MgmtTargetMapper.toResponse(assignedTarget, tenantConfigHelper));
-    }
-
     private TargetTag findTargetTagById(final Long targetTagId) {
         return tagManagement.get(targetTagId)
                 .orElseThrow(() -> new EntityNotFoundException(TargetTag.class, targetTagId));
     }
-
-    private List<String> findTargetControllerIds(
-            final List<MgmtAssignedTargetRequestBody> assignedTargetRequestBodies) {
-        return assignedTargetRequestBodies.stream().map(MgmtAssignedTargetRequestBody::getControllerId)
-                .collect(Collectors.toList());
-    }
 }