-
-
Notifications
You must be signed in to change notification settings - Fork 390
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add REST controller for CRUD functionality of Ocpp Tags (#910)
- Loading branch information
Showing
4 changed files
with
217 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
170 changes: 170 additions & 0 deletions
170
src/main/java/de/rwth/idsg/steve/web/api/OcppTagsRestController.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| /* | ||
| * SteVe - SteckdosenVerwaltung - https://github.com/steve-community/steve | ||
| * Copyright (C) 2013-2019 RWTH Aachen University - Information Systems - Intelligent Distributed Systems Group (IDSG). | ||
| * All Rights Reserved. | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
| package de.rwth.idsg.steve.web.api; | ||
|
|
||
| import de.rwth.idsg.steve.repository.OcppTagRepository; | ||
| import de.rwth.idsg.steve.repository.dto.OcppTag; | ||
| import de.rwth.idsg.steve.service.OcppTagService; | ||
| import de.rwth.idsg.steve.web.api.ApiControllerAdvice.ApiErrorResponse; | ||
| import de.rwth.idsg.steve.web.dto.OcppTagForm; | ||
| import de.rwth.idsg.steve.web.dto.OcppTagQueryForm; | ||
| import io.swagger.annotations.ApiResponse; | ||
| import io.swagger.annotations.ApiResponses; | ||
| import lombok.RequiredArgsConstructor; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import org.springframework.http.HttpStatus; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.web.bind.annotation.DeleteMapping; | ||
| import org.springframework.web.bind.annotation.GetMapping; | ||
| import org.springframework.web.bind.annotation.PathVariable; | ||
| import org.springframework.web.bind.annotation.PostMapping; | ||
| import org.springframework.web.bind.annotation.PutMapping; | ||
| import org.springframework.web.bind.annotation.RequestBody; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.ResponseBody; | ||
| import org.springframework.web.bind.annotation.ResponseStatus; | ||
| import org.springframework.web.bind.annotation.RestController; | ||
| import org.springframework.web.server.ResponseStatusException; | ||
|
|
||
| import javax.validation.Valid; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
||
| /** | ||
| * @author Sevket Goekay <sevketgokay@gmail.com> | ||
| * @since 13.09.2022 | ||
| */ | ||
| @Slf4j | ||
| @RestController | ||
| @RequestMapping(value = "/api/v1/ocppTags", produces = MediaType.APPLICATION_JSON_VALUE) | ||
| @RequiredArgsConstructor | ||
| public class OcppTagsRestController { | ||
|
|
||
| private final OcppTagRepository ocppTagRepository; | ||
| private final OcppTagService ocppTagService; | ||
|
|
||
| @ApiResponses(value = { | ||
| @ApiResponse(code = 200, message = "OK"), | ||
| @ApiResponse(code = 400, message = "Bad Request", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 401, message = "Unauthorized", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 403, message = "Forbidden", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 500, message = "Internal Server Error", response = ApiErrorResponse.class)} | ||
| ) | ||
| @GetMapping(value = "") | ||
| @ResponseBody | ||
| public List<OcppTag.Overview> get(OcppTagQueryForm params) { | ||
| log.debug("Read request for query: {}", params); | ||
|
|
||
| var response = ocppTagRepository.getOverview(params); | ||
| log.debug("Read response for query: {}", response); | ||
| return response; | ||
| } | ||
|
|
||
| @ApiResponses(value = { | ||
| @ApiResponse(code = 200, message = "OK"), | ||
| @ApiResponse(code = 400, message = "Bad Request", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 401, message = "Unauthorized", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 403, message = "Forbidden", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 404, message = "Not Found", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 500, message = "Internal Server Error", response = ApiErrorResponse.class)} | ||
| ) | ||
| @GetMapping("/{ocppTagPk}") | ||
| @ResponseBody | ||
| public OcppTag.Overview getOne(@PathVariable("ocppTagPk") Integer ocppTagPk) { | ||
| log.debug("Read request for ocppTagPk: {}", ocppTagPk); | ||
|
|
||
| var response = getOneInternal(ocppTagPk); | ||
| log.debug("Read response: {}", response); | ||
| return response; | ||
| } | ||
|
|
||
| @ApiResponses(value = { | ||
| @ApiResponse(code = 201, message = "Created"), | ||
| @ApiResponse(code = 400, message = "Bad Request", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 401, message = "Unauthorized", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 403, message = "Forbidden", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 404, message = "Not Found", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 500, message = "Internal Server Error", response = ApiErrorResponse.class)} | ||
| ) | ||
| @PostMapping | ||
| @ResponseBody | ||
| @ResponseStatus(HttpStatus.CREATED) | ||
| public OcppTag.Overview create(@RequestBody @Valid OcppTagForm params) { | ||
| log.debug("Create request: {}", params); | ||
|
|
||
| int ocppTagPk = ocppTagRepository.addOcppTag(params); | ||
| ocppTagService.removeUnknown(Collections.singletonList(params.getIdTag())); | ||
|
|
||
| var response = getOneInternal(ocppTagPk); | ||
| log.debug("Create response: {}", response); | ||
| return response; | ||
| } | ||
|
|
||
| @ApiResponses(value = { | ||
| @ApiResponse(code = 200, message = "OK"), | ||
| @ApiResponse(code = 400, message = "Bad Request", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 401, message = "Unauthorized", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 403, message = "Forbidden", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 404, message = "Not Found", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 500, message = "Internal Server Error", response = ApiErrorResponse.class)} | ||
| ) | ||
| @PutMapping("/{ocppTagPk}") | ||
| @ResponseBody | ||
| public OcppTag.Overview update(@PathVariable("ocppTagPk") Integer ocppTagPk, @RequestBody @Valid OcppTagForm params) { | ||
| params.setOcppTagPk(ocppTagPk); // the one from incoming params does not matter | ||
| log.debug("Update request: {}", params); | ||
|
|
||
| ocppTagRepository.updateOcppTag(params); | ||
|
|
||
| var response = getOneInternal(ocppTagPk); | ||
| log.debug("Update response: {}", response); | ||
| return response; | ||
| } | ||
|
|
||
| @ApiResponses(value = { | ||
| @ApiResponse(code = 200, message = "OK"), | ||
| @ApiResponse(code = 400, message = "Bad Request", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 401, message = "Unauthorized", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 403, message = "Forbidden", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 404, message = "Not Found", response = ApiErrorResponse.class), | ||
| @ApiResponse(code = 500, message = "Internal Server Error", response = ApiErrorResponse.class)} | ||
| ) | ||
| @DeleteMapping("/{ocppTagPk}") | ||
| @ResponseBody | ||
| public OcppTag.Overview delete(@PathVariable("ocppTagPk") Integer ocppTagPk) { | ||
| log.debug("Delete request for ocppTagPk: {}", ocppTagPk); | ||
|
|
||
| var response = getOneInternal(ocppTagPk); | ||
| ocppTagRepository.deleteOcppTag(ocppTagPk); | ||
|
|
||
| log.debug("Delete response: {}", response); | ||
| return response; | ||
| } | ||
|
|
||
| private OcppTag.Overview getOneInternal(int ocppTagPk) { | ||
| OcppTagQueryForm params = new OcppTagQueryForm(); | ||
| params.setOcppTagPk(ocppTagPk); | ||
|
|
||
| List<OcppTag.Overview> results = ocppTagRepository.getOverview(params); | ||
| if (results.isEmpty()) { | ||
| throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Could not find this ocppTag"); | ||
| } | ||
| return results.get(0); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters