Package it.univr.passportease.helper.ratelimiter

Enum Class RateLimiter

java.lang.Object

java.lang.Enum<RateLimiter>

it.univr.passportease.helper.ratelimiter.RateLimiter

All Implemented Interfaces:

Serializable, Comparable<RateLimiter>, Constable

public enum RateLimiter
extends Enum<RateLimiter>

This enum contains all the rate limiters used in the application. Each enum value is associated with a Bandwidth object that represents the rate limiter. Every mutation or query that needs to be rate limited should be associated with a rate limiter.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHANGE_EMAIL	Rate limiter for UserAuthController.changeEmail(String, String)
CHANGE_PASSWORD	Rate limiter for UserAuthController.changePassword(String, String)
CREATE_NOTIFICATION	Rate limiter for UserMutationController.createReservation(String)
CREATE_REQUEST	Rate limiter for WorkerMutationController.createRequest(RequestInput)
CREATE_RESERVATION	Rate limiter for UserMutationController.createReservation(String)
DELETE_NOTIFICATION	Rate limiter for UserMutationController.deleteNotification(UUID)
DELETE_REQUEST	Rate limiter for WorkerMutationController.deleteRequest(String)
DELETE_RESERVATION	Rate limiter for UserMutationController.deleteReservation(String)
GET_ALL_REQUEST_TYPES	Rate limiter for WorkerQueryController.getAllRequestTypes()
GET_AVAILABILITIES	Rate limiter for UserWorkerQueryController.getAvailabilities(AvailabilityFilters, Integer, Integer)
GET_OFFICES	Rate limiter for UserWorkerQueryController.getOffices()
GET_REPORT_DETAILS_BY_AVAILABILITY_ID	Rate limiter for UserQueryController.getReportDetailsByAvailabilityID(String)
GET_REQUEST_BY_AVAILABILITY_ID	Rate limiter for WorkerQueryController.getRequestByAvailabilityID(String)
GET_REQUEST_TYPES_BY_USER	Rate limiter for UserQueryController.getRequestTypesByUser()
GET_USER_DETAILS	Rate limiter for UserQueryController.getUserDetails()
GET_USER_NOTIFICATIONS	Rate limiter for UserQueryController.getUserNotifications()
GET_USER_RESERVATIONS	Rate limiter for UserQueryController.getUserReservations()
LOGIN_USER	Rate limiter for UserAuthController.loginUser(String, String)
LOGIN_WORKER	Rate limiter for WorkerAuthController.loginWorker(String, String)
LOGOUT	Rate limiter for UserAuthController.logout()
MODIFY_NOTIFICATION	Rate limiter for UserMutationController.modifyNotification(NotificationInput, UUID)
MODIFY_REQUEST	Rate limiter for WorkerMutationController.modifyRequest(String, RequestInput)
PRESERVE_AVAILABILITY	Rate limiter for UserMutationController.preserveAvailability(String)}
REFRESH_ACCESS_TOKEN	Rate limiter for UserAuthController.refreshAccessToken(String)
REGISTER_USER	Rate limiter for UserAuthController.registerUser(RegisterInput)
REGISTER_WORKER	Deprecated. Rate limiter for WorkerAuthController.registerWorker(WorkerInput)

Constructor Summary

Constructors

Modifier	Constructor	Description
private	RateLimiter()

Method Summary

Modifier and Type	Method	Description
(package private) io.github.bucket4j.Bandwidth	getBandwidth()	Get the default rate limiter for the enum value.
(package private) io.github.bucket4j.Bandwidth	getBandwidth(int seconds)	Get the rate limiter for the enum value with the specified number of seconds.
abstract io.github.bucket4j.Bandwidth	getLimit()	Get the rate limiter for the enum value.
static RateLimiter	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RateLimiter[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GET_REQUEST_TYPES_BY_USER

public static final RateLimiter GET_REQUEST_TYPES_BY_USER

Rate limiter for UserQueryController.getRequestTypesByUser()

GET_REPORT_DETAILS_BY_AVAILABILITY_ID

public static final RateLimiter GET_REPORT_DETAILS_BY_AVAILABILITY_ID

Rate limiter for UserQueryController.getReportDetailsByAvailabilityID(String)

GET_USER_NOTIFICATIONS

public static final RateLimiter GET_USER_NOTIFICATIONS

Rate limiter for UserQueryController.getUserNotifications()

GET_USER_DETAILS

public static final RateLimiter GET_USER_DETAILS

Rate limiter for UserQueryController.getUserDetails()

GET_USER_RESERVATIONS

public static final RateLimiter GET_USER_RESERVATIONS

Rate limiter for UserQueryController.getUserReservations()

LOGIN_USER

public static final RateLimiter LOGIN_USER

Rate limiter for UserAuthController.loginUser(String, String)

LOGOUT

public static final RateLimiter LOGOUT

Rate limiter for UserAuthController.logout()

REGISTER_USER

public static final RateLimiter REGISTER_USER

Rate limiter for UserAuthController.registerUser(RegisterInput)

REFRESH_ACCESS_TOKEN

public static final RateLimiter REFRESH_ACCESS_TOKEN

Rate limiter for UserAuthController.refreshAccessToken(String)

CHANGE_PASSWORD

public static final RateLimiter CHANGE_PASSWORD

Rate limiter for UserAuthController.changePassword(String, String)

CREATE_RESERVATION

public static final RateLimiter CREATE_RESERVATION

Rate limiter for UserMutationController.createReservation(String)

DELETE_RESERVATION

public static final RateLimiter DELETE_RESERVATION

Rate limiter for UserMutationController.deleteReservation(String)

CREATE_NOTIFICATION

public static final RateLimiter CREATE_NOTIFICATION

Rate limiter for UserMutationController.createReservation(String)

MODIFY_NOTIFICATION

public static final RateLimiter MODIFY_NOTIFICATION

Rate limiter for UserMutationController.modifyNotification(NotificationInput, UUID)

DELETE_NOTIFICATION

public static final RateLimiter DELETE_NOTIFICATION

Rate limiter for UserMutationController.deleteNotification(UUID)

CHANGE_EMAIL

public static final RateLimiter CHANGE_EMAIL

Rate limiter for UserAuthController.changeEmail(String, String)

GET_REQUEST_BY_AVAILABILITY_ID

public static final RateLimiter GET_REQUEST_BY_AVAILABILITY_ID

Rate limiter for WorkerQueryController.getRequestByAvailabilityID(String)

GET_ALL_REQUEST_TYPES

public static final RateLimiter GET_ALL_REQUEST_TYPES

Rate limiter for WorkerQueryController.getAllRequestTypes()

GET_AVAILABILITIES

public static final RateLimiter GET_AVAILABILITIES

Rate limiter for UserWorkerQueryController.getAvailabilities(AvailabilityFilters, Integer, Integer)

GET_OFFICES

public static final RateLimiter GET_OFFICES

Rate limiter for UserWorkerQueryController.getOffices()

LOGIN_WORKER

public static final RateLimiter LOGIN_WORKER

Rate limiter for WorkerAuthController.loginWorker(String, String)

CREATE_REQUEST

public static final RateLimiter CREATE_REQUEST

Rate limiter for WorkerMutationController.createRequest(RequestInput)

MODIFY_REQUEST

public static final RateLimiter MODIFY_REQUEST

Rate limiter for WorkerMutationController.modifyRequest(String, RequestInput)

DELETE_REQUEST

public static final RateLimiter DELETE_REQUEST

Rate limiter for WorkerMutationController.deleteRequest(String)

PRESERVE_AVAILABILITY

public static final RateLimiter PRESERVE_AVAILABILITY

Rate limiter for UserMutationController.preserveAvailability(String)}

REGISTER_WORKER

@Deprecated
public static final RateLimiter REGISTER_WORKER

Deprecated.

Rate limiter for WorkerAuthController.registerWorker(WorkerInput)

Constructor Details

RateLimiter

private RateLimiter()

Method Details

values

public static RateLimiter[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RateLimiter valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getLimit

public abstract io.github.bucket4j.Bandwidth getLimit()

Get the rate limiter for the enum value.

Returns:

the rate limiter for the enum value

getBandwidth

io.github.bucket4j.Bandwidth getBandwidth()

Get the default rate limiter for the enum value.

Returns:

the default rate limiter for the enum value

getBandwidth

io.github.bucket4j.Bandwidth getBandwidth(int seconds)

Get the rate limiter for the enum value with the specified number of seconds.

Parameters:

seconds - the number of seconds to wait before refilling the bucket by 1 token

Returns:

the Bandwidth object for the enum value