Class EquipmentAdminRestController

java.lang.Object

de.gustavblass.fsu.fmi.roombooking.controller.admin.EquipmentAdminRestController

@RestController
public class EquipmentAdminRestController
extends Object

Defines the behaviour of the API server for the path /api/v1/admin/equipment.

Field Summary

Fields

Modifier and Type	Field	Description
private final EquipmentService	equipmentService	Used to retrieve and save EquipmentTypes from the database.
private final @NonNull EquipmentTypeMapper	equipmentTypeMapper	Converts data-transfer objects to EquipmentTypes.

Constructor Summary

Constructors

Constructor	Description
EquipmentAdminRestController(@NonNull EquipmentService equipmentService, @NonNull EquipmentTypeMapper equipmentTypeMapper)	Constructs a new EquipmentAdminRestController with the given equipmentService.

Method Summary

Modifier and Type	Method	Description
@NonNull org.springframework.http.ResponseEntity<Void>	createEquipment(@Valid @NonNull EquipmentTypeDTO dto)	Handles POST requests to /api/v1/admin/equipment and adds the given EquipmentTypeDTO as a new EquipmentType to the database.
org.springframework.http.ResponseEntity<Void>	deleteEquipment(@NonNull String name)	Removes the EquipmentType with the given EquipmentType.name from the database.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

equipmentService

private final EquipmentService equipmentService

Used to retrieve and save EquipmentTypes from the database.

equipmentTypeMapper

@NonNull
private final @NonNull EquipmentTypeMapper equipmentTypeMapper

Converts data-transfer objects to EquipmentTypes.

Constructor Details

EquipmentAdminRestController

public EquipmentAdminRestController(@NonNull
 @NonNull EquipmentService equipmentService,
 @NonNull
 @NonNull EquipmentTypeMapper equipmentTypeMapper)

Constructs a new EquipmentAdminRestController with the given equipmentService.

Parameters:

equipmentService - The equipmentService to use for database access.

equipmentTypeMapper - The equipmentTypeMapper to use for database access.

Method Details

createEquipment

@PostMapping("/api/v1/admin/equipment")
@NonNull
public @NonNull org.springframework.http.ResponseEntity<Void> createEquipment(@RequestBody @Valid @NonNull
 @Valid @NonNull EquipmentTypeDTO dto)
                                                                       throws AlreadyExistsException,
InvalidEquipmentException

Handles POST requests to /api/v1/admin/equipment and adds the given EquipmentTypeDTO as a new EquipmentType to the database.

Parameters:

dto -

The data-transfer object that represents the new EquipmentType. Must be valid according to the annotations on the class fields. Allowed values for the EquipmentTypeDTO.type:

• IndividualEquipmentType.CODE
• CommonEquipmentType.CODE

Returns:

Empty response. Only the status code indicates success. The response's location header will point to the URI of all equipment.

Throws:

AlreadyExistsException - If the new EquipmentType is not unique.

InvalidEquipmentException - If the EquipmentTypeDTO.type does not exist.

deleteEquipment

@DeleteMapping("/api/v1/admin/equipment/{name}")
public org.springframework.http.ResponseEntity<Void> deleteEquipment(@NonNull @PathVariable
 @NonNull String name)
                                                              throws NotFoundException

Removes the EquipmentType with the given EquipmentType.name from the database.

Parameters:

name - The title of the EquipmentType that shall no longer be part of the system.

Returns:

Empty response. Only the status code indicates success.

Throws:

NotFoundException - If no EquipmentType with the given number exists.