Skip to content

chore(#119): defer ESPI resource CRUD writes — delete write/admin controllers #166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dfcoffin merged 1 commit into from
Jun 5, 2026
Merged

chore(#119): defer ESPI resource CRUD writes — delete write/admin controllers #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 4 additions & 102 deletions .../greenbuttonalliance/espi/datacustodian/web/api/ApplicationInformationRESTController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,17 @@
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.server.ResponseStatusException;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;

import java.io.ByteArrayOutputStream;
import java.net.URI;
import java.util.List;
import java.util.UUID;

/**
* Modern RESTful controller for managing ApplicationInformation resources according to the
* Modern RESTful controller for reading ApplicationInformation resources according to the
* Green Button Alliance ESPI (Energy Services Provider Interface) specification.
* <p>
* This controller uses ApplicationInformationService and modern Spring Boot 3.5 patterns.
* GET-only. The CRUD write endpoints (POST/PUT/DELETE) are deferred — they are admin/sandbox-DB
* management APIs to be delivered in the separate admin-CRUD track (see issue #119 build plan).
*/
@RestController
@RequestMapping("/espi/1_1/resource/ApplicationInformation")
Expand Down Expand Up @@ -119,101 +118,4 @@ public ResponseEntity<byte[]> getApplicationInformation(
.contentType(MediaType.APPLICATION_XML)
.body(out.toByteArray());
}

/**
* Creates a new ApplicationInformation resource.
*
* @param dto ApplicationInformationDto to create
* @return created ApplicationInformationDto
*/
@PostMapping(consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)
@Operation(
summary = "Create ApplicationInformation",
description = "Creates a new ApplicationInformation resource"
)
@ApiResponses(value = {
@ApiResponse(responseCode = "201", description = "Successfully created ApplicationInformation"),
@ApiResponse(responseCode = "400", description = "Invalid ApplicationInformation data")
})
@PreAuthorize("hasAuthority('SCOPE_DataCustodian_Admin_Access')")
public ResponseEntity<ApplicationInformationEntity> createApplicationInformation(
@Parameter(description = "ApplicationInformation data to create", required = true)
@RequestBody ApplicationInformationDto dto) {

ApplicationInformationEntity entity = applicationInformationService.fromDto(dto);
ApplicationInformationEntity savedEntity = applicationInformationService.save(entity);

URI location = ServletUriComponentsBuilder.fromCurrentRequest()
.path("/{id}")
.buildAndExpand(savedEntity.getId())
.toUri();

return ResponseEntity.created(location).body(savedEntity);
}

/**
* Updates an existing ApplicationInformation resource.
*
* @param applicationInformationId Unique identifier for the ApplicationInformation to update
* @param dto Updated ApplicationInformationDto data
* @return updated ApplicationInformationEntity
*/
@PutMapping(value = "/{applicationInformationId}",
consumes = MediaType.APPLICATION_JSON_VALUE,
produces = MediaType.APPLICATION_JSON_VALUE)
@Operation(
summary = "Update ApplicationInformation",
description = "Updates an existing ApplicationInformation resource"
)
@ApiResponses(value = {
@ApiResponse(responseCode = "200", description = "Successfully updated ApplicationInformation"),
@ApiResponse(responseCode = "404", description = "ApplicationInformation not found"),
@ApiResponse(responseCode = "400", description = "Invalid ApplicationInformation data")
})
@PreAuthorize("hasAuthority('SCOPE_DataCustodian_Admin_Access')")
public ResponseEntity<ApplicationInformationEntity> updateApplicationInformation(
@Parameter(description = "Unique identifier of the ApplicationInformation to update", required = true)
@PathVariable UUID applicationInformationId,
@Parameter(description = "Updated ApplicationInformation data", required = true)
@RequestBody ApplicationInformationDto dto) {

ApplicationInformationEntity existing = applicationInformationService.findById(applicationInformationId);
if (existing == null) {
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "ApplicationInformation not found");
}

ApplicationInformationEntity entity = applicationInformationService.fromDto(dto);
entity.setId(applicationInformationId);
ApplicationInformationEntity updatedEntity = applicationInformationService.save(entity);

return ResponseEntity.ok(updatedEntity);
}

/**
* Deletes an ApplicationInformation resource.
*
* @param applicationInformationId Unique identifier for the ApplicationInformation to delete
*/
@DeleteMapping("/{applicationInformationId}")
@Operation(
summary = "Delete ApplicationInformation",
description = "Deletes an ApplicationInformation resource"
)
@ApiResponses(value = {
@ApiResponse(responseCode = "204", description = "Successfully deleted ApplicationInformation"),
@ApiResponse(responseCode = "404", description = "ApplicationInformation not found")
})
@PreAuthorize("hasAuthority('SCOPE_DataCustodian_Admin_Access')")
public ResponseEntity<Void> deleteApplicationInformation(
@Parameter(description = "Unique identifier of the ApplicationInformation to delete", required = true)
@PathVariable UUID applicationInformationId) {

ApplicationInformationEntity existing = applicationInformationService.findById(applicationInformationId);
if (existing == null) {
throw new ResponseStatusException(HttpStatus.NOT_FOUND, "ApplicationInformation not found");
}

applicationInformationService.deleteById(applicationInformationId);
return ResponseEntity.noContent().build();
}
}
}
Loading
Loading