Class RoomAdminController

java.lang.Object

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

@Controller
public class RoomAdminController
extends Object

Defines the behaviour of the API server for the path /admin/rooms.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	RoomAdminController.Template	Represents templates in the resources, allowing one or several Reservations to be rendered as HTML.

Field Summary

Fields

Modifier and Type	Field	Description
private final EquipmentService	equipmentService	Used to fetch existing EquipmentTypes from the database.
private final @NonNull PathLocaliser	pathLocaliser	Used to resolve the URL paths in the correct Locale.
private final @NonNull RoomMapper	roomMapper	Converts data-transfer objects to Rooms.
private final RoomService	roomService	Used to retrieve and save Rooms from the database.

Constructor Summary

Constructors

Constructor	Description
RoomAdminController(@NonNull RoomService roomService, @NonNull EquipmentService equipmentService, @NonNull RoomMapper roomMapper, @NonNull PathLocaliser pathLocaliser)	Constructs a new RoomAdminController with the given roomService.

Method Summary

Modifier and Type	Method	Description
@NonNull String	createRoom(@Valid @NonNull NewRoomDTO dto, @NonNull org.springframework.validation.BindingResult bindingResult, @NonNull org.springframework.ui.Model model, @NonNull jakarta.servlet.http.HttpServletResponse response)	Handles POST requests to /admin/rooms and adds the given NewRoomDTO as a new Room to the database.
@NonNull String	getCreateRoomForm(NewRoomDTO newRoomDTO, @NonNull org.springframework.ui.Model model)	Handles GET requests to /admin/rooms/add.

Methods inherited from class Object

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

Field Details

roomService

private final RoomService roomService

Used to retrieve and save Rooms from the database.

equipmentService

private final EquipmentService equipmentService

Used to fetch existing EquipmentTypes from the database.

See Also:

• getCreateRoomForm(NewRoomDTO, Model)

roomMapper

@NonNull
private final @NonNull RoomMapper roomMapper

Converts data-transfer objects to Rooms.

pathLocaliser

@NonNull
private final @NonNull PathLocaliser pathLocaliser

Used to resolve the URL paths in the correct Locale.

Constructor Details

RoomAdminController

public RoomAdminController(@NonNull
 @NonNull RoomService roomService,
 @NonNull
 @NonNull EquipmentService equipmentService,
 @NonNull
 @NonNull RoomMapper roomMapper,
 @NonNull
 @NonNull PathLocaliser pathLocaliser)

Constructs a new RoomAdminController with the given roomService.

Parameters:

roomService - The roomService to use for database access.

equipmentService - The equipmentService to use for database access.

roomMapper - The roomMapper.

pathLocaliser - The pathLocaliser to use for localising paths.

Method Details

getCreateRoomForm

@GetMapping({"/admin/r\u00e4ume/hinzuf\u00fcgen","/en/admin/rooms/add"})
@NonNull
public @NonNull String getCreateRoomForm(NewRoomDTO newRoomDTO,
 @NonNull
 @NonNull org.springframework.ui.Model model)

Handles GET requests to /admin/rooms/add.

Parameters:

newRoomDTO - An empty NewRoomDTO only used for binding in the Thymeleaf template.

model - Used to add the existing EquipmentTypes to the form.

Returns:

The admins' create-room form.

createRoom

@PostMapping({"/admin/r\u00e4ume/hinzuf\u00fcgen","/en/admin/rooms/add"})
@NonNull
public @NonNull String createRoom(@Valid @NonNull
 @Valid @NonNull NewRoomDTO dto,
 @NonNull
 @NonNull org.springframework.validation.BindingResult bindingResult,
 @NonNull
 @NonNull org.springframework.ui.Model model,
 @NonNull
 @NonNull jakarta.servlet.http.HttpServletResponse response)
                           throws IllegalStateException,
InvalidIndividualEquipmentException,
InvalidCommonEquipmentException,
de.gustavblass.commons.exceptions.IllegalArgumentException

Handles POST requests to /admin/rooms and adds the given NewRoomDTO as a new Room to the database.

Parameters:

dto - The data-transfer object that represents the new Room. Must be valid according to the annotations on the class fields. Must have a unique (new) Room.number.

bindingResult - The result of the DTO validation.

model - Used to add the existing EquipmentTypes to the form.

response - The web server's response to the admin's HTTP request.

Returns:

In case of success: The room page (e.g. /rooms/42). Otherwise: The form, with the original input preserved and with error messages shown.

Throws:

de.gustavblass.commons.exceptions.IllegalArgumentException - If the DTO conversion fails.

InvalidIndividualEquipmentException - If one of the Room's IndividualEquipmentTypes does not exist in the database.

InvalidCommonEquipmentException - If one of the Room's CommonEquipmentTypes does not exist in the database.

IllegalStateException - If the room path is malformed.