refactoring: 01 - Alarm only
This commit is contained in:
parent
c6a8b9fbaf
commit
913e52abbc
@ -17,6 +17,7 @@ package org.thingsboard.server.controller;
|
|||||||
|
|
||||||
import io.swagger.annotations.ApiOperation;
|
import io.swagger.annotations.ApiOperation;
|
||||||
import io.swagger.annotations.ApiParam;
|
import io.swagger.annotations.ApiParam;
|
||||||
|
import lombok.RequiredArgsConstructor;
|
||||||
import org.apache.commons.lang3.StringUtils;
|
import org.apache.commons.lang3.StringUtils;
|
||||||
import org.springframework.http.HttpStatus;
|
import org.springframework.http.HttpStatus;
|
||||||
import org.springframework.http.MediaType;
|
import org.springframework.http.MediaType;
|
||||||
@ -29,29 +30,24 @@ import org.springframework.web.bind.annotation.RequestParam;
|
|||||||
import org.springframework.web.bind.annotation.ResponseBody;
|
import org.springframework.web.bind.annotation.ResponseBody;
|
||||||
import org.springframework.web.bind.annotation.ResponseStatus;
|
import org.springframework.web.bind.annotation.ResponseStatus;
|
||||||
import org.springframework.web.bind.annotation.RestController;
|
import org.springframework.web.bind.annotation.RestController;
|
||||||
import org.thingsboard.server.common.data.EntityType;
|
|
||||||
import org.thingsboard.server.common.data.alarm.Alarm;
|
import org.thingsboard.server.common.data.alarm.Alarm;
|
||||||
import org.thingsboard.server.common.data.alarm.AlarmInfo;
|
import org.thingsboard.server.common.data.alarm.AlarmInfo;
|
||||||
import org.thingsboard.server.common.data.alarm.AlarmQuery;
|
import org.thingsboard.server.common.data.alarm.AlarmQuery;
|
||||||
import org.thingsboard.server.common.data.alarm.AlarmSearchStatus;
|
import org.thingsboard.server.common.data.alarm.AlarmSearchStatus;
|
||||||
import org.thingsboard.server.common.data.alarm.AlarmSeverity;
|
import org.thingsboard.server.common.data.alarm.AlarmSeverity;
|
||||||
import org.thingsboard.server.common.data.alarm.AlarmStatus;
|
import org.thingsboard.server.common.data.alarm.AlarmStatus;
|
||||||
import org.thingsboard.server.common.data.audit.ActionType;
|
|
||||||
import org.thingsboard.server.common.data.edge.EdgeEventActionType;
|
|
||||||
import org.thingsboard.server.common.data.exception.ThingsboardErrorCode;
|
import org.thingsboard.server.common.data.exception.ThingsboardErrorCode;
|
||||||
import org.thingsboard.server.common.data.exception.ThingsboardException;
|
import org.thingsboard.server.common.data.exception.ThingsboardException;
|
||||||
import org.thingsboard.server.common.data.id.AlarmId;
|
import org.thingsboard.server.common.data.id.AlarmId;
|
||||||
import org.thingsboard.server.common.data.id.EdgeId;
|
|
||||||
import org.thingsboard.server.common.data.id.EntityId;
|
import org.thingsboard.server.common.data.id.EntityId;
|
||||||
import org.thingsboard.server.common.data.id.EntityIdFactory;
|
import org.thingsboard.server.common.data.id.EntityIdFactory;
|
||||||
import org.thingsboard.server.common.data.page.PageData;
|
import org.thingsboard.server.common.data.page.PageData;
|
||||||
import org.thingsboard.server.common.data.page.TimePageLink;
|
import org.thingsboard.server.common.data.page.TimePageLink;
|
||||||
import org.thingsboard.server.queue.util.TbCoreComponent;
|
import org.thingsboard.server.queue.util.TbCoreComponent;
|
||||||
|
import org.thingsboard.server.service.entitiy.alarm.TbAlarmService;
|
||||||
import org.thingsboard.server.service.security.permission.Operation;
|
import org.thingsboard.server.service.security.permission.Operation;
|
||||||
import org.thingsboard.server.service.security.permission.Resource;
|
import org.thingsboard.server.service.security.permission.Resource;
|
||||||
|
|
||||||
import java.util.List;
|
|
||||||
|
|
||||||
import static org.thingsboard.server.controller.ControllerConstants.ALARM_ID_PARAM_DESCRIPTION;
|
import static org.thingsboard.server.controller.ControllerConstants.ALARM_ID_PARAM_DESCRIPTION;
|
||||||
import static org.thingsboard.server.controller.ControllerConstants.ALARM_INFO_DESCRIPTION;
|
import static org.thingsboard.server.controller.ControllerConstants.ALARM_INFO_DESCRIPTION;
|
||||||
import static org.thingsboard.server.controller.ControllerConstants.ALARM_SORT_PROPERTY_ALLOWABLE_VALUES;
|
import static org.thingsboard.server.controller.ControllerConstants.ALARM_SORT_PROPERTY_ALLOWABLE_VALUES;
|
||||||
@ -70,9 +66,12 @@ import static org.thingsboard.server.controller.ControllerConstants.UUID_WIKI_LI
|
|||||||
|
|
||||||
@RestController
|
@RestController
|
||||||
@TbCoreComponent
|
@TbCoreComponent
|
||||||
|
@RequiredArgsConstructor
|
||||||
@RequestMapping("/api")
|
@RequestMapping("/api")
|
||||||
public class AlarmController extends BaseController {
|
public class AlarmController extends BaseController {
|
||||||
|
|
||||||
|
private final TbAlarmService tbAlarmService;
|
||||||
|
|
||||||
public static final String ALARM_ID = "alarmId";
|
public static final String ALARM_ID = "alarmId";
|
||||||
private static final String ALARM_SECURITY_CHECK = "If the user has the authority of 'Tenant Administrator', the server checks that the originator of alarm is owned by the same tenant. " +
|
private static final String ALARM_SECURITY_CHECK = "If the user has the authority of 'Tenant Administrator', the server checks that the originator of alarm is owned by the same tenant. " +
|
||||||
"If the user has the authority of 'Customer User', the server checks that the originator of alarm belongs to the customer. ";
|
"If the user has the authority of 'Customer User', the server checks that the originator of alarm belongs to the customer. ";
|
||||||
@ -133,24 +132,9 @@ public class AlarmController extends BaseController {
|
|||||||
@RequestMapping(value = "/alarm", method = RequestMethod.POST)
|
@RequestMapping(value = "/alarm", method = RequestMethod.POST)
|
||||||
@ResponseBody
|
@ResponseBody
|
||||||
public Alarm saveAlarm(@ApiParam(value = "A JSON value representing the alarm.") @RequestBody Alarm alarm) throws ThingsboardException {
|
public Alarm saveAlarm(@ApiParam(value = "A JSON value representing the alarm.") @RequestBody Alarm alarm) throws ThingsboardException {
|
||||||
try {
|
|
||||||
alarm.setTenantId(getCurrentUser().getTenantId());
|
alarm.setTenantId(getCurrentUser().getTenantId());
|
||||||
|
|
||||||
checkEntity(alarm.getId(), alarm, Resource.ALARM);
|
checkEntity(alarm.getId(), alarm, Resource.ALARM);
|
||||||
|
return tbAlarmService.save(alarm, getCurrentUser());
|
||||||
Alarm savedAlarm = checkNotNull(alarmService.createOrUpdateAlarm(alarm));
|
|
||||||
logEntityAction(savedAlarm.getOriginator(), savedAlarm,
|
|
||||||
getCurrentUser().getCustomerId(),
|
|
||||||
alarm.getId() == null ? ActionType.ADDED : ActionType.UPDATED, null);
|
|
||||||
|
|
||||||
sendEntityNotificationMsg(getTenantId(), savedAlarm.getId(), alarm.getId() == null ? EdgeEventActionType.ADDED : EdgeEventActionType.UPDATED);
|
|
||||||
|
|
||||||
return savedAlarm;
|
|
||||||
} catch (Exception e) {
|
|
||||||
logEntityAction(emptyId(EntityType.ALARM), alarm,
|
|
||||||
null, alarm.getId() == null ? ActionType.ADDED : ActionType.UPDATED, e);
|
|
||||||
throw handleException(e);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@ApiOperation(value = "Delete Alarm (deleteAlarm)",
|
@ApiOperation(value = "Delete Alarm (deleteAlarm)",
|
||||||
@ -163,16 +147,7 @@ public class AlarmController extends BaseController {
|
|||||||
try {
|
try {
|
||||||
AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
|
AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
|
||||||
Alarm alarm = checkAlarmId(alarmId, Operation.WRITE);
|
Alarm alarm = checkAlarmId(alarmId, Operation.WRITE);
|
||||||
|
return tbAlarmService.delete(alarm, getCurrentUser());
|
||||||
List<EdgeId> relatedEdgeIds = findRelatedEdgeIds(getTenantId(), alarm.getOriginator());
|
|
||||||
|
|
||||||
logEntityAction(alarm.getOriginator(), alarm,
|
|
||||||
getCurrentUser().getCustomerId(),
|
|
||||||
ActionType.ALARM_DELETE, null);
|
|
||||||
|
|
||||||
sendAlarmDeleteNotificationMsg(getTenantId(), alarmId, relatedEdgeIds, alarm);
|
|
||||||
|
|
||||||
return alarmService.deleteAlarm(getTenantId(), alarmId);
|
|
||||||
} catch (Exception e) {
|
} catch (Exception e) {
|
||||||
throw handleException(e);
|
throw handleException(e);
|
||||||
}
|
}
|
||||||
@ -187,19 +162,9 @@ public class AlarmController extends BaseController {
|
|||||||
@ResponseStatus(value = HttpStatus.OK)
|
@ResponseStatus(value = HttpStatus.OK)
|
||||||
public void ackAlarm(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
|
public void ackAlarm(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
|
||||||
checkParameter(ALARM_ID, strAlarmId);
|
checkParameter(ALARM_ID, strAlarmId);
|
||||||
try {
|
|
||||||
AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
|
AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
|
||||||
Alarm alarm = checkAlarmId(alarmId, Operation.WRITE);
|
Alarm alarm = checkAlarmId(alarmId, Operation.WRITE);
|
||||||
long ackTs = System.currentTimeMillis();
|
tbAlarmService.ack(alarm, getCurrentUser());
|
||||||
alarmService.ackAlarm(getCurrentUser().getTenantId(), alarmId, ackTs).get();
|
|
||||||
alarm.setAckTs(ackTs);
|
|
||||||
alarm.setStatus(alarm.getStatus().isCleared() ? AlarmStatus.CLEARED_ACK : AlarmStatus.ACTIVE_ACK);
|
|
||||||
logEntityAction(alarm.getOriginator(), alarm, getCurrentUser().getCustomerId(), ActionType.ALARM_ACK, null);
|
|
||||||
|
|
||||||
sendEntityNotificationMsg(getTenantId(), alarmId, EdgeEventActionType.ALARM_ACK);
|
|
||||||
} catch (Exception e) {
|
|
||||||
throw handleException(e);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@ApiOperation(value = "Clear Alarm (clearAlarm)",
|
@ApiOperation(value = "Clear Alarm (clearAlarm)",
|
||||||
@ -211,19 +176,9 @@ public class AlarmController extends BaseController {
|
|||||||
@ResponseStatus(value = HttpStatus.OK)
|
@ResponseStatus(value = HttpStatus.OK)
|
||||||
public void clearAlarm(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
|
public void clearAlarm(@ApiParam(value = ALARM_ID_PARAM_DESCRIPTION) @PathVariable(ALARM_ID) String strAlarmId) throws ThingsboardException {
|
||||||
checkParameter(ALARM_ID, strAlarmId);
|
checkParameter(ALARM_ID, strAlarmId);
|
||||||
try {
|
|
||||||
AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
|
AlarmId alarmId = new AlarmId(toUUID(strAlarmId));
|
||||||
Alarm alarm = checkAlarmId(alarmId, Operation.WRITE);
|
Alarm alarm = checkAlarmId(alarmId, Operation.WRITE);
|
||||||
long clearTs = System.currentTimeMillis();
|
tbAlarmService.clear(alarm, getCurrentUser());
|
||||||
alarmService.clearAlarm(getCurrentUser().getTenantId(), alarmId, null, clearTs).get();
|
|
||||||
alarm.setClearTs(clearTs);
|
|
||||||
alarm.setStatus(alarm.getStatus().isAck() ? AlarmStatus.CLEARED_ACK : AlarmStatus.CLEARED_UNACK);
|
|
||||||
logEntityAction(alarm.getOriginator(), alarm, getCurrentUser().getCustomerId(), ActionType.ALARM_CLEAR, null);
|
|
||||||
|
|
||||||
sendEntityNotificationMsg(getTenantId(), alarmId, EdgeEventActionType.ALARM_CLEAR);
|
|
||||||
} catch (Exception e) {
|
|
||||||
throw handleException(e);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@ApiOperation(value = "Get Alarms (getAlarms)",
|
@ApiOperation(value = "Get Alarms (getAlarms)",
|
||||||
@ -276,6 +231,7 @@ public class AlarmController extends BaseController {
|
|||||||
throw handleException(e);
|
throw handleException(e);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ApiOperation(value = "Get All Alarms (getAllAlarms)",
|
@ApiOperation(value = "Get All Alarms (getAllAlarms)",
|
||||||
notes = "Returns a page of alarms that belongs to the current user owner. " +
|
notes = "Returns a page of alarms that belongs to the current user owner. " +
|
||||||
"If the user has the authority of 'Tenant Administrator', the server returns alarms that belongs to the tenant of current user. " +
|
"If the user has the authority of 'Tenant Administrator', the server returns alarms that belongs to the tenant of current user. " +
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user