Class ReservationRestController

java.lang.Object

de.gustavblass.fsu.fmi.roombooking.controller.ReservationRestController

@RestController
public class ReservationRestController
extends Object

Defines the behaviour of the API server for the path /api/v1/book-room.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static enum	ReservationRestController.ReservationRestUriTemplate	Pre-compiled UriTemplates for HATEOAS-compliant API responses.

Field Summary

Fields

Modifier and Type	Field	Description
private final @NonNull ReservationMapper	reservationMapper	Converts Reservations to data-transfer objects.
private final ReservationService	reservationService	Used to retrieve and save Reservations from the database.

Constructor Summary

Constructors

Constructor	Description
ReservationRestController(@NonNull ReservationService reservationService, @NonNull ReservationMapper reservationMapper)	Creates a new ReservationRestController.

Method Summary

Modifier and Type	Method	Description
@NonNull org.springframework.hateoas.EntityModel<ReservationDTO>	bookRoom(@NonNull @Valid BookRoomDTO bookRoomDTO)	Handles POST requests to /api/v1/reservations and places a new Reservation based on the given BookRoomDTO.
@NonNull org.springframework.http.ResponseEntity<Void>	deleteReservation(@Min(0L) Long id)	Handles DELETE requests to /api/v1/reservations/{id} and removes the requesting Actor's Reservation with the given Reservation.id from the database.
@NonNull org.springframework.hateoas.EntityModel<ReservationDTO>	getReservation(@NonNull Long id)	Handles GET requests to /api/v1/reservations/{id} and fetches the Reservation with the specified Reservation.id from the database, converts it to a ReservationDTO object and returns that.
org.springframework.hateoas.PagedModel<org.springframework.hateoas.EntityModel<ReservationSummaryDTO>>	getReservations(int page, @Max(20L) int size, @NonNull String sortBy, boolean ascending)	Handles GET requests to /api/v1/reservations and retrieves a paginated subset of all Reservations by the requesting Actor according to the URL parameters given.
private @NonNull org.springframework.hateoas.EntityModel<ReservationSummaryDTO>	reservationToSummaryDtoModel(@NonNull Reservation reservation)	Converts a Reservation to an EntityModel of a ReservationSummaryDTO, with

Methods inherited from class Object

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

Field Details

reservationService

private final ReservationService reservationService

Used to retrieve and save Reservations from the database.

reservationMapper

@NonNull
private final @NonNull ReservationMapper reservationMapper

Converts Reservations to data-transfer objects.

Constructor Details

ReservationRestController

public ReservationRestController(@NonNull
 @NonNull ReservationService reservationService,
 @NonNull
 @NonNull ReservationMapper reservationMapper)

Creates a new ReservationRestController.

Parameters:

reservationService - The reservationService.

reservationMapper - The reservationMapper.

Method Details

getReservations

@GetMapping("/api/v1/reservations")
public org.springframework.hateoas.PagedModel<org.springframework.hateoas.EntityModel<ReservationSummaryDTO>> getReservations(@RequestParam(name="page",defaultValue="0")
 int page,
 @Max(20L) @RequestParam(name="size",defaultValue="5")
 @Max(20L) int size,
 @NonNull @RequestParam(name="sortBy",defaultValue="id")
 @NonNull String sortBy,
 @RequestParam(name="ascending",defaultValue="true")
 boolean ascending)
                                                                                                                       throws NotLoggedInException

Handles GET requests to /api/v1/reservations and retrieves a paginated subset of all Reservations by the requesting Actor according to the URL parameters given.

Parameters:

page - The index of the page requested.

size - How many Reservation items each page in the pagination has.

sortBy - Which of the Reservations' fields shall be used to sort the items. Determines the order of the items and thereby also which items are present on the requested page.

ascending - Whether to count from the start or from the end of the list sorted using sortBy.

Returns:

The specified subset of all Reservations as summarised data-transfer objects.

Throws:

NotLoggedInException - If the user is not authenticated.

getReservation

@GetMapping("/api/v1/reservations/{id}")
@NonNull
public @NonNull org.springframework.hateoas.EntityModel<ReservationDTO> getReservation(@NonNull @PathVariable
 @NonNull Long id)
                                                                                throws NotFoundException

Handles GET requests to /api/v1/reservations/{id} and fetches the Reservation with the specified Reservation.id from the database, converts it to a ReservationDTO object and returns that.

Parameters:

id - The ID of the Reservation that shall be returned.

Returns:

The requested Reservation, represented as a data-transfer object.

Throws:

NotFoundException - If there is no Reservation with the given ID.

bookRoom

@PostMapping("/api/v1/reservations")
@PreAuthorize("hasRole('REGULAR')")
@NonNull
public @NonNull org.springframework.hateoas.EntityModel<ReservationDTO> bookRoom(@NonNull @Valid @RequestBody
 @NonNull @Valid BookRoomDTO bookRoomDTO)
                                                                          throws IllegalStateException,
NotFoundException,
TimeTravelException,
ReversedTimePeriodException,
ReservationPeriodTooSmallException,
ReservationPeriodTooBigException,
InvalidUseException,
ConflictingReservationsException,
de.gustavblass.commons.exceptions.IllegalArgumentException

Handles POST requests to /api/v1/reservations and places a new Reservation based on the given BookRoomDTO.

Parameters:

bookRoomDTO - The data-transfer object representing the Reservation that shall be placed. Corresponds to the form input.

Returns:

The successfully placed Reservation as a data-transfer object.

Throws:

IllegalStateException - If the user cannot be authenticated for unknown reasons.

NotFoundException - If the Room.number does not exist.

TimeTravelException - If the reservation starts in the past.

ReversedTimePeriodException - If FilterReservationsDTO.from does not come before FilterReservationsDTO.to.

ReservationPeriodTooSmallException - If FilterReservationsDTO.to comes too shortly after FilterReservationsDTO.from.

ReservationPeriodTooBigException - If the period between FilterReservationsDTO.from and FilterReservationsDTO.to is too long.

ConflictingReservationsException - If there is already at least one Reservation for the Room in the specified time period.

InvalidUseException - If the BookRoomDTO.use is not an IntendedUse enum value.

de.gustavblass.commons.exceptions.IllegalArgumentException - If the Room, FilterReservationsDTO.date, start time, end time or intended use is not specified.

deleteReservation

@DeleteMapping("/api/v1/reservations/{id}")
@NonNull
public @NonNull org.springframework.http.ResponseEntity<Void> deleteReservation(@Min(0L) @PathVariable
 @Min(0L) Long id)
                                                                         throws NotFoundException

Handles DELETE requests to /api/v1/reservations/{id} and removes the requesting Actor's Reservation with the given Reservation.id from the database.

Parameters:

id - The identifier whose corresponding Reservation shall no longer be present in the system.

Returns:

Empty response. Only the status code indicates success.

Throws:

NotFoundException - If the requesting Actor has no Reservation with the given ID.

reservationToSummaryDtoModel

@NonNull
private @NonNull org.springframework.hateoas.EntityModel<ReservationSummaryDTO> reservationToSummaryDtoModel(@NonNull
 @NonNull Reservation reservation)

Converts a Reservation to an EntityModel of a ReservationSummaryDTO, with

• the getReservation(Long) method as an IanaLinkRelations.SELF link,
• the RoomRestController.getRoom(String) method as link with the relation room,
• the ActorRestController.getActor(String) method as link with the relation applicant.

Parameters:

reservation - The Reservation to be converted.

Returns:

The converted Reservation.