mirror of
https://github.com/Stirling-Tools/Stirling-PDF.git
synced 2025-06-22 23:45:02 +00:00
5f8b208db4
# Description of Changes - **What was changed:** - Removed explicit constructor definitions annotated with `@Autowired` across services, controllers, filters, and schedulers. - Added Lombok’s `@RequiredArgsConstructor` to automatically generate required-args constructors and eliminate boilerplate. - Introduced other Lombok annotations (`@Data`, `@Getter`, `@Setter`, `@EqualsAndHashCode`, `@NoArgsConstructor`) on model and API classes to replace manual getters/setters and constructors. - Standardized string comparisons to use the constant-first form (e.g., `"value".equals(variable)`). - Cleaned up unused imports and organized OpenAPI configuration by extracting default title/description constants. - **Why the change was made:** - To reduce repetitive boilerplate code and improve maintainability. - To leverage Lombok for cleaner, more consistent dependency injection and data modeling. - To ensure a uniform coding style across the entire codebase. #3406 --- ## Checklist ### General - [x] I have read the [Contribution Guidelines](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/CONTRIBUTING.md) - [ ] I have read the [Stirling-PDF Developer Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md) (if applicable) - [ ] I have read the [How to add new languages to Stirling-PDF](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md) (if applicable) - [x] I have performed a self-review of my own code - [x] My changes generate no new warnings ### Documentation - [ ] I have updated relevant docs on [Stirling-PDF's doc repo](https://github.com/Stirling-Tools/Stirling-Tools.github.io/blob/main/docs/) (if functionality has heavily changed) - [ ] I have read the section [Add New Translation Tags](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/HowToAddNewLanguage.md#add-new-translation-tags) (for new translation tags only) ### UI Changes (if applicable) - [ ] Screenshots or videos demonstrating the UI changes are attached ### Testing (if applicable) - [ ] I have tested my changes locally. Refer to the [Testing Guide](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/DeveloperGuide.md#6-testing) for more details.
67 lines
2.1 KiB
Java
67 lines
2.1 KiB
Java
package stirling.software.SPDF.model;
|
|
|
|
import java.util.LinkedHashMap;
|
|
import java.util.Map;
|
|
|
|
import lombok.Getter;
|
|
import lombok.RequiredArgsConstructor;
|
|
|
|
@Getter
|
|
@RequiredArgsConstructor
|
|
public enum Role {
|
|
|
|
// Unlimited access
|
|
ADMIN("ROLE_ADMIN", Integer.MAX_VALUE, Integer.MAX_VALUE, "adminUserSettings.admin"),
|
|
|
|
// Unlimited access
|
|
USER("ROLE_USER", Integer.MAX_VALUE, Integer.MAX_VALUE, "adminUserSettings.user"),
|
|
|
|
// 40 API calls Per Day, 40 web calls
|
|
LIMITED_API_USER("ROLE_LIMITED_API_USER", 40, 40, "adminUserSettings.apiUser"),
|
|
|
|
// 20 API calls Per Day, 20 web calls
|
|
EXTRA_LIMITED_API_USER("ROLE_EXTRA_LIMITED_API_USER", 20, 20, "adminUserSettings.extraApiUser"),
|
|
|
|
// 0 API calls per day and 20 web calls
|
|
WEB_ONLY_USER("ROLE_WEB_ONLY_USER", 0, 20, "adminUserSettings.webOnlyUser"),
|
|
|
|
INTERNAL_API_USER(
|
|
"STIRLING-PDF-BACKEND-API-USER",
|
|
Integer.MAX_VALUE,
|
|
Integer.MAX_VALUE,
|
|
"adminUserSettings.internalApiUser"),
|
|
|
|
DEMO_USER("ROLE_DEMO_USER", 100, 100, "adminUserSettings.demoUser");
|
|
|
|
private final String roleId;
|
|
private final int apiCallsPerDay;
|
|
private final int webCallsPerDay;
|
|
private final String roleName;
|
|
|
|
public static String getRoleNameByRoleId(String roleId) {
|
|
// Using the fromString method to get the Role enum based on the roleId
|
|
Role role = fromString(roleId);
|
|
// Return the roleName of the found Role enum
|
|
return role.getRoleName();
|
|
}
|
|
|
|
// Method to retrieve all role IDs and role names
|
|
public static Map<String, String> getAllRoleDetails() {
|
|
// Using LinkedHashMap to preserve order
|
|
Map<String, String> roleDetails = new LinkedHashMap<>();
|
|
for (Role role : Role.values()) {
|
|
roleDetails.put(role.getRoleId(), role.getRoleName());
|
|
}
|
|
return roleDetails;
|
|
}
|
|
|
|
public static Role fromString(String roleId) {
|
|
for (Role role : Role.values()) {
|
|
if (role.getRoleId().equalsIgnoreCase(roleId)) {
|
|
return role;
|
|
}
|
|
}
|
|
throw new IllegalArgumentException("No Role defined for id: " + roleId);
|
|
}
|
|
}
|