Class ActorAdminRestController

java.lang.Object

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

@RestController
public class ActorAdminRestController
extends Object

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

Field Summary

Fields

Modifier and Type	Field	Description
private final ActorService	actorService	Used to retrieve and save Actors from the database.

Constructor Summary

Constructors

Constructor	Description
ActorAdminRestController(@NonNull ActorService actorService)	Constructs a new ActorRestController with the given actorService.

Method Summary

Modifier and Type	Method	Description
@NonNull org.springframework.http.ResponseEntity<Void>	createActor(@Valid LocalActorCreatedByAdminDTO dto)	Handles POST requests to /api/v1/admin/users and saves a new Actor based on the form input (represented as an ActorCreatedByAdminDTO) to the database.
@NonNull org.springframework.http.ResponseEntity<Void>	deleteActor(String userName)	Handles DELETE requests to /api/v1/admin/users/{userName} and removes the Actor with the given Actor.userName from the database.

Methods inherited from class Object

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

Field Details

actorService

private final ActorService actorService

Used to retrieve and save Actors from the database.

Constructor Details

ActorAdminRestController

public ActorAdminRestController(@NonNull
 @NonNull ActorService actorService)

Constructs a new ActorRestController with the given actorService.

Parameters:

actorService - The actorService to use for database access.

Method Details

createActor

@PostMapping("/api/v1/admin/users")
@NonNull
public @NonNull org.springframework.http.ResponseEntity<Void> createActor(@RequestBody @Valid
 @Valid LocalActorCreatedByAdminDTO dto)
                                                                   throws UnauthorisedException,
PasswordNotConfirmedException,
AlreadyExistsException,
de.gustavblass.commons.exceptions.IllegalArgumentException

Handles POST requests to /api/v1/admin/users and saves a new Actor based on the form input (represented as an ActorCreatedByAdminDTO) to the database. Validates the input according to the annotations in ActorCreatedByAdminDTO.

Parameters:

dto - The form input by the admin, represented as a data-transfer object.

Returns:

Empty response. Only the status code indicates success.

Throws:

AlreadyExistsException - If the ActorCreatedByAdminDTO.userName is already taken.

UnauthorisedException - If the end user making the request is not permitted to create Actors with the ActorRole that the given DTO has.

PasswordNotConfirmedException - If the LocalActorCreatedByAdminDTO.repeatedPassword does not match the LocalActorCreatedByAdminDTO.password.

de.gustavblass.commons.exceptions.IllegalArgumentException - If no LocalActorCreatedByAdminDTO.password is set.

deleteActor

@DeleteMapping("/api/v1/admin/users/{userName}")
@NonNull
public @NonNull org.springframework.http.ResponseEntity<Void> deleteActor(@PathVariable
 String userName)
                                                                   throws UnauthorisedException,
ActorStillHasReservationsException,
NotFoundException

Handles DELETE requests to /api/v1/admin/users/{userName} and removes the Actor with the given Actor.userName from the database.

The Actor to be deleted must not still have active Reservations that begin or end after the current time.

Parameters:

userName - The user name whose corresponding user shall no longer be registered with the system.

Returns:

Empty response. Only the status code indicates success.

Throws:

NotFoundException - If no user with the given user name exists.

UnauthorisedException - If the end user making the request is not permitted to delete Actors with the ActorRole that the Actor concerned has.

ActorStillHasReservationsException - If the given Actor still has Reservations.