Commit 427e7ac0944b0247b21f8f2cfb3214fe463907af
1 parent
c68cbff3
Added swagger API for edge event controller. Added search text usage for edge ev…
…ent type. Code cleanup
Showing
5 changed files
with
24 additions
and
6 deletions
... | ... | @@ -174,7 +174,7 @@ public abstract class BaseController { |
174 | 174 | protected final String SORT_ORDER_ALLOWABLE_VALUES = "ASC, DESC"; |
175 | 175 | protected final String DEVICE_INFO_DESCRIPTION = "Device Info is an extension of the default Device object that contains information about the assigned customer name and device profile name. "; |
176 | 176 | |
177 | - | |
177 | + protected final String EDGE_EVENT_TEXT_SEARCH_DESCRIPTION = "The case insensitive 'startsWith' filter based on the edge event type name."; | |
178 | 178 | |
179 | 179 | public static final String INCORRECT_TENANT_ID = "Incorrect tenantId "; |
180 | 180 | protected static final String DEFAULT_DASHBOARD = "defaultDashboardId"; | ... | ... |
... | ... | @@ -15,6 +15,8 @@ |
15 | 15 | */ |
16 | 16 | package org.thingsboard.server.controller; |
17 | 17 | |
18 | +import io.swagger.annotations.ApiOperation; | |
19 | +import io.swagger.annotations.ApiParam; | |
18 | 20 | import lombok.extern.slf4j.Slf4j; |
19 | 21 | import org.springframework.beans.factory.annotation.Autowired; |
20 | 22 | import org.springframework.security.access.prepost.PreAuthorize; |
... | ... | @@ -45,17 +47,28 @@ public class EdgeEventController extends BaseController { |
45 | 47 | |
46 | 48 | public static final String EDGE_ID = "edgeId"; |
47 | 49 | |
50 | + @ApiOperation(value = "Get Edge Events (getEdgeEvents)", | |
51 | + notes = "Returns a page of edge events for the requested edge. " + | |
52 | + PAGE_DATA_PARAMETERS) | |
48 | 53 | @PreAuthorize("hasAuthority('TENANT_ADMIN')") |
49 | 54 | @RequestMapping(value = "/edge/{edgeId}/events", method = RequestMethod.GET) |
50 | 55 | @ResponseBody |
51 | 56 | public PageData<EdgeEvent> getEdgeEvents( |
57 | + @ApiParam(value = EDGE_ID_PARAM_DESCRIPTION) | |
52 | 58 | @PathVariable(EDGE_ID) String strEdgeId, |
59 | + @ApiParam(value = PAGE_SIZE_DESCRIPTION) | |
53 | 60 | @RequestParam int pageSize, |
61 | + @ApiParam(value = PAGE_NUMBER_DESCRIPTION) | |
54 | 62 | @RequestParam int page, |
63 | + @ApiParam(value = EDGE_EVENT_TEXT_SEARCH_DESCRIPTION) | |
55 | 64 | @RequestParam(required = false) String textSearch, |
65 | + @ApiParam(value = SORT_PROPERTY_DESCRIPTION, allowableValues = SORT_PROPERTY_ALLOWABLE_VALUES) | |
56 | 66 | @RequestParam(required = false) String sortProperty, |
67 | + @ApiParam(value = SORT_ORDER_DESCRIPTION, allowableValues = SORT_ORDER_ALLOWABLE_VALUES) | |
57 | 68 | @RequestParam(required = false) String sortOrder, |
69 | + @ApiParam(value = "Timestamp. Edge events with creation time before it won't be queried") | |
58 | 70 | @RequestParam(required = false) Long startTime, |
71 | + @ApiParam(value = "Timestamp. Edge events with creation time after it won't be queried") | |
59 | 72 | @RequestParam(required = false) Long endTime) throws ThingsboardException { |
60 | 73 | checkParameter(EDGE_ID, strEdgeId); |
61 | 74 | try { | ... | ... |
... | ... | @@ -15,7 +15,6 @@ |
15 | 15 | */ |
16 | 16 | package org.thingsboard.server.dao.model.sql; |
17 | 17 | |
18 | -import com.datastax.oss.driver.api.core.uuid.Uuids; | |
19 | 18 | import com.fasterxml.jackson.databind.JsonNode; |
20 | 19 | import lombok.Data; |
21 | 20 | import lombok.EqualsAndHashCode; |
... | ... | @@ -40,15 +39,14 @@ import javax.persistence.Table; |
40 | 39 | import java.util.UUID; |
41 | 40 | |
42 | 41 | import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_ACTION_PROPERTY; |
42 | +import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_BODY_PROPERTY; | |
43 | 43 | import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_COLUMN_FAMILY_NAME; |
44 | 44 | import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_EDGE_ID_PROPERTY; |
45 | -import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_BODY_PROPERTY; | |
46 | 45 | import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_ENTITY_ID_PROPERTY; |
47 | 46 | import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_TENANT_ID_PROPERTY; |
48 | 47 | import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_TYPE_PROPERTY; |
49 | 48 | import static org.thingsboard.server.dao.model.ModelConstants.EDGE_EVENT_UID_PROPERTY; |
50 | 49 | import static org.thingsboard.server.dao.model.ModelConstants.EPOCH_DIFF; |
51 | -import static org.thingsboard.server.dao.model.ModelConstants.EVENT_UID_PROPERTY; | |
52 | 50 | import static org.thingsboard.server.dao.model.ModelConstants.TS_COLUMN; |
53 | 51 | |
54 | 52 | @Data | ... | ... |
... | ... | @@ -31,10 +31,12 @@ public interface EdgeEventRepository extends PagingAndSortingRepository<EdgeEven |
31 | 31 | "e.tenantId = :tenantId " + |
32 | 32 | "AND e.edgeId = :edgeId " + |
33 | 33 | "AND (:startTime IS NULL OR e.createdTime >= :startTime) " + |
34 | - "AND (:endTime IS NULL OR e.createdTime <= :endTime) " | |
34 | + "AND (:endTime IS NULL OR e.createdTime <= :endTime) " + | |
35 | + "AND LOWER(e.edgeEventType) LIKE LOWER(CONCAT(:textSearch, '%'))" | |
35 | 36 | ) |
36 | 37 | Page<EdgeEventEntity> findEdgeEventsByTenantIdAndEdgeId(@Param("tenantId") UUID tenantId, |
37 | 38 | @Param("edgeId") UUID edgeId, |
39 | + @Param("textSearch") String textSearch, | |
38 | 40 | @Param("startTime") Long startTime, |
39 | 41 | @Param("endTime") Long endTime, |
40 | 42 | Pageable pageable); |
... | ... | @@ -44,10 +46,12 @@ public interface EdgeEventRepository extends PagingAndSortingRepository<EdgeEven |
44 | 46 | "AND e.edgeId = :edgeId " + |
45 | 47 | "AND (:startTime IS NULL OR e.createdTime >= :startTime) " + |
46 | 48 | "AND (:endTime IS NULL OR e.createdTime <= :endTime) " + |
47 | - "AND e.edgeEventAction <> 'TIMESERIES_UPDATED'" | |
49 | + "AND e.edgeEventAction <> 'TIMESERIES_UPDATED' " + | |
50 | + "AND LOWER(e.edgeEventType) LIKE LOWER(CONCAT(:textSearch, '%'))" | |
48 | 51 | ) |
49 | 52 | Page<EdgeEventEntity> findEdgeEventsByTenantIdAndEdgeIdWithoutTimeseriesUpdated(@Param("tenantId") UUID tenantId, |
50 | 53 | @Param("edgeId") UUID edgeId, |
54 | + @Param("textSearch") String textSearch, | |
51 | 55 | @Param("startTime") Long startTime, |
52 | 56 | @Param("endTime") Long endTime, |
53 | 57 | Pageable pageable); | ... | ... |
... | ... | @@ -39,6 +39,7 @@ import java.sql.Connection; |
39 | 39 | import java.sql.PreparedStatement; |
40 | 40 | import java.sql.ResultSet; |
41 | 41 | import java.sql.SQLException; |
42 | +import java.util.Objects; | |
42 | 43 | import java.util.Optional; |
43 | 44 | import java.util.UUID; |
44 | 45 | import java.util.concurrent.ConcurrentHashMap; |
... | ... | @@ -107,6 +108,7 @@ public class JpaBaseEdgeEventDao extends JpaAbstractSearchTextDao<EdgeEventEntit |
107 | 108 | .findEdgeEventsByTenantIdAndEdgeId( |
108 | 109 | tenantId, |
109 | 110 | edgeId.getId(), |
111 | + Objects.toString(pageLink.getTextSearch(), ""), | |
110 | 112 | pageLink.getStartTime(), |
111 | 113 | pageLink.getEndTime(), |
112 | 114 | DaoUtil.toPageable(pageLink))); |
... | ... | @@ -116,6 +118,7 @@ public class JpaBaseEdgeEventDao extends JpaAbstractSearchTextDao<EdgeEventEntit |
116 | 118 | .findEdgeEventsByTenantIdAndEdgeIdWithoutTimeseriesUpdated( |
117 | 119 | tenantId, |
118 | 120 | edgeId.getId(), |
121 | + Objects.toString(pageLink.getTextSearch(), ""), | |
119 | 122 | pageLink.getStartTime(), |
120 | 123 | pageLink.getEndTime(), |
121 | 124 | DaoUtil.toPageable(pageLink))); | ... | ... |