From c785c8acfdd071592cb63277b8ab021e1ad8cccf Mon Sep 17 00:00:00 2001 From: Oleksandra Matviienko Date: Thu, 28 Mar 2024 15:37:00 +0100 Subject: [PATCH] Minor changes of validation methods and code formatting. Signed-off-by: Oleksandra Matviienko --- .../dao/attributes/CachedAttributesService.java | 2 +- .../dao/device/DeviceCredentialsServiceImpl.java | 2 +- .../server/dao/device/DeviceServiceImpl.java | 4 ++-- .../server/dao/edge/EdgeServiceImpl.java | 2 +- .../thingsboard/server/dao/service/Validator.java | 6 +++--- .../dao/tenant/TenantProfileServiceImpl.java | 7 +++++-- .../dao/usagerecord/ApiUsageStateServiceImpl.java | 2 +- .../server/dao/user/UserServiceImpl.java | 4 ++-- .../server/dao/service/ValidatorTest.java | 14 +++----------- 9 files changed, 19 insertions(+), 24 deletions(-) diff --git a/dao/src/main/java/org/thingsboard/server/dao/attributes/CachedAttributesService.java b/dao/src/main/java/org/thingsboard/server/dao/attributes/CachedAttributesService.java index 20e9c8b619..dcd13fb168 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/attributes/CachedAttributesService.java +++ b/dao/src/main/java/org/thingsboard/server/dao/attributes/CachedAttributesService.java @@ -117,7 +117,7 @@ public class CachedAttributesService implements AttributesService { @Override public ListenableFuture> find(TenantId tenantId, EntityId entityId, AttributeScope scope, String attributeKey) { validate(entityId, scope); - Validator.validateString(attributeKey, k ->"Incorrect attribute key " + k); + Validator.validateString(attributeKey, k -> "Incorrect attribute key " + k); return cacheExecutor.submit(() -> { AttributeCacheKey attributeCacheKey = new AttributeCacheKey(scope, entityId, attributeKey); diff --git a/dao/src/main/java/org/thingsboard/server/dao/device/DeviceCredentialsServiceImpl.java b/dao/src/main/java/org/thingsboard/server/dao/device/DeviceCredentialsServiceImpl.java index 6064908717..6025e7c820 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/device/DeviceCredentialsServiceImpl.java +++ b/dao/src/main/java/org/thingsboard/server/dao/device/DeviceCredentialsServiceImpl.java @@ -79,7 +79,7 @@ public class DeviceCredentialsServiceImpl extends AbstractCachedEntityService"Incorrect credentialsId " + id); + validateString(credentialsId, id -> "Incorrect credentialsId " + id); return cache.getAndPutInTransaction(credentialsId, () -> deviceCredentialsDao.findByCredentialsId(TenantId.SYS_TENANT_ID, credentialsId), true); // caching null values is essential for permanently invalid requests diff --git a/dao/src/main/java/org/thingsboard/server/dao/device/DeviceServiceImpl.java b/dao/src/main/java/org/thingsboard/server/dao/device/DeviceServiceImpl.java index 33bf7f34a0..ff00db3564 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/device/DeviceServiceImpl.java +++ b/dao/src/main/java/org/thingsboard/server/dao/device/DeviceServiceImpl.java @@ -389,7 +389,7 @@ public class DeviceServiceImpl extends AbstractCachedEntityService INCORRECT_TENANT_ID + id); - validateId(tenantId, id -> INCORRECT_DEVICE_PROFILE_ID + id); + validateId(deviceProfileId, id -> INCORRECT_DEVICE_PROFILE_ID + id); validatePageLink(pageLink); return deviceDao.findDevicesByTenantIdAndTypeAndEmptyOtaPackage(tenantId.getId(), deviceProfileId.getId(), type, pageLink); } @@ -398,7 +398,7 @@ public class DeviceServiceImpl extends AbstractCachedEntityService INCORRECT_TENANT_ID + id); - validateId(tenantId, id -> INCORRECT_DEVICE_PROFILE_ID + id); + validateId(deviceProfileId, id -> INCORRECT_DEVICE_PROFILE_ID + id); return deviceDao.countDevicesByTenantIdAndDeviceProfileIdAndEmptyOtaPackage(tenantId.getId(), deviceProfileId.getId(), type); } diff --git a/dao/src/main/java/org/thingsboard/server/dao/edge/EdgeServiceImpl.java b/dao/src/main/java/org/thingsboard/server/dao/edge/EdgeServiceImpl.java index 79411559db..c1eb51be95 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/edge/EdgeServiceImpl.java +++ b/dao/src/main/java/org/thingsboard/server/dao/edge/EdgeServiceImpl.java @@ -400,7 +400,7 @@ public class EdgeServiceImpl extends AbstractCachedEntityService findEdgesByTenantIdAndEntityId(TenantId tenantId, EntityId entityId, PageLink pageLink) { log.trace("Executing findEdgesByTenantIdAndEntityId, tenantId [{}], entityId [{}], pageLink [{}]", tenantId, entityId, pageLink); - Validator.validateId(tenantId, id -> "Incorrect tenantId " + id); + Validator.validateId(tenantId, id -> INCORRECT_TENANT_ID + id); validatePageLink(pageLink); return edgeDao.findEdgesByTenantIdAndEntityId(tenantId.getId(), entityId.getId(), entityId.getEntityType(), pageLink); } diff --git a/dao/src/main/java/org/thingsboard/server/dao/service/Validator.java b/dao/src/main/java/org/thingsboard/server/dao/service/Validator.java index 3d671385e5..116d2beefa 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/service/Validator.java +++ b/dao/src/main/java/org/thingsboard/server/dao/service/Validator.java @@ -28,7 +28,6 @@ import org.thingsboard.server.dao.exception.IncorrectParameterException; import java.util.List; import java.util.UUID; import java.util.function.Function; -import java.util.function.Supplier; import java.util.regex.Pattern; public class Validator { @@ -52,8 +51,8 @@ public class Validator { * This method validate EntityId entity id. If entity id is invalid than throw * IncorrectParameterException exception * - * @param entityId the entityId - * @param errorMessageFunction the error message for exception that applies entityId + * @param entityId the entityId + * @param errorMessageFunction the error message for exception that applies entityId */ public static void validateEntityId(EntityId entityId, Function errorMessageFunction) { if (entityId == null || entityId.getId() == null) { @@ -231,4 +230,5 @@ public class Validator { throw new IncorrectParameterException(errorMessage); } } + } diff --git a/dao/src/main/java/org/thingsboard/server/dao/tenant/TenantProfileServiceImpl.java b/dao/src/main/java/org/thingsboard/server/dao/tenant/TenantProfileServiceImpl.java index 9a4ab7fa1e..7a6f5cd8f8 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/tenant/TenantProfileServiceImpl.java +++ b/dao/src/main/java/org/thingsboard/server/dao/tenant/TenantProfileServiceImpl.java @@ -51,6 +51,7 @@ import static org.thingsboard.server.dao.service.Validator.validateId; public class TenantProfileServiceImpl extends AbstractCachedEntityService implements TenantProfileService { private static final String INCORRECT_TENANT_PROFILE_ID = "Incorrect tenantProfileId "; + public static final String INCORRECT_TENANT_ID = "Incorrect tenantId "; @Autowired private TenantProfileDao tenantProfileDao; @@ -111,7 +112,8 @@ public class TenantProfileServiceImpl extends AbstractCachedEntityService INCORRECT_TENANT_PROFILE_ID + id); + validateId(tenantId, id -> INCORRECT_TENANT_ID + id); + validateId(tenantProfileId, id -> INCORRECT_TENANT_PROFILE_ID + id); TenantProfile tenantProfile = tenantProfileDao.findById(tenantId, tenantProfileId.getId()); if (tenantProfile != null && tenantProfile.isDefault()) { throw new DataValidationException("Deletion of Default Tenant Profile is prohibited!"); @@ -186,7 +188,8 @@ public class TenantProfileServiceImpl extends AbstractCachedEntityService INCORRECT_TENANT_PROFILE_ID + id); + validateId(tenantId, id -> INCORRECT_TENANT_ID + id); + validateId(tenantProfileId, id -> INCORRECT_TENANT_PROFILE_ID + id); TenantProfile tenantProfile = tenantProfileDao.findById(tenantId, tenantProfileId.getId()); if (!tenantProfile.isDefault()) { tenantProfile.setDefault(true); diff --git a/dao/src/main/java/org/thingsboard/server/dao/usagerecord/ApiUsageStateServiceImpl.java b/dao/src/main/java/org/thingsboard/server/dao/usagerecord/ApiUsageStateServiceImpl.java index 0f98fc945e..9eb78764b5 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/usagerecord/ApiUsageStateServiceImpl.java +++ b/dao/src/main/java/org/thingsboard/server/dao/usagerecord/ApiUsageStateServiceImpl.java @@ -167,7 +167,7 @@ public class ApiUsageStateServiceImpl extends AbstractEntityService implements A public ApiUsageState findApiUsageStateById(TenantId tenantId, ApiUsageStateId id) { log.trace("Executing findApiUsageStateById, tenantId [{}], apiUsageStateId [{}]", tenantId, id); validateId(tenantId, t -> INCORRECT_TENANT_ID + t); - validateId(id, usId -> "Incorrect apiUsageStateId " + usId); + validateId(id, u -> "Incorrect apiUsageStateId " + u); return apiUsageStateDao.findById(tenantId, id.getId()); } diff --git a/dao/src/main/java/org/thingsboard/server/dao/user/UserServiceImpl.java b/dao/src/main/java/org/thingsboard/server/dao/user/UserServiceImpl.java index b80c9be38f..4b804353ad 100644 --- a/dao/src/main/java/org/thingsboard/server/dao/user/UserServiceImpl.java +++ b/dao/src/main/java/org/thingsboard/server/dao/user/UserServiceImpl.java @@ -173,7 +173,7 @@ public class UserServiceImpl extends AbstractEntityService implements UserServic @Override public UserCredentials findUserCredentialsByResetToken(TenantId tenantId, String resetToken) { log.trace("Executing findUserCredentialsByResetToken [{}]", resetToken); - validateString(resetToken, t -> "Incorrect activateToken " + t); + validateString(resetToken, t -> "Incorrect resetToken " + t); return userCredentialsDao.findByResetToken(tenantId, resetToken); } @@ -335,7 +335,7 @@ public class UserServiceImpl extends AbstractEntityService implements UserServic log.trace("Executing findTenantAndCustomerUsers, tenantId [{}], customerIds [{}], pageLink [{}]", tenantId, customerIds, pageLink); validateId(tenantId, id -> INCORRECT_TENANT_ID + id); validatePageLink(pageLink); - customerIds.forEach(customerId -> {validateId(customerId, id -> "Incorrect customerId " + id);}); + customerIds.forEach(customerId -> validateId(customerId, id -> "Incorrect customerId " + id)); return userDao.findUsersByCustomerIds(tenantId.getId(), customerIds, pageLink); } diff --git a/dao/src/test/java/org/thingsboard/server/dao/service/ValidatorTest.java b/dao/src/test/java/org/thingsboard/server/dao/service/ValidatorTest.java index 9bfb0b6c8f..f0a4938d64 100644 --- a/dao/src/test/java/org/thingsboard/server/dao/service/ValidatorTest.java +++ b/dao/src/test/java/org/thingsboard/server/dao/service/ValidatorTest.java @@ -15,7 +15,6 @@ */ package org.thingsboard.server.dao.service; -import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; import org.thingsboard.server.common.data.id.*; import org.thingsboard.server.dao.exception.IncorrectParameterException; @@ -27,20 +26,15 @@ import java.util.UUID; import static org.assertj.core.api.Assertions.assertThatThrownBy; - class ValidatorTest { final DeviceId goodDeviceId = new DeviceId(UUID.fromString("18594c15-9f05-4cda-b58e-70172467c3e5")); final UserId nullUserId = new UserId(null); - @BeforeEach - void setUp() { - } - @Test void validateEntityIdTest() { Validator.validateEntityId(TenantId.SYS_TENANT_ID, id -> "Incorrect entityId " + id); - Validator.validateEntityId((goodDeviceId), id -> "Incorrect entityId " + id); + Validator.validateEntityId(goodDeviceId, id -> "Incorrect entityId " + id); assertThatThrownBy(() -> Validator.validateEntityId(null, id -> "Incorrect entityId " + id)) .as("EntityId is null") @@ -51,7 +45,6 @@ class ValidatorTest { .as("EntityId with null UUID") .isInstanceOf(IncorrectParameterException.class) .hasMessageContaining("Incorrect entityId null"); - } @Test @@ -84,13 +77,12 @@ class ValidatorTest { .as("Id is null") .isInstanceOf(IncorrectParameterException.class) .hasMessageContaining("Incorrect Id null"); - } @Test void validateUUIDBasedIdTest() { Validator.validateId(TenantId.SYS_TENANT_ID, id -> "Incorrect Id " + id); - Validator.validateId((goodDeviceId), id -> "Incorrect Id " + id); + Validator.validateId(goodDeviceId, id -> "Incorrect Id " + id); assertThatThrownBy(() -> Validator.validateId((UUIDBased) null, id -> "Incorrect Id " + id)) .as("Id is null") @@ -119,7 +111,7 @@ class ValidatorTest { .isInstanceOf(IncorrectParameterException.class) .hasMessageContaining("Incorrect Ids []"); - ArrayList badList = new ArrayList<>(2); + List badList = new ArrayList<>(2); badList.add(goodDeviceId); badList.add(null);