Skip to content

Commit 87ba987

Browse files
dbraquartdbraquart
authored
Add spreadsheet notifications (#734)
Now all end-points that change the spreadsheet have to pass through the study-server, and trigger specific notifications. Signed-off-by: David BRAQUART <[email protected]>
1 parent 45c2200 commit 87ba987

16 files changed

+722
-61
lines changed

‎src/main/java/org/gridsuite/study/server/StudyApi.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
* @author Abdelsalem Hedhili <abdelsalem.hedhili at rte-france.com>
1111
*/
1212

13-
final class StudyApi {
13+
public final class StudyApi {
1414

1515
private StudyApi() {
1616
}
1717

18-
static final String API_VERSION = "v1";
18+
public static final String API_VERSION = "v1";
1919
}

‎src/main/java/org/gridsuite/study/server/StudyException.java

+1
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@ public enum Type {
151151
GET_SPREADSHEET_CONFIG_COLLECTION_FAILED,
152152
CREATE_SPREADSHEET_CONFIG_COLLECTION_FAILED,
153153
UPDATE_SPREADSHEET_CONFIG_COLLECTION_FAILED,
154+
UPDATE_SPREADSHEET_CONFIG_FAILED,
154155
NETWORK_EXPORT_FAILED
155156
}
156157

‎src/main/java/org/gridsuite/study/server/controller/SpreadsheetConfigCollectionController.java

+108
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
/*
2+
* Copyright (c) 2025, RTE (http://www.rte-france.com)
3+
* This Source Code Form is subject to the terms of the Mozilla Public
4+
* License, v. 2.0. If a copy of the MPL was not distributed with this
5+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
6+
*/
7+
package org.gridsuite.study.server.controller;
8+
9+
import io.swagger.v3.oas.annotations.Operation;
10+
import io.swagger.v3.oas.annotations.Parameter;
11+
import io.swagger.v3.oas.annotations.responses.ApiResponse;
12+
import io.swagger.v3.oas.annotations.responses.ApiResponses;
13+
import io.swagger.v3.oas.annotations.tags.Tag;
14+
import jakarta.validation.Valid;
15+
import org.gridsuite.study.server.StudyApi;
16+
import org.gridsuite.study.server.service.*;
17+
import org.springframework.http.HttpStatus;
18+
import org.springframework.http.ResponseEntity;
19+
import org.springframework.web.bind.annotation.*;
20+
21+
import java.util.List;
22+
import java.util.UUID;
23+
24+
import static org.gridsuite.study.server.StudyConstants.HEADER_USER_ID;
25+
26+
@RestController
27+
@RequestMapping(value = "/" + StudyApi.API_VERSION + "/studies/{studyUuid}/spreadsheet-config-collection")
28+
@Tag(name = "Study server - Spreadsheet collections")
29+
public class SpreadsheetConfigCollectionController {
30+
private final StudyService studyService;
31+
32+
public SpreadsheetConfigCollectionController(StudyService studyService) {
33+
this.studyService = studyService;
34+
}
35+
36+
@GetMapping()
37+
@Operation(summary = "Get study's spreadsheet config collection")
38+
@ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The spreadsheet config collection")})
39+
public ResponseEntity<String> getSpreadsheetConfigCollection(
40+
@PathVariable("studyUuid") UUID studyUuid) {
41+
return ResponseEntity.ok().body(studyService.getSpreadsheetConfigCollection(studyUuid));
42+
}
43+
44+
@PutMapping()
45+
@Operation(summary = "Update study's spreadsheet config collection, with replace or append mode")
46+
@ApiResponses(value = {
47+
@ApiResponse(responseCode = "200", description = "The updated spreadsheet config collection"),
48+
@ApiResponse(responseCode = "404", description = "The study or the collection doesn't exist")
49+
})
50+
public ResponseEntity<String> updateSpreadsheetConfigCollection(
51+
@PathVariable("studyUuid") UUID studyUuid,
52+
@RequestParam("collectionUuid") UUID collectionUuid,
53+
@RequestParam(value = "append", required = false, defaultValue = "false") Boolean appendMode) {
54+
return ResponseEntity.ok().body(studyService.updateSpreadsheetConfigCollection(studyUuid, collectionUuid, appendMode));
55+
}
56+
57+
@PostMapping()
58+
@Operation(summary = "Set spreadsheet config collection on study, reset to default one if empty body")
59+
@ApiResponses(value = {
60+
@ApiResponse(responseCode = "200", description = "The spreadsheet config collection is set"),
61+
@ApiResponse(responseCode = "204", description = "Reset with user profile cannot be done")
62+
})
63+
public ResponseEntity<Void> setSpreadsheetConfigCollection(
64+
@PathVariable("studyUuid") UUID studyUuid,
65+
@RequestBody(required = false) String configCollection,
66+
@RequestHeader(HEADER_USER_ID) String userId) {
67+
return studyService.setSpreadsheetConfigCollection(studyUuid, configCollection, userId) ?
68+
ResponseEntity.noContent().build() : ResponseEntity.ok().build();
69+
}
70+
71+
@PostMapping("/{id}/spreadsheet-configs")
72+
@Operation(summary = "Add a spreadsheet configuration to a collection",
73+
description = "Adds a new spreadsheet configuration to a collection")
74+
@ApiResponse(responseCode = "201", description = "Configuration added")
75+
@ApiResponse(responseCode = "404", description = "Configuration collection not found")
76+
public ResponseEntity<UUID> addSpreadsheetConfigToCollection(
77+
@PathVariable("studyUuid") UUID studyUuid,
78+
@Parameter(description = "ID of the configuration collection") @PathVariable UUID id,
79+
@Parameter(description = "Configuration to add") @Valid @RequestBody String configurationDto) {
80+
return ResponseEntity.status(HttpStatus.CREATED).body(studyService.addSpreadsheetConfigToCollection(studyUuid, id, configurationDto));
81+
}
82+
83+
@DeleteMapping("/{id}/spreadsheet-configs/{configId}")
84+
@Operation(summary = "Remove a spreadsheet configuration from a collection",
85+
description = "Removes an existing spreadsheet configuration from a collection")
86+
@ApiResponse(responseCode = "204", description = "Configuration removed")
87+
@ApiResponse(responseCode = "404", description = "Configuration collection or configuration not found")
88+
public ResponseEntity<Void> removeSpreadsheetConfigFromCollection(
89+
@PathVariable("studyUuid") UUID studyUuid,
90+
@Parameter(description = "ID of the configuration collection") @PathVariable UUID id,
91+
@Parameter(description = "ID of the configuration to remove") @PathVariable UUID configId) {
92+
studyService.removeSpreadsheetConfigFromCollection(studyUuid, id, configId);
93+
return ResponseEntity.noContent().build();
94+
}
95+
96+
@PutMapping("/{id}/reorder")
97+
@Operation(summary = "Reorder spreadsheet configs in a collection",
98+
description = "Updates the order of spreadsheet configs within a collection")
99+
@ApiResponse(responseCode = "204", description = "Order updated")
100+
@ApiResponse(responseCode = "404", description = "Collection not found")
101+
public ResponseEntity<Void> reorderSpreadsheetConfigs(
102+
@PathVariable("studyUuid") UUID studyUuid,
103+
@Parameter(description = "ID of the configuration collection") @PathVariable UUID id,
104+
@Valid @RequestBody List<UUID> newOrder) {
105+
studyService.reorderSpreadsheetConfigs(studyUuid, id, newOrder);
106+
return ResponseEntity.noContent().build();
107+
}
108+
}

‎src/main/java/org/gridsuite/study/server/controller/SpreadsheetConfigController.java

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
/*
2+
* Copyright (c) 2025, RTE (http://www.rte-france.com)
3+
* This Source Code Form is subject to the terms of the Mozilla Public
4+
* License, v. 2.0. If a copy of the MPL was not distributed with this
5+
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
6+
*/
7+
package org.gridsuite.study.server.controller;
8+
9+
import io.swagger.v3.oas.annotations.Operation;
10+
import io.swagger.v3.oas.annotations.Parameter;
11+
import io.swagger.v3.oas.annotations.responses.ApiResponse;
12+
import io.swagger.v3.oas.annotations.tags.Tag;
13+
import jakarta.validation.Valid;
14+
import org.gridsuite.study.server.StudyApi;
15+
import org.gridsuite.study.server.service.StudyService;
16+
import org.springframework.http.HttpStatus;
17+
import org.springframework.http.ResponseEntity;
18+
import org.springframework.web.bind.annotation.DeleteMapping;
19+
import org.springframework.web.bind.annotation.PatchMapping;
20+
import org.springframework.web.bind.annotation.PathVariable;
21+
import org.springframework.web.bind.annotation.PostMapping;
22+
import org.springframework.web.bind.annotation.PutMapping;
23+
import org.springframework.web.bind.annotation.RequestBody;
24+
import org.springframework.web.bind.annotation.RequestMapping;
25+
import org.springframework.web.bind.annotation.RestController;
26+
27+
import java.util.List;
28+
import java.util.UUID;
29+
30+
@RestController
31+
@RequestMapping(value = "/" + StudyApi.API_VERSION + "/studies/{studyUuid}/spreadsheet-config")
32+
@Tag(name = "Study server - Spreadsheet configurations")
33+
public class SpreadsheetConfigController {
34+
private final StudyService studyService;
35+
36+
public SpreadsheetConfigController(StudyService studyService) {
37+
this.studyService = studyService;
38+
}
39+
40+
@PostMapping("/{id}/columns")
41+
@Operation(summary = "Create a column", description = "Creates a new column")
42+
@ApiResponse(responseCode = "201", description = "Column created")
43+
public ResponseEntity<UUID> createColumn(
44+
@PathVariable("studyUuid") UUID studyUuid,
45+
@Parameter(description = "ID of the spreadsheet config") @PathVariable UUID id,
46+
@Valid @RequestBody String columnInfos) {
47+
UUID newColumnId = studyService.createColumn(studyUuid, id, columnInfos);
48+
return ResponseEntity.status(HttpStatus.CREATED).body(newColumnId);
49+
}
50+
51+
@PutMapping("/{id}/columns/{columnUuid}")
52+
@Operation(summary = "Update a column", description = "Updates an existing column")
53+
@ApiResponse(responseCode = "204", description = "Column updated")
54+
public ResponseEntity<Void> updateColumn(
55+
@PathVariable("studyUuid") UUID studyUuid,
56+
@Parameter(description = "ID of the spreadsheet config") @PathVariable UUID id,
57+
@Parameter(description = "ID of the column to update") @PathVariable UUID columnUuid,
58+
@Valid @RequestBody String columnInfos) {
59+
studyService.updateColumn(studyUuid, id, columnUuid, columnInfos);
60+
return ResponseEntity.noContent().build();
61+
}
62+
63+
@DeleteMapping("/{id}/columns/{columnUuid}")
64+
@Operation(summary = "Delete a column", description = "Deletes an existing column")
65+
@ApiResponse(responseCode = "204", description = "Column deleted")
66+
@ApiResponse(responseCode = "404", description = "Column not found")
67+
public ResponseEntity<Void> deleteColumn(
68+
@PathVariable("studyUuid") UUID studyUuid,
69+
@Parameter(description = "ID of the spreadsheet config") @PathVariable UUID id,
70+
@Parameter(description = "ID of the column to delete") @PathVariable UUID columnUuid) {
71+
studyService.deleteColumn(studyUuid, id, columnUuid);
72+
return ResponseEntity.noContent().build();
73+
}
74+
75+
@PutMapping("/{id}/columns/reorder")
76+
@Operation(summary = "Reorder columns", description = "Reorders the columns of a spreadsheet configuration")
77+
@ApiResponse(responseCode = "204", description = "Columns reordered")
78+
public ResponseEntity<Void> reorderColumns(
79+
@PathVariable("studyUuid") UUID studyUuid,
80+
@Parameter(description = "ID of the spreadsheet config") @PathVariable UUID id,
81+
@Parameter(description = "New order of column IDs") @RequestBody List<UUID> columnOrder) {
82+
studyService.reorderColumns(studyUuid, id, columnOrder);
83+
return ResponseEntity.noContent().build();
84+
}
85+
86+
@PatchMapping("/{id}/name")
87+
@Operation(summary = "Rename a spreadsheet configuration",
88+
description = "Updates the name of an existing spreadsheet configuration")
89+
@ApiResponse(responseCode = "204", description = "Configuration renamed")
90+
@ApiResponse(responseCode = "404", description = "Configuration not found")
91+
public ResponseEntity<Void> renameSpreadsheetConfig(
92+
@PathVariable("studyUuid") UUID studyUuid,
93+
@Parameter(description = "ID of the configuration to rename") @PathVariable UUID id,
94+
@Parameter(description = "New name for the configuration") @RequestBody String name) {
95+
studyService.renameSpreadsheetConfig(studyUuid, id, name);
96+
return ResponseEntity.noContent().build();
97+
}
98+
}

‎src/main/java/org/gridsuite/study/server/StudyController.java renamed to ‎src/main/java/org/gridsuite/study/server/controller/StudyController.java

+6-39
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* License, v. 2.0. If a copy of the MPL was not distributed with this
55
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
66
*/
7-
package org.gridsuite.study.server;
7+
package org.gridsuite.study.server.controller;
88

99
import com.fasterxml.jackson.databind.JsonNode;
1010
import com.powsybl.iidm.network.ThreeSides;
@@ -18,6 +18,8 @@
1818

1919
import org.apache.commons.lang3.StringUtils;
2020
import org.gridsuite.modification.dto.ModificationInfos;
21+
import org.gridsuite.study.server.StudyApi;
22+
import org.gridsuite.study.server.StudyException;
2123
import org.gridsuite.study.server.StudyException.Type;
2224
import org.gridsuite.study.server.dto.*;
2325
import org.gridsuite.study.server.dto.dynamicmapping.MappingInfos;
@@ -386,7 +388,7 @@ public ResponseEntity<byte[]> getVoltageLevelDiagram(
386388
@Parameter(description = "diagonalLabel") @RequestParam(name = "diagonalLabel", defaultValue = "false") boolean diagonalLabel,
387389
@Parameter(description = "topologicalColoring") @RequestParam(name = "topologicalColoring", defaultValue = "false") boolean topologicalColoring,
388390
@Parameter(description = "component library name") @RequestParam(name = "componentLibrary", required = false) String componentLibrary,
389-
@Parameter(description = "Sld display mode") @RequestParam(name = "sldDisplayMode", defaultValue = "STATE_VARIABLE") StudyConstants.SldDisplayMode sldDisplayMode,
391+
@Parameter(description = "Sld display mode") @RequestParam(name = "sldDisplayMode", defaultValue = "STATE_VARIABLE") SldDisplayMode sldDisplayMode,
390392
@Parameter(description = "language") @RequestParam(name = "language", defaultValue = "en") String language) {
391393
DiagramParameters diagramParameters = DiagramParameters.builder()
392394
.useName(useName)
@@ -420,7 +422,7 @@ public ResponseEntity<String> getVoltageLevelDiagramAndMetadata(
420422
@Parameter(description = "diagonalLabel") @RequestParam(name = "diagonalLabel", defaultValue = "false") boolean diagonalLabel,
421423
@Parameter(description = "topologicalColoring") @RequestParam(name = "topologicalColoring", defaultValue = "false") boolean topologicalColoring,
422424
@Parameter(description = "component library name") @RequestParam(name = "componentLibrary", required = false) String componentLibrary,
423-
@Parameter(description = "Sld display mode") @RequestParam(name = "sldDisplayMode", defaultValue = "STATE_VARIABLE") StudyConstants.SldDisplayMode sldDisplayMode,
425+
@Parameter(description = "Sld display mode") @RequestParam(name = "sldDisplayMode", defaultValue = "STATE_VARIABLE") SldDisplayMode sldDisplayMode,
424426
@Parameter(description = "language") @RequestParam(name = "language", defaultValue = "en") String language) {
425427
DiagramParameters diagramParameters = DiagramParameters.builder()
426428
.useName(useName)
@@ -626,7 +628,7 @@ public ResponseEntity<Void> moveModification(@PathVariable("studyUuid") UUID stu
626628
@ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The modification list has been updated.")})
627629
public ResponseEntity<Void> moveOrCopyModifications(@PathVariable("studyUuid") UUID studyUuid,
628630
@PathVariable("nodeUuid") UUID nodeUuid,
629-
@RequestParam("action") StudyConstants.ModificationsActionType action,
631+
@RequestParam("action") ModificationsActionType action,
630632
@Nullable @RequestParam("originNodeUuid") UUID originNodeUuid,
631633
@RequestBody List<UUID> modificationsToCopyUuidList,
632634
@RequestHeader(HEADER_USER_ID) String userId) {
@@ -845,41 +847,6 @@ public ResponseEntity<StudyVoltageInitParameters> getVoltageInitParameters(
845847
return ResponseEntity.ok().body(studyService.getVoltageInitParameters(studyUuid));
846848
}
847849

848-
@GetMapping(value = "/studies/{studyUuid}/spreadsheet-config-collection")
849-
@Operation(summary = "Get study spreadsheet config collection")
850-
@ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The spreadsheet config collection")})
851-
public ResponseEntity<String> getSpreadsheetConfigCollection(
852-
@PathVariable("studyUuid") UUID studyUuid) {
853-
return ResponseEntity.ok().body(studyService.getSpreadsheetConfigCollection(studyUuid));
854-
}
855-
856-
@PutMapping(value = "/studies/{studyUuid}/spreadsheet-config-collection")
857-
@Operation(summary = "Update study's spreadsheet config collection, with replace or append mode")
858-
@ApiResponses(value = {
859-
@ApiResponse(responseCode = "200", description = "The updated spreadsheet config collection"),
860-
@ApiResponse(responseCode = "404", description = "The study or the collection doesn't exist")
861-
})
862-
public ResponseEntity<String> updateStudySpreadsheetConfigCollection(
863-
@PathVariable("studyUuid") UUID studyUuid,
864-
@RequestParam("collectionUuid") UUID collectionUuid,
865-
@RequestParam(value = "append", required = false, defaultValue = "false") Boolean appendMode) {
866-
return ResponseEntity.ok().body(studyService.updateStudySpreadsheetConfigCollection(studyUuid, collectionUuid, appendMode));
867-
}
868-
869-
@PostMapping(value = "/studies/{studyUuid}/spreadsheet-config-collection")
870-
@Operation(summary = "Set spreadsheet config collection on study, reset to default one if empty body")
871-
@ApiResponses(value = {
872-
@ApiResponse(responseCode = "200", description = "The spreadsheet config collection is set"),
873-
@ApiResponse(responseCode = "204", description = "Reset with user profile cannot be done")
874-
})
875-
public ResponseEntity<Void> setSpreadsheetConfigCollection(
876-
@PathVariable("studyUuid") UUID studyUuid,
877-
@RequestBody(required = false) String configCollection,
878-
@RequestHeader(HEADER_USER_ID) String userId) {
879-
return studyService.setSpreadsheetConfigCollection(studyUuid, configCollection, userId) ?
880-
ResponseEntity.noContent().build() : ResponseEntity.ok().build();
881-
}
882-
883850
@GetMapping(value = "/export-network-formats")
884851
@Operation(summary = "get the available export format")
885852
@ApiResponses(value = {@ApiResponse(responseCode = "200", description = "The available export format")})

‎src/main/java/org/gridsuite/study/server/SupervisionController.java renamed to ‎src/main/java/org/gridsuite/study/server/controller/SupervisionController.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* License, v. 2.0. If a copy of the MPL was not distributed with this
55
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
66
*/
7-
package org.gridsuite.study.server;
7+
package org.gridsuite.study.server.controller;
88

99
import io.swagger.v3.oas.annotations.Operation;
1010
import io.swagger.v3.oas.annotations.Parameter;
@@ -13,6 +13,7 @@
1313
import io.swagger.v3.oas.annotations.tags.Tag;
1414
import org.apache.http.HttpHost;
1515
import org.elasticsearch.client.RestClient;
16+
import org.gridsuite.study.server.StudyApi;
1617
import org.gridsuite.study.server.service.StudyService;
1718
import org.gridsuite.study.server.service.SupervisionService;
1819

0 commit comments

Comments
 (0)