Class EquipmentAdminController

java.lang.Object

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

@Controller
public class EquipmentAdminController
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	EquipmentAdminController.Template	Represents templates in the resources, allowing one or several EquipmentTypes 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 EquipmentTypeMapper	equipmentTypeMapper	Converts data-transfer objects to EquipmentTypes.
private final @NonNull PathLocaliser	pathLocaliser	Used to resolve the URL paths in the correct Locale.

Constructor Summary

Constructors

Constructor	Description
EquipmentAdminController(@NonNull EquipmentService equipmentService, @NonNull EquipmentTypeMapper equipmentTypeMapper, @NonNull PathLocaliser pathLocaliser)	Constructs a new EquipmentAdminController.

Method Summary

Modifier and Type	Method	Description
@NonNull String	createEquipmentType(@Valid @NonNull EquipmentTypeDTO dto, @NonNull org.springframework.validation.BindingResult bindingResult, @NonNull org.springframework.ui.Model model, @NonNull jakarta.servlet.http.HttpServletResponse response)	Handles POST requests to /admin/equipment/new and adds the given EquipmentTypeDTO as a new EquipmentType to the database.
@NonNull String	deleteEquipmentType(@NonNull String name, @NonNull Locale locale)	Removes the EquipmentType with the given EquipmentType.name from the database if existent.
@NonNull String	getCreateEquipmentTypeForm(@NonNull EquipmentTypeDTO equipmentTypeDTO, @NonNull org.springframework.ui.Model model)	Handles GET requests to /admin/equipment.
@NonNull String	getDeleteTypeConfirmationPage(@NonNull String name, @NonNull org.springframework.ui.Model model)	Handles GET requests to /admin/equipment/{name}/delete and asks the user whether they really wish to delete the EquipmentType with the given EquipmentType.name from the database.
@NonNull String	getEquipmentTypes(@NonNull EquipmentTypeDTO equipmentTypeDTO, @NonNull org.springframework.ui.Model model)	Handles GET requests to /admin/equipment.

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 fetch existing EquipmentTypes from the database.

equipmentTypeMapper

@NonNull
private final @NonNull EquipmentTypeMapper equipmentTypeMapper

Converts data-transfer objects to EquipmentTypes.

pathLocaliser

@NonNull
private final @NonNull PathLocaliser pathLocaliser

Used to resolve the URL paths in the correct Locale.

Constructor Details

EquipmentAdminController

public EquipmentAdminController(@NonNull
 @NonNull EquipmentService equipmentService,
 @NonNull
 @NonNull EquipmentTypeMapper equipmentTypeMapper,
 @NonNull
 @NonNull PathLocaliser pathLocaliser)

Constructs a new EquipmentAdminController.

Parameters:

equipmentService - The equipmentService.

equipmentTypeMapper - The equipmentTypeMapper.

pathLocaliser - The pathLocaliser to use for localising paths.

Method Details

getEquipmentTypes

@GetMapping({"/admin/ausstattung","/en/admin/equipment"})
@NonNull
public @NonNull String getEquipmentTypes(@NonNull
 @NonNull EquipmentTypeDTO equipmentTypeDTO,
 @NonNull
 @NonNull org.springframework.ui.Model model)

Handles GET requests to /admin/equipment.

Parameters:

equipmentTypeDTO - An empty EquipmentTypeDTO only used for binding in the Thymeleaf template.

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

Returns:

The admins' equipment page.

getCreateEquipmentTypeForm

@GetMapping({"/admin/ausstattung/neu","/en/admin/equipment/new"})
@NonNull
public @NonNull String getCreateEquipmentTypeForm(@NonNull
 @NonNull EquipmentTypeDTO equipmentTypeDTO,
 @NonNull
 @NonNull org.springframework.ui.Model model)

Handles GET requests to /admin/equipment.

Parameters:

equipmentTypeDTO - An empty EquipmentTypeDTO only used for binding in the Thymeleaf template.

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

Returns:

The admins' equipment page.

createEquipmentType

@PostMapping({"/admin/ausstattung/neu","/en/admin/equipment/new"})
@NonNull
public @NonNull String createEquipmentType(@Valid @NonNull
 @Valid @NonNull EquipmentTypeDTO dto,
 @NonNull
 @NonNull org.springframework.validation.BindingResult bindingResult,
 @NonNull
 @NonNull org.springframework.ui.Model model,
 @NonNull
 @NonNull jakarta.servlet.http.HttpServletResponse response)
                                    throws IllegalStateException,
InvalidEquipmentException

Handles POST requests to /admin/equipment/new 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

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 equipment page. Otherwise: The form, with the original input preserved and with error messages shown.

Throws:

InvalidEquipmentException - If the EquipmentTypeDTO.type is invalid.

IllegalStateException - If the equipment path is malformed.

getDeleteTypeConfirmationPage

@GetMapping({"/admin/ausstattung/{name}/l\u00f6schen","/en/admin/equipment/{name}/delete"})
@NonNull
public @NonNull String getDeleteTypeConfirmationPage(@NonNull @PathVariable
 @NonNull String name,
 @NonNull
 @NonNull org.springframework.ui.Model model)
                                              throws NotFoundException,
de.gustavblass.commons.exceptions.IllegalArgumentException

Handles GET requests to /admin/equipment/{name}/delete and asks the user whether they really wish to delete the EquipmentType with the given EquipmentType.name from the database.

Parameters:

name - The title of the EquipmentType to be deleted.

model - Used to display the details of the EquipmentType.

Returns:

A confirmation form.

Throws:

NotFoundException - If the given EquipmentType does not exist.

de.gustavblass.commons.exceptions.IllegalArgumentException - See EquipmentTypeMapper.toDto(EquipmentType).

deleteEquipmentType

@PostMapping({"/admin/ausstattung/{name}/l\u00f6schen","/en/admin/equipment/delete"})
@NonNull
public @NonNull String deleteEquipmentType(@NonNull @PathVariable
 @NonNull String name,
 @NonNull
 @NonNull Locale locale)
                                    throws NotFoundException,
IllegalStateException

Removes the EquipmentType with the given EquipmentType.name from the database if existent. Also removes all RoomEquipment that has the RoomEquipment.type that shall be deleted.

Parameters:

name - The title of the EquipmentType to delete.

locale - The language of the request.

Returns:

Redirects to the list of all equipment types.

Throws:

NotFoundException - If no EquipmentType with the given name exists.

IllegalStateException - If the equipment URL is malformed.