Package it.univr.passportease.controller.user

Class UserQueryController

java.lang.Object

it.univr.passportease.controller.user.UserQueryController

@Controller
public class UserQueryController
extends Object

Controller for user queries. It handles the following GraphQL queries:

• getRequestTypesByUser()
• getReportDetailsByAvailabilityID(String)
• getUserNotifications()
• getUserDetails()
• getUserReservations()

See Also:

• UserQueryService

Field Summary

Fields

Modifier and Type	Field	Description
private BucketLimiter	bucketLimiter	Bucket limiter.
private RequestAnalyzer	requestAnalyzer	Request analyzer.
private final UserQueryService	userQueryService	User query service.

Constructor Summary

Constructors

Constructor	Description
UserQueryController()

Method Summary

Modifier and Type	Method	Description
ReportDetails	getReportDetailsByAvailabilityID(String availabilityId)	This query returns the report details for the given availability id.
List<RequestType>	getRequestTypesByUser()	This query returns the request types associated to the user.
User	getUserDetails()	This query returns the user details associated to the user.
List<Notification>	getUserNotifications()	This query returns the notifications associated to the user.
List<Availability>	getUserReservations()	This query returns the reservations associated to the user.

Methods inherited from class java.lang.Object

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

Field Details

userQueryService

private final UserQueryService userQueryService

User query service.

bucketLimiter

private BucketLimiter bucketLimiter

Bucket limiter.

requestAnalyzer

private RequestAnalyzer requestAnalyzer

Request analyzer.

Constructor Details

UserQueryController

public UserQueryController()

Method Details

getRequestTypesByUser

@QueryMapping
public List<RequestType> getRequestTypesByUser()
                                        throws RateLimitException,
RequestTypeNotFoundException,
AuthenticationCredentialsNotFoundException

This query returns the request types associated to the user.

Returns:

the list of request types associated to the user

Throws:

RateLimitException - if the user has exceeded the rate limit

RequestTypeNotFoundException - if the user has no request types associated

AuthenticationCredentialsNotFoundException - if the user has not included the token in the request

getReportDetailsByAvailabilityID

@QueryMapping
public ReportDetails getReportDetailsByAvailabilityID(@Argument("availabilityID")
 String availabilityId)
                                               throws SecurityException,
InvalidAvailabilityIDException

This query returns the report details for the given availability id.

Parameters:

availabilityId - the availability id for which the report details are requested

Returns:

see ReportDetails, containing all the information to generate the report for the given availability

Throws:

SecurityException - if the user is not authorized to access the report details requested, or if the user has not included the token in the request

InvalidAvailabilityIDException - if the availability id is not valid

getUserNotifications

@QueryMapping
public List<Notification> getUserNotifications()
                                        throws AuthenticationCredentialsNotFoundException,
RateLimitException

This query returns the notifications associated to the user.

Returns:

the list of notifications associated to the user

Throws:

AuthenticationCredentialsNotFoundException - if the user has not included the token in the request

RateLimitException - if the user has exceeded the rate limit

getUserDetails

@QueryMapping
public User getUserDetails()
                    throws AuthenticationCredentialsNotFoundException,
RateLimitException,
UserNotFoundException

This query returns the user details associated to the user.

Returns:

the user details associated to the user, for generating the profile page

Throws:

AuthenticationCredentialsNotFoundException - if the user has not included the token in the request

RateLimitException - if the user has exceeded the rate limit

UserNotFoundException - if the user is not found

getUserReservations

@QueryMapping
public List<Availability> getUserReservations()
                                       throws AuthenticationCredentialsNotFoundException,
RateLimitException

This query returns the reservations associated to the user.

Returns:

the list of reservations associated to the user

Throws:

AuthenticationCredentialsNotFoundException - if the user has not included the token in the request

RateLimitException - if the user has exceeded the rate limit