lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Refactoring the audit log message -> description field

Browse Source 
Signed-off-by: Denislav Prinov <denislav.prinov@bosch.com>
This commit is contained in:
Denislav Prinov
2025-04-22 08:11:53 +03:00
parent 7486f54291
commit 7aa33cd96b
16 changed files with 50 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
hawkbit-ddi/hawkbit-ddi-resource/src/main/java/org/eclipse/hawkbit/ddi/rest/resource/DdiRootController.java
View File

@@ -452,7 +452,7 @@ public class DdiRootController implements DdiRootControllerRestApi {
} }
@Override @Override
@AuditLog(entity = "DDI", type = AuditLog.Type.UPDATE, message = "Activate Auto Confirmation", logResponse = true) @AuditLog(entity = "DDI", type = AuditLog.Type.UPDATE, description = "Activate Auto Confirmation", logResponse = true)
public ResponseEntity<Void> activateAutoConfirmation( public ResponseEntity<Void> activateAutoConfirmation(
final String tenant, final String controllerId, final DdiActivateAutoConfirmation body) { final String tenant, final String controllerId, final DdiActivateAutoConfirmation body) {
final String initiator = body == null ? null : body.getInitiator(); final String initiator = body == null ? null : body.getInitiator();
@@ -464,7 +464,7 @@ public class DdiRootController implements DdiRootControllerRestApi {
} }
@Override @Override
@AuditLog(entity = "DDI", type = AuditLog.Type.UPDATE, message = "Deactivate Auto Confirmation", logResponse = true) @AuditLog(entity = "DDI", type = AuditLog.Type.UPDATE, description = "Deactivate Auto Confirmation", logResponse = true)
public ResponseEntity<Void> deactivateAutoConfirmation(final String tenant, final String controllerId) { public ResponseEntity<Void> deactivateAutoConfirmation(final String tenant, final String controllerId) {
log.debug("Deactivate auto-confirmation request for device ‘{}‘", controllerId); log.debug("Deactivate auto-confirmation request for device ‘{}‘", controllerId);
confirmationManagement.deactivateAutoConfirmation(controllerId); confirmationManagement.deactivateAutoConfirmation(controllerId);

2
hawkbit-dmf/hawkbit-dmf-amqp/src/main/java/org/eclipse/hawkbit/amqp/AmqpMessageHandlerService.java
View File

@@ -407,7 +407,7 @@ public class AmqpMessageHandlerService extends BaseAmqpService {
} }
} }
@AuditLog(entity = "DMF", type = AuditLog.Type.DELETE, message = "Delete Target", logResponse = true) @AuditLog(entity = "DMF", type = AuditLog.Type.DELETE, description = "Delete Target", logResponse = true)
private void deleteTarget(final Message message) { private void deleteTarget(final Message message) {
final String thingId = getStringHeaderKey(message, MessageHeaderKey.THING_ID, THING_ID_NULL); final String thingId = getStringHeaderKey(message, MessageHeaderKey.THING_ID, THING_ID_NULL);
controllerManagement.deleteExistingTarget(thingId); controllerManagement.deleteExistingTarget(thingId);

2
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtBasicAuthResource.java
View File

@@ -32,7 +32,7 @@ public class MgmtBasicAuthResource implements MgmtBasicAuthRestApi {
} }
@Override @Override
@AuditLog(entity = "BasicAuth", type = AuditLog.Type.READ, message = "Validate Basic Auth") @AuditLog(entity = "BasicAuth", type = AuditLog.Type.READ, description = "Validate Basic Auth")
public ResponseEntity<MgmtUserInfo> validateBasicAuth() { public ResponseEntity<MgmtUserInfo> validateBasicAuth() {
final MgmtUserInfo userInfo = new MgmtUserInfo(); final MgmtUserInfo userInfo = new MgmtUserInfo();
userInfo.setTenant(tenantAware.getCurrentTenant()); userInfo.setTenant(tenantAware.getCurrentTenant());

8
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtDistributionSetResource.java
View File

@@ -169,14 +169,14 @@ public class MgmtDistributionSetResource implements MgmtDistributionSetRestApi {
} }
@Override @Override
@AuditLog(entity = "DistributionSet", type = AuditLog.Type.DELETE, message = "Delete Distribution Set") @AuditLog(entity = "DistributionSet", type = AuditLog.Type.DELETE, description = "Delete Distribution Set")
public ResponseEntity<Void> deleteDistributionSet(final Long distributionSetId) { public ResponseEntity<Void> deleteDistributionSet(final Long distributionSetId) {
distributionSetManagement.delete(distributionSetId); distributionSetManagement.delete(distributionSetId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
} }
@Override @Override
@AuditLog(entity = "DistributionSet", type = AuditLog.Type.UPDATE, message = "Update Distribution Set") @AuditLog(entity = "DistributionSet", type = AuditLog.Type.UPDATE, description = "Update Distribution Set")
public ResponseEntity<MgmtDistributionSet> updateDistributionSet( public ResponseEntity<MgmtDistributionSet> updateDistributionSet(
final Long distributionSetId, final Long distributionSetId,
final MgmtDistributionSetRequestBodyPut toUpdate) { final MgmtDistributionSetRequestBodyPut toUpdate) {
@@ -346,7 +346,7 @@ public class MgmtDistributionSetResource implements MgmtDistributionSetRestApi {
} }
@Override @Override
@AuditLog(entity = "DistributionSet", type = AuditLog.Type.DELETE, message = "Delete Assigned Distribution Set") @AuditLog(entity = "DistributionSet", type = AuditLog.Type.DELETE, description = "Delete Assigned Distribution Set")
public ResponseEntity<Void> deleteAssignSoftwareModules(final Long distributionSetId, final Long softwareModuleId) { public ResponseEntity<Void> deleteAssignSoftwareModules(final Long distributionSetId, final Long softwareModuleId) {
distributionSetManagement.unassignSoftwareModule(distributionSetId, softwareModuleId); distributionSetManagement.unassignSoftwareModule(distributionSetId, softwareModuleId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
@@ -400,7 +400,7 @@ public class MgmtDistributionSetResource implements MgmtDistributionSetRestApi {
} }
@Override @Override
@AuditLog(entity = "DistributionSet", type = AuditLog.Type.DELETE, message = "Invalidate Distribution Set") @AuditLog(entity = "DistributionSet", type = AuditLog.Type.DELETE, description = "Invalidate Distribution Set")
public ResponseEntity<Void> invalidateDistributionSet( public ResponseEntity<Void> invalidateDistributionSet(
final Long distributionSetId, final MgmtInvalidateDistributionSetRequestBody invalidateRequestBody) { final Long distributionSetId, final MgmtInvalidateDistributionSetRequestBody invalidateRequestBody) {
distributionSetInvalidationManagement distributionSetInvalidationManagement

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

@@ -100,7 +100,7 @@ public class MgmtDistributionSetTagResource implements MgmtDistributionSetTagRes
} }
@Override @Override
@AuditLog(entity = "DistributionSetTag", type = AuditLog.Type.UPDATE, message = "Update Distribution Set Tag") @AuditLog(entity = "DistributionSetTag", type = AuditLog.Type.UPDATE, description = "Update Distribution Set Tag")
public ResponseEntity<MgmtTag> updateDistributionSetTag( public ResponseEntity<MgmtTag> updateDistributionSetTag(
final Long distributionsetTagId, final Long distributionsetTagId,
final MgmtTagRequestBodyPut restDSTagRest) { final MgmtTagRequestBodyPut restDSTagRest) {
@@ -116,7 +116,7 @@ public class MgmtDistributionSetTagResource implements MgmtDistributionSetTagRes
} }
@Override @Override
@AuditLog(entity = "DistributionSetTag", type = AuditLog.Type.DELETE, message = "Delete Distribution Set Tag") @AuditLog(entity = "DistributionSetTag", type = AuditLog.Type.DELETE, description = "Delete Distribution Set Tag")
public ResponseEntity<Void> deleteDistributionSetTag( public ResponseEntity<Void> deleteDistributionSetTag(
final Long distributionsetTagId) { final Long distributionsetTagId) {
log.debug("Delete {} distribution set tag", distributionsetTagId); log.debug("Delete {} distribution set tag", distributionsetTagId);
@@ -172,7 +172,7 @@ public class MgmtDistributionSetTagResource implements MgmtDistributionSetTagRes
} }
@Override @Override
@AuditLog(entity = "DistributionSetTag", type = AuditLog.Type.UPDATE, message = "Unassign Distribution Set From Tag") @AuditLog(entity = "DistributionSetTag", type = AuditLog.Type.UPDATE, description = "Unassign Distribution Set From Tag")
public ResponseEntity<Void> unassignDistributionSet( public ResponseEntity<Void> unassignDistributionSet(
final Long distributionsetTagId, final Long distributionsetTagId,
final Long distributionsetId) { final Long distributionsetId) {
@@ -182,7 +182,7 @@ public class MgmtDistributionSetTagResource implements MgmtDistributionSetTagRes
} }
@Override @Override
@AuditLog(entity = "DistributionSetTag", type = AuditLog.Type.UPDATE, message = "Unassign Distribution Sets From Tag") @AuditLog(entity = "DistributionSetTag", type = AuditLog.Type.UPDATE, description = "Unassign Distribution Sets From Tag")
public ResponseEntity<Void> unassignDistributionSets( public ResponseEntity<Void> unassignDistributionSets(
final Long distributionsetTagId, final Long distributionsetTagId,
final List<Long> distributionsetIds) { final List<Long> distributionsetIds) {

8
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtDistributionSetTypeResource.java
View File

@@ -88,7 +88,7 @@ public class MgmtDistributionSetTypeResource implements MgmtDistributionSetTypeR
} }
@Override @Override
@AuditLog(entity = "DistributionSetType", type = AuditLog.Type.DELETE, message = "Delete Distribution Set Type") @AuditLog(entity = "DistributionSetType", type = AuditLog.Type.DELETE, description = "Delete Distribution Set Type")
public ResponseEntity<Void> deleteDistributionSetType(final Long distributionSetTypeId) { public ResponseEntity<Void> deleteDistributionSetType(final Long distributionSetTypeId) {
distributionSetTypeManagement.delete(distributionSetTypeId); distributionSetTypeManagement.delete(distributionSetTypeId);
@@ -96,7 +96,7 @@ public class MgmtDistributionSetTypeResource implements MgmtDistributionSetTypeR
} }
@Override @Override
@AuditLog(entity = "DistributionSetType", type = AuditLog.Type.UPDATE, message = "Update Distribution Set Type") @AuditLog(entity = "DistributionSetType", type = AuditLog.Type.UPDATE, description = "Update Distribution Set Type")
public ResponseEntity<MgmtDistributionSetType> updateDistributionSetType( public ResponseEntity<MgmtDistributionSetType> updateDistributionSetType(
final Long distributionSetTypeId, final MgmtDistributionSetTypeRequestBodyPut restDistributionSetType) { final Long distributionSetTypeId, final MgmtDistributionSetTypeRequestBodyPut restDistributionSetType) {
final DistributionSetType updated = distributionSetTypeManagement.update(entityFactory.distributionSetType() final DistributionSetType updated = distributionSetTypeManagement.update(entityFactory.distributionSetType()
@@ -156,7 +156,7 @@ public class MgmtDistributionSetTypeResource implements MgmtDistributionSetTypeR
} }
@Override @Override
@AuditLog(entity = "DistributionSetType", type = AuditLog.Type.UPDATE, message = "Remove Mandatory Module From Distribution Set Type") @AuditLog(entity = "DistributionSetType", type = AuditLog.Type.UPDATE, description = "Remove Mandatory Module From Distribution Set Type")
public ResponseEntity<Void> removeMandatoryModule(final Long distributionSetTypeId, final Long softwareModuleTypeId) { public ResponseEntity<Void> removeMandatoryModule(final Long distributionSetTypeId, final Long softwareModuleTypeId) {
distributionSetTypeManagement.unassignSoftwareModuleType(distributionSetTypeId, softwareModuleTypeId); distributionSetTypeManagement.unassignSoftwareModuleType(distributionSetTypeId, softwareModuleTypeId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
@@ -168,7 +168,7 @@ public class MgmtDistributionSetTypeResource implements MgmtDistributionSetTypeR
} }
@Override @Override
@AuditLog(entity = "DistributionSetType", type = AuditLog.Type.UPDATE, message = "Add Mandatory Module From Distribution Set Type") @AuditLog(entity = "DistributionSetType", type = AuditLog.Type.UPDATE, description = "Add Mandatory Module From Distribution Set Type")
public ResponseEntity<Void> addMandatoryModule(final Long distributionSetTypeId, final MgmtId smtId) { public ResponseEntity<Void> addMandatoryModule(final Long distributionSetTypeId, final MgmtId smtId) {
distributionSetTypeManagement.assignMandatorySoftwareModuleTypes(distributionSetTypeId, Collections.singletonList(smtId.getId())); distributionSetTypeManagement.assignMandatorySoftwareModuleTypes(distributionSetTypeId, Collections.singletonList(smtId.getId()));
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();

10
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtRolloutResource.java
View File

@@ -181,28 +181,28 @@ public class MgmtRolloutResource implements MgmtRolloutRestApi {
} }
@Override @Override
@AuditLog(entity = "Rollout", type = AuditLog.Type.UPDATE, message = "Start Rollout") @AuditLog(entity = "Rollout", type = AuditLog.Type.UPDATE, description = "Start Rollout")
public ResponseEntity<Void> start(final Long rolloutId) { public ResponseEntity<Void> start(final Long rolloutId) {
this.rolloutManagement.start(rolloutId); this.rolloutManagement.start(rolloutId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
} }
@Override @Override
@AuditLog(entity = "Rollout", type = AuditLog.Type.UPDATE, message = "Pause Rollout") @AuditLog(entity = "Rollout", type = AuditLog.Type.UPDATE, description = "Pause Rollout")
public ResponseEntity<Void> pause(final Long rolloutId) { public ResponseEntity<Void> pause(final Long rolloutId) {
this.rolloutManagement.pauseRollout(rolloutId); this.rolloutManagement.pauseRollout(rolloutId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
} }
@Override @Override
@AuditLog(entity = "Rollout", type = AuditLog.Type.DELETE, message = "Delete Rollout") @AuditLog(entity = "Rollout", type = AuditLog.Type.DELETE, description = "Delete Rollout")
public ResponseEntity<Void> delete(final Long rolloutId) { public ResponseEntity<Void> delete(final Long rolloutId) {
this.rolloutManagement.delete(rolloutId); this.rolloutManagement.delete(rolloutId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
} }
@Override @Override
@AuditLog(entity = "Rollout", type = AuditLog.Type.UPDATE, message = "Resume Rollout") @AuditLog(entity = "Rollout", type = AuditLog.Type.UPDATE, description = "Resume Rollout")
public ResponseEntity<Void> resume(final Long rolloutId) { public ResponseEntity<Void> resume(final Long rolloutId) {
this.rolloutManagement.resumeRollout(rolloutId); this.rolloutManagement.resumeRollout(rolloutId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
@@ -281,7 +281,7 @@ public class MgmtRolloutResource implements MgmtRolloutRestApi {
} }
@Override @Override
@AuditLog(entity = "Rollout", type = AuditLog.Type.UPDATE, message = "Trigger Next Rollout Group") @AuditLog(entity = "Rollout", type = AuditLog.Type.UPDATE, description = "Trigger Next Rollout Group")
public ResponseEntity<Void> triggerNextGroup(final Long rolloutId) { public ResponseEntity<Void> triggerNextGroup(final Long rolloutId) {
this.rolloutManagement.triggerNextGroup(rolloutId); this.rolloutManagement.triggerNextGroup(rolloutId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();

6
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtSoftwareModuleResource.java
View File

@@ -147,7 +147,7 @@ public class MgmtSoftwareModuleResource implements MgmtSoftwareModuleRestApi {
} }
@Override @Override
@AuditLog(entity = "SoftwareModule", type = AuditLog.Type.DELETE, message = "Delete Software Module Artifact") @AuditLog(entity = "SoftwareModule", type = AuditLog.Type.DELETE, description = "Delete Software Module Artifact")
public ResponseEntity<Void> deleteArtifact(final Long softwareModuleId, final Long artifactId) { public ResponseEntity<Void> deleteArtifact(final Long softwareModuleId, final Long artifactId) {
findSoftwareModuleWithExceptionIfNotFound(softwareModuleId, artifactId); findSoftwareModuleWithExceptionIfNotFound(softwareModuleId, artifactId);
artifactManagement.delete(artifactId); artifactManagement.delete(artifactId);
@@ -225,7 +225,7 @@ public class MgmtSoftwareModuleResource implements MgmtSoftwareModuleRestApi {
} }
@Override @Override
@AuditLog(entity = "SoftwareModule", type = AuditLog.Type.DELETE, message = "Delete Software Module") @AuditLog(entity = "SoftwareModule", type = AuditLog.Type.DELETE, description = "Delete Software Module")
public ResponseEntity<Void> deleteSoftwareModule(final Long softwareModuleId) { public ResponseEntity<Void> deleteSoftwareModule(final Long softwareModuleId) {
final SoftwareModule module = findSoftwareModuleWithExceptionIfNotFound(softwareModuleId, null); final SoftwareModule module = findSoftwareModuleWithExceptionIfNotFound(softwareModuleId, null);
softwareModuleManagement.delete(module.getId()); softwareModuleManagement.delete(module.getId());
@@ -277,7 +277,7 @@ public class MgmtSoftwareModuleResource implements MgmtSoftwareModuleRestApi {
} }
@Override @Override
@AuditLog(entity = "SoftwareModule", type = AuditLog.Type.DELETE, message = "Delete Software Module Metadata") @AuditLog(entity = "SoftwareModule", type = AuditLog.Type.DELETE, description = "Delete Software Module Metadata")
public ResponseEntity<Void> deleteMetadata(final Long softwareModuleId, final String metadataKey) { public ResponseEntity<Void> deleteMetadata(final Long softwareModuleId, final String metadataKey) {
softwareModuleManagement.deleteMetaData(softwareModuleId, metadataKey); softwareModuleManagement.deleteMetaData(softwareModuleId, metadataKey);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();

2
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtSoftwareModuleTypeResource.java
View File

@@ -75,7 +75,7 @@ public class MgmtSoftwareModuleTypeResource implements MgmtSoftwareModuleTypeRes
} }
@Override @Override
@AuditLog(entity = "SoftwareModuleType", type = AuditLog.Type.DELETE, message = "Delete Software Module Type") @AuditLog(entity = "SoftwareModuleType", type = AuditLog.Type.DELETE, description = "Delete Software Module Type")
public ResponseEntity<Void> deleteSoftwareModuleType(final Long softwareModuleTypeId) { public ResponseEntity<Void> deleteSoftwareModuleType(final Long softwareModuleTypeId) {
softwareModuleTypeManagement.delete(softwareModuleTypeId); softwareModuleTypeManagement.delete(softwareModuleTypeId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();

4
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtTargetFilterQueryResource.java
View File

@@ -128,7 +128,7 @@ public class MgmtTargetFilterQueryResource implements MgmtTargetFilterQueryRestA
} }
@Override @Override
@AuditLog(entity = "TargetFilter", type = AuditLog.Type.DELETE, message = "Delete Target Filter") @AuditLog(entity = "TargetFilter", type = AuditLog.Type.DELETE, description = "Delete Target Filter")
public ResponseEntity<Void> deleteFilter(final Long filterId) { public ResponseEntity<Void> deleteFilter(final Long filterId) {
filterManagement.delete(filterId); filterManagement.delete(filterId);
log.debug("{} target filter query deleted, return status {}", filterId, HttpStatus.OK); log.debug("{} target filter query deleted, return status {}", filterId, HttpStatus.OK);
@@ -171,7 +171,7 @@ public class MgmtTargetFilterQueryResource implements MgmtTargetFilterQueryRestA
} }
@Override @Override
@AuditLog(entity = "TargetFilter", type = AuditLog.Type.DELETE, message = "Delete Target Filter Assigned Distribution Set") @AuditLog(entity = "TargetFilter", type = AuditLog.Type.DELETE, description = "Delete Target Filter Assigned Distribution Set")
public ResponseEntity<Void> deleteAssignedDistributionSet(final Long filterId) { public ResponseEntity<Void> deleteAssignedDistributionSet(final Long filterId) {
filterManagement.updateAutoAssignDS(entityFactory.targetFilterQuery().updateAutoAssign(filterId).ds(null)); filterManagement.updateAutoAssignDS(entityFactory.targetFilterQuery().updateAutoAssign(filterId).ds(null));
return ResponseEntity.noContent().build(); return ResponseEntity.noContent().build();

22
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtTargetResource.java
View File

@@ -139,7 +139,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Update Target") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Update Target")
public ResponseEntity<MgmtTarget> updateTarget(final String targetId, final MgmtTargetRequestBody targetRest) { public ResponseEntity<MgmtTarget> updateTarget(final String targetId, final MgmtTargetRequestBody targetRest) {
if (targetRest.getRequestAttributes() != null) { if (targetRest.getRequestAttributes() != null) {
if (Boolean.TRUE.equals(targetRest.getRequestAttributes())) { if (Boolean.TRUE.equals(targetRest.getRequestAttributes())) {
@@ -174,7 +174,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.DELETE, message = "Delete Target") @AuditLog(entity = "Target", type = AuditLog.Type.DELETE, description = "Delete Target")
public ResponseEntity<Void> deleteTarget(final String targetId) { public ResponseEntity<Void> deleteTarget(final String targetId) {
this.targetManagement.deleteByControllerID(targetId); this.targetManagement.deleteByControllerID(targetId);
log.debug("{} target deleted, return status {}", targetId, HttpStatus.OK); log.debug("{} target deleted, return status {}", targetId, HttpStatus.OK);
@@ -182,14 +182,14 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Unassign Target Type") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Unassign Target Type")
public ResponseEntity<Void> unassignTargetType(final String targetId) { public ResponseEntity<Void> unassignTargetType(final String targetId) {
this.targetManagement.unassignType(targetId); this.targetManagement.unassignType(targetId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Assign Target") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Assign Target")
public ResponseEntity<Void> assignTargetType(final String targetId, final MgmtId targetTypeId) { public ResponseEntity<Void> assignTargetType(final String targetId, final MgmtId targetTypeId) {
this.targetManagement.assignType(targetId, targetTypeId.getId()); this.targetManagement.assignType(targetId, targetTypeId.getId());
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
@@ -250,7 +250,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Cancel Target Action") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Cancel Target Action")
public ResponseEntity<Void> cancelAction(final String targetId, final Long actionId, final boolean force) { public ResponseEntity<Void> cancelAction(final String targetId, final Long actionId, final boolean force) {
final Action action = deploymentManagement.findAction(actionId) final Action action = deploymentManagement.findAction(actionId)
.orElseThrow(() -> new EntityNotFoundException(Action.class, actionId)); .orElseThrow(() -> new EntityNotFoundException(Action.class, actionId));
@@ -272,7 +272,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Update Target Action") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Update Target Action")
public ResponseEntity<MgmtAction> updateAction(final String targetId, final Long actionId, final MgmtActionRequestBodyPut actionUpdate) { public ResponseEntity<MgmtAction> updateAction(final String targetId, final Long actionId, final MgmtActionRequestBodyPut actionUpdate) {
Action action = deploymentManagement.findAction(actionId) Action action = deploymentManagement.findAction(actionId)
@@ -292,7 +292,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Cancel Target Action Confirmation") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Cancel Target Action Confirmation")
public ResponseEntity<Void> updateActionConfirmation(final String targetId, final Long actionId, public ResponseEntity<Void> updateActionConfirmation(final String targetId, final Long actionId,
final MgmtActionConfirmationRequestBodyPut actionConfirmation) { final MgmtActionConfirmationRequestBodyPut actionConfirmation) {
log.debug("updateActionConfirmation with data [targetId={}, actionId={}]: {}", targetId, actionId, actionConfirmation); log.debug("updateActionConfirmation with data [targetId={}, actionId={}]: {}", targetId, actionId, actionConfirmation);
@@ -377,7 +377,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Set Distribution Set To Target") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Set Distribution Set To Target")
public ResponseEntity<MgmtTargetAssignmentResponseBody> postAssignedDistributionSet( public ResponseEntity<MgmtTargetAssignmentResponseBody> postAssignedDistributionSet(
final String targetId, final MgmtDistributionSetAssignments dsAssignments, final Boolean offline) { final String targetId, final MgmtDistributionSetAssignments dsAssignments, final Boolean offline) {
if (offline != null && offline) { if (offline != null && offline) {
@@ -461,7 +461,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.DELETE, message = "Delete Target Metadata") @AuditLog(entity = "Target", type = AuditLog.Type.DELETE, description = "Delete Target Metadata")
public ResponseEntity<Void> deleteMetadata(final String targetId, final String metadataKey) { public ResponseEntity<Void> deleteMetadata(final String targetId, final String metadataKey) {
targetManagement.deleteMetaData(targetId, metadataKey); targetManagement.deleteMetaData(targetId, metadataKey);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
@@ -482,7 +482,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Activate Target Auto Confirmation") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Activate Target Auto Confirmation")
public ResponseEntity<Void> activateAutoConfirm(final String targetId, final MgmtTargetAutoConfirmUpdate update) { public ResponseEntity<Void> activateAutoConfirm(final String targetId, final MgmtTargetAutoConfirmUpdate update) {
final String initiator = getNullIfEmpty(update, MgmtTargetAutoConfirmUpdate::getInitiator); final String initiator = getNullIfEmpty(update, MgmtTargetAutoConfirmUpdate::getInitiator);
final String remark = getNullIfEmpty(update, MgmtTargetAutoConfirmUpdate::getRemark); final String remark = getNullIfEmpty(update, MgmtTargetAutoConfirmUpdate::getRemark);
@@ -491,7 +491,7 @@ public class MgmtTargetResource implements MgmtTargetRestApi {
} }
@Override @Override
@AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, message = "Deactivate Target Auto Confirmation") @AuditLog(entity = "Target", type = AuditLog.Type.UPDATE, description = "Deactivate Target Auto Confirmation")
public ResponseEntity<Void> deactivateAutoConfirm(final String targetId) { public ResponseEntity<Void> deactivateAutoConfirm(final String targetId) {
confirmationManagement.deactivateAutoConfirmation(targetId); confirmationManagement.deactivateAutoConfirmation(targetId);
return new ResponseEntity<>(HttpStatus.OK); return new ResponseEntity<>(HttpStatus.OK);

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

@@ -113,7 +113,7 @@ public class MgmtTargetTagResource implements MgmtTargetTagRestApi {
} }
@Override @Override
@AuditLog(entity = "TargetTag", type = AuditLog.Type.DELETE, message = "Delete Target Tag") @AuditLog(entity = "TargetTag", type = AuditLog.Type.DELETE, description = "Delete Target Tag")
public ResponseEntity<Void> deleteTargetTag(final Long targetTagId) { public ResponseEntity<Void> deleteTargetTag(final Long targetTagId) {
log.debug("Delete {} target tag", targetTagId); log.debug("Delete {} target tag", targetTagId);
final TargetTag targetTag = findTargetTagById(targetTagId); final TargetTag targetTag = findTargetTagById(targetTagId);
@@ -168,7 +168,7 @@ public class MgmtTargetTagResource implements MgmtTargetTagRestApi {
} }
@Override @Override
@AuditLog(entity = "TargetTag", type = AuditLog.Type.UPDATE, message = "Unassign Target From Target Tag") @AuditLog(entity = "TargetTag", type = AuditLog.Type.UPDATE, description = "Unassign Target From Target Tag")
public ResponseEntity<Void> unassignTarget(final Long targetTagId, final String controllerId) { public ResponseEntity<Void> unassignTarget(final Long targetTagId, final String controllerId) {
log.debug("Unassign target {} for target tag {}", controllerId, targetTagId); log.debug("Unassign target {} for target tag {}", controllerId, targetTagId);
this.targetManagement.unassignTag(List.of(controllerId), targetTagId); this.targetManagement.unassignTag(List.of(controllerId), targetTagId);
@@ -176,7 +176,7 @@ public class MgmtTargetTagResource implements MgmtTargetTagRestApi {
} }
@Override @Override
@AuditLog(entity = "TargetTag", type = AuditLog.Type.UPDATE, message = "Unassign Targets From Target Tag") @AuditLog(entity = "TargetTag", type = AuditLog.Type.UPDATE, description = "Unassign Targets From Target Tag")
public ResponseEntity<Void> unassignTargets( public ResponseEntity<Void> unassignTargets(
final Long targetTagId, final OnNotFoundPolicy onNotFoundPolicy, final List<String> controllerIds) { final Long targetTagId, final OnNotFoundPolicy onNotFoundPolicy, final List<String> controllerIds) {
log.debug("Unassign {} targets for target tag {}", controllerIds.size(), targetTagId); log.debug("Unassign {} targets for target tag {}", controllerIds.size(), targetTagId);

6
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtTargetTypeResource.java
View File

@@ -80,7 +80,7 @@ public class MgmtTargetTypeResource implements MgmtTargetTypeRestApi {
} }
@Override @Override
@AuditLog(entity = "TargetType", type = AuditLog.Type.DELETE, message = "Delete Target Type") @AuditLog(entity = "TargetType", type = AuditLog.Type.DELETE, description = "Delete Target Type")
public ResponseEntity<Void> deleteTargetType(final Long targetTypeId) { public ResponseEntity<Void> deleteTargetType(final Long targetTypeId) {
log.debug("Delete {} target type", targetTypeId); log.debug("Delete {} target type", targetTypeId);
targetTypeManagement.delete(targetTypeId); targetTypeManagement.delete(targetTypeId);
@@ -111,14 +111,14 @@ public class MgmtTargetTypeResource implements MgmtTargetTypeRestApi {
} }
@Override @Override
@AuditLog(entity = "TargetType", type = AuditLog.Type.DELETE, message = "Remove Compatible Distribution Set From Target Type") @AuditLog(entity = "TargetType", type = AuditLog.Type.DELETE, description = "Remove Compatible Distribution Set From Target Type")
public ResponseEntity<Void> removeCompatibleDistributionSet(final Long targetTypeId, final Long distributionSetTypeId) { public ResponseEntity<Void> removeCompatibleDistributionSet(final Long targetTypeId, final Long distributionSetTypeId) {
targetTypeManagement.unassignDistributionSetType(targetTypeId, distributionSetTypeId); targetTypeManagement.unassignDistributionSetType(targetTypeId, distributionSetTypeId);
return ResponseEntity.ok().build(); return ResponseEntity.ok().build();
} }
@Override @Override
@AuditLog(entity = "TargetType", type = AuditLog.Type.UPDATE, message = "Add Compatible Distribution Set To Target Type") @AuditLog(entity = "TargetType", type = AuditLog.Type.UPDATE, description = "Add Compatible Distribution Set To Target Type")
public ResponseEntity<Void> addCompatibleDistributionSets( public ResponseEntity<Void> addCompatibleDistributionSets(
final Long targetTypeId, final List<MgmtDistributionSetTypeAssignment> distributionSetTypeIds) { final Long targetTypeId, final List<MgmtDistributionSetTypeAssignment> distributionSetTypeIds) {
targetTypeManagement.assignCompatibleDistributionSetTypes( targetTypeManagement.assignCompatibleDistributionSetTypes(

6
hawkbit-mgmt/hawkbit-mgmt-resource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtTenantManagementResource.java
View File

@@ -73,7 +73,7 @@ public class MgmtTenantManagementResource implements MgmtTenantManagementRestApi
} }
@Override @Override
@AuditLog(entity = "TenantConfiguration", type = AuditLog.Type.DELETE, message = "Delete Tenant Configuration Value") @AuditLog(entity = "TenantConfiguration", type = AuditLog.Type.DELETE, description = "Delete Tenant Configuration Value")
public ResponseEntity<Void> deleteTenantConfigurationValue(final String keyName) { public ResponseEntity<Void> deleteTenantConfigurationValue(final String keyName) {
//Default DistributionSet Type cannot be deleted as is part of TenantMetadata //Default DistributionSet Type cannot be deleted as is part of TenantMetadata
if (isDefaultDistributionSetTypeKey(keyName)) { if (isDefaultDistributionSetTypeKey(keyName)) {
@@ -92,7 +92,7 @@ public class MgmtTenantManagementResource implements MgmtTenantManagementRestApi
} }
@Override @Override
@AuditLog(entity = "TenantConfiguration", type = AuditLog.Type.UPDATE, message = "Update Tenant Configuration Value") @AuditLog(entity = "TenantConfiguration", type = AuditLog.Type.UPDATE, description = "Update Tenant Configuration Value")
public ResponseEntity<MgmtSystemTenantConfigurationValue> updateTenantConfigurationValue( public ResponseEntity<MgmtSystemTenantConfigurationValue> updateTenantConfigurationValue(
final String keyName, final MgmtSystemTenantConfigurationValueRequest configurationValueRest) { final String keyName, final MgmtSystemTenantConfigurationValueRequest configurationValueRest) {
Serializable configurationValue = configurationValueRest.getValue(); Serializable configurationValue = configurationValueRest.getValue();
@@ -109,7 +109,7 @@ public class MgmtTenantManagementResource implements MgmtTenantManagementRestApi
} }
@Override @Override
@AuditLog(entity = "TenantConfiguration", type = AuditLog.Type.UPDATE, message = "Update Tenant Configuration") @AuditLog(entity = "TenantConfiguration", type = AuditLog.Type.UPDATE, description = "Update Tenant Configuration")
public ResponseEntity<List<MgmtSystemTenantConfigurationValue>> updateTenantConfiguration( public ResponseEntity<List<MgmtSystemTenantConfigurationValue>> updateTenantConfiguration(
final Map<String, Serializable> configurationValueMap) { final Map<String, Serializable> configurationValueMap) {
final boolean containsNull = configurationValueMap.keySet().stream().anyMatch(Objects::isNull); final boolean containsNull = configurationValueMap.keySet().stream().anyMatch(Objects::isNull);

2
hawkbit-security-core/src/main/java/org/eclipse/hawkbit/audit/AuditLog.java
View File

@@ -32,7 +32,7 @@ public @interface AuditLog {
String entity(); String entity();
String message() default ""; String description() default "";
String[] logParams() default {"*"}; String[] logParams() default {"*"};

4
hawkbit-security-core/src/main/java/org/eclipse/hawkbit/audit/AuditLoggingAspect.java
View File

@@ -75,8 +75,8 @@ public class AuditLoggingAspect {
final String methodName = joinPoint.getSignature().getName(); final String methodName = joinPoint.getSignature().getName();
final String logMessage = String.format( final String logMessage = String.format(
"Type: %s, Method: %s - Message: %s - Parameters: %s - Response: %s", "Type: %s, Method: %s - Description: %s - Parameters: %s - Response: %s",
auditLog.type(), methodName, auditLog.message(), paramsToLog, resultMessage auditLog.type(), methodName, auditLog.description(), paramsToLog, resultMessage
); );
switch (logLevel) { switch (logLevel) {