From 67eb170f7c93166fc35250a4773072f6d463cc42 Mon Sep 17 00:00:00 2001 From: Avgustin Marinov Date: Tue, 5 Nov 2024 09:32:03 +0200 Subject: [PATCH] Code format hawkbit-repository-api (#1926) Signed-off-by: Marinov Avgustin --- .../hawkbit-repository-api/pom.xml | 166 +++--- .../repository/ArtifactEncryption.java | 24 +- .../ArtifactEncryptionSecretsStore.java | 28 +- .../repository/ArtifactEncryptionService.java | 40 +- .../repository/ArtifactManagement.java | 80 +-- .../BaseRepositoryTypeProvider.java | 1 + .../repository/ConfirmationManagement.java | 58 +- .../eclipse/hawkbit/repository/Constants.java | 1 - .../repository/ControllerManagement.java | 264 +++------ .../repository/DeploymentManagement.java | 310 ++++------ ...DistributionSetInvalidationManagement.java | 12 +- .../repository/DistributionSetManagement.java | 321 +++------- .../DistributionSetTagManagement.java | 22 +- .../DistributionSetTypeManagement.java | 79 +-- .../hawkbit/repository/EntityFactory.java | 19 +- .../hawkbit/repository/FilterParams.java | 40 +- .../repository/MaintenanceScheduleHelper.java | 125 ++-- .../repository/OffsetBasedPageRequest.java | 19 +- .../hawkbit/repository/QuotaManagement.java | 1 - .../repository/RegexCharacterCollection.java | 4 +- .../repository/RepositoryConstants.java | 3 +- .../repository/RepositoryManagement.java | 93 +-- .../hawkbit/repository/RolloutExecutor.java | 2 +- .../repository/RolloutGroupManagement.java | 145 ++--- .../hawkbit/repository/RolloutHandler.java | 1 - .../hawkbit/repository/RolloutManagement.java | 275 +++------ .../repository/SizeConversionHelper.java | 3 +- .../repository/SoftwareModuleManagement.java | 180 ++---- .../SoftwareModuleTypeManagement.java | 9 +- .../hawkbit/repository/SystemManagement.java | 22 +- .../TargetFilterQueryManagement.java | 161 ++--- .../hawkbit/repository/TargetManagement.java | 549 ++++++------------ .../repository/TargetTagManagement.java | 16 +- .../repository/TargetTypeManagement.java | 55 +- .../TenantConfigurationManagement.java | 100 ++-- .../repository/TenantStatsManagement.java | 1 - .../hawkbit/repository/UpdateMode.java | 2 +- .../hawkbit/repository/ValidString.java | 1 - .../repository/ValidStringValidator.java | 21 +- .../autoassign/AutoAssignExecutor.java | 3 +- .../builder/ActionStatusBuilder.java | 4 +- .../builder/ActionStatusCreate.java | 14 +- .../AutoAssignDistributionSetUpdate.java | 25 +- .../builder/DistributionSetBuilder.java | 4 +- .../builder/DistributionSetCreate.java | 22 +- .../builder/DistributionSetTypeBuilder.java | 4 +- .../builder/DistributionSetTypeCreate.java | 31 +- .../builder/DistributionSetTypeUpdate.java | 13 +- .../builder/DistributionSetUpdate.java | 4 +- .../builder/DynamicRolloutGroupTemplate.java | 1 + .../repository/builder/RolloutCreate.java | 19 +- .../builder/RolloutGroupCreate.java | 3 +- .../repository/builder/RolloutUpdate.java | 5 +- .../builder/SoftwareModuleBuilder.java | 4 +- .../builder/SoftwareModuleCreate.java | 23 +- .../SoftwareModuleMetadataBuilder.java | 10 +- .../builder/SoftwareModuleMetadataCreate.java | 10 +- .../builder/SoftwareModuleMetadataUpdate.java | 8 +- .../builder/SoftwareModuleTypeBuilder.java | 4 +- .../builder/SoftwareModuleTypeCreate.java | 17 +- .../builder/SoftwareModuleTypeUpdate.java | 8 +- .../builder/SoftwareModuleUpdate.java | 8 +- .../repository/builder/TagBuilder.java | 4 +- .../hawkbit/repository/builder/TagCreate.java | 11 +- .../hawkbit/repository/builder/TagUpdate.java | 11 +- .../repository/builder/TargetBuilder.java | 4 +- .../repository/builder/TargetCreate.java | 38 +- .../builder/TargetFilterQueryBuilder.java | 12 +- .../builder/TargetFilterQueryCreate.java | 37 +- .../builder/TargetFilterQueryUpdate.java | 8 +- .../repository/builder/TargetTypeBuilder.java | 5 +- .../repository/builder/TargetTypeCreate.java | 35 +- .../repository/builder/TargetTypeUpdate.java | 15 +- .../repository/builder/TargetUpdate.java | 27 +- .../event/ApplicationEventFilter.java | 5 +- .../repository/event/CustomEvents.java | 4 - .../repository/event/TenantAwareEvent.java | 1 - .../event/remote/AbstractAssignmentEvent.java | 8 +- .../remote/DistributionSetDeletedEvent.java | 11 +- .../DistributionSetTagDeletedEvent.java | 14 +- .../DistributionSetTypeDeletedEvent.java | 15 +- .../event/remote/DownloadProgressEvent.java | 15 +- .../event/remote/EventEntityManager.java | 11 +- .../remote/EventEntityManagerHolder.java | 1 - .../event/remote/MultiActionAssignEvent.java | 13 +- .../event/remote/MultiActionCancelEvent.java | 9 +- .../event/remote/MultiActionEvent.java | 9 +- .../event/remote/RemoteIdEvent.java | 20 +- .../event/remote/RemoteTenantAwareEvent.java | 18 +- .../event/remote/RolloutDeletedEvent.java | 15 +- .../remote/RolloutGroupDeletedEvent.java | 15 +- .../event/remote/RolloutStoppedEvent.java | 13 +- .../remote/SoftwareModuleDeletedEvent.java | 15 +- .../SoftwareModuleTypeDeletedEvent.java | 15 +- .../TargetAssignDistributionSetEvent.java | 23 +- .../TargetAttributesRequestedEvent.java | 22 +- .../event/remote/TargetDeletedEvent.java | 23 +- .../remote/TargetFilterQueryDeletedEvent.java | 14 +- .../event/remote/TargetPollEvent.java | 4 +- .../event/remote/TargetTagDeletedEvent.java | 15 +- .../event/remote/TargetTypeDeletedEvent.java | 13 +- .../TenantConfigurationDeletedEvent.java | 4 +- .../remote/entity/AbstractActionEvent.java | 2 +- .../entity/AbstractRolloutGroupEvent.java | 1 + .../remote/entity/ActionCreatedEvent.java | 18 +- .../remote/entity/ActionUpdatedEvent.java | 18 +- .../entity/DistributionSetCreatedEvent.java | 9 +- .../DistributionSetTagCreatedEvent.java | 9 +- .../DistributionSetTagUpdatedEvent.java | 9 +- .../DistributionSetTypeCreatedEvent.java | 10 +- .../DistributionSetTypeUpdatedEvent.java | 9 +- .../entity/DistributionSetUpdatedEvent.java | 14 +- .../remote/entity/RemoteEntityEvent.java | 3 +- .../remote/entity/RolloutCreatedEvent.java | 10 +- .../entity/RolloutGroupCreatedEvent.java | 13 +- .../entity/RolloutGroupUpdatedEvent.java | 11 +- .../remote/entity/RolloutUpdatedEvent.java | 9 +- .../entity/SoftwareModuleCreatedEvent.java | 10 +- .../SoftwareModuleTypeCreatedEvent.java | 10 +- .../SoftwareModuleTypeUpdatedEvent.java | 9 +- .../entity/SoftwareModuleUpdatedEvent.java | 9 +- .../remote/entity/TargetCreatedEvent.java | 10 +- .../entity/TargetFilterQueryCreatedEvent.java | 10 +- .../entity/TargetFilterQueryUpdatedEvent.java | 9 +- .../remote/entity/TargetTagCreatedEvent.java | 9 +- .../remote/entity/TargetTagUpdatedEvent.java | 9 +- .../remote/entity/TargetTypeCreatedEvent.java | 8 +- .../remote/entity/TargetTypeUpdatedEvent.java | 7 +- .../remote/entity/TargetUpdatedEvent.java | 9 +- .../TenantConfigurationCreatedEvent.java | 10 +- .../TenantConfigurationUpdatedEvent.java | 10 +- ...ArtifactBinaryNoLongerExistsException.java | 16 +- .../ArtifactBinaryNotFoundException.java | 12 +- .../ArtifactDeleteFailedException.java | 15 +- ...rtifactEncryptionUnsupportedException.java | 3 +- .../ArtifactUploadFailedException.java | 14 +- .../AssignmentQuotaExceededException.java | 70 +-- ...utoConfirmationAlreadyActiveException.java | 8 +- .../CancelActionNotAllowedException.java | 8 +- .../ConcurrentModificationException.java | 22 +- .../exception/DeletedException.java | 4 +- ...DistributionSetTypeUndefinedException.java | 15 +- .../EntityAlreadyExistsException.java | 18 +- .../exception/EntityNotFoundException.java | 18 +- .../exception/EntityReadOnlyException.java | 18 +- .../FileSizeQuotaExceededException.java | 5 +- .../ForceQuitActionNotAllowedException.java | 12 +- .../IncompatibleTargetTypeException.java | 14 +- .../IncompleteDistributionSetException.java | 15 +- .../InsufficientPermissionException.java | 8 +- .../InvalidDistributionSetException.java | 11 +- .../exception/InvalidMD5HashException.java | 18 +- .../InvalidMaintenanceScheduleException.java | 25 +- .../exception/InvalidSHA1HashException.java | 18 +- .../exception/InvalidSHA256HashException.java | 9 +- .../InvalidTargetAddressException.java | 11 +- ...nvalidTenantConfigurationKeyException.java | 19 +- .../repository/exception/LockedException.java | 4 +- .../MethodNotSupportedException.java | 16 +- .../MultiAssignmentIsNotEnabledException.java | 19 +- ...rovidedInMultiAssignmentModeException.java | 20 +- .../RSQLParameterSyntaxException.java | 30 +- ...SQLParameterUnsupportedFieldException.java | 16 +- .../RolloutIllegalStateException.java | 19 +- ...areModuleNotAssignedToTargetException.java | 10 +- ...TypeNotInDistributionSetTypeException.java | 10 +- .../exception/StopRolloutException.java | 7 +- .../StorageQuotaExceededException.java | 5 +- .../exception/TargetTypeInUseException.java | 12 +- .../TargetTypeKeyOrNameRequiredException.java | 4 +- ...urationValueChangeNotAllowedException.java | 5 +- .../exception/TenantNotExistException.java | 21 +- ...ModuleForThisDistributionSetException.java | 6 +- .../model/AbstractAssignmentResult.java | 12 +- .../hawkbit/repository/model/Action.java | 125 ++-- .../repository/model/ActionProperties.java | 8 +- .../repository/model/ActionStatus.java | 1 - .../hawkbit/repository/model/Artifact.java | 2 +- .../repository/model/ArtifactUpload.java | 48 +- .../model/AssignedSoftwareModule.java | 10 +- .../model/AutoConfirmationStatus.java | 1 - .../hawkbit/repository/model/BaseEntity.java | 5 +- .../repository/model/DeploymentRequest.java | 65 +-- .../model/DeploymentRequestBuilder.java | 54 +- .../repository/model/DistributionSet.java | 6 +- .../DistributionSetAssignmentResult.java | 16 +- .../model/DistributionSetFilter.java | 4 +- .../model/DistributionSetInvalidation.java | 42 +- .../model/DistributionSetMetadata.java | 1 - .../repository/model/DistributionSetTag.java | 1 - .../DistributionSetTagAssignmentResult.java | 16 +- .../repository/model/DistributionSetType.java | 25 +- .../hawkbit/repository/model/MetaData.java | 2 +- .../hawkbit/repository/model/NamedEntity.java | 2 +- .../model/NamedVersionedEntity.java | 2 +- .../hawkbit/repository/model/PollStatus.java | 5 +- .../model/RepositoryModelConstants.java | 1 - .../hawkbit/repository/model/Rollout.java | 3 - .../repository/model/RolloutGroup.java | 2 - .../model/RolloutGroupConditionBuilder.java | 27 +- .../model/RolloutGroupsValidation.java | 11 +- .../repository/model/SoftwareModule.java | 6 +- .../model/SoftwareModuleMetadata.java | 1 - .../repository/model/SoftwareModuleType.java | 1 - .../hawkbit/repository/model/Statistic.java | 18 +- .../eclipse/hawkbit/repository/model/Tag.java | 2 +- .../hawkbit/repository/model/Target.java | 1 + .../repository/model/TargetFilterQuery.java | 4 +- .../repository/model/TargetMetadata.java | 1 - .../hawkbit/repository/model/TargetTag.java | 1 - .../model/TargetTagAssignmentResult.java | 16 +- .../hawkbit/repository/model/TargetType.java | 9 +- .../model/TargetTypeAssignmentResult.java | 19 +- .../repository/model/TargetUpdateStatus.java | 1 - .../model/TargetWithActionType.java | 66 +-- .../model/TenantAwareBaseEntity.java | 1 - .../repository/model/TenantConfiguration.java | 1 - .../model/TenantConfigurationValue.java | 8 +- .../repository/model/TenantMetaData.java | 1 - .../model/TotalTargetCountActionStatus.java | 1 - .../model/TotalTargetCountStatus.java | 223 ++++--- .../hawkbit/repository/model/Type.java | 1 + .../report/model/SystemUsageReport.java | 16 +- .../model/SystemUsageReportWithTenants.java | 16 +- .../repository/report/model/TenantUsage.java | 29 +- .../repository/rsql/RsqlValidationOracle.java | 10 +- .../repository/rsql/RsqlVisitorFactory.java | 12 +- .../hawkbit/repository/rsql/SuggestToken.java | 16 +- .../repository/rsql/SuggestionContext.java | 27 +- .../repository/rsql/SyntaxErrorContext.java | 10 +- .../rsql/ValidationOracleContext.java | 16 +- .../rsql/VirtualPropertyReplacer.java | 5 +- .../tenancy/configuration/DurationHelper.java | 84 ++- .../TenantConfigurationProperties.java | 2 +- ...ConfigurationPollingDurationValidator.java | 6 +- .../TenantConfigurationValidator.java | 11 +- ...TenantConfigurationValidatorException.java | 19 +- .../hawkbit/utils/TenantConfigHelper.java | 16 +- .../ArtifactEncryptionServiceTest.java | 5 +- .../MaintenanceScheduleHelperTest.java | 10 +- .../hawkbit/repository/RegexCharTest.java | 90 ++- ...gementMethodPreAuthorizeAnnotatedTest.java | 10 +- .../model/TotalTargetCountStatusTest.java | 10 +- 243 files changed, 2256 insertions(+), 3976 deletions(-) diff --git a/hawkbit-repository/hawkbit-repository-api/pom.xml b/hawkbit-repository/hawkbit-repository-api/pom.xml index 6bfbee10f..dbb2399c9 100644 --- a/hawkbit-repository/hawkbit-repository-api/pom.xml +++ b/hawkbit-repository/hawkbit-repository-api/pom.xml @@ -9,89 +9,89 @@ SPDX-License-Identifier: EPL-2.0 --> - - 4.0.0 - - org.eclipse.hawkbit - hawkbit-repository - ${revision} - - hawkbit-repository-api - hawkBit :: Repository :: API + + 4.0.0 + + org.eclipse.hawkbit + hawkbit-repository + ${revision} + + hawkbit-repository-api + hawkBit :: Repository :: API - - - org.eclipse.hawkbit - hawkbit-security-core - ${project.version} - - - com.fasterxml.jackson.core - jackson-annotations - - - jakarta.validation - jakarta.validation-api - - - org.springframework.hateoas - spring-hateoas - - - org.springframework.cloud - spring-cloud-bus - - - org.springframework.boot - spring-boot-starter-tomcat - - - org.springframework.security - spring-security-rsa - - - org.objenesis - objenesis - - - org.apache.tomcat.embed - tomcat-embed-el - - - org.springframework.cloud - spring-cloud-function-context - - - - - com.cronutils - cron-utils - - - cz.jirutka.rsql - rsql-parser - - - org.jsoup - jsoup - + + + org.eclipse.hawkbit + hawkbit-security-core + ${project.version} + + + com.fasterxml.jackson.core + jackson-annotations + + + jakarta.validation + jakarta.validation-api + + + org.springframework.hateoas + spring-hateoas + + + org.springframework.cloud + spring-cloud-bus + + + org.springframework.boot + spring-boot-starter-tomcat + + + org.springframework.security + spring-security-rsa + + + org.objenesis + objenesis + + + org.apache.tomcat.embed + tomcat-embed-el + + + org.springframework.cloud + spring-cloud-function-context + + + + + com.cronutils + cron-utils + + + cz.jirutka.rsql + rsql-parser + + + org.jsoup + jsoup + - - - io.github.classgraph - classgraph - test - - - io.qameta.allure - allure-junit5 - test - - - org.springframework.boot - spring-boot-starter-test - test - - + + + io.github.classgraph + classgraph + test + + + io.qameta.allure + allure-junit5 + test + + + org.springframework.boot + spring-boot-starter-test + test + + diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryption.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryption.java index f3948f615..85728f8d9 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryption.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryption.java @@ -17,7 +17,6 @@ import org.eclipse.hawkbit.repository.exception.ArtifactEncryptionFailedExceptio /** * Interface definition for artifact encryption. - * */ public interface ArtifactEncryption { @@ -32,40 +31,33 @@ public interface ArtifactEncryption { * Generates required secrets key/value pairs. * * @return secrets key/value pairs - * @throws ArtifactEncryptionFailedException - * thrown in case of an error while generating secrets + * @throws ArtifactEncryptionFailedException thrown in case of an error while generating secrets */ Map generateSecrets(); /** * Encrypts artifact stream with provided secrets. * - * @param secrets - * secrets key/value pairs to be used for encryption - * @param stream - * artifact stream to encrypt + * @param secrets secrets key/value pairs to be used for encryption + * @param stream artifact stream to encrypt * @return encrypted input stream - * @throws ArtifactEncryptionFailedException - * thrown in case of an error while encrypting the provided stream + * @throws ArtifactEncryptionFailedException thrown in case of an error while encrypting the provided stream */ InputStream encryptStream(final Map secrets, final InputStream stream); /** * Decrypts encrypted artifact stream based on provided secrets. * - * @param secrets - * secrets key/value pairs to be used for decryption - * @param stream - * artifact stream to decrypt + * @param secrets secrets key/value pairs to be used for decryption + * @param stream artifact stream to decrypt * @return decrypted input stream - * @throws ArtifactEncryptionFailedException - * thrown in case of an error while decrypting the provided stream + * @throws ArtifactEncryptionFailedException thrown in case of an error while decrypting the provided stream */ InputStream decryptStream(final Map secrets, final InputStream stream); /** * Size of the underlying encryption algorithm overhead in bytes - * + * * @return encryption overhead in byte */ int encryptionSizeOverhead(); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryptionSecretsStore.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryptionSecretsStore.java index 740033ef7..df548eae5 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryptionSecretsStore.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryptionSecretsStore.java @@ -15,7 +15,6 @@ import org.eclipse.hawkbit.repository.model.SoftwareModule; /** * Interface definition for artifact encryption secrets store. - * */ public interface ArtifactEncryptionSecretsStore { @@ -23,12 +22,9 @@ public interface ArtifactEncryptionSecretsStore { * Adds secret key/value pair associated with particular * {@link SoftwareModule} id to the store. * - * @param softwareModuleId - * {@link SoftwareModule} id associated with the secret - * @param secretKey - * key of the secret - * @param secretValue - * value of the secret + * @param softwareModuleId {@link SoftwareModule} id associated with the secret + * @param secretKey key of the secret + * @param secretValue value of the secret */ void addSecret(final long softwareModuleId, final String secretKey, final String secretValue); @@ -36,10 +32,8 @@ public interface ArtifactEncryptionSecretsStore { * Checks if secret is present for particular {@link SoftwareModule} id and * key in the store. * - * @param softwareModuleId - * {@link SoftwareModule} id associated with the secret - * @param secretKey - * key of the secret + * @param softwareModuleId {@link SoftwareModule} id associated with the secret + * @param secretKey key of the secret */ boolean secretExists(final long softwareModuleId, final String secretKey); @@ -47,10 +41,8 @@ public interface ArtifactEncryptionSecretsStore { * Retrieves secret value associated with particular {@link SoftwareModule} * id and key from the store. * - * @param softwareModuleId - * {@link SoftwareModule} id associated with the secret - * @param secretKey - * key of the secret + * @param softwareModuleId {@link SoftwareModule} id associated with the secret + * @param secretKey key of the secret */ Optional getSecret(final long softwareModuleId, final String secretKey); @@ -58,10 +50,8 @@ public interface ArtifactEncryptionSecretsStore { * Removes secret key/value pair associated with particular * {@link SoftwareModule} id from the store. * - * @param softwareModuleId - * {@link SoftwareModule} id associated with the secret - * @param secretKey - * key of the secret + * @param softwareModuleId {@link SoftwareModule} id associated with the secret + * @param secretKey key of the secret */ void removeSecret(final long softwareModuleId, final String secretKey); } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryptionService.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryptionService.java index b1284501d..10d3a527a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryptionService.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactEncryptionService.java @@ -20,7 +20,6 @@ import org.springframework.beans.factory.annotation.Autowired; /** * Service responsible for encryption operations. - * */ public final class ArtifactEncryptionService { @@ -55,8 +54,7 @@ public final class ArtifactEncryptionService { * Generates encryption secrets and saves them in secret store by software * module id reference. * - * @param smId - * software module id + * @param smId software module id */ public void addSoftwareModuleEncryptionSecrets(final long smId) { if (!isEncryptionSupported()) { @@ -73,10 +71,8 @@ public final class ArtifactEncryptionService { * Encrypts artifact stream using the keys retrieved from secrets store by * software module id reference. * - * @param smId - * software module id - * @param artifactStream - * artifact stream to encrypt + * @param smId software module id + * @param artifactStream artifact stream to encrypt * @return encrypted input stream */ public InputStream encryptSoftwareModuleArtifact(final long smId, final InputStream artifactStream) { @@ -87,26 +83,12 @@ public final class ArtifactEncryptionService { return artifactEncryption.encryptStream(getSoftwareModuleEncryptionSecrets(smId), artifactStream); } - private Map getSoftwareModuleEncryptionSecrets(final long smId) { - final Set requiredSecretsKeys = artifactEncryption.requiredSecretKeys(); - final Map requiredSecrets = new HashMap<>(); - for (final String requiredSecretsKey : requiredSecretsKeys) { - final Optional requiredSecretsValue = artifactEncryptionSecretsStore.getSecret(smId, - requiredSecretsKey); - requiredSecretsValue.ifPresent(secretValue -> requiredSecrets.put(requiredSecretsKey, secretValue)); - } - - return requiredSecrets; - } - /** * Decrypts artifact stream using the keys retrieved from secrets store by * software module id reference. * - * @param smId - * software module id - * @param encryptedArtifactStream - * artifact stream to decrypt + * @param smId software module id + * @param encryptedArtifactStream artifact stream to decrypt * @return decrypted input stream */ public InputStream decryptSoftwareModuleArtifact(final long smId, final InputStream encryptedArtifactStream) { @@ -125,4 +107,16 @@ public final class ArtifactEncryptionService { public int encryptionSizeOverhead() { return artifactEncryption.encryptionSizeOverhead(); } + + private Map getSoftwareModuleEncryptionSecrets(final long smId) { + final Set requiredSecretsKeys = artifactEncryption.requiredSecretKeys(); + final Map requiredSecrets = new HashMap<>(); + for (final String requiredSecretsKey : requiredSecretsKeys) { + final Optional requiredSecretsValue = artifactEncryptionSecretsStore.getSecret(smId, + requiredSecretsKey); + requiredSecretsValue.ifPresent(secretValue -> requiredSecrets.put(requiredSecretsKey, secretValue)); + } + + return requiredSecrets; + } } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactManagement.java index 10d913664..dd8ffe46f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ArtifactManagement.java @@ -33,9 +33,9 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Service for {@link Artifact} management operations. - * */ public interface ArtifactManagement { + /** * @return the total amount of local artifacts stored in the artifact * management @@ -47,23 +47,14 @@ public interface ArtifactManagement { * Persists artifact binary as provided by given InputStream. assign the * artifact in addition to given {@link SoftwareModule}. * - * @param artifactUpload - * {@link ArtifactUpload} containing the upload information - * + * @param artifactUpload {@link ArtifactUpload} containing the upload information * @return uploaded {@link Artifact} - * - * @throws EntityNotFoundException - * if given software module does not exist - * @throws EntityAlreadyExistsException - * if File with that name already exists in the Software Module - * @throws ArtifactUploadFailedException - * if upload fails with internal server errors - * @throws InvalidMD5HashException - * if check against provided MD5 checksum failed - * @throws InvalidSHA1HashException - * if check against provided SHA1 checksum failed - * @throws ConstraintViolationException - * if {@link ArtifactUpload} contains invalid values + * @throws EntityNotFoundException if given software module does not exist + * @throws EntityAlreadyExistsException if File with that name already exists in the Software Module + * @throws ArtifactUploadFailedException if upload fails with internal server errors + * @throws InvalidMD5HashException if check against provided MD5 checksum failed + * @throws InvalidSHA1HashException if check against provided SHA1 checksum failed + * @throws ConstraintViolationException if {@link ArtifactUpload} contains invalid values */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_CREATE_REPOSITORY) Artifact create(@NotNull @Valid ArtifactUpload artifactUpload); @@ -71,12 +62,9 @@ public interface ArtifactManagement { /** * Deletes {@link Artifact} based on given id. * - * @param id - * of the {@link Artifact} that has to be deleted. - * @throws ArtifactDeleteFailedException - * if deletion failed (MongoDB is not available) - * @throws EntityNotFoundException - * if artifact with given ID does not exist + * @param id of the {@link Artifact} that has to be deleted. + * @throws ArtifactDeleteFailedException if deletion failed (MongoDB is not available) + * @throws EntityNotFoundException if artifact with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_DELETE_REPOSITORY) void delete(long id); @@ -84,8 +72,7 @@ public interface ArtifactManagement { /** * Searches for {@link Artifact} with given {@link Identifiable}. * - * @param id - * to search for + * @param id to search for * @return found {@link Artifact} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY + SpringEvalExpressions.HAS_AUTH_OR @@ -95,14 +82,10 @@ public interface ArtifactManagement { /** * Find by artifact by software module id and filename. * - * @param filename - * file name - * @param softwareModuleId - * software module id. + * @param filename file name + * @param softwareModuleId software module id. * @return found {@link Artifact} - * - * @throws EntityNotFoundException - * if software module with given ID does not exist + * @throws EntityNotFoundException if software module with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY + SpringEvalExpressions.HAS_AUTH_OR + SpringEvalExpressions.IS_CONTROLLER) @@ -111,8 +94,7 @@ public interface ArtifactManagement { /** * Find all local artifact by sha1 and return the first artifact. * - * @param sha1 - * the sha1 + * @param sha1 the sha1 * @return the first local artifact */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY + SpringEvalExpressions.HAS_AUTH_OR @@ -122,8 +104,7 @@ public interface ArtifactManagement { /** * Searches for {@link Artifact} with given file name. * - * @param filename - * to search for + * @param filename to search for * @return found List of {@link Artifact}s. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY + SpringEvalExpressions.HAS_AUTH_OR @@ -133,14 +114,10 @@ public interface ArtifactManagement { /** * Get local artifact for a base software module. * - * @param pageReq - * Pageable parameter - * @param softwareModuleId - * software module id + * @param pageReq Pageable parameter + * @param softwareModuleId software module id * @return Page - * - * @throws EntityNotFoundException - * if software module with given ID does not exist + * @throws EntityNotFoundException if software module with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findBySoftwareModule(@NotNull Pageable pageReq, long softwareModuleId); @@ -148,12 +125,9 @@ public interface ArtifactManagement { /** * Count local artifacts for a base software module. * - * @param softwareModuleId - * software module id + * @param softwareModuleId software module id * @return count by software module - * - * @throws EntityNotFoundException - * if software module with given ID does not exist + * @throws EntityNotFoundException if software module with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) long countBySoftwareModule(long softwareModuleId); @@ -161,14 +135,10 @@ public interface ArtifactManagement { /** * Loads {@link DbArtifact} from store for given {@link Artifact}. * - * @param sha1Hash - * to search for - * @param softwareModuleId - * software module id. - * @param isEncrypted - * flag to indicate if artifact is encrypted. + * @param sha1Hash to search for + * @param softwareModuleId software module id. + * @param isEncrypted flag to indicate if artifact is encrypted. * @return loaded {@link DbArtifact} - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_DOWNLOAD_ARTIFACT + SpringEvalExpressions.HAS_AUTH_OR + SpringEvalExpressions.IS_CONTROLLER) diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/BaseRepositoryTypeProvider.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/BaseRepositoryTypeProvider.java index 74a5f1d69..d019d5db0 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/BaseRepositoryTypeProvider.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/BaseRepositoryTypeProvider.java @@ -17,6 +17,7 @@ public interface BaseRepositoryTypeProvider { /** * Return a base repository implementation that shall be used based on provided repository type + * * @param repositoryType type of repository * @return base repository implementation class */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ConfirmationManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ConfirmationManagement.java index ead913abd..5092a1d6d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ConfirmationManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ConfirmationManagement.java @@ -9,17 +9,18 @@ */ package org.eclipse.hawkbit.repository; +import java.util.Collection; +import java.util.List; +import java.util.Optional; + +import jakarta.validation.constraints.NotEmpty; + import org.eclipse.hawkbit.im.authentication.SpPermission; import org.eclipse.hawkbit.repository.model.Action; import org.eclipse.hawkbit.repository.model.AutoConfirmationStatus; import org.eclipse.hawkbit.tenancy.TenantAware; import org.springframework.security.access.prepost.PreAuthorize; -import jakarta.validation.constraints.NotEmpty; -import java.util.Collection; -import java.util.List; -import java.util.Optional; - /** * Service layer for all confirmation related operations. */ @@ -28,9 +29,8 @@ public interface ConfirmationManagement { /** * Find active actions in the {@link Action.Status#WAIT_FOR_CONFIRMATION} state * for a specific target with a specified controllerId. - * - * @param controllerId - * of the target to check + * + * @param controllerId of the target to check * @return a list of {@link Action} */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -40,13 +40,10 @@ public interface ConfirmationManagement { * Activate auto confirmation for a given controller ID. In case auto * confirmation is active already, this method will fail with an exception. * - * @param controllerId - * to activate the feature for - * @param initiator - * who initiated this operation. If 'null' we will take the current - * user from {@link TenantAware#getCurrentUsername()} - * @param remark - * optional field to set a remark + * @param controllerId to activate the feature for + * @param initiator who initiated this operation. If 'null' we will take the current + * user from {@link TenantAware#getCurrentUsername()} + * @param remark optional field to set a remark * @return the persisted {@link AutoConfirmationStatus} */ @PreAuthorize(SpPermission.SpringEvalExpressions.IS_CONTROLLER_OR_HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) @@ -56,8 +53,7 @@ public interface ConfirmationManagement { /** * Get the current state of auto-confirmation for a given controllerId * - * @param controllerId - * to check the state for + * @param controllerId to check the state for * @return instance of {@link AutoConfirmationStatus} wrapped in an * {@link Optional}. Present if active and empty if disabled. */ @@ -68,9 +64,8 @@ public interface ConfirmationManagement { /** * Auto confirm active actions for a specific controller ID having the * {@link Action.Status#WAIT_FOR_CONFIRMATION} status. - * - * @param controllerId - * to confirm actions for + * + * @param controllerId to confirm actions for * @return a list of confirmed actions */ @PreAuthorize(SpPermission.SpringEvalExpressions.IS_CONTROLLER_OR_HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) @@ -80,13 +75,10 @@ public interface ConfirmationManagement { * Confirm a given action to put it from * {@link Action.Status#WAIT_FOR_CONFIRMATION} to {@link Action.Status#RUNNING} * state. - * - * @param actionId - * mandatory to know which action to confirm - * @param code - * optional value to specify a code for the created action status - * @param messages - * optional value to specify message for the created action status + * + * @param actionId mandatory to know which action to confirm + * @param code optional value to specify a code for the created action status + * @param messages optional value to specify message for the created action status */ @PreAuthorize(SpPermission.SpringEvalExpressions.IS_CONTROLLER_OR_HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) Action confirmAction(long actionId, Integer code, Collection messages); @@ -95,12 +87,9 @@ public interface ConfirmationManagement { * Deny a given action and leave it in * {@link Action.Status#WAIT_FOR_CONFIRMATION} state. * - * @param actionId - * mandatory to know which action to deny - * @param code - * optional value to specify a code for the created action status - * @param messages - * optional value to specify message for the created action status + * @param actionId mandatory to know which action to deny + * @param code optional value to specify a code for the created action status + * @param messages optional value to specify message for the created action status */ @PreAuthorize(SpPermission.SpringEvalExpressions.IS_CONTROLLER_OR_HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) Action denyAction(long actionId, Integer code, Collection messages); @@ -108,8 +97,7 @@ public interface ConfirmationManagement { /** * Deactivate auto confirmation for a specific controller id * - * @param controllerId - * to disable auto confirmation for + * @param controllerId to disable auto confirmation for */ @PreAuthorize(SpPermission.SpringEvalExpressions.IS_CONTROLLER_OR_HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) void deactivateAutoConfirmation(@NotEmpty String controllerId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/Constants.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/Constants.java index 04ea67b5b..6e75cd616 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/Constants.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/Constants.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleType; /** * Repository API constants. - * */ public final class Constants { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ControllerManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ControllerManagement.java index 9f4a34fe7..b4110fc79 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ControllerManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ControllerManagement.java @@ -43,7 +43,6 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Service layer for all operations of the DDI API (with access permissions only * for the controller). - * */ public interface ControllerManagement { @@ -51,22 +50,14 @@ public interface ControllerManagement { * Adds an {@link ActionStatus} for a cancel {@link Action} including * potential state changes for the target and the {@link Action} itself. * - * @param create - * to be added + * @param create to be added * @return the updated {@link Action} - * - * @throws EntityAlreadyExistsException - * if a given entity already exists - * - * @throws AssignmentQuotaExceededException - * if more than the allowed number of status entries or messages - * per entry are inserted - * @throws EntityNotFoundException - * if given action does not exist - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link ActionStatusCreate} for field constraints. - * + * @throws EntityAlreadyExistsException if a given entity already exists + * @throws AssignmentQuotaExceededException if more than the allowed number of status entries or messages + * per entry are inserted + * @throws EntityNotFoundException if given action does not exist + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link ActionStatusCreate} for field constraints. */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Action addCancelActionStatus(@NotNull @Valid ActionStatusCreate create); @@ -74,8 +65,7 @@ public interface ControllerManagement { /** * Retrieves assigned {@link SoftwareModule} of a target. * - * @param moduleId - * of the {@link SoftwareModule} + * @param moduleId of the {@link SoftwareModule} * @return {@link SoftwareModule} identified by ID */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) @@ -85,8 +75,7 @@ public interface ControllerManagement { * Retrieves {@link SoftwareModuleMetadata} where * {@link SoftwareModuleMetadata#isTargetVisible()}. * - * @param moduleId - * of the {@link SoftwareModule} + * @param moduleId of the {@link SoftwareModule} * @return list of {@link SoftwareModuleMetadata} with maximum size of * {@link RepositoryConstants#MAX_META_DATA_COUNT} */ @@ -98,19 +87,13 @@ public interface ControllerManagement { * Simple addition of a new {@link ActionStatus} entry to the * {@link Action}. No state changes. * - * @param create - * to add to the action - * + * @param create to add to the action * @return created {@link ActionStatus} entity - * - * @throws AssignmentQuotaExceededException - * if more than the allowed number of status entries or messages - * per entry are inserted - * @throws EntityNotFoundException - * if given action does not exist - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link ActionStatusCreate} for field constraints. + * @throws AssignmentQuotaExceededException if more than the allowed number of status entries or messages + * per entry are inserted + * @throws EntityNotFoundException if given action does not exist + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link ActionStatusCreate} for field constraints. */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) ActionStatus addInformationalActionStatus(@NotNull @Valid ActionStatusCreate create); @@ -119,20 +102,14 @@ public interface ControllerManagement { * Adds an {@link ActionStatus} entry for an update {@link Action} including * potential state changes for the target and the {@link Action} itself. * - * @param create - * to be added + * @param create to be added * @return the updated {@link Action} - * - * @throws EntityAlreadyExistsException - * if a given entity already exists - * @throws AssignmentQuotaExceededException - * if more than the allowed number of status entries or messages - * per entry are inserted - * @throws EntityNotFoundException - * if action status not exist - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link ActionStatusCreate} for field constraints. + * @throws EntityAlreadyExistsException if a given entity already exists + * @throws AssignmentQuotaExceededException if more than the allowed number of status entries or messages + * per entry are inserted + * @throws EntityNotFoundException if action status not exist + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link ActionStatusCreate} for field constraints. */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Action addUpdateActionStatus(@NotNull @Valid ActionStatusCreate create); @@ -140,15 +117,13 @@ public interface ControllerManagement { /** * Retrieves active {@link Action} with highest priority that is assigned to * a {@link Target}. - * + * * For performance reasons this method does not throw * {@link EntityNotFoundException} in case target with given controllerId * does not exist but will return an {@link Optional#empty()} instead. * - * @param controllerId - * identifies the target to retrieve the action from + * @param controllerId identifies the target to retrieve the action from * @return the action - * */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Optional findActiveActionWithHighestWeight(@NotEmpty String controllerId); @@ -156,13 +131,10 @@ public interface ControllerManagement { /** * Retrieves active {@link Action}s with highest weight that are assigned to * a {@link Target}. - * - * @param controllerId - * identifies the target to retrieve the action from - * @param maxActionCount - * max size of returned list + * + * @param controllerId identifies the target to retrieve the action from + * @param maxActionCount max size of returned list * @return the action - * */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) List findActiveActionsWithHighestWeight(@NotEmpty String controllerId, int maxActionCount); @@ -170,9 +142,8 @@ public interface ControllerManagement { /** * Get weight of an Action. Returns the default value if the weight is null * according to the properties. - * - * @param action - * to extract the weight from + * + * @param action to extract the weight from * @return weight of the action */ int getWeightConsideringDefault(final Action action); @@ -181,8 +152,7 @@ public interface ControllerManagement { * Get the {@link Action} entity for given actionId with all lazy * attributes. * - * @param actionId - * to be id of the action + * @param actionId to be id of the action * @return the corresponding {@link Action} */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) @@ -192,14 +162,10 @@ public interface ControllerManagement { * Retrieves all the {@link ActionStatus} entries of the given * {@link Action}. * - * @param pageReq - * pagination parameter - * @param actionId - * to be filtered on + * @param pageReq pagination parameter + * @param actionId to be filtered on * @return the corresponding {@link Page} of {@link ActionStatus} - * - * @throws EntityNotFoundException - * if action with given ID does not exist + * @throws EntityNotFoundException if action with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Page findActionStatusByAction(@NotNull Pageable pageReq, long actionId); @@ -211,10 +177,8 @@ public interface ControllerManagement { * {@link TargetUpdateStatus#UNKNOWN} to * {@link TargetUpdateStatus#REGISTERED}. * - * @param controllerId - * reference - * @param address - * the client IP address of the target, might be {@code null} + * @param controllerId reference + * @param address the client IP address of the target, might be {@code null} * @return target reference */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) @@ -228,14 +192,10 @@ public interface ControllerManagement { * switches if {@link TargetUpdateStatus#UNKNOWN} to * {@link TargetUpdateStatus#REGISTERED}. * - * @param controllerId - * reference - * @param address - * the client IP address of the target, might be {@code null} - * @param name - * the name of the target - * @param type - * the target type name of the target + * @param controllerId reference + * @param address the client IP address of the target, might be {@code null} + * @param name the name of the target + * @param type the target type name of the target * @return target reference */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) @@ -246,16 +206,11 @@ public interface ControllerManagement { * Retrieves last {@link Action} for a download of an artifact of given * module and target if exists and is not canceled. * - * @param controllerId - * to look for - * @param moduleId - * of the the {@link SoftwareModule} that should be assigned to - * the target + * @param controllerId to look for + * @param moduleId of the the {@link SoftwareModule} that should be assigned to + * the target * @return last {@link Action} for given combination - * - * @throws EntityNotFoundException - * if target with given ID does not exist - * + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Optional getActionForDownloadByTargetAndSoftwareModule(@NotEmpty String controllerId, long moduleId); @@ -297,10 +252,8 @@ public interface ControllerManagement { * of maintenance window, it resets to default * {@link TenantConfigurationKey#POLLING_TIME_INTERVAL}. * - * @param actionId - * id the {@link Action} for which polling time is calculated - * based on it having maintenance window or not - * + * @param actionId id the {@link Action} for which polling time is calculated + * based on it having maintenance window or not * @return current {@link TenantConfigurationKey#POLLING_TIME_INTERVAL}. */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) @@ -313,17 +266,13 @@ public interface ControllerManagement { * assigned or had ever been assigned to the target and so it's visible to a * specific target e.g. for downloading. * - * @param controllerId - * the ID of the target to check - * @param sha1Hash - * of the artifact to verify if the given target had even been - * assigned to + * @param controllerId the ID of the target to check + * @param sha1Hash of the artifact to verify if the given target had even been + * assigned to * @return {@code true} if the given target has currently or had ever a * relation to the given artifact through the action history, * otherwise {@code false} - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) boolean hasTargetArtifactAssigned(@NotEmpty String controllerId, @NotEmpty String sha1Hash); @@ -335,17 +284,13 @@ public interface ControllerManagement { * assigned or had ever been assigned to the target and so it's visible to a * specific target e.g. for downloading. * - * @param targetId - * the ID of the target to check - * @param sha1Hash - * of the artifact to verify if the given target had even been - * assigned to + * @param targetId the ID of the target to check + * @param sha1Hash of the artifact to verify if the given target had even been + * assigned to * @return {@code true} if the given target has currently or had ever a * relation to the given artifact through the action history, * otherwise {@code false} - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) boolean hasTargetArtifactAssigned(long targetId, @NotEmpty String sha1Hash); @@ -354,15 +299,11 @@ public interface ControllerManagement { * Registers retrieved status for given {@link Target} and {@link Action} if * it does not exist yet. * - * @param actionId - * to the handle status for - * @param message - * for the status + * @param actionId to the handle status for + * @param message for the status * @return the update action in case the status has been changed to * {@link Status#RETRIEVED} - * - * @throws EntityNotFoundException - * if action with given ID does not exist + * @throws EntityNotFoundException if action with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Action registerRetrieved(long actionId, String message); @@ -371,21 +312,13 @@ public interface ControllerManagement { * Updates attributes of the controller according to the given * {@link UpdateMode}. * - * @param controllerId - * to update - * @param attributes - * to insert - * @param mode - * the update mode or null - * + * @param controllerId to update + * @param attributes to insert + * @param mode the update mode or null * @return updated {@link Target} - * - * @throws EntityNotFoundException - * if target that has to be updated could not be found - * @throws AssignmentQuotaExceededException - * if maximum number of attributes per target is exceeded - * @throws InvalidTargetAttributeException - * if attributes violate constraints + * @throws EntityNotFoundException if target that has to be updated could not be found + * @throws AssignmentQuotaExceededException if maximum number of attributes per target is exceeded + * @throws InvalidTargetAttributeException if attributes violate constraints */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Target updateControllerAttributes(@NotEmpty String controllerId, @NotNull Map attributes, @@ -396,8 +329,7 @@ public interface ControllerManagement { * without details, i.e. NO {@link Target#getTags()} and * {@link Target#getActions()} possible. * - * @param controllerId - * to look for. + * @param controllerId to look for. * @return {@link Target} or {@code null} if it does not exist * @see Target#getControllerId() */ @@ -410,8 +342,7 @@ public interface ControllerManagement { * details, i.e. NO {@link Target#getTags()} and {@link Target#getActions()} * possible. * - * @param targetId - * to look for. + * @param targetId to look for. * @return {@link Target} or {@code null} if it does not exist * @see Target#getId() */ @@ -436,11 +367,8 @@ public interface ControllerManagement { * first, the sub-ordering of messages from within single * {@link ActionStatus} is unspecified. * - * @param actionId - * to be filtered on - * @param messageCount - * is the number of messages to return from history - * + * @param actionId to be filtered on + * @param messageCount is the number of messages to return from history * @return action history. */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) @@ -452,15 +380,10 @@ public interface ControllerManagement { * cancellation. The controller needs to acknowledge or reject the * cancellation using {@link DdiRootController#postCancelActionFeedback}. * - * @param actionId - * to be canceled - * + * @param actionId to be canceled * @return canceled {@link Action} - * - * @throws CancelActionNotAllowedException - * in case the given action is not active or is already canceled - * @throws EntityNotFoundException - * if action with given actionId does not exist. + * @throws CancelActionNotAllowedException in case the given action is not active or is already canceled + * @throws EntityNotFoundException if action with given actionId does not exist. */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Action cancelAction(long actionId); @@ -468,19 +391,16 @@ public interface ControllerManagement { /** * Updates given {@link Action} with its external id. * - * @param actionId - * to be updated - * @param externalRef - * of the action + * @param actionId to be updated + * @param externalRef of the action */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) void updateActionExternalRef(long actionId, @NotEmpty String externalRef); /** * Retrieves an {@link Action} using {@link Action#getExternalRef()} - * - * @param externalRef - * of the action. See {@link Action#getExternalRef()} + * + * @param externalRef of the action. See {@link Action#getExternalRef()} * @return {@link Action} or {@code null} if it does not exist */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) @@ -489,8 +409,7 @@ public interface ControllerManagement { /** * Delete a single target. * - * @param controllerId - * of the target to delete + * @param controllerId of the target to delete */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) void deleteExistingTarget(@NotEmpty String controllerId); @@ -498,22 +417,18 @@ public interface ControllerManagement { /** * Finds an {@link Action} based on the target that it's assigned to * - * @param controllerId - * of the target the action is assigned to + * @param controllerId of the target the action is assigned to */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) Optional getInstalledActionByTarget(@NotEmpty String controllerId); /** * Activate auto confirmation for a given controllerId - * - * @param controllerId - * to activate auto-confirmation on - * @param initiator - * can be set optionally (fallback is the current acting security - * user) - * @param remark - * (optional) remark + * + * @param controllerId to activate auto-confirmation on + * @param initiator can be set optionally (fallback is the current acting security + * user) + * @param remark (optional) remark * @return the persisted {@link AutoConfirmationStatus} */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) @@ -521,9 +436,8 @@ public interface ControllerManagement { /** * Deactivate auto confirmation for a given controllerId - * - * @param controllerId - * to deactivate auto-confirmation on + * + * @param controllerId to deactivate auto-confirmation on */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) void deactivateAutoConfirmation(@NotEmpty String controllerId); @@ -531,17 +445,11 @@ public interface ControllerManagement { /** * Updates distributionSet installed version (experimental) * - * @param distributionName - * installed - * @param version - * installed - * + * @param distributionName installed + * @param version installed * @return updated {@link Target} - * - * @throws EntityNotFoundException - * if target that has to be updated could not be found - * @throws java.util.NoSuchElementException - * if DistributionSetAssignmentResult list is empty + * @throws EntityNotFoundException if target that has to be updated could not be found + * @throws java.util.NoSuchElementException if DistributionSetAssignmentResult list is empty */ @PreAuthorize(SpringEvalExpressions.IS_CONTROLLER) boolean updateOfflineAssignedVersion(@NotEmpty String controllerId, String distributionName, String version); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DeploymentManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DeploymentManagement.java index adea1dd09..5ca4b4a40 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DeploymentManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DeploymentManagement.java @@ -48,34 +48,35 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * A DeploymentManagement service provides operations for the deployment of * {@link DistributionSet}s to {@link Target}s. - * */ public interface DeploymentManagement { + /** + * build a {@link DeploymentRequest} for a target distribution set + * assignment + * + * @param controllerId ID of target + * @param distributionSetId ID of distribution set + * @return the builder + */ + static DeploymentRequestBuilder deploymentRequest(final String controllerId, final long distributionSetId) { + return new DeploymentRequestBuilder(controllerId, distributionSetId); + } + /** * Assigns {@link DistributionSet}s to {@link Target}s according to the * {@link DeploymentRequest}. * - * @param deploymentRequests - * information about all target-ds-assignments that shall be made - * + * @param deploymentRequests information about all target-ds-assignments that shall be made * @return the list of assignment results - * - * @throws IncompleteDistributionSetException - * if mandatory {@link SoftwareModuleType} are not assigned as - * defined by the {@link DistributionSetType}. - * - * @throws EntityNotFoundException - * if either provided {@link DistributionSet} or {@link Target}s - * do not exist - * - * @throws AssignmentQuotaExceededException - * if the maximum number of targets the distribution set can be - * assigned to at once is exceeded - * @throws MultiAssignmentIsNotEnabledException - * if the request results in multiple assignments to the same - * target and multiassignment is disabled - * + * @throws IncompleteDistributionSetException if mandatory {@link SoftwareModuleType} are not assigned as + * defined by the {@link DistributionSetType}. + * @throws EntityNotFoundException if either provided {@link DistributionSet} or {@link Target}s + * do not exist + * @throws AssignmentQuotaExceededException if the maximum number of targets the distribution set can be + * assigned to at once is exceeded + * @throws MultiAssignmentIsNotEnabledException if the request results in multiple assignments to the same + * target and multiassignment is disabled */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) List assignDistributionSets( @@ -85,49 +86,23 @@ public interface DeploymentManagement { * Assigns {@link DistributionSet}s to {@link Target}s according to the * {@link DeploymentRequest}. * - * @param initiatedBy - * the username of the user who initiated the assignment - * @param deploymentRequests - * information about all target-ds-assignments that shall be made - * @param actionMessage - * an optional message for the action status - * + * @param initiatedBy the username of the user who initiated the assignment + * @param deploymentRequests information about all target-ds-assignments that shall be made + * @param actionMessage an optional message for the action status * @return the list of assignment results - * - * @throws IncompleteDistributionSetException - * if mandatory {@link SoftwareModuleType} are not assigned as - * defined by the {@link DistributionSetType}. - * - * @throws EntityNotFoundException - * if either provided {@link DistributionSet} or {@link Target}s - * do not exist - * - * @throws AssignmentQuotaExceededException - * if the maximum number of targets the distribution set can be - * assigned to at once is exceeded - * @throws MultiAssignmentIsNotEnabledException - * if the request results in multiple assignments to the same - * target and multiassignment is disabled - * + * @throws IncompleteDistributionSetException if mandatory {@link SoftwareModuleType} are not assigned as + * defined by the {@link DistributionSetType}. + * @throws EntityNotFoundException if either provided {@link DistributionSet} or {@link Target}s + * do not exist + * @throws AssignmentQuotaExceededException if the maximum number of targets the distribution set can be + * assigned to at once is exceeded + * @throws MultiAssignmentIsNotEnabledException if the request results in multiple assignments to the same + * target and multiassignment is disabled */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) List assignDistributionSets(String initiatedBy, @Valid @NotEmpty List deploymentRequests, String actionMessage); - /** - * build a {@link DeploymentRequest} for a target distribution set - * assignment - * - * @param controllerId - * ID of target - * @param distributionSetId - * ID of distribution set - * @return the builder - */ - static DeploymentRequestBuilder deploymentRequest(final String controllerId, final long distributionSetId) { - return new DeploymentRequestBuilder(controllerId, distributionSetId); - } - /** * Registers "offline" assignments. "offline" assignment means adding a * completed action for a {@link DistributionSet} to a {@link Target}. @@ -143,26 +118,17 @@ public interface DeploymentManagement { *
  • does not send a {@link TargetAssignDistributionSetEvent}.
    • * * - * @param assignments - * target IDs with the respective distribution set ID which they - * are supposed to be assigned to + * @param assignments target IDs with the respective distribution set ID which they + * are supposed to be assigned to * @return the assignment results - * - * @throws IncompleteDistributionSetException - * if mandatory {@link SoftwareModuleType} are not assigned as - * defined by the {@link DistributionSetType}. - * - * @throws EntityNotFoundException - * if either provided {@link DistributionSet} or {@link Target}s - * do not exist - * - * @throws AssignmentQuotaExceededException - * if the maximum number of targets the distribution set can be - * assigned to at once is exceeded - * - * @throws MultiAssignmentIsNotEnabledException - * if the request results in multiple assignments to the same - * target and multiassignment is disabled + * @throws IncompleteDistributionSetException if mandatory {@link SoftwareModuleType} are not assigned as + * defined by the {@link DistributionSetType}. + * @throws EntityNotFoundException if either provided {@link DistributionSet} or {@link Target}s + * do not exist + * @throws AssignmentQuotaExceededException if the maximum number of targets the distribution set can be + * assigned to at once is exceeded + * @throws MultiAssignmentIsNotEnabledException if the request results in multiple assignments to the same + * target and multiassignment is disabled */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) List offlineAssignedDistributionSets(Collection> assignments, String initiatedBy); @@ -175,16 +141,11 @@ public interface DeploymentManagement { * add a {@link Status#CANCELED} status to the action. However, it might be * possible that the controller will continue to work on the cancellation. * - * @param actionId - * to be canceled - * + * @param actionId to be canceled * @return canceled {@link Action} - * - * @throws CancelActionNotAllowedException - * in case the given action is not active or is already a cancel - * action - * @throws EntityNotFoundException - * if action with given ID does not exist + * @throws CancelActionNotAllowedException in case the given action is not active or is already a cancel + * action + * @throws EntityNotFoundException if action with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) Action cancelAction(long actionId); @@ -192,19 +153,13 @@ public interface DeploymentManagement { /** * Counts all actions associated to a specific target. * - * @param rsqlParam - * rsql query string - * @param controllerId - * the target associated to the actions to count + * @param rsqlParam rsql query string + * @param controllerId the target associated to the actions to count * @return the count value of found actions associated to the target - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) long countActionsByTarget(@NotNull String rsqlParam, @NotEmpty String controllerId); @@ -223,9 +178,8 @@ public interface DeploymentManagement { * Counts the actions which match the given query. *

    * No access control applied. - * - * @param rsqlParam - * RSQL query. + * + * @param rsqlParam RSQL query. * @return the total number of actions matching the given RSQL query. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -234,12 +188,9 @@ public interface DeploymentManagement { /** * Counts all actions associated to a specific target. * - * @param controllerId - * the target associated to the actions to count + * @param controllerId the target associated to the actions to count * @return the count value of found actions associated to the target - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) long countActionsByTarget(@NotEmpty String controllerId); @@ -247,10 +198,8 @@ public interface DeploymentManagement { /** * Get the {@link Action} entity for given actionId. * - * @param actionId - * to be id of the action + * @param actionId to be id of the action * @return the corresponding {@link Action} - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Optional findAction(long actionId); @@ -270,10 +219,9 @@ public interface DeploymentManagement { * Retrieves all {@link Action} entities which match the given RSQL query. *

    * No access control applied. - * + * * @param rsqlParam RSQL query string * @param pageable the page request parameter for paging and sorting the result - * * @return a paged list of {@link Action}s. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -283,20 +231,14 @@ public interface DeploymentManagement { * Retrieves all {@link Action}s assigned to a specific {@link Target} and a * given specification. * - * @param rsqlParam - * rsql query string - * @param controllerId - * the target which must be assigned to the actions - * @param pageable - * the page request + * @param rsqlParam rsql query string + * @param controllerId the target which must be assigned to the actions + * @param pageable the page request * @return a slice of actions assigned to the specific target and the * specification - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findActionsByTarget(@NotNull String rsqlParam, @NotEmpty String controllerId, @@ -306,12 +248,9 @@ public interface DeploymentManagement { * Retrieves all {@link Action}s which are referring the given * {@link Target}. * - * @param controllerId - * the target to find actions for - * @param pageable - * the pageable request to limit, sort the actions + * @param controllerId the target to find actions for + * @param pageable the pageable request to limit, sort the actions * @return a slice of actions found for a specific target - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findActionsByTarget(@NotEmpty String controllerId, @NotNull Pageable pageable); @@ -320,14 +259,10 @@ public interface DeploymentManagement { * Retrieves all the {@link ActionStatus} entries of the given * {@link Action}. * - * @param pageReq - * pagination parameter - * @param actionId - * to be filtered on + * @param pageReq pagination parameter + * @param actionId to be filtered on * @return the corresponding {@link Page} of {@link ActionStatus} - * - * @throws EntityNotFoundException - * if action with given ID does not exist + * @throws EntityNotFoundException if action with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Page findActionStatusByAction(@NotNull Pageable pageReq, long actionId); @@ -335,12 +270,9 @@ public interface DeploymentManagement { /** * Counts all the {@link ActionStatus} entries of the given {@link Action}. * - * @param actionId - * to be filtered on + * @param actionId to be filtered on * @return count of {@link ActionStatus} entries - * - * @throws EntityNotFoundException - * if action with given ID does not exist + * @throws EntityNotFoundException if action with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) long countActionStatusByAction(long actionId); @@ -350,10 +282,8 @@ public interface DeploymentManagement { *

    * No entity based access control applied. * - * @param pageable - * the page request parameter for paging and sorting the result - * @param actionStatusId - * the id of {@link ActionStatus} to retrieve the messages from + * @param pageable the page request parameter for paging and sorting the result + * @param actionStatusId the id of {@link ActionStatus} to retrieve the messages from * @return a page of messages by a specific {@link ActionStatus} id */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -363,8 +293,7 @@ public interface DeploymentManagement { * Get the {@link Action} entity for given actionId with all lazy attributes * (i.e. distributionSet, target, target.assignedDs). * - * @param actionId - * to be id of the action + * @param actionId to be id of the action * @return the corresponding {@link Action} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -373,14 +302,10 @@ public interface DeploymentManagement { /** * Retrieves all active {@link Action}s of a specific target. * - * @param pageable - * the page request parameter for paging and sorting the result - * @param controllerId - * the target associated with the actions + * @param pageable the page request parameter for paging and sorting the result + * @param controllerId the target associated with the actions * @return a list of actions associated with the given target - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Page findActiveActionsByTarget(@NotNull Pageable pageable, @NotEmpty String controllerId); @@ -388,14 +313,10 @@ public interface DeploymentManagement { /** * Retrieves all inactive {@link Action}s of a specific target. * - * @param pageable - * the page request parameter for paging and sorting the result - * @param controllerId - * the target associated with the actions + * @param pageable the page request parameter for paging and sorting the result + * @param controllerId the target associated with the actions * @return a list of actions associated with the given target - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Page findInActiveActionsByTarget(@NotNull Pageable pageable, @NotEmpty String controllerId); @@ -404,12 +325,9 @@ public interface DeploymentManagement { * Retrieves active {@link Action}s with highest weight that are assigned to a * {@link Target}. * - * @param controllerId - * identifies the target to retrieve the action from - * @param maxActionCount - * max size of returned list + * @param controllerId identifies the target to retrieve the action from + * @param maxActionCount max size of returned list * @return the action - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) List findActiveActionsWithHighestWeight(@NotEmpty String controllerId, int maxActionCount); @@ -418,8 +336,7 @@ public interface DeploymentManagement { * Get weight of an Action. Returns the default value if the weight is null * according to the properties. * - * @param action - * to extract the weight from + * @param action to extract the weight from * @return weight of the action */ int getWeightConsideringDefault(final Action action); @@ -430,16 +347,10 @@ public interface DeploymentManagement { * and a cancel request is sent to the target. But however it's not tracked, * if the targets handles the cancel request or not. * - * @param actionId - * to be canceled - * + * @param actionId to be canceled * @return quite {@link Action} - * - * @throws CancelActionNotAllowedException - * in case the given action is not active - * - * @throws EntityNotFoundException - * if action with given ID does not exist + * @throws CancelActionNotAllowedException in case the given action is not active + * @throws EntityNotFoundException if action with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) Action forceQuitAction(long actionId); @@ -448,12 +359,9 @@ public interface DeploymentManagement { * Updates a {@link Action} and forces the {@link Action} if it's not * already forced. * - * @param actionId - * the ID of the action + * @param actionId the ID of the action * @return the updated or the found {@link Action} - * - * @throws EntityNotFoundException - * if action with given ID does not exist + * @throws EntityNotFoundException if action with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) Action forceTargetAction(long actionId); @@ -462,9 +370,7 @@ public interface DeploymentManagement { * Sets the status of inactive scheduled {@link Action}s for the specified * {@link Target}s to {@link Status#CANCELED} * - * @param targetIds - * ids of the {@link Target}s the actions belong to - * + * @param targetIds ids of the {@link Target}s the actions belong to */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) void cancelInactiveScheduledActionsForTargets(List targetIds); @@ -474,13 +380,10 @@ public interface DeploymentManagement { *

    * No entity based access control applied. * - * @param rolloutId - * the rollout the actions belong to - * @param distributionSetId - * to assign - * @param rolloutGroupParentId - * the parent rollout group the actions should reference. null - * references the first group + * @param rolloutId the rollout the actions belong to + * @param distributionSetId to assign + * @param rolloutGroupParentId the parent rollout group the actions should reference. null + * references the first group * @return the amount of started actions */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -497,12 +400,9 @@ public interface DeploymentManagement { /** * Returns {@link DistributionSet} that is assigned to given {@link Target}. * - * @param controllerId - * of target + * @param controllerId of target * @return assigned {@link DistributionSet} - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ Optional getAssignedDistributionSet(@NotEmpty String controllerId); @@ -510,12 +410,9 @@ public interface DeploymentManagement { * Returns {@link DistributionSet} that is installed on given * {@link Target}. * - * @param controllerId - * of target + * @param controllerId of target * @return installed {@link DistributionSet} - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ Optional getInstalledDistributionSet(@NotEmpty String controllerId); @@ -525,11 +422,8 @@ public interface DeploymentManagement { *

    * No entity based access control applied. * - * @param status - * Set of action status. - * @param lastModified - * A time-stamp in milliseconds. - * + * @param status Set of action status. + * @param lastModified A time-stamp in milliseconds. * @return The number of action entries that were deleted. */ @PreAuthorize(SpringEvalExpressions.IS_SYSTEM_CODE) @@ -549,10 +443,8 @@ public interface DeploymentManagement { * Cancels all actions that refer to a given distribution set. This method * is called when a distribution set is invalidated. * - * @param cancelationType - * defines if a force or soft cancel is executed - * @param set - * the distribution set for that the actions should be canceled + * @param cancelationType defines if a force or soft cancel is executed + * @param set the distribution set for that the actions should be canceled */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) void cancelActionsForDistributionSet(final CancelationType cancelationType, final DistributionSet set); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetInvalidationManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetInvalidationManagement.java index 0d1131aa0..a6646208b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetInvalidationManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetInvalidationManagement.java @@ -16,7 +16,6 @@ import org.eclipse.hawkbit.repository.model.DistributionSetInvalidationCount; /** * A DistributionSetInvalidationManagement service provides operations to * invalidate {@link DistributionSet}s. - * */ public interface DistributionSetInvalidationManagement { @@ -26,9 +25,8 @@ public interface DistributionSetInvalidationManagement { * can not be undone. Optionally, all rollouts and actions referring this * {@link DistributionSet} can be canceled. * - * @param distributionSetInvalidation - * defines the {@link DistributionSet} and options what should be - * canceled + * @param distributionSetInvalidation defines the {@link DistributionSet} and options what should be + * canceled */ void invalidateDistributionSet(final DistributionSetInvalidation distributionSetInvalidation); @@ -36,10 +34,8 @@ public interface DistributionSetInvalidationManagement { * Counts all entities for a list of {@link DistributionSet}s that will be * canceled when invalidation is called for those {@link DistributionSet}s. * - * - * @param distributionSetInvalidation - * defines the {@link DistributionSet} and options what should be - * canceled + * @param distributionSetInvalidation defines the {@link DistributionSet} and options what should be + * canceled * @return The {@link DistributionSetInvalidationCount} object that holds * information about the count of affected rollouts, * auto-assignments and actions diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetManagement.java index 08ade0025..7dc7b56cd 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetManagement.java @@ -45,7 +45,6 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Management service for {@link DistributionSet}s. - * */ public interface DistributionSetManagement extends RepositoryManagement { @@ -53,27 +52,16 @@ public interface DistributionSetManagement /** * Assigns {@link SoftwareModule} to existing {@link DistributionSet}. * - * @param id - * to assign and update - * @param moduleIds - * to get assigned - * + * @param id to assign and update + * @param moduleIds to get assigned * @return the updated {@link DistributionSet}. - * - * @throws EntityNotFoundException - * if (at least one) given module does not exist - * - * @throws EntityReadOnlyException - * if use tries to change the {@link DistributionSet} s while - * the DS is already in use. - * - * @throws UnsupportedSoftwareModuleForThisDistributionSetException - * if {@link SoftwareModule#getType()} is not supported by this - * {@link DistributionSet#getType()}. - * - * @throws AssignmentQuotaExceededException - * if the maximum number of {@link SoftwareModule}s is exceeded - * for the addressed {@link DistributionSet}. + * @throws EntityNotFoundException if (at least one) given module does not exist + * @throws EntityReadOnlyException if use tries to change the {@link DistributionSet} s while + * the DS is already in use. + * @throws UnsupportedSoftwareModuleForThisDistributionSetException if {@link SoftwareModule#getType()} is not supported by this + * {@link DistributionSet#getType()}. + * @throws AssignmentQuotaExceededException if the maximum number of {@link SoftwareModule}s is exceeded + * for the addressed {@link DistributionSet}. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) DistributionSet assignSoftwareModules(long id, @NotEmpty Collection moduleIds); @@ -82,16 +70,11 @@ public interface DistributionSetManagement * Assign a {@link DistributionSetTag} assignment to given * {@link DistributionSet}s. * - * @param ids - * to assign for - * @param tagId - * to assign - * + * @param ids to assign for + * @param tagId to assign * @return list of assigned ds - * - * @throws EntityNotFoundException - * if tag with given ID does not exist or (at least one) of the - * distribution sets. + * @throws EntityNotFoundException if tag with given ID does not exist or (at least one) of the + * distribution sets. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) List assignTag(@NotEmpty Collection ids, long tagId); @@ -110,23 +93,15 @@ public interface DistributionSetManagement /** * Creates a list of distribution set meta data entries. * - * @param id - * if the {@link DistributionSet} the metadata has to be created - * for - * @param metadata - * the meta data entries to create or update + * @param id if the {@link DistributionSet} the metadata has to be created + * for + * @param metadata the meta data entries to create or update * @return the updated or created distribution set meta data entries - * - * @throws EntityNotFoundException - * if given set does not exist - * - * @throws EntityAlreadyExistsException - * in case one of the meta data entry already exists for the - * specific key - * - * @throws AssignmentQuotaExceededException - * if the maximum number of {@link MetaData} entries is exceeded - * for the addressed {@link DistributionSet} + * @throws EntityNotFoundException if given set does not exist + * @throws EntityAlreadyExistsException in case one of the meta data entry already exists for the + * specific key + * @throws AssignmentQuotaExceededException if the maximum number of {@link MetaData} entries is exceeded + * for the addressed {@link DistributionSet} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) List createMetaData(long id, @NotEmpty Collection metadata); @@ -134,13 +109,9 @@ public interface DistributionSetManagement /** * Deletes a distribution set meta data entry. * - * @param id - * where meta data has to be deleted - * @param key - * of the meta data element - * - * @throws EntityNotFoundException - * if given set does not exist + * @param id where meta data has to be deleted + * @param key of the meta data element + * @throws EntityNotFoundException if given set does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) void deleteMetaData(long id, @NotEmpty String key); @@ -169,12 +140,9 @@ public interface DistributionSetManagement /** * Retrieves the distribution set for a given action. * - * @param actionId - * the action associated with the distribution set + * @param actionId the action associated with the distribution set * @return the distribution set which is associated with the action - * - * @throws EntityNotFoundException - * if action with given ID does not exist + * @throws EntityNotFoundException if action with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Optional getByAction(long actionId); @@ -186,9 +154,7 @@ public interface DistributionSetManagement * Note: for performance reasons it is recommended to use {@link #get(Long)} * if details are not necessary. * - * @param id - * to look for. - * + * @param id to look for. * @return {@link DistributionSet} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -197,11 +163,8 @@ public interface DistributionSetManagement /** * Find distribution set by name and version. * - * @param distributionName - * name of {@link DistributionSet}; case insensitive - * @param version - * version of {@link DistributionSet} - * + * @param distributionName name of {@link DistributionSet}; case insensitive + * @param version version of {@link DistributionSet} * @return the page with the found {@link DistributionSet} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -211,19 +174,11 @@ public interface DistributionSetManagement * Find distribution set by id and throw an exception if it is deleted, * incomplete or invalidated. * - * @param id - * id of {@link DistributionSet} - * + * @param id id of {@link DistributionSet} * @return the found valid {@link DistributionSet} - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist - * - * @throws InvalidDistributionSetException - * if distribution set with given ID is invalidated - * - * @throws IncompleteDistributionSetException - * if distribution set with given ID is incomplete + * @throws EntityNotFoundException if distribution set with given ID does not exist + * @throws InvalidDistributionSetException if distribution set with given ID is invalidated + * @throws IncompleteDistributionSetException if distribution set with given ID is incomplete */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) DistributionSet getValidAndComplete(long id); @@ -232,16 +187,10 @@ public interface DistributionSetManagement * Find distribution set by id and throw an exception if it is deleted or * invalidated. * - * @param id - * id of {@link DistributionSet} - * + * @param id id of {@link DistributionSet} * @return the found valid {@link DistributionSet} - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist - * - * @throws InvalidDistributionSetException - * if distribution set with given ID is invalidated + * @throws EntityNotFoundException if distribution set with given ID does not exist + * @throws InvalidDistributionSetException if distribution set with given ID is invalidated */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) DistributionSet getValid(long id); @@ -250,13 +199,9 @@ public interface DistributionSetManagement * Find distribution set by id and throw an exception if it is (soft) * deleted. * - * @param id - * id of {@link DistributionSet} - * + * @param id id of {@link DistributionSet} * @return the found valid {@link DistributionSet} - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) DistributionSet getOrElseThrowException(long id); @@ -264,16 +209,11 @@ public interface DistributionSetManagement /** * Finds all meta data by the given distribution set id. * - * @param pageable - * the page request to page the result - * @param id - * the distribution set id to retrieve the meta data from - * + * @param pageable the page request to page the result + * @param id the distribution set id to retrieve the meta data from * @return a paged result of all meta data entries for a given distribution * set id - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findMetaDataByDistributionSetId(@NotNull Pageable pageable, long id); @@ -281,13 +221,9 @@ public interface DistributionSetManagement /** * Counts all meta data by the given distribution set id. * - * @param id - * the distribution set id to retrieve the meta data count from - * + * @param id the distribution set id to retrieve the meta data count from * @return count of ds metadata - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) long countMetaDataByDistributionSetId(long id); @@ -295,40 +231,27 @@ public interface DistributionSetManagement /** * Finds all meta data by the given distribution set id. * - * @param pageable - * the page request to page the result - * @param id - * the distribution set id to retrieve the meta data from - * @param rsqlParam - * rsql query string - * + * @param pageable the page request to page the result + * @param id the distribution set id to retrieve the meta data from + * @param rsqlParam rsql query string * @return a paged result of all meta data entries for a given distribution * set id - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong - * - * @throws EntityNotFoundException - * of distribution set with given ID does not exist + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong + * @throws EntityNotFoundException of distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findMetaDataByDistributionSetIdAndRsql(@NotNull Pageable pageable, - long id, @NotNull String rsqlParam); + long id, @NotNull String rsqlParam); /** * Finds all {@link DistributionSet}s based on completeness. * - * @param pageable - * the pagination parameter - * @param complete - * to true for returning only completed distribution - * sets or false for only incomplete ones nor - * null to return both. - * + * @param pageable the pagination parameter + * @param complete to true for returning only completed distribution + * sets or false for only incomplete ones nor + * null to return both. * @return all found {@link DistributionSet}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -337,11 +260,9 @@ public interface DistributionSetManagement /** * Counts all {@link DistributionSet}s based on completeness. * - * @param complete - * to true for counting only completed distribution - * sets or false for only incomplete ones nor - * null to count both. - * + * @param complete to true for counting only completed distribution + * sets or false for only incomplete ones nor + * null to count both. * @return count of all found {@link DistributionSet}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -350,10 +271,8 @@ public interface DistributionSetManagement /** * Retrieves {@link DistributionSet}s by filtering on the given parameters. * - * @param pageable - * page parameter - * @param distributionSetFilter - * has details of filters to be applied. + * @param pageable page parameter + * @param distributionSetFilter has details of filters to be applied. * @return the page of found {@link DistributionSet} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -373,13 +292,9 @@ public interface DistributionSetManagement * 3) {@link DistributionSet}s which have no connection to the given * {@link Target} ordered by ID of the DistributionSet. * - * @param pageable - * the page request to page the result set * - * @param distributionSetFilter - * has details of filters to be applied. - * @param assignedOrInstalled - * the id of the Target to be ordered by - * + * @param pageable the page request to page the result set * + * @param distributionSetFilter has details of filters to be applied. + * @param assignedOrInstalled the id of the Target to be ordered by * @return {@link DistributionSet}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -389,9 +304,7 @@ public interface DistributionSetManagement /** * Counts all {@link DistributionSet}s in repository based on given filter. * - * @param distributionSetFilter - * has details of filters to be applied. - * + * @param distributionSetFilter has details of filters to be applied. * @return count of {@link DistributionSet}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -400,21 +313,13 @@ public interface DistributionSetManagement /** * Retrieves {@link DistributionSet}s by filtering on the given parameters. * - * @param pageable - * page parameter - * @param tagId - * of the tag the DS are assigned to + * @param pageable page parameter + * @param tagId of the tag the DS are assigned to * @return the page of found {@link DistributionSet} - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong - * - * @throws EntityNotFoundException - * of distribution set tag with given ID does not exist + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong + * @throws EntityNotFoundException of distribution set tag with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findByTag(@NotNull Pageable pageable, long tagId); @@ -422,16 +327,11 @@ public interface DistributionSetManagement /** * Retrieves {@link DistributionSet}s by filtering on the given parameters. * - * @param pageable - * page parameter - * @param rsqlParam - * rsql query string - * @param tagId - * of the tag the DS are assigned to + * @param pageable page parameter + * @param rsqlParam rsql query string + * @param tagId of the tag the DS are assigned to * @return the page of found {@link DistributionSet} - * - * @throws EntityNotFoundException - * of distribution set tag with given ID does not exist + * @throws EntityNotFoundException of distribution set tag with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findByRsqlAndTag(@NotNull Pageable pageable, @NotNull String rsqlParam, long tagId); @@ -439,14 +339,10 @@ public interface DistributionSetManagement /** * Finds a single distribution set meta data by its id. * - * @param id - * of the {@link DistributionSet} - * @param key - * of the meta data element + * @param id of the {@link DistributionSet} + * @param key of the meta data element * @return the found DistributionSetMetadata - * - * @throws EntityNotFoundException - * is set with given ID does not exist + * @throws EntityNotFoundException is set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Optional getMetaDataByDistributionSetId(long id, @NotEmpty String key); @@ -455,9 +351,7 @@ public interface DistributionSetManagement * Checks if a {@link DistributionSet} is currently in use by a target in * the repository. * - * @param id - * to check - * + * @param id to check * @return true if in use */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -467,18 +361,12 @@ public interface DistributionSetManagement * Unassigns a {@link SoftwareModule} form an existing * {@link DistributionSet}. * - * @param id - * to get unassigned form - * @param moduleId - * to be unassigned + * @param id to get unassigned form + * @param moduleId to be unassigned * @return the updated {@link DistributionSet}. - * - * @throws EntityNotFoundException - * if given module or DS does not exist - * - * @throws EntityReadOnlyException - * if use tries to change the {@link DistributionSet} s while - * the DS is already in use. + * @throws EntityNotFoundException if given module or DS does not exist + * @throws EntityReadOnlyException if use tries to change the {@link DistributionSet} s while + * the DS is already in use. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) DistributionSet unassignSoftwareModule(long id, long moduleId); @@ -486,15 +374,11 @@ public interface DistributionSetManagement /** * Updates a distribution set meta data value if corresponding entry exists. * - * @param id - * {@link DistributionSet} of the meta data entry to be updated - * @param metadata - * meta data entry to be updated + * @param id {@link DistributionSet} of the meta data entry to be updated + * @param metadata meta data entry to be updated * @return the updated meta data entry - * - * @throws EntityNotFoundException - * in case the meta data entry does not exists and cannot be - * updated + * @throws EntityNotFoundException in case the meta data entry does not exists and cannot be + * updated */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) DistributionSetMetadata updateMetaData(long id, @NotNull MetaData metadata); @@ -503,13 +387,9 @@ public interface DistributionSetManagement * Count all {@link DistributionSet}s in the repository that are not marked * as deleted. * - * @param typeId - * to look for - * + * @param typeId to look for * @return number of {@link DistributionSet}s - * - * @throws EntityNotFoundException - * if type with given ID does not exist + * @throws EntityNotFoundException if type with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) long countByTypeId(long typeId); @@ -518,11 +398,8 @@ public interface DistributionSetManagement * Count all {@link org.eclipse.hawkbit.repository.model.Rollout}s by status for * Distribution Set. * - * @param id - * to look for - * + * @param id to look for * @return List of Statistics for {@link org.eclipse.hawkbit.repository.model.Rollout}s status counts - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) List countRolloutsByStatusForDistributionSet(@NotNull Long id); @@ -531,11 +408,8 @@ public interface DistributionSetManagement * Count all {@link org.eclipse.hawkbit.repository.model.Action}s by status for * Distribution Set. * - * @param id - * to look for - * + * @param id to look for * @return List of Statistics for {@link org.eclipse.hawkbit.repository.model.Action}s status counts - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) List countActionsByStatusForDistributionSet(@NotNull Long id); @@ -544,11 +418,8 @@ public interface DistributionSetManagement * Count all {@link org.eclipse.hawkbit.repository.builder.AutoAssignDistributionSetUpdate}s * for Distribution Set. * - * @param id - * to look for - * + * @param id to look for * @return number of {@link org.eclipse.hawkbit.repository.builder.AutoAssignDistributionSetUpdate}s - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Long countAutoAssignmentsForDistributionSet(@NotNull Long id); @@ -556,8 +427,7 @@ public interface DistributionSetManagement /** * Sets the specified {@link DistributionSet} as invalidated. * - * @param distributionSet - * the ID of the {@link DistributionSet} to be set to invalid + * @param distributionSet the ID of the {@link DistributionSet} to be set to invalid */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) void invalidate(DistributionSet distributionSet); @@ -568,25 +438,24 @@ public interface DistributionSetManagement * the list have the {@link Tag} not yet assigned, they will be. Only if all * of theme have the tag already assigned they will be removed instead. * - * @deprecated since 0.6.0 in favor of assign/unassign * @param ids to toggle for * @param tagName to toggle * @return {@link DistributionSetTagAssignmentResult} with all meta data of the assignment outcome. * @throws EntityNotFoundException if given tag does not exist or (at least one) module + * @deprecated since 0.6.0 in favor of assign/unassign */ @Deprecated(forRemoval = true) @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) DistributionSetTagAssignmentResult toggleTagAssignment(@NotEmpty Collection ids, @NotNull String tagName); - /** * Unassign a {@link DistributionSetTag} assignment to given {@link DistributionSet}. * - * @deprecated since 0.6.0 in favor of unassignTag(List, long) * @param id to unassign for * @param tagId to unassign * @return the unassigned ds or if no ds is unassigned * @throws EntityNotFoundException if set or tag with given ID does not exist + * @deprecated since 0.6.0 in favor of unassignTag(List, long) */ @Deprecated(forRemoval = true) @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetTagManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetTagManagement.java index 360353a72..b4d8a7a2f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetTagManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetTagManagement.java @@ -28,7 +28,6 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Management service for {@link DistributionSetTag}s. - * */ public interface DistributionSetTagManagement extends RepositoryManagement { @@ -36,11 +35,8 @@ public interface DistributionSetTagManagement extends RepositoryManagement findByDistributionSet(@NotNull Pageable pageable, long distributionSetId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetTypeManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetTypeManagement.java index 860edd31d..c236f7333 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetTypeManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/DistributionSetTypeManagement.java @@ -17,9 +17,9 @@ import jakarta.validation.constraints.NotEmpty; import org.eclipse.hawkbit.im.authentication.SpPermission.SpringEvalExpressions; import org.eclipse.hawkbit.repository.builder.DistributionSetTypeCreate; import org.eclipse.hawkbit.repository.builder.DistributionSetTypeUpdate; +import org.eclipse.hawkbit.repository.exception.AssignmentQuotaExceededException; import org.eclipse.hawkbit.repository.exception.EntityNotFoundException; import org.eclipse.hawkbit.repository.exception.EntityReadOnlyException; -import org.eclipse.hawkbit.repository.exception.AssignmentQuotaExceededException; import org.eclipse.hawkbit.repository.model.DistributionSet; import org.eclipse.hawkbit.repository.model.DistributionSetType; import org.eclipse.hawkbit.repository.model.SoftwareModuleType; @@ -27,14 +27,12 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Management service for {@link DistributionSetType}s. - * */ public interface DistributionSetTypeManagement extends RepositoryManagement { /** - * @param key - * as {@link DistributionSetType#getKey()} + * @param key as {@link DistributionSetType#getKey()} * @return {@link DistributionSetType} */ @@ -42,8 +40,7 @@ public interface DistributionSetTypeManagement Optional getByKey(@NotEmpty String key); /** - * @param name - * as {@link DistributionSetType#getName()} + * @param name as {@link DistributionSetType#getName()} * @return {@link DistributionSetType} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -51,48 +48,32 @@ public interface DistributionSetTypeManagement /** * Assigns {@link DistributionSetType#getMandatoryModuleTypes()}. - * - * @param id - * to update - * @param softwareModuleTypeIds - * to assign + * + * @param id to update + * @param softwareModuleTypeIds to assign * @return updated {@link DistributionSetType} - * - * @throws EntityNotFoundException - * in case the {@link DistributionSetType} or at least one of - * the {@link SoftwareModuleType}s do not exist - * - * @throws EntityReadOnlyException - * if the {@link DistributionSetType} while it is already in use - * by a {@link DistributionSet} - * - * @throws AssignmentQuotaExceededException - * if the maximum number of {@link SoftwareModuleType}s is - * exceeded for the addressed {@link DistributionSetType} + * @throws EntityNotFoundException in case the {@link DistributionSetType} or at least one of + * the {@link SoftwareModuleType}s do not exist + * @throws EntityReadOnlyException if the {@link DistributionSetType} while it is already in use + * by a {@link DistributionSet} + * @throws AssignmentQuotaExceededException if the maximum number of {@link SoftwareModuleType}s is + * exceeded for the addressed {@link DistributionSetType} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) DistributionSetType assignOptionalSoftwareModuleTypes(long id, @NotEmpty Collection softwareModuleTypeIds); /** * Assigns {@link DistributionSetType#getOptionalModuleTypes()}. - * - * @param id - * to update - * @param softwareModuleTypeIds - * to assign + * + * @param id to update + * @param softwareModuleTypeIds to assign * @return updated {@link DistributionSetType} - * - * @throws EntityNotFoundException - * in case the {@link DistributionSetType} or at least one of - * the {@link SoftwareModuleType}s do not exist - * - * @throws EntityReadOnlyException - * if the {@link DistributionSetType} while it is already in use - * by a {@link DistributionSet} - * - * @throws AssignmentQuotaExceededException - * if the maximum number of {@link SoftwareModuleType}s is - * exceeded for the addressed {@link DistributionSetType} + * @throws EntityNotFoundException in case the {@link DistributionSetType} or at least one of + * the {@link SoftwareModuleType}s do not exist + * @throws EntityReadOnlyException if the {@link DistributionSetType} while it is already in use + * by a {@link DistributionSet} + * @throws AssignmentQuotaExceededException if the maximum number of {@link SoftwareModuleType}s is + * exceeded for the addressed {@link DistributionSetType} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) DistributionSetType assignMandatorySoftwareModuleTypes(long id, @NotEmpty Collection softwareModuleTypeIds); @@ -101,19 +82,13 @@ public interface DistributionSetTypeManagement * Unassigns a {@link SoftwareModuleType} from the * {@link DistributionSetType}. Does nothing if {@link SoftwareModuleType} * has not been assigned in the first place. - * - * @param id - * to update - * @param softwareModuleTypeId - * to unassign + * + * @param id to update + * @param softwareModuleTypeId to unassign * @return updated {@link DistributionSetType} - * - * @throws EntityNotFoundException - * in case the {@link DistributionSetType} does not exist - * - * @throws EntityReadOnlyException - * if the {@link DistributionSetType} while it is already in use - * by a {@link DistributionSet} + * @throws EntityNotFoundException in case the {@link DistributionSetType} does not exist + * @throws EntityReadOnlyException if the {@link DistributionSetType} while it is already in use + * by a {@link DistributionSet} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) DistributionSetType unassignSoftwareModuleType(long id, long softwareModuleTypeId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/EntityFactory.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/EntityFactory.java index 4a97ad68b..ac770392a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/EntityFactory.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/EntityFactory.java @@ -30,7 +30,6 @@ import org.eclipse.hawkbit.repository.model.MetaData; /** * central {@link BaseEntity} generation service. Objects are created but not * persisted. - * */ public interface EntityFactory { @@ -47,12 +46,9 @@ public interface EntityFactory { /** * Generates an {@link MetaData} element for distribution set without * persisting it. - * - * @param key - * {@link MetaData#getKey()} - * @param value - * {@link MetaData#getValue()} - * + * + * @param key {@link MetaData#getKey()} + * @param value {@link MetaData#getValue()} * @return {@link MetaData} object */ MetaData generateDsMetadata(@Size(min = 1, max = MetaData.KEY_MAX_SIZE) @NotNull String key, @@ -60,12 +56,9 @@ public interface EntityFactory { /** * Generates an {@link MetaData} element for target without persisting it. - * - * @param key - * {@link MetaData#getKey()} - * @param value - * {@link MetaData#getValue()} - * + * + * @param key {@link MetaData#getKey()} + * @param value {@link MetaData#getValue()} * @return {@link MetaData} object */ MetaData generateTargetMetadata(@Size(min = 1, max = MetaData.KEY_MAX_SIZE) @NotNull String key, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/FilterParams.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/FilterParams.java index 8d385e3ae..ef4fd6902 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/FilterParams.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/FilterParams.java @@ -35,21 +35,15 @@ public class FilterParams { /** * Constructor for the filter parameters of a Simple Filter. * - * @param filterByInstalledOrAssignedDistributionSetId - * if set, a filter is added for the given - * {@link DistributionSet#getId()} - * @param filterByStatus - * if set, a filter is added for target states included by the - * collection - * @param overdueState - * if set, a filter is added for overdued devices - * @param filterBySearchText - * if set, a filter is added for the given search text - * @param selectTargetWithNoTag - * if set, tag-filtering is enabled - * @param filterByTagNames - * if tag-filtering is enabled, a filter is added for the given - * tag-names + * @param filterByInstalledOrAssignedDistributionSetId if set, a filter is added for the given + * {@link DistributionSet#getId()} + * @param filterByStatus if set, a filter is added for target states included by the + * collection + * @param overdueState if set, a filter is added for overdued devices + * @param filterBySearchText if set, a filter is added for the given search text + * @param selectTargetWithNoTag if set, tag-filtering is enabled + * @param filterByTagNames if tag-filtering is enabled, a filter is added for the given + * tag-names */ public FilterParams(final Collection filterByStatus, final Boolean overdueState, final String filterBySearchText, final Long filterByInstalledOrAssignedDistributionSetId, @@ -67,18 +61,14 @@ public class FilterParams { /** * Constructor for the filter parameters of a Type Filter. * - * @param filterBySearchText - * if set, a filter is added for the given search text - * @param filterByInstalledOrAssignedDistributionSetId - * if set, a filter is added for the given - * {@link DistributionSet#getId()} - * @param selectTargetWithNoType - * if true, a filter is added with no type - * @param filterByType - * if set, a filter is added for the given target type + * @param filterBySearchText if set, a filter is added for the given search text + * @param filterByInstalledOrAssignedDistributionSetId if set, a filter is added for the given + * {@link DistributionSet#getId()} + * @param selectTargetWithNoType if true, a filter is added with no type + * @param filterByType if set, a filter is added for the given target type */ public FilterParams(final String filterBySearchText, final Long filterByInstalledOrAssignedDistributionSetId, - final Boolean selectTargetWithNoType, final Long filterByType) { + final Boolean selectTargetWithNoType, final Long filterByType) { this.filterBySearchText = filterBySearchText; this.filterByDistributionId = filterByInstalledOrAssignedDistributionSetId; this.filterByStatus = null; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/MaintenanceScheduleHelper.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/MaintenanceScheduleHelper.java index 8b4add976..1470cc577 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/MaintenanceScheduleHelper.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/MaintenanceScheduleHelper.java @@ -16,14 +16,13 @@ import java.time.ZonedDateTime; import java.time.format.DateTimeParseException; import java.util.Optional; -import org.eclipse.hawkbit.repository.exception.InvalidMaintenanceScheduleException; -import org.springframework.util.StringUtils; - import com.cronutils.model.Cron; import com.cronutils.model.CronType; import com.cronutils.model.definition.CronDefinitionBuilder; import com.cronutils.model.time.ExecutionTime; import com.cronutils.parser.CronParser; +import org.eclipse.hawkbit.repository.exception.InvalidMaintenanceScheduleException; +import org.springframework.util.StringUtils; /** * Helper class to check validity of maintenance schedule definition and manage @@ -43,23 +42,18 @@ public final class MaintenanceScheduleHelper { /** * Calculate the next available maintenance window. * - * @param cronSchedule - * is a cron expression with 6 mandatory fields and 1 last - * optional field: "second minute hour dayofmonth month weekday - * year". - * @param duration - * in HH:mm:ss format specifying the duration of a maintenance - * window, for example 00:30:00 for 30 minutes. - * @param timezone - * is the time zone specified as +/-hh:mm offset from UTC. For - * example +02:00 for CET summer time and +00:00 for UTC. The - * start time of a maintenance window calculated based on the - * cron expression is relative to this time zone. - * + * @param cronSchedule is a cron expression with 6 mandatory fields and 1 last + * optional field: "second minute hour dayofmonth month weekday + * year". + * @param duration in HH:mm:ss format specifying the duration of a maintenance + * window, for example 00:30:00 for 30 minutes. + * @param timezone is the time zone specified as +/-hh:mm offset from UTC. For + * example +02:00 for CET summer time and +00:00 for UTC. The + * start time of a maintenance window calculated based on the + * cron expression is relative to this time zone. * @return { @link Optional} of the next available window. In * case there is none, or there are maintenance window validation * errors, returns empty value. - * */ // Exception squid:S1166 - if there are validation error(format of cron // expression or duration is wrong), we simply return empty value @@ -79,15 +73,11 @@ public final class MaintenanceScheduleHelper { /** * Parse the given cron expression with quartz parser. * - * @param cronSchedule - * is a cron expression with 6 mandatory fields and 1 last - * optional field: "second minute hour dayofmonth month weekday - * year". - * + * @param cronSchedule is a cron expression with 6 mandatory fields and 1 last + * optional field: "second minute hour dayofmonth month weekday + * year". * @return {@link Cron} object, that corresponds to the expression. - * - * @throws IllegalArgumentException - * if the cron expression doesn't have a valid format. + * @throws IllegalArgumentException if the cron expression doesn't have a valid format. */ public static Cron getCronFromExpression(final String cronSchedule) { return cronParser.parse(cronSchedule); @@ -100,21 +90,16 @@ public final class MaintenanceScheduleHelper { * either all the parameters: schedule, duration and time zone are valid or * are null. * - * @param cronSchedule - * is a cron expression with 6 mandatory fields and 1 last - * optional field: "second minute hour dayofmonth month weekday - * year". - * @param duration - * in HH:mm:ss format specifying the duration of a maintenance - * window, for example 00:30:00 for 30 minutes. - * @param timezone - * is the time zone specified as +/-hh:mm offset from UTC. For - * example +02:00 for CET summer time and +00:00 for UTC. The - * start time of a maintenance window calculated based on the - * cron expression is relative to this time zone. - * - * @throws InvalidMaintenanceScheduleException - * if the defined schedule fails the validity criteria. + * @param cronSchedule is a cron expression with 6 mandatory fields and 1 last + * optional field: "second minute hour dayofmonth month weekday + * year". + * @param duration in HH:mm:ss format specifying the duration of a maintenance + * window, for example 00:30:00 for 30 minutes. + * @param timezone is the time zone specified as +/-hh:mm offset from UTC. For + * example +02:00 for CET summer time and +00:00 for UTC. The + * start time of a maintenance window calculated based on the + * cron expression is relative to this time zone. + * @throws InvalidMaintenanceScheduleException if the defined schedule fails the validity criteria. */ public static void validateMaintenanceSchedule(final String cronSchedule, final String duration, final String timezone) { @@ -133,47 +118,28 @@ public final class MaintenanceScheduleHelper { } } - private static boolean atLeastOneNotEmpty(final String cronSchedule, final String duration, final String timezone) { - return !(StringUtils.isEmpty(cronSchedule) && StringUtils.isEmpty(duration) && StringUtils.isEmpty(timezone)); - } - - private static boolean allNotEmpty(final String cronSchedule, final String duration, final String timezone) { - return !StringUtils.isEmpty(cronSchedule) && !StringUtils.isEmpty(duration) && !StringUtils.isEmpty(timezone); - } - /** * Convert the time interval or duration specified in "HH:mm:ss" format to * ISO format. * - * @param timeInterval - * in "HH:mm:ss" string format. This format is popularly used but - * can be confused with time of the day, hence conversion to ISO - * specified format for time duration is required. - * + * @param timeInterval in "HH:mm:ss" string format. This format is popularly used but + * can be confused with time of the day, hence conversion to ISO + * specified format for time duration is required. * @return {@link Duration} in ISO format. - * - * @throws DateTimeParseException - * if the text cannot be converted to ISO format. + * @throws DateTimeParseException if the text cannot be converted to ISO format. */ public static Duration convertToISODuration(final String timeInterval) { return Duration.between(LocalTime.MIN, convertDurationToLocalTime(timeInterval)); } - private static LocalTime convertDurationToLocalTime(final String timeInterval) { - return LocalTime.parse(StringUtils.trimWhitespace(timeInterval)); - } - /** * Validates the format of the maintenance window duration * - * @param duration - * in "HH:mm:ss" string format. This format is popularly used but - * can be confused with time of the day, hence conversion to ISO - * specified format for time duration is required. - * - * @throws InvalidMaintenanceScheduleException - * if the duration doesn't have a valid format to be converted - * to ISO. + * @param duration in "HH:mm:ss" string format. This format is popularly used but + * can be confused with time of the day, hence conversion to ISO + * specified format for time duration is required. + * @throws InvalidMaintenanceScheduleException if the duration doesn't have a valid format to be converted + * to ISO. */ public static void validateDuration(final String duration) { try { @@ -188,13 +154,10 @@ public final class MaintenanceScheduleHelper { /** * Validates the format of the maintenance window cron expression * - * @param cronSchedule - * is a cron expression with 6 mandatory fields and 1 last - * optional field: "second minute hour dayofmonth month weekday - * year". - * - * @throws InvalidMaintenanceScheduleException - * if the cron expression doesn't have a valid quartz format. + * @param cronSchedule is a cron expression with 6 mandatory fields and 1 last + * optional field: "second minute hour dayofmonth month weekday + * year". + * @throws InvalidMaintenanceScheduleException if the cron expression doesn't have a valid quartz format. */ public static void validateCronSchedule(final String cronSchedule) { try { @@ -205,4 +168,16 @@ public final class MaintenanceScheduleHelper { throw new InvalidMaintenanceScheduleException(e.getMessage(), e); } } + + private static boolean atLeastOneNotEmpty(final String cronSchedule, final String duration, final String timezone) { + return !(StringUtils.isEmpty(cronSchedule) && StringUtils.isEmpty(duration) && StringUtils.isEmpty(timezone)); + } + + private static boolean allNotEmpty(final String cronSchedule, final String duration, final String timezone) { + return !StringUtils.isEmpty(cronSchedule) && !StringUtils.isEmpty(duration) && !StringUtils.isEmpty(timezone); + } + + private static LocalTime convertDurationToLocalTime(final String timeInterval) { + return LocalTime.parse(StringUtils.trimWhitespace(timeInterval)); + } } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/OffsetBasedPageRequest.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/OffsetBasedPageRequest.java index b024dbf3a..17a947c1f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/OffsetBasedPageRequest.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/OffsetBasedPageRequest.java @@ -30,11 +30,9 @@ public final class OffsetBasedPageRequest extends PageRequest { /** * Creates a new {@link OffsetBasedPageRequest}. Offsets are zero indexed, * thus providing 0 for {@code offset} will return the first entry. - * - * @param offset - * zero-based offset index. - * @param limit - * the limit of the page to be returned. + * + * @param offset zero-based offset index. + * @param limit the limit of the page to be returned. */ public OffsetBasedPageRequest(final long offset, final int limit) { this(offset, limit, Sort.unsorted()); @@ -43,13 +41,10 @@ public final class OffsetBasedPageRequest extends PageRequest { /** * Creates a new {@link OffsetBasedPageRequest}. Offsets are zero indexed, * thus providing 0 for {@code offset} will return the first entry. - * - * @param offset - * zero-based offset index. - * @param limit - * the limit of the page to be returned. - * @param sort - * sort can be {@literal null}. + * + * @param offset zero-based offset index. + * @param limit the limit of the page to be returned. + * @param sort sort can be {@literal null}. */ public OffsetBasedPageRequest(final long offset, final int limit, final Sort sort) { super(0, limit, sort); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/QuotaManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/QuotaManagement.java index 42763b4ed..2afce90c9 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/QuotaManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/QuotaManagement.java @@ -16,7 +16,6 @@ import org.eclipse.hawkbit.repository.model.RolloutGroup; /** * Central service for defined limits of the repository. - * */ public interface QuotaManagement { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RegexCharacterCollection.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RegexCharacterCollection.java index b5fd5399e..50671c957 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RegexCharacterCollection.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RegexCharacterCollection.java @@ -43,7 +43,7 @@ public class RegexCharacterCollection { public enum RegexChar { WHITESPACE("\\s", "character.whitespace"), DIGITS("0-9", "character.digits"), QUOTATION_MARKS("'\"", "character.quotationMarks"), SLASHES("\\/\\\\", "character.slashes"), GREATER_THAN( - ">"), LESS_THAN("<"), EQUALS_SYMBOL("="), EXCLAMATION_MARK("!"), QUESTION_MARK("?"), COLON(":"); + ">"), LESS_THAN("<"), EQUALS_SYMBOL("="), EXCLAMATION_MARK("!"), QUESTION_MARK("?"), COLON(":"); private final String regExp; private final String l18nReferenceDescription; @@ -51,7 +51,7 @@ public class RegexCharacterCollection { RegexChar(final String character) { this(character, null); } - + RegexChar(final String regExp, final String l18nReferenceDescription) { this.regExp = regExp; this.l18nReferenceDescription = l18nReferenceDescription; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RepositoryConstants.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RepositoryConstants.java index 9ceb2a7d3..9b188f982 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RepositoryConstants.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RepositoryConstants.java @@ -16,7 +16,6 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleMetadata; /** * Repository constants. - * */ public final class RepositoryConstants { @@ -46,7 +45,7 @@ public final class RepositoryConstants { /** * Maximum number of metadata entries provided to controllers. - * + * * @see SoftwareModuleMetadata#isTargetVisible() */ public static final int MAX_META_DATA_COUNT = 50; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RepositoryManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RepositoryManagement.java index 470baf678..98f21bb0c 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RepositoryManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RepositoryManagement.java @@ -32,25 +32,19 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Generic management methods common to (software) repository content. * - * @param - * type of the {@link BaseEntity} - * @param - * entity create builder - * @param - * entity update builder + * @param type of the {@link BaseEntity} + * @param entity create builder + * @param entity update builder */ public interface RepositoryManagement { /** * Creates multiple {@link BaseEntity}s. * - * @param creates - * to create + * @param creates to create * @return created Entity - * - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link BaseEntity} for field constraints. + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link BaseEntity} for field constraints. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_CREATE_REPOSITORY) List create(@NotNull @Valid Collection creates); @@ -58,13 +52,10 @@ public interface RepositoryManagement { /** * Creates new {@link BaseEntity}. * - * @param create - * to create + * @param create to create * @return created Entity - * - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link BaseEntity} for field constraints. + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link BaseEntity} for field constraints. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_CREATE_REPOSITORY) T create(@NotNull @Valid C create); @@ -72,20 +63,14 @@ public interface RepositoryManagement { /** * Updates existing {@link BaseEntity}. * - * @param update - * to update - * + * @param update to update * @return updated Entity - * - * @throws EntityReadOnlyException - * if the {@link BaseEntity} cannot be updated (e.g. is already - * in use) - * @throws EntityNotFoundException - * in case the {@link BaseEntity} does not exists and cannot be - * updated - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link BaseEntity} for field constraints. + * @throws EntityReadOnlyException if the {@link BaseEntity} cannot be updated (e.g. is already + * in use) + * @throws EntityNotFoundException in case the {@link BaseEntity} does not exists and cannot be + * updated + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link BaseEntity} for field constraints. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) T update(@NotNull @Valid U update); @@ -99,11 +84,8 @@ public interface RepositoryManagement { /** * Deletes or marks as delete in case the {@link BaseEntity} is in use. * - * @param id - * to delete - * - * @throws EntityNotFoundException - * BaseEntity with given ID does not exist + * @param id to delete + * @throws EntityNotFoundException BaseEntity with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_DELETE_REPOSITORY) void delete(long id); @@ -113,11 +95,8 @@ public interface RepositoryManagement { * the entities have been linked to another entity before or a hard delete * if not. * - * @param ids - * to be deleted - * - * @throws EntityNotFoundException - * if (at least one) given distribution set does not exist + * @param ids to be deleted + * @throws EntityNotFoundException if (at least one) given distribution set does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_DELETE_REPOSITORY) void delete(@NotEmpty Collection ids); @@ -125,8 +104,7 @@ public interface RepositoryManagement { /** * Retrieves all {@link BaseEntity}s without details. * - * @param ids - * the ids to for + * @param ids the ids to for * @return the found {@link BaseEntity}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -134,9 +112,8 @@ public interface RepositoryManagement { /** * Verifies that {@link BaseEntity} with given ID exists in the repository. - * - * @param id - * of entity to check existence + * + * @param id of entity to check existence * @return true if entity with given ID exists */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -145,8 +122,7 @@ public interface RepositoryManagement { /** * Retrieve {@link BaseEntity} * - * @param id - * to search for + * @param id to search for * @return {@link BaseEntity} in the repository with given * {@link BaseEntity#getId()} */ @@ -155,9 +131,8 @@ public interface RepositoryManagement { /** * Retrieves {@link Page} of all {@link BaseEntity} of given type. - * - * @param pageable - * paging parameter + * + * @param pageable paging parameter * @return all {@link BaseEntity}s in the repository. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -165,19 +140,13 @@ public interface RepositoryManagement { /** * Retrieves all {@link BaseEntity}s with a given specification. - * - * @param pageable - * pagination parameter - * @param rsqlParam - * filter definition in RSQL syntax * + * @param pageable pagination parameter + * @param rsqlParam filter definition in RSQL syntax * @return the found {@link BaseEntity}s - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findByRsql(@NotNull Pageable pageable, @NotNull String rsqlParam); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutExecutor.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutExecutor.java index 3f386e013..7f5ae019f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutExecutor.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutExecutor.java @@ -24,7 +24,7 @@ public interface RolloutExecutor { /** * This execution should only be triggered by the system as a background job and * not available via API. - * + * * Process rollout based on its current {@link Rollout#getStatus()}. * * For {@link RolloutStatus#CREATING} that means creating the diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutGroupManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutGroupManagement.java index 969173fa7..d160a4b50 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutGroupManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutGroupManagement.java @@ -27,42 +27,32 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Repository management service for RolloutGroup. - * */ public interface RolloutGroupManagement { /** * Retrieves a page of {@link RolloutGroup}s filtered by a given * {@link Rollout} with the detailed status. - * - * @param pageable - * the page request to sort and limit the result - * @param rolloutId - * the ID of the rollout to filter the {@link RolloutGroup}s - * + * + * @param pageable the page request to sort and limit the result + * @param rolloutId the ID of the rollout to filter the {@link RolloutGroup}s * @return a page of found {@link RolloutGroup}s - * - * @throws EntityNotFoundException - * of rollout with given ID does not exist + * @throws EntityNotFoundException of rollout with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) Page findByRolloutWithDetailedStatus(@NotNull Pageable pageable, long rolloutId); /** - * * Find all targets with action status by rollout group id. The action * status might be {@code null} if for the target within the rollout no * actions as been created, e.g. the target already had assigned the same * distribution set we do not create an action for it but the target is in * the result list of the rollout-group. - * - * @param pageable - * the page request to sort and limit the result - * @param rolloutGroupId - * rollout group + * + * @param pageable the page request to sort and limit the result + * @param rolloutGroupId rollout group * @return {@link TargetWithActionStatus} target with action status - * @throws EntityNotFoundException - * if rollout group with given ID does not exist + * @throws EntityNotFoundException if rollout group with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ_AND_TARGET_READ) Page findAllTargetsOfRolloutGroupWithActionStatus(@NotNull Pageable pageable, @@ -70,12 +60,10 @@ public interface RolloutGroupManagement { /** * Retrieves a single {@link RolloutGroup} by its ID. - * - * @param rolloutGroupId - * the ID of the rollout group to find + * + * @param rolloutGroupId the ID of the rollout group to find * @return the found {@link RolloutGroup} by its ID or {@code null} if it * does not exists - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) Optional get(long rolloutGroupId); @@ -83,47 +71,32 @@ public interface RolloutGroupManagement { /** * Retrieves a page of {@link RolloutGroup}s filtered by a given * {@link Rollout} and the an rsql filter. - * - * @param pageable - * the page request to sort and limit the result - * @param rolloutId - * the rollout to filter the {@link RolloutGroup}s - * @param rsqlParam - * the specification to filter the result set based on attributes - * of the {@link RolloutGroup} - * + * + * @param pageable the page request to sort and limit the result + * @param rolloutId the rollout to filter the {@link RolloutGroup}s + * @param rsqlParam the specification to filter the result set based on attributes + * of the {@link RolloutGroup} * @return a page of found {@link RolloutGroup}s - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) Page findByRolloutAndRsql(@NotNull Pageable pageable, long rolloutId, @NotNull String rsqlParam); - - + /** * Retrieves a page of {@link RolloutGroup}s filtered by a given * {@link Rollout} and a rsql filter with detailed status. - * - * @param pageable - * the page request to sort and limit the result - * @param rolloutId - * the rollout to filter the {@link RolloutGroup}s - * @param rsqlParam - * the specification to filter the result set based on attributes - * of the {@link RolloutGroup} - * + * + * @param pageable the page request to sort and limit the result + * @param rolloutId the rollout to filter the {@link RolloutGroup}s + * @param rsqlParam the specification to filter the result set based on attributes + * of the {@link RolloutGroup} * @return a page of found {@link RolloutGroup}s - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) Page findByRolloutAndRsqlWithDetailedStatus(@NotNull Pageable pageable, long rolloutId, @@ -132,12 +105,9 @@ public interface RolloutGroupManagement { /** * Retrieves a page of {@link RolloutGroup}s filtered by a given * {@link Rollout}. - * - * @param pageable - * the page request to sort and limit the result - * @param rolloutId - * the ID of the rollout to filter the {@link RolloutGroup}s - * + * + * @param pageable the page request to sort and limit the result + * @param rolloutId the ID of the rollout to filter the {@link RolloutGroup}s * @return a page of found {@link RolloutGroup}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) @@ -146,11 +116,9 @@ public interface RolloutGroupManagement { /** * Retrieves a page of {@link RolloutGroup}s filtered by a given * {@link Rollout}. - * - * @param rolloutId - * the ID of the rollout to filter the {@link RolloutGroup}s - * @param pageable - * the page request to sort and limit the result + * + * @param rolloutId the ID of the rollout to filter the {@link RolloutGroup}s + * @param pageable the page request to sort and limit the result * @return a page of found {@link RolloutGroup}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) @@ -158,37 +126,25 @@ public interface RolloutGroupManagement { /** * Get targets of specified rollout group. - * - * @param pageable - * the page request to sort and limit the result - * @param rolloutGroupId - * rollout group - * + * + * @param pageable the page request to sort and limit the result + * @param rolloutGroupId rollout group * @return Page list of targets of a rollout group - * - * @throws EntityNotFoundException - * if group with ID does not exist + * @throws EntityNotFoundException if group with ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ_AND_TARGET_READ) Page findTargetsOfRolloutGroup(@NotNull Pageable pageable, long rolloutGroupId); /** * Get targets of specified rollout group. - * - * @param pageable - * the page request to sort and limit the result - * @param rolloutGroupId - * rollout group - * @param rsqlParam - * the specification for filtering the targets of a rollout group - * + * + * @param pageable the page request to sort and limit the result + * @param rolloutGroupId rollout group + * @param rsqlParam the specification for filtering the targets of a rollout group * @return Page list of targets of a rollout group - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ_AND_TARGET_READ) Page findTargetsOfRolloutGroupByRsql(@NotNull Pageable pageable, long rolloutGroupId, @@ -197,23 +153,18 @@ public interface RolloutGroupManagement { /** * Get {@link RolloutGroup} by Id. * - * @param rolloutGroupId - * rollout group id + * @param rolloutGroupId rollout group id * @return rolloutGroup with details of targets count for different statuses - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) Optional getWithDetailedStatus(long rolloutGroupId); /** * Count targets of rollout group. - * - * @param rolloutGroupId - * the rollout group id for the count + * + * @param rolloutGroupId the rollout group id for the count * @return the target rollout group count - * - * @throws EntityNotFoundException - * if rollout group with given ID does not exist + * @throws EntityNotFoundException if rollout group with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) long countTargetsOfRolloutsGroup(long rolloutGroupId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutHandler.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutHandler.java index 6ca8d92a3..3854361df 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutHandler.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutHandler.java @@ -46,7 +46,6 @@ public interface RolloutHandler { * case rollout was already {@link Rollout.RolloutStatus#RUNNING} which results * in status change {@link Rollout.RolloutStatus#DELETED} or hard delete from * the persistence otherwise. - * */ @PreAuthorize(SpringEvalExpressions.IS_SYSTEM_CODE) void handleAll(); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutManagement.java index 1b45771e2..a57794b41 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/RolloutManagement.java @@ -59,8 +59,7 @@ public interface RolloutManagement { /** * Count rollouts by given text in name or description. * - * @param searchText - * name or description + * @param searchText name or description * @return total count rollouts for specified filter text. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) @@ -72,8 +71,7 @@ public interface RolloutManagement { *

    * No access control applied * - * @param setId - * the distribution set + * @param setId the distribution set * @return the count */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) @@ -94,25 +92,17 @@ public interface RolloutManagement { * targets have been assigned to the groups, the rollout status is changed to * {@link RolloutStatus#READY} so it can be started with . * - * @param create - * the rollout entity to create - * @param amountGroup - * the amount of groups to split the rollout into - * @param confirmationRequired - * if a confirmation is required by the device group(s) of the rollout - * @param conditions - * the rolloutgroup conditions and actions which should be applied - * for each {@link RolloutGroup} + * @param create the rollout entity to create + * @param amountGroup the amount of groups to split the rollout into + * @param confirmationRequired if a confirmation is required by the device group(s) of the rollout + * @param conditions the rolloutgroup conditions and actions which should be applied + * for each {@link RolloutGroup} * @param dynamicRolloutGroupTemplate the template for dynamic rollout groups * @return the persisted rollout. - * - * @throws EntityNotFoundException - * if given {@link DistributionSet} does not exist - * @throws ConstraintViolationException - * if rollout or group parameters are invalid. - * @throws AssignmentQuotaExceededException - * if the maximum number of allowed targets per rollout group is - * exceeded. + * @throws EntityNotFoundException if given {@link DistributionSet} does not exist + * @throws ConstraintViolationException if rollout or group parameters are invalid. + * @throws AssignmentQuotaExceededException if the maximum number of allowed targets per rollout group is + * exceeded. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_CREATE) Rollout create(@NotNull @Valid RolloutCreate create, int amountGroup, boolean confirmationRequired, @@ -133,24 +123,16 @@ public interface RolloutManagement { * targets have been assigned to the groups, the rollout status is changed to * {@link RolloutStatus#READY} so it can be started with . * - * @param create - * the rollout entity to create - * @param amountGroup - * the amount of groups to split the rollout into - * @param confirmationRequired - * if a confirmation is required by the device group(s) of the rollout - * @param conditions - * the rolloutgroup conditions and actions which should be applied - * for each {@link RolloutGroup} + * @param create the rollout entity to create + * @param amountGroup the amount of groups to split the rollout into + * @param confirmationRequired if a confirmation is required by the device group(s) of the rollout + * @param conditions the rolloutgroup conditions and actions which should be applied + * for each {@link RolloutGroup} * @return the persisted rollout. - * - * @throws EntityNotFoundException - * if given {@link DistributionSet} does not exist - * @throws ConstraintViolationException - * if rollout or group parameters are invalid. - * @throws AssignmentQuotaExceededException - * if the maximum number of allowed targets per rollout group is - * exceeded. + * @throws EntityNotFoundException if given {@link DistributionSet} does not exist + * @throws ConstraintViolationException if rollout or group parameters are invalid. + * @throws AssignmentQuotaExceededException if the maximum number of allowed targets per rollout group is + * exceeded. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_CREATE) Rollout create(@NotNull @Valid RolloutCreate create, int amountGroup, boolean confirmationRequired, @@ -172,23 +154,16 @@ public interface RolloutManagement { * {@link RolloutStatus#READY} so it can be started with * {@link #start(long)}. * - * @param rollout - * the rollout entity to create - * @param groups - * optional definition of groups - * @param conditions - * the rollout group conditions and actions which should be applied - * for each {@link RolloutGroup} if not defined by the RolloutGroup - * itself + * @param rollout the rollout entity to create + * @param groups optional definition of groups + * @param conditions the rollout group conditions and actions which should be applied + * for each {@link RolloutGroup} if not defined by the RolloutGroup + * itself * @return the persisted rollout. - * - * @throws EntityNotFoundException - * if given {@link DistributionSet} does not exist - * @throws ConstraintViolationException - * if rollout or group parameters are invalid - * @throws AssignmentQuotaExceededException - * if the maximum number of allowed targets per rollout group is - * exceeded. + * @throws EntityNotFoundException if given {@link DistributionSet} does not exist + * @throws ConstraintViolationException if rollout or group parameters are invalid + * @throws AssignmentQuotaExceededException if the maximum number of allowed targets per rollout group is + * exceeded. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_CREATE) Rollout create(@Valid @NotNull RolloutCreate rollout, @NotNull @Valid List groups, @@ -198,20 +173,14 @@ public interface RolloutManagement { * Calculates how many targets are addressed by each rollout group and * returns the validation information. * - * @param groups - * a list of rollout groups - * @param targetFilter - * the rollout - * @param createdAt - * timestamp when the rollout was created - * @param dsTypeId - * ID of the type of distribution set of the rollout + * @param groups a list of rollout groups + * @param targetFilter the rollout + * @param createdAt timestamp when the rollout was created + * @param dsTypeId ID of the type of distribution set of the rollout * @return the validation information - * @throws RolloutIllegalStateException - * thrown when no targets are targeted by the rollout - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link RolloutGroupCreate} for field constraints. + * @throws RolloutIllegalStateException thrown when no targets are targeted by the rollout + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link RolloutGroupCreate} for field constraints. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ_AND_TARGET_READ) ListenableFuture validateTargetsInGroups(@Valid List groups, @@ -220,10 +189,8 @@ public interface RolloutManagement { /** * Retrieves all rollouts. * - * @param pageable - * the page request to sort and limit the result - * @param deleted - * flag if deleted rollouts should be included + * @param pageable the page request to sort and limit the result + * @param deleted flag if deleted rollouts should be included * @return a page of found rollouts */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) @@ -232,10 +199,8 @@ public interface RolloutManagement { /** * Get count of targets in different status in rollout. * - * @param pageable - * the page request to sort and limit the result - * @param deleted - * flag if deleted rollouts should be included + * @param pageable the page request to sort and limit the result + * @param deleted flag if deleted rollouts should be included * @return a list of rollouts with details of targets count for different * statuses */ @@ -245,20 +210,13 @@ public interface RolloutManagement { /** * Retrieves all rollouts found by the given specification. * - * @param pageable - * the page request to sort and limit the result - * @param rsqlParam - * the specification to filter rollouts - * @param deleted - * flag if deleted rollouts should be included - * + * @param pageable the page request to sort and limit the result + * @param rsqlParam the specification to filter rollouts + * @param deleted flag if deleted rollouts should be included * @return a page of found rollouts - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) Page findByRsql(@NotNull Pageable pageable, @NotNull String rsqlParam, boolean deleted); @@ -266,12 +224,9 @@ public interface RolloutManagement { /** * Finds rollouts by given text in name or description. * - * @param pageable - * the page request to sort and limit the result - * @param searchText - * search text which matches name or description of rollout - * @param deleted - * flag if deleted rollouts should be included + * @param pageable the page request to sort and limit the result + * @param searchText search text which matches name or description of rollout + * @param deleted flag if deleted rollouts should be included * @return the founded rollout or {@code null} if rollout with given ID does * not exists */ @@ -281,7 +236,7 @@ public interface RolloutManagement { /** * Find rollouts which are still active and needs to be handled. - * + * * @return a list of active rollouts */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) @@ -290,8 +245,7 @@ public interface RolloutManagement { /** * Retrieves a specific rollout by its ID. * - * @param rolloutId - * the ID of the rollout to retrieve + * @param rolloutId the ID of the rollout to retrieve * @return the founded rollout or {@code null} if rollout with given ID does * not exists */ @@ -301,8 +255,7 @@ public interface RolloutManagement { /** * Retrieves a specific rollout by its name. * - * @param rolloutName - * the name of the rollout to retrieve + * @param rolloutName the name of the rollout to retrieve * @return the founded rollout or {@code null} if rollout with given name * does not exists */ @@ -312,11 +265,8 @@ public interface RolloutManagement { /** * Get count of targets in different status in rollout. * - * @param rolloutId - * rollout id + * @param rolloutId rollout id * @return rollout details of targets count for different statuses - * - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_READ) Optional getWithDetailedStatus(long rolloutId); @@ -324,9 +274,7 @@ public interface RolloutManagement { /** * Checks if rollout with given ID exists. * - * @param rolloutId - * rollout id - * + * @param rolloutId rollout id * @return true if rollout exists */ boolean exists(long rolloutId); @@ -343,15 +291,10 @@ public interface RolloutManagement { * sufficient due the {@link #checkRunningRollouts(long)} will not check * this rollout anymore. * - * @param rolloutId - * the rollout to be paused. - * - * @throws EntityNotFoundException - * if rollout or group with given ID does not exist - * @throws RolloutIllegalStateException - * if given rollout is not in {@link RolloutStatus#RUNNING}. - * Only running rollouts can be paused. - * + * @param rolloutId the rollout to be paused. + * @throws EntityNotFoundException if rollout or group with given ID does not exist + * @throws RolloutIllegalStateException if given rollout is not in {@link RolloutStatus#RUNNING}. + * Only running rollouts can be paused. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_HANDLE) void pauseRollout(long rolloutId); @@ -361,14 +304,10 @@ public interface RolloutManagement { * {@link RolloutStatus#RUNNING} state which is then picked up again by the * {@link #checkRunningRollouts(long)}. * - * @param rolloutId - * the rollout to be resumed - * - * @throws EntityNotFoundException - * if rollout with given ID does not exist - * @throws RolloutIllegalStateException - * if given rollout is not in {@link RolloutStatus#PAUSED}. Only - * paused rollouts can be resumed. + * @param rolloutId the rollout to be resumed + * @throws EntityNotFoundException if rollout with given ID does not exist + * @throws RolloutIllegalStateException if given rollout is not in {@link RolloutStatus#PAUSED}. Only + * paused rollouts can be resumed. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_HANDLE) void resumeRollout(long rolloutId); @@ -379,19 +318,13 @@ public interface RolloutManagement { * it switches state to {@link RolloutStatus#READY}, otherwise it switches * to state {@link RolloutStatus#APPROVAL_DENIED} * - * @param rolloutId - * the rollout to be approved or denied. - * @param decision - * decision whether a rollout is approved or denied. - * + * @param rolloutId the rollout to be approved or denied. + * @param decision decision whether a rollout is approved or denied. * @return approved or denied rollout - * - * @throws EntityNotFoundException - * if rollout with given ID does not exist - * @throws RolloutIllegalStateException - * if given rollout is not in - * {@link RolloutStatus#WAITING_FOR_APPROVAL}. Only rollouts - * waiting for approval can be acted upon. + * @throws EntityNotFoundException if rollout with given ID does not exist + * @throws RolloutIllegalStateException if given rollout is not in + * {@link RolloutStatus#WAITING_FOR_APPROVAL}. Only rollouts + * waiting for approval can be acted upon. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_APPROVE) Rollout approveOrDeny(long rolloutId, Rollout.ApprovalDecision decision); @@ -402,21 +335,14 @@ public interface RolloutManagement { * it switches state to {@link RolloutStatus#READY}, otherwise it switches * to state {@link RolloutStatus#APPROVAL_DENIED} * - * @param rolloutId - * the rollout to be approved or denied. - * @param decision - * decision whether a rollout is approved or denied. - * @param remark - * user remark on approve / deny decision - * + * @param rolloutId the rollout to be approved or denied. + * @param decision decision whether a rollout is approved or denied. + * @param remark user remark on approve / deny decision * @return approved or denied rollout - * - * @throws EntityNotFoundException - * if rollout with given ID does not exist - * @throws RolloutIllegalStateException - * if given rollout is not in - * {@link RolloutStatus#WAITING_FOR_APPROVAL}. Only rollouts - * waiting for approveOrDeny can be acted upon. + * @throws EntityNotFoundException if rollout with given ID does not exist + * @throws RolloutIllegalStateException if given rollout is not in + * {@link RolloutStatus#WAITING_FOR_APPROVAL}. Only rollouts + * waiting for approveOrDeny can be acted upon. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_APPROVE) Rollout approveOrDeny(long rolloutId, Rollout.ApprovalDecision decision, String remark); @@ -428,16 +354,11 @@ public interface RolloutManagement { * all actions are created and the first group is started. The rollout * itself will be then also in {@link RolloutStatus#RUNNING}. * - * @param rolloutId - * the rollout to be started - * + * @param rolloutId the rollout to be started * @return started rollout - * - * @throws EntityNotFoundException - * if rollout with given ID does not exist - * @throws RolloutIllegalStateException - * if given rollout is not in {@link RolloutStatus#READY}. Only - * ready rollouts can be started. + * @throws EntityNotFoundException if rollout with given ID does not exist + * @throws RolloutIllegalStateException if given rollout is not in {@link RolloutStatus#READY}. Only + * ready rollouts can be started. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_HANDLE) Rollout start(long rolloutId); @@ -445,17 +366,11 @@ public interface RolloutManagement { /** * Update rollout details. * - * @param update - * rollout to be updated - * + * @param update rollout to be updated * @return Rollout updated rollout - * - * @throws EntityNotFoundException - * if rollout or DS with given IDs do not exist - * @throws EntityReadOnlyException - * if rollout is in soft deleted state, i.e. only kept as - * reference - * + * @throws EntityNotFoundException if rollout or DS with given IDs do not exist + * @throws EntityReadOnlyException if rollout is in soft deleted state, i.e. only kept as + * reference */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_UPDATE) Rollout update(@NotNull @Valid RolloutUpdate update); @@ -464,9 +379,7 @@ public interface RolloutManagement { * Deletes a rollout. A rollout might be deleted asynchronously by * indicating the rollout by {@link RolloutStatus#DELETING} * - * - * @param rolloutId - * the ID of the rollout to be deleted + * @param rolloutId the ID of the rollout to be deleted */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_DELETE) void delete(long rolloutId); @@ -476,9 +389,8 @@ public interface RolloutManagement { * This is called when a distribution set is invalidated and the cancel * rollouts option is activated. * - * @param set - * the {@link DistributionSet} for that the rollouts should be - * canceled + * @param set the {@link DistributionSet} for that the rollouts should be + * canceled */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_UPDATE) void cancelRolloutsForDistributionSet(DistributionSet set); @@ -487,14 +399,9 @@ public interface RolloutManagement { * Triggers next group of a rollout for processing even success threshold * isn't met yet. Current running groups will not change their status. * - * @param rolloutId - * the rollout to be paused. - * - * @throws EntityNotFoundException - * if rollout or group with given ID does not exist - * @throws RolloutIllegalStateException - * if given rollout is not in {@link RolloutStatus#RUNNING}. - * + * @param rolloutId the rollout to be paused. + * @throws EntityNotFoundException if rollout or group with given ID does not exist + * @throws RolloutIllegalStateException if given rollout is not in {@link RolloutStatus#RUNNING}. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_UPDATE) void triggerNextGroup(long rolloutId); @@ -502,9 +409,7 @@ public interface RolloutManagement { /** * Enrich the rollouts Slice with additional details * - * @param rollouts - * the rollouts to be enriched. - * + * @param rollouts the rollouts to be enriched. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_ROLLOUT_MANAGEMENT_UPDATE) void setRolloutStatusDetails(final Slice rollouts); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SizeConversionHelper.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SizeConversionHelper.java index 9e590010b..eac5aa4c4 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SizeConversionHelper.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SizeConversionHelper.java @@ -25,8 +25,7 @@ public final class SizeConversionHelper { /** * Convert byte values to human readable strings with units * - * @param byteValue - * Value to convert in bytes + * @param byteValue Value to convert in bytes */ public static String byteValueToReadableString(final long byteValue) { double outputValue = byteValue / 1024.0; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SoftwareModuleManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SoftwareModuleManagement.java index 7ec58403f..e90e7043d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SoftwareModuleManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SoftwareModuleManagement.java @@ -27,7 +27,6 @@ import org.eclipse.hawkbit.repository.exception.EntityAlreadyExistsException; import org.eclipse.hawkbit.repository.exception.EntityNotFoundException; import org.eclipse.hawkbit.repository.exception.RSQLParameterSyntaxException; import org.eclipse.hawkbit.repository.exception.RSQLParameterUnsupportedFieldException; -import org.eclipse.hawkbit.repository.model.AssignedSoftwareModule; import org.eclipse.hawkbit.repository.model.DistributionSet; import org.eclipse.hawkbit.repository.model.SoftwareModule; import org.eclipse.hawkbit.repository.model.SoftwareModuleMetadata; @@ -39,7 +38,6 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Service for managing {@link SoftwareModule}s. - * */ public interface SoftwareModuleManagement extends RepositoryManagement { @@ -47,21 +45,13 @@ public interface SoftwareModuleManagement /** * Creates a list of software module meta data entries. * - * @param metadata - * the meta data entries to create - * + * @param metadata the meta data entries to create * @return the updated or created software module meta data entries - * - * @throws EntityAlreadyExistsException - * in case one of the meta data entry already exists for the - * specific key - * - * @throws EntityNotFoundException - * if software module with given ID does not exist - * - * @throws AssignmentQuotaExceededException - * if the maximum number of {@link SoftwareModuleMetadata} - * entries is exceeded for the addressed {@link SoftwareModule} + * @throws EntityAlreadyExistsException in case one of the meta data entry already exists for the + * specific key + * @throws EntityNotFoundException if software module with given ID does not exist + * @throws AssignmentQuotaExceededException if the maximum number of {@link SoftwareModuleMetadata} + * entries is exceeded for the addressed {@link SoftwareModule} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) List createMetaData(@NotNull @Valid Collection metadata); @@ -69,21 +59,13 @@ public interface SoftwareModuleManagement /** * Creates or updates a single software module meta data entry. * - * @param metadata - * the meta data entry to create - * + * @param metadata the meta data entry to create * @return the updated or created software module meta data entry - * - * @throws EntityAlreadyExistsException - * in case the meta data entry already exists for the specific - * key - * - * @throws EntityNotFoundException - * if software module with given ID does not exist - * - * @throws AssignmentQuotaExceededException - * if the maximum number of {@link SoftwareModuleMetadata} - * entries is exceeded for the addressed {@link SoftwareModule} + * @throws EntityAlreadyExistsException in case the meta data entry already exists for the specific + * key + * @throws EntityNotFoundException if software module with given ID does not exist + * @throws AssignmentQuotaExceededException if the maximum number of {@link SoftwareModuleMetadata} + * entries is exceeded for the addressed {@link SoftwareModule} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) SoftwareModuleMetadata createMetaData(@NotNull @Valid SoftwareModuleMetadataCreate metadata); @@ -91,13 +73,9 @@ public interface SoftwareModuleManagement /** * Deletes a software module meta data entry. * - * @param id - * where meta data has to be deleted - * @param key - * of the metda data element - * - * @throws EntityNotFoundException - * of module or metadata entry does not exist + * @param id where meta data has to be deleted + * @param key of the metda data element + * @throws EntityNotFoundException of module or metadata entry does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) void deleteMetaData(long id, @NotEmpty String key); @@ -105,16 +83,11 @@ public interface SoftwareModuleManagement /** * Returns all modules assigned to given {@link DistributionSet}. * - * @param pageable - * the page request to page the result set - * @param distributionSetId - * to search for - * + * @param pageable the page request to page the result set + * @param distributionSetId to search for * @return all {@link SoftwareModule}s that are assigned to given * {@link DistributionSet}. - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findByAssignedTo(@NotNull Pageable pageable, long distributionSetId); @@ -122,14 +95,10 @@ public interface SoftwareModuleManagement /** * Returns count of all modules assigned to given {@link DistributionSet}. * - * @param distributionSetId - * to search for - * + * @param distributionSetId to search for * @return count of {@link SoftwareModule}s that are assigned to given * {@link DistributionSet}. - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) long countByAssignedTo(long distributionSetId); @@ -139,17 +108,11 @@ public interface SoftwareModuleManagement * {@link SoftwareModule#getName()} or {@link SoftwareModule#getVersion()} * and {@link SoftwareModule#getType()} that are not marked as deleted. * - * @param pageable - * page parameter - * @param searchText - * to be filtered as "like" on {@link SoftwareModule#getName()} - * @param typeId - * to be filtered as "like" on {@link SoftwareModule#getType()} - * + * @param pageable page parameter + * @param searchText to be filtered as "like" on {@link SoftwareModule#getName()} + * @param typeId to be filtered as "like" on {@link SoftwareModule#getType()} * @return the page of found {@link SoftwareModule} - * - * @throws EntityNotFoundException - * if given software module type does not exist + * @throws EntityNotFoundException if given software module type does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Slice findByTextAndType(@NotNull Pageable pageable, String searchText, Long typeId); @@ -157,17 +120,11 @@ public interface SoftwareModuleManagement /** * Retrieves {@link SoftwareModule} by their name AND version AND type.. * - * @param name - * of the {@link SoftwareModule} - * @param version - * of the {@link SoftwareModule} - * @param typeId - * of the {@link SoftwareModule} - * + * @param name of the {@link SoftwareModule} + * @param version of the {@link SoftwareModule} + * @param typeId of the {@link SoftwareModule} * @return the found {@link SoftwareModule} - * - * @throws EntityNotFoundException - * if software module type with given ID does not exist + * @throws EntityNotFoundException if software module type with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Optional getByNameAndVersionAndType(@NotEmpty String name, @NotEmpty String version, long typeId); @@ -175,14 +132,10 @@ public interface SoftwareModuleManagement /** * Finds a single software module meta data by its id. * - * @param id - * where meta data has to be found - * @param key - * of the meta data element + * @param id where meta data has to be found + * @param key of the meta data element * @return the found SoftwareModuleMetadata or {@code null} if not exits - * - * @throws EntityNotFoundException - * is module with given ID does not exist + * @throws EntityNotFoundException is module with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Optional getMetaDataBySoftwareModuleId(long id, @NotEmpty String key); @@ -190,16 +143,11 @@ public interface SoftwareModuleManagement /** * Finds all meta data by the given software module id. * - * @param pageable - * the page request to page the result - * @param id - * the software module id to retrieve the meta data from - * + * @param pageable the page request to page the result + * @param id the software module id to retrieve the meta data from * @return a paged result of all meta data entries for a given software * module id - * - * @throws EntityNotFoundException - * if software module with given ID does not exist + * @throws EntityNotFoundException if software module with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findMetaDataBySoftwareModuleId(@NotNull Pageable pageable, long id); @@ -207,13 +155,9 @@ public interface SoftwareModuleManagement /** * Counts all meta data by the given software module id. * - * @param id - * the software module id to retrieve the meta data count from - * + * @param id the software module id to retrieve the meta data count from * @return count of all meta data entries for a given software module id - * - * @throws EntityNotFoundException - * if software module with given ID does not exist + * @throws EntityNotFoundException if software module with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) long countMetaDataBySoftwareModuleId(long id); @@ -222,16 +166,11 @@ public interface SoftwareModuleManagement * Finds all meta data by the given software module id where * {@link SoftwareModuleMetadata#isTargetVisible()}. * - * @param pageable - * the page request to page the result - * @param id - * the software module id to retrieve the meta data from - * + * @param pageable the page request to page the result + * @param id the software module id to retrieve the meta data from * @return a paged result of all meta data entries for a given software * module id - * - * @throws EntityNotFoundException - * if software module with given ID does not exist + * @throws EntityNotFoundException if software module with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findMetaDataBySoftwareModuleIdAndTargetVisible(@NotNull Pageable pageable, @@ -240,25 +179,15 @@ public interface SoftwareModuleManagement /** * Finds all meta data by the given software module id. * - * @param pageable - * the page request to page the result - * @param id - * the software module id to retrieve the meta data from - * @param rsqlParam - * filter definition in RSQL syntax - * + * @param pageable the page request to page the result + * @param id the software module id to retrieve the meta data from + * @param rsqlParam filter definition in RSQL syntax * @return a paged result of all meta data entries for a given software * module id - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong - * - * @throws EntityNotFoundException - * if software module with given ID does not exist + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong + * @throws EntityNotFoundException if software module with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findMetaDataByRsql(@NotNull Pageable pageable, long id, @@ -268,11 +197,8 @@ public interface SoftwareModuleManagement * Retrieves the {@link SoftwareModule}s by their {@link SoftwareModuleType} * . * - * @param pageable - * page parameters - * @param typeId - * to be filtered on - * + * @param pageable page parameters + * @param typeId to be filtered on * @return the found {@link SoftwareModule}s * @throws EntityNotFoundException if software module type with given ID does not exist */ @@ -302,14 +228,10 @@ public interface SoftwareModuleManagement /** * Updates a distribution set meta data value if corresponding entry exists. * - * @param update - * the meta data entry to be updated - * + * @param update the meta data entry to be updated * @return the updated meta data entry - * - * @throws EntityNotFoundException - * in case the meta data entry does not exists and cannot be - * updated + * @throws EntityNotFoundException in case the meta data entry does not exists and cannot be + * updated */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) SoftwareModuleMetadata updateMetaData(@NotNull @Valid SoftwareModuleMetadataUpdate update); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SoftwareModuleTypeManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SoftwareModuleTypeManagement.java index c842087fe..2a73a11c7 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SoftwareModuleTypeManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SoftwareModuleTypeManagement.java @@ -21,15 +21,12 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Service for managing {@link SoftwareModuleType}s. - * */ public interface SoftwareModuleTypeManagement extends RepositoryManagement { /** - * - * @param key - * to search for + * @param key to search for * @return {@link SoftwareModuleType} in the repository with given * {@link SoftwareModuleType#getKey()} */ @@ -37,9 +34,7 @@ public interface SoftwareModuleTypeManagement Optional getByKey(@NotEmpty String key); /** - * - * @param name - * to search for + * @param name to search for * @return all {@link SoftwareModuleType}s in the repository with given * {@link SoftwareModuleType#getName()} */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SystemManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SystemManagement.java index e9cda6cc5..5aad33cb9 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SystemManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/SystemManagement.java @@ -26,7 +26,6 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Central system management operations of the update server. - * */ public interface SystemManagement { @@ -40,16 +39,13 @@ public interface SystemManagement { /** * Deletes all data related to a given tenant. * - * @param tenant - * to delete + * @param tenant to delete */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_SYSTEM_ADMIN) void deleteTenant(@NotNull String tenant); /** - * - * @param pageable - * for paging information + * @param pageable for paging information * @return list of all tenant names in the system. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_SYSTEM_ADMIN) @@ -60,9 +56,8 @@ public interface SystemManagement { * {@link TenantAware#runAsTenant(String, org.eclipse.hawkbit.tenancy.TenantAware.TenantRunner)} * sliently (i.e. exceptions will be logged but operations will continue for * further tenants). - * - * @param consumer - * to run as teanant + * + * @param consumer to run as teanant */ @PreAuthorize(SpringEvalExpressions.IS_SYSTEM_CODE) void forEachTenant(Consumer consumer); @@ -103,8 +98,7 @@ public interface SystemManagement { * is not yet in the session). Please user {@link #getTenantMetadata()} for * regular requests. * - * @param tenant - * to retrieve data for + * @param tenant to retrieve data for * @return {@link TenantMetaData} of given tenant */ @PreAuthorize(SpringEvalExpressions.IS_SYSTEM_CODE) @@ -113,8 +107,7 @@ public interface SystemManagement { /** * Update call for {@link TenantMetaData} of the current tenant. * - * @param defaultDsType - * to update + * @param defaultDsType to update * @return updated {@link TenantMetaData} entity */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_TENANT_CONFIGURATION) @@ -123,8 +116,7 @@ public interface SystemManagement { /** * Returns {@link TenantMetaData} of given tenant ID. * - * @param tenantId - * to retrieve data for + * @param tenantId to retrieve data for * @return {@link TenantMetaData} of given tenant */ @PreAuthorize(SpringEvalExpressions.IS_SYSTEM_CODE) diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetFilterQueryManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetFilterQueryManagement.java index 50b40c73d..c93412228 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetFilterQueryManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetFilterQueryManagement.java @@ -36,25 +36,18 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Management service for {@link TargetFilterQuery}s. - * */ public interface TargetFilterQueryManagement { /** * Creates a new {@link TargetFilterQuery}. * - * @param create - * to create - * + * @param create to create * @return the new {@link TargetFilterQuery} - * - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link TargetFilterQueryCreate} for field constraints. - * - * @throws AssignmentQuotaExceededException - * if the maximum number of targets that is addressed by the - * given query is exceeded (auto-assignments only) + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link TargetFilterQueryCreate} for field constraints. + * @throws AssignmentQuotaExceededException if the maximum number of targets that is addressed by the + * given query is exceeded (auto-assignments only) */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_CREATE_TARGET) TargetFilterQuery create(@NotNull @Valid TargetFilterQueryCreate create); @@ -62,11 +55,8 @@ public interface TargetFilterQueryManagement { /** * Deletes the {@link TargetFilterQuery} with the given ID. * - * @param targetFilterQueryId - * IDs of target filter query to be deleted - * - * @throws EntityNotFoundException - * if filter with given ID does not exist + * @param targetFilterQueryId IDs of target filter query to be deleted + * @throws EntityNotFoundException if filter with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_DELETE_TARGET) void delete(long targetFilterQueryId); @@ -74,27 +64,19 @@ public interface TargetFilterQueryManagement { /** * Verifies the provided filter syntax. * - * @param query - * to verify - * + * @param query to verify * @return true if syntax is valid - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) boolean verifyTargetFilterQuerySyntax(@NotNull String query); /** - * * Retrieves all {@link TargetFilterQuery}s. * - * @param pageable - * pagination parameter + * @param pageable pagination parameter * @return the found {@link TargetFilterQuery}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -114,8 +96,7 @@ public interface TargetFilterQueryManagement { *

    * No access control applied * - * @param autoAssignDistributionSetId - * the id of the distribution set + * @param autoAssignDistributionSetId the id of the distribution set * @return the count */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -125,10 +106,8 @@ public interface TargetFilterQueryManagement { * Retrieves all {@link TargetFilterQuery}s which match the given name * filter. * - * @param pageable - * pagination parameter - * @param name - * name filter + * @param pageable pagination parameter + * @param name name filter * @return the page with the found {@link TargetFilterQuery}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -137,8 +116,7 @@ public interface TargetFilterQueryManagement { /** * Counts all {@link TargetFilterQuery}s which match the given name filter. * - * @param name - * name filter + * @param name name filter * @return count of found {@link TargetFilterQuery}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -148,10 +126,8 @@ public interface TargetFilterQueryManagement { * Retrieves all {@link TargetFilterQuery} which match the given RSQL * filter. * - * @param pageable - * pagination parameter - * @param rsqlFilter - * RSQL filter string + * @param pageable pagination parameter + * @param rsqlFilter RSQL filter string * @return the page with the found {@link TargetFilterQuery}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -160,10 +136,8 @@ public interface TargetFilterQueryManagement { /** * Retrieves all {@link TargetFilterQuery}s which match the given query. * - * @param pageable - * pagination parameter - * @param query - * the query saved in the target filter query + * @param pageable pagination parameter + * @param query the query saved in the target filter query * @return the page with the found {@link TargetFilterQuery}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -173,14 +147,10 @@ public interface TargetFilterQueryManagement { * Retrieves all {@link TargetFilterQuery}s which match the given * auto-assign distribution set ID. * - * @param pageable - * pagination parameter - * @param setId - * the auto assign distribution set + * @param pageable pagination parameter + * @param setId the auto assign distribution set * @return the page with the found {@link TargetFilterQuery}s - * - * @throws EntityNotFoundException - * if DS with given ID does not exist + * @throws EntityNotFoundException if DS with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findByAutoAssignDistributionSetId(@NotNull Pageable pageable, long setId); @@ -189,16 +159,11 @@ public interface TargetFilterQueryManagement { * Retrieves all {@link TargetFilterQuery}s which match the given * auto-assign distribution set and RSQL filter. * - * @param pageable - * pagination parameter - * @param setId - * the auto assign distribution set - * @param rsqlParam - * RSQL filter + * @param pageable pagination parameter + * @param setId the auto assign distribution set + * @param rsqlParam RSQL filter * @return the page with the found {@link TargetFilterQuery}s - * - * @throws EntityNotFoundException - * if DS with given ID does not exist + * @throws EntityNotFoundException if DS with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Page findByAutoAssignDSAndRsql(@NotNull Pageable pageable, long setId, String rsqlParam); @@ -207,9 +172,8 @@ public interface TargetFilterQueryManagement { * Retrieves all {@link TargetFilterQuery}s with an auto-assign distribution * set. * + * @param pageable pagination information * @return the page with the found {@link TargetFilterQuery}s - * @param pageable - * pagination information */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findWithAutoAssignDS(@NotNull Pageable pageable); @@ -217,10 +181,8 @@ public interface TargetFilterQueryManagement { /** * Finds the {@link TargetFilterQuery} by id. * - * @param targetFilterQueryId - * Target filter query id + * @param targetFilterQueryId Target filter query id * @return the found {@link TargetFilterQuery} - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Optional get(long targetFilterQueryId); @@ -228,10 +190,8 @@ public interface TargetFilterQueryManagement { /** * Finds the {@link TargetFilterQuery} that matches the given name. * - * @param targetFilterQueryName - * Target filter query name + * @param targetFilterQueryName Target filter query name * @return the found {@link TargetFilterQuery} - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Optional getByName(@NotNull String targetFilterQueryName); @@ -239,22 +199,14 @@ public interface TargetFilterQueryManagement { /** * Updates the {@link TargetFilterQuery}. * - * @param update - * to be updated - * + * @param update to be updated * @return the updated {@link TargetFilterQuery} - * - * @throws EntityNotFoundException - * if either {@link TargetFilterQuery} and/or autoAssignDs are - * provided but not found - * - * @throws ConstraintViolationException - * if fields are not filled as specified. Check - * {@link TargetFilterQueryUpdate} for field constraints. - * - * @throws QuotaExceededException - * if the update contains a new query which addresses too many - * targets (auto-assignments only) + * @throws EntityNotFoundException if either {@link TargetFilterQuery} and/or autoAssignDs are + * provided but not found + * @throws ConstraintViolationException if fields are not filled as specified. Check + * {@link TargetFilterQueryUpdate} for field constraints. + * @throws QuotaExceededException if the update contains a new query which addresses too many + * targets (auto-assignments only) */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) TargetFilterQuery update(@NotNull @Valid TargetFilterQueryUpdate update); @@ -262,30 +214,18 @@ public interface TargetFilterQueryManagement { /** * Updates the auto assign settings of an {@link TargetFilterQuery}. * - * @param autoAssignDistributionSetUpdate - * the new auto assignment - * + * @param autoAssignDistributionSetUpdate the new auto assignment * @return the updated {@link TargetFilterQuery} - * - * @throws EntityNotFoundException - * if either {@link TargetFilterQuery} and/or autoAssignDs are - * provided but not found - * - * @throws AssignmentQuotaExceededException - * if the query that is already associated with this filter - * query addresses too many targets (auto-assignments only) - * - * @throws InvalidAutoAssignActionTypeException - * if the provided auto-assign {@link ActionType} is not valid - * (neither FORCED, nor SOFT) - * - * @throws IncompleteDistributionSetException - * if the provided auto-assign {@link DistributionSet} is - * incomplete - * - * @throws InvalidDistributionSetException - * if the provided auto-assign {@link DistributionSet} is - * invalidated + * @throws EntityNotFoundException if either {@link TargetFilterQuery} and/or autoAssignDs are + * provided but not found + * @throws AssignmentQuotaExceededException if the query that is already associated with this filter + * query addresses too many targets (auto-assignments only) + * @throws InvalidAutoAssignActionTypeException if the provided auto-assign {@link ActionType} is not valid + * (neither FORCED, nor SOFT) + * @throws IncompleteDistributionSetException if the provided auto-assign {@link DistributionSet} is + * incomplete + * @throws InvalidDistributionSetException if the provided auto-assign {@link DistributionSet} is + * invalidated */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) TargetFilterQuery updateAutoAssignDS( @@ -294,9 +234,8 @@ public interface TargetFilterQueryManagement { /** * Removes the given {@link DistributionSet} from all auto assignments. * - * @param setId - * the {@link DistributionSet} to be removed from auto - * assignments. + * @param setId the {@link DistributionSet} to be removed from auto + * assignments. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) void cancelAutoAssignmentForDistributionSet(long setId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetManagement.java index e4ee5f2a5..8a65dbba8 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetManagement.java @@ -55,11 +55,9 @@ public interface TargetManagement { /** * Counts number of targets with the given distribution set assigned. * - * @param distributionSetId - * to search for + * @param distributionSetId to search for * @return number of found {@link Target}s. - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET + SpringEvalExpressions.HAS_AUTH_OR + SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -68,14 +66,10 @@ public interface TargetManagement { /** * Count {@link Target}s for all the given filter parameters. * - * @param filterParams - * the filters to apply; only filters are enabled that have non-null - * value; filters are AND-gated - * + * @param filterParams the filters to apply; only filters are enabled that have non-null + * value; filters are AND-gated * @return the found number {@link Target}s - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) long countByFilters(@NotNull final FilterParams filterParams); @@ -83,11 +77,9 @@ public interface TargetManagement { /** * Get the count of targets with the given distribution set id. * - * @param distributionSetId - * to search for + * @param distributionSetId to search for * @return number of found {@link Target}s. - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET + SpringEvalExpressions.HAS_AUTH_OR + SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -97,11 +89,9 @@ public interface TargetManagement { * Checks if there is already a {@link Target} that has the given distribution * set Id assigned or installed. * - * @param distributionSetId - * to search for + * @param distributionSetId to search for * @return true if a {@link Target} exists. - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET + SpringEvalExpressions.HAS_AUTH_OR + SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) @@ -110,8 +100,7 @@ public interface TargetManagement { /** * Count {@link TargetFilterQuery}s for given target filter query. * - * @param rsqlParam - * filter definition in RSQL syntax + * @param rsqlParam filter definition in RSQL syntax * @return the found number of {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -120,8 +109,7 @@ public interface TargetManagement { /** * Count {@link TargetFilterQuery}s for given target filter query with UPDATE permission. * - * @param rsqlParam - * filter definition in RSQL syntax + * @param rsqlParam filter definition in RSQL syntax * @return the found number of {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -131,11 +119,9 @@ public interface TargetManagement { * Count all targets for given {@link TargetFilterQuery} and that are compatible * with the passed {@link DistributionSetType}. * - * @param rsqlParam - * filter definition in RSQL syntax - * @param distributionSetIdTypeId - * ID of the {@link DistributionSetType} the targets need to be - * compatible with + * @param rsqlParam filter definition in RSQL syntax + * @param distributionSetIdTypeId ID of the {@link DistributionSetType} the targets need to be + * compatible with * @return the found number of{@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -145,11 +131,9 @@ public interface TargetManagement { * Count all targets for given {@link TargetFilterQuery} and that are compatible * with the passed {@link DistributionSetType} and UPDATE permission. * - * @param rsqlParam - * filter definition in RSQL syntax - * @param distributionSetIdTypeId - * ID of the {@link DistributionSetType} the targets need to be - * compatible with + * @param rsqlParam filter definition in RSQL syntax + * @param distributionSetIdTypeId ID of the {@link DistributionSetType} the targets need to be + * compatible with * @return the found number of{@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -160,11 +144,9 @@ public interface TargetManagement { * compatible with the passed {@link DistributionSetType} and created after * given timestamp * - * @param rolloutId - * rolloutId of the rollout to be retried. - * @param dsTypeId - * ID of the {@link DistributionSetType} the targets need to be - * compatible with + * @param rolloutId rolloutId of the rollout to be retried. + * @param dsTypeId ID of the {@link DistributionSetType} the targets need to be + * compatible with * @return the found number of{@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -173,12 +155,9 @@ public interface TargetManagement { /** * Count {@link TargetFilterQuery}s for given target filter query. * - * @param targetFilterQueryId - * {@link TargetFilterQuery#getId()} + * @param targetFilterQueryId {@link TargetFilterQuery#getId()} * @return the found number of {@link Target}s - * - * @throws EntityNotFoundException - * if {@link TargetFilterQuery} with given ID does not exist + * @throws EntityNotFoundException if {@link TargetFilterQuery} with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) long countByTargetFilterQuery(long targetFilterQueryId); @@ -194,16 +173,11 @@ public interface TargetManagement { /** * creating a new {@link Target}. * - * @param create - * to be created + * @param create to be created * @return the created {@link Target} - * - * @throws EntityAlreadyExistsException - * given target already exists. - * @throws ConstraintViolationException - * if fields are not filled as specified. Check {@link TargetCreate} - * for field constraints. - * + * @throws EntityAlreadyExistsException given target already exists. + * @throws ConstraintViolationException if fields are not filled as specified. Check {@link TargetCreate} + * for field constraints. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_CREATE_TARGET) Target create(@NotNull @Valid TargetCreate create); @@ -213,15 +187,11 @@ public interface TargetManagement { * in the DB an {@link EntityAlreadyExistsException} is thrown. {@link Target}s * contain all objects of the parameter targets, including duplicates. * - * @param creates - * to be created. + * @param creates to be created. * @return the created {@link Target}s - * - * @throws EntityAlreadyExistsException - * of one of the given targets already exist. - * @throws ConstraintViolationException - * if fields are not filled as specified. Check {@link TargetCreate} - * for field constraints. + * @throws EntityAlreadyExistsException of one of the given targets already exist. + * @throws ConstraintViolationException if fields are not filled as specified. Check {@link TargetCreate} + * for field constraints. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_CREATE_TARGET) List create(@NotNull @Valid Collection creates); @@ -229,11 +199,8 @@ public interface TargetManagement { /** * Deletes all targets with the given IDs. * - * @param ids - * the IDs of the targets to be deleted - * - * @throws EntityNotFoundException - * if (at least one) of the given target IDs does not exist + * @param ids the IDs of the targets to be deleted + * @throws EntityNotFoundException if (at least one) of the given target IDs does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_DELETE_TARGET) void delete(@NotEmpty Collection ids); @@ -241,11 +208,8 @@ public interface TargetManagement { /** * Deletes target with the given controller ID. * - * @param controllerId - * the controller ID of the target to be deleted - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @param controllerId the controller ID of the target to be deleted + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_DELETE_TARGET) void deleteByControllerID(@NotEmpty String controllerId); @@ -255,16 +219,11 @@ public interface TargetManagement { * that don't have the specified distribution set in their action history and * are compatible with the passed {@link DistributionSetType}. * - * @param pageRequest - * the pageRequest to enhance the query for paging and sorting - * @param distributionSetId - * id of the {@link DistributionSet} - * @param rsqlParam - * filter definition in RSQL syntax + * @param pageRequest the pageRequest to enhance the query for paging and sorting + * @param distributionSetId id of the {@link DistributionSet} + * @param rsqlParam filter definition in RSQL syntax * @return a page of the found {@link Target}s - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) Slice findByTargetFilterQueryAndNonDSAndCompatibleAndUpdatable(@NotNull Pageable pageRequest, @@ -275,14 +234,10 @@ public interface TargetManagement { * that don't have the specified distribution set in their action history and * are compatible with the passed {@link DistributionSetType}. * - * @param distributionSetId - * id of the {@link DistributionSet} - * @param rsqlParam - * filter definition in RSQL syntax + * @param distributionSetId id of the {@link DistributionSet} + * @param rsqlParam filter definition in RSQL syntax * @return the count of found {@link Target}s - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) long countByRsqlAndNonDSAndCompatibleAndUpdatable(long distributionSetId, @NotNull String rsqlParam); @@ -292,15 +247,11 @@ public interface TargetManagement { * that are not assigned to one of the {@link RolloutGroup}s and are compatible * with the passed {@link DistributionSetType}. * - * @param pageRequest - * the pageRequest to enhance the query for paging and sorting - * @param groups - * the list of {@link RolloutGroup}s - * @param targetFilterQuery - * filter definition in RSQL syntax - * @param distributionSetType - * type of the {@link DistributionSet} the targets must be compatible - * withs + * @param pageRequest the pageRequest to enhance the query for paging and sorting + * @param groups the list of {@link RolloutGroup}s + * @param targetFilterQuery filter definition in RSQL syntax + * @param distributionSetType type of the {@link DistributionSet} the targets must be compatible + * withs * @return a page of the found {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) @@ -321,12 +272,9 @@ public interface TargetManagement { * assigned to one of the retried {@link RolloutGroup}s and are compatible with * the passed {@link DistributionSetType}. * - * @param pageRequest - * the pageRequest to enhance the query for paging and sorting - * @param groups - * the list of {@link RolloutGroup}s - * @param rolloutId - * rolloutId of the rollout to be retried. + * @param pageRequest the pageRequest to enhance the query for paging and sorting + * @param groups the list of {@link RolloutGroup}s + * @param rolloutId rolloutId of the rollout to be retried. * @return a page of the found {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -338,13 +286,10 @@ public interface TargetManagement { * that are not assigned to one of the {@link RolloutGroup}s and are compatible * with the passed {@link DistributionSetType}. * - * @param groups - * the list of {@link RolloutGroup}s - * @param rsqlParam - * filter definition in RSQL syntax - * @param distributionSetType - * type of the {@link DistributionSet} the targets must be compatible - * with + * @param groups the list of {@link RolloutGroup}s + * @param rsqlParam filter definition in RSQL syntax + * @param distributionSetType type of the {@link DistributionSet} the targets must be compatible + * with * @return count of the found {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) @@ -356,10 +301,8 @@ public interface TargetManagement { * assigned to one of the {@link RolloutGroup}s and are compatible with the * passed {@link DistributionSetType}. * - * @param groups - * the list of {@link RolloutGroup}s - * @param rolloutId - * rolloutId of the rollout to be retried. + * @param groups the list of {@link RolloutGroup}s + * @param rolloutId rolloutId of the rollout to be retried. * @return count of the found {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -369,31 +312,21 @@ public interface TargetManagement { * Finds all targets of the provided {@link RolloutGroup} that have no Action * for the RolloutGroup. * - * @param pageRequest - * the pageRequest to enhance the query for paging and sorting - * @param group - * the {@link RolloutGroup} + * @param pageRequest the pageRequest to enhance the query for paging and sorting + * @param group the {@link RolloutGroup} * @return the found {@link Target}s - * - * @throws EntityNotFoundException - * if rollout group with given ID does not exist + * @throws EntityNotFoundException if rollout group with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findByInRolloutGroupWithoutAction(@NotNull Pageable pageRequest, long group); /** * retrieves {@link Target}s by the assigned {@link DistributionSet}. - * - * @param pageReq - * page parameter - * @param distributionSetId - * the ID of the {@link DistributionSet} - * * + * @param pageReq page parameter + * @param distributionSetId the ID of the {@link DistributionSet} * @return the found {@link Target}s - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_READ_TARGET) Page findByAssignedDistributionSet(@NotNull Pageable pageReq, long distributionSetId); @@ -401,22 +334,15 @@ public interface TargetManagement { /** * Retrieves {@link Target}s by the assigned {@link DistributionSet} possible * including additional filtering based on the given {@code spec}. - * - * @param pageReq - * page parameter - * @param distributionSetId - * the ID of the {@link DistributionSet} - * @param rsqlParam - * the specification to filter the result set * + * @param pageReq page parameter + * @param distributionSetId the ID of the {@link DistributionSet} + * @param rsqlParam the specification to filter the result set * @return the found {@link Target}s, never {@code null} - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_READ_TARGET) Page findByAssignedDistributionSetAndRsql(@NotNull Pageable pageReq, long distributionSetId, @@ -425,8 +351,7 @@ public interface TargetManagement { /** * Find {@link Target}s based a given IDs. * - * @param controllerIDs - * to look for. + * @param controllerIDs to look for. * @return List of found{@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -435,8 +360,7 @@ public interface TargetManagement { /** * Find a {@link Target} based a given ID. * - * @param controllerId - * to look for. + * @param controllerId to look for. * @return {@link Target} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -446,32 +370,22 @@ public interface TargetManagement { * Filter {@link Target}s for all the given parameters. If all parameters except * pageable are null, all available {@link Target}s are returned. * - * @param pageable - * page parameters - * @param filterParams - * the filters to apply; only filters are enabled that have non-null - * value; filters are AND-gated - * + * @param pageable page parameters + * @param filterParams the filters to apply; only filters are enabled that have non-null + * value; filters are AND-gated * @return the found {@link Target}s - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findByFilters(@NotNull Pageable pageable, @NotNull FilterParams filterParams); /** * retrieves {@link Target}s by the installed {@link DistributionSet}. - * - * @param pageReq - * page parameter - * @param distributionSetId - * the ID of the {@link DistributionSet} * + * @param pageReq page parameter + * @param distributionSetId the ID of the {@link DistributionSet} * @return the found {@link Target}s - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_READ_TARGET) Page findByInstalledDistributionSet(@NotNull Pageable pageReq, long distributionSetId); @@ -479,24 +393,15 @@ public interface TargetManagement { /** * retrieves {@link Target}s by the installed {@link DistributionSet} including * additional filtering based on the given {@code spec}. - * - * @param pageReq - * page parameter - * @param distributionSetId - * the ID of the {@link DistributionSet} - * @param rsqlParam - * the specification to filter the result * + * @param pageReq page parameter + * @param distributionSetId the ID of the {@link DistributionSet} + * @param rsqlParam the specification to filter the result * @return the found {@link Target}s, never {@code null} - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_READ_TARGET) Page findByInstalledDistributionSetAndRsql(@NotNull Pageable pageReq, long distributionSetId, @@ -505,10 +410,8 @@ public interface TargetManagement { /** * Retrieves the {@link Target} which have a certain {@link TargetUpdateStatus}. * - * @param pageable - * page parameter - * @param status - * the {@link TargetUpdateStatus} to be filtered on + * @param pageable page parameter + * @param status the {@link TargetUpdateStatus} to be filtered on * @return the found {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -517,8 +420,7 @@ public interface TargetManagement { /** * Retrieves all targets. * - * @param pageable - * pagination parameter + * @param pageable pagination parameter * @return the found {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -526,41 +428,27 @@ public interface TargetManagement { /** * Retrieves all targets. - * - * @param pageable - * pagination parameter - * @param rsqlParam - * in RSQL notation * + * @param pageable pagination parameter + * @param rsqlParam in RSQL notation * @return the found {@link Target}s, never {@code null} - * - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findByRsql(@NotNull Pageable pageable, @NotNull String rsqlParam); /** * Retrieves all target based on {@link TargetFilterQuery}. - * - * @param pageable - * pagination parameter - * @param targetFilterQueryId - * {@link TargetFilterQuery#getId()} * + * @param pageable pagination parameter + * @param targetFilterQueryId {@link TargetFilterQuery#getId()} * @return the found {@link Target}s, never {@code null} - * - * @throws EntityNotFoundException - * if {@link TargetFilterQuery} with given ID does not exist. - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws EntityNotFoundException if {@link TargetFilterQuery} with given ID does not exist. + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findByTargetFilterQuery(@NotNull Pageable pageable, long targetFilterQueryId); @@ -577,18 +465,13 @@ public interface TargetManagement { * {@link DistributionSet} * * - * @param pageable - * the page request to page the result set - * @param orderByDistributionSetId - * {@link DistributionSet#getId()} to be ordered by - * @param filterParams - * the filters to apply; only filters are enabled that have non-null - * value; filters are AND-gated + * @param pageable the page request to page the result set + * @param orderByDistributionSetId {@link DistributionSet#getId()} to be ordered by + * @param filterParams the filters to apply; only filters are enabled that have non-null + * value; filters are AND-gated * @return a paged result {@link Page} of the {@link Target}s in a defined * order. - * - * @throws EntityNotFoundException - * if distribution set with given ID does not exist + * @throws EntityNotFoundException if distribution set with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findByFilterOrderByLinkedDistributionSet(@NotNull Pageable pageable, long orderByDistributionSetId, @@ -596,38 +479,26 @@ public interface TargetManagement { /** * Find targets by tag name. - * - * @param pageable - * the page request parameter for paging and sorting the result - * @param tagId - * tag ID + * + * @param pageable the page request parameter for paging and sorting the result + * @param tagId tag ID * @return list of matching targets - * - * @throws EntityNotFoundException - * if target tag with given ID does not exist + * @throws EntityNotFoundException if target tag with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Page findByTag(@NotNull Pageable pageable, long tagId); /** * Find targets by tag name. - * - * @param pageable - * the page request parameter for paging and sorting the result - * @param tagId - * tag ID - * @param rsqlParam - * in RSQL notation - * + * + * @param pageable the page request parameter for paging and sorting the result + * @param tagId tag ID + * @param rsqlParam in RSQL notation * @return list of matching targets - * - * @throws EntityNotFoundException - * if target tag with given ID does not exist - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong + * @throws EntityNotFoundException if target tag with given ID does not exist + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Page findByRsqlAndTag(@NotNull Pageable pageable, @NotNull String rsqlParam, long tagId); @@ -638,15 +509,11 @@ public interface TargetManagement { * get assigned. If all targets are already of that type, there will be no * un-assignment. * - * @param controllerIds - * to set the type to - * @param typeId - * to assign targets to + * @param controllerIds to set the type to + * @param typeId to assign targets to * @return {@link TargetTypeAssignmentResult} with all metadata of the * assignment outcome. - * - * @throws EntityNotFoundException - * if target type with given id does not exist + * @throws EntityNotFoundException if target type with given id does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) TargetTypeAssignmentResult assignType(@NotEmpty Collection controllerIds, @NotNull Long typeId); @@ -655,8 +522,7 @@ public interface TargetManagement { * Initiates {@link TargetType} un-assignment to given {@link Target}s. The type * of the targets will be set to {@code null} * - * @param controllerIds - * to remove the type from + * @param controllerIds to remove the type from * @return {@link TargetTypeAssignmentResult} with all metadata of the * assignment outcome. */ @@ -718,7 +584,6 @@ public interface TargetManagement { * * @param controllerId to un-assign for * @return the unassigned target - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) Target unassignType(@NotEmpty String controllerId); @@ -726,14 +591,10 @@ public interface TargetManagement { /** * Assign a {@link TargetType} assignment to given {@link Target}. * - * @param controllerId - * to un-assign for - * @param targetTypeId - * Target type id + * @param controllerId to un-assign for + * @param targetTypeId Target type id * @return the unassigned target - * - * @throws EntityNotFoundException - * if TargetType with given target ID does not exist + * @throws EntityNotFoundException if TargetType with given target ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) Target assignType(@NotEmpty String controllerId, @NotNull Long targetTypeId); @@ -741,25 +602,19 @@ public interface TargetManagement { /** * updates the {@link Target}. * - * @param update - * to be updated - * + * @param update to be updated * @return the updated {@link Target} - * - * @throws EntityNotFoundException - * if given target does not exist - * @throws ConstraintViolationException - * if fields are not filled as specified. Check {@link TargetUpdate} - * for field constraints. + * @throws EntityNotFoundException if given target does not exist + * @throws ConstraintViolationException if fields are not filled as specified. Check {@link TargetUpdate} + * for field constraints. */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) Target update(@NotNull @Valid TargetUpdate update); /** * Find a {@link Target} based a given ID. - * - * @param id - * to look for + * + * @param id to look for * @return {@link Target} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -768,8 +623,7 @@ public interface TargetManagement { /** * Retrieves all targets. * - * @param ids - * the ids to for + * @param ids the ids to for * @return the found {@link Target}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -777,13 +631,10 @@ public interface TargetManagement { /** * Get controller attributes of given {@link Target}. - * - * @param controllerId - * of the target + * + * @param controllerId of the target * @return controller attributes as key/value pairs - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Map getControllerAttributes(@NotEmpty String controllerId); @@ -791,20 +642,16 @@ public interface TargetManagement { /** * Trigger given {@link Target} to update its attributes. * - * @param controllerId - * of the target - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @param controllerId of the target + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) void requestControllerAttributes(@NotEmpty String controllerId); /** * Check if update of given {@link Target} attributes is already requested. - * - * @param controllerId - * of target + * + * @param controllerId of target * @return {@code true}: update of controller attributes triggered. * {@code false}: update of controller attributes not requested. */ @@ -814,12 +661,9 @@ public interface TargetManagement { /** * Retrieves {@link Target}s where * {@link #isControllerAttributesRequested(String)}. - * - * @param pageReq - * page parameter * + * @param pageReq page parameter * @return the found {@link Target}s - * */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) Page findByControllerAttributesRequested(@NotNull Pageable pageReq); @@ -827,9 +671,8 @@ public interface TargetManagement { /** * Verifies that {@link Target} with given controller ID exists in the * repository. - * - * @param controllerId - * of target + * + * @param controllerId of target * @return {@code true} if target with given ID exists */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -839,15 +682,12 @@ public interface TargetManagement { * Verify if a target matches a specific target filter query, does not have a * specific DS already assigned and is compatible with it. * - * @param controllerId - * of the {@link org.eclipse.hawkbit.repository.model.Target} to - * check - * @param distributionSetId - * of the - * {@link org.eclipse.hawkbit.repository.model.DistributionSet} to - * consider - * @param targetFilterQuery - * to execute + * @param controllerId of the {@link org.eclipse.hawkbit.repository.model.Target} to + * check + * @param distributionSetId of the + * {@link org.eclipse.hawkbit.repository.model.DistributionSet} to + * consider + * @param targetFilterQuery to execute * @return true if it matches */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_READ_TARGET) @@ -867,22 +707,14 @@ public interface TargetManagement { /** * Creates a list of target meta data entries. * - * @param controllerId - * {@link Target} controller id the metadata has to be created for - * @param metadata - * the meta data entries to create or update + * @param controllerId {@link Target} controller id the metadata has to be created for + * @param metadata the meta data entries to create or update * @return the updated or created target metadata entries - * - * @throws EntityNotFoundException - * if given target does not exist - * - * @throws EntityAlreadyExistsException - * in case one of the metadata entry already exists for the specific - * key - * - * @throws AssignmentQuotaExceededException - * if the maximum number of {@link MetaData} entries is exceeded for - * the addressed {@link Target} + * @throws EntityNotFoundException if given target does not exist + * @throws EntityAlreadyExistsException in case one of the metadata entry already exists for the specific + * key + * @throws AssignmentQuotaExceededException if the maximum number of {@link MetaData} entries is exceeded for + * the addressed {@link Target} */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) List createMetaData(@NotEmpty String controllerId, @NotEmpty Collection metadata); @@ -890,29 +722,20 @@ public interface TargetManagement { /** * Deletes a target meta data entry. * - * @param controllerId - * where metadata has to be deleted - * @param key - * of the meta data element - * - * @throws EntityNotFoundException - * if given target does not exist + * @param controllerId where metadata has to be deleted + * @param key of the meta data element + * @throws EntityNotFoundException if given target does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) void deleteMetaData(@NotEmpty String controllerId, @NotEmpty String key); /** * Finds all meta data by the given target id. - * - * @param pageable - * the page request to page the result - * @param controllerId - * the controller id to retrieve the metadata from * + * @param pageable the page request to page the result + * @param controllerId the controller id to retrieve the metadata from * @return a paged result of all meta data entries for a given target id - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findMetaDataByControllerId(@NotNull Pageable pageable, @NotEmpty String controllerId); @@ -920,13 +743,9 @@ public interface TargetManagement { /** * Counts all meta data by the given target id. * - * @param controllerId - * the controller id to retrieve the meta data from - * + * @param controllerId the controller id to retrieve the meta data from * @return count of all meta data entries for a given target id - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) long countMetaDataByControllerId(@NotEmpty String controllerId); @@ -934,24 +753,14 @@ public interface TargetManagement { /** * Finds all metadata by the given target id and query. * - * @param pageable - * the page request to page the result - * @param controllerId - * the controller id to retrieve the metadata from - * @param rsqlParam - * rsql query string - * + * @param pageable the page request to page the result + * @param controllerId the controller id to retrieve the metadata from + * @param rsqlParam rsql query string * @return a paged result of all meta data entries for a given target id - * - * @throws RSQLParameterUnsupportedFieldException - * if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} - * - * @throws RSQLParameterSyntaxException - * if the RSQL syntax is wrong - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the + * given {@code fieldNameProvider} + * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Page findMetaDataByControllerIdAndRsql(@NotNull Pageable pageable, @NotEmpty String controllerId, @@ -960,14 +769,10 @@ public interface TargetManagement { /** * Finds a single target meta data by its id. * - * @param controllerId - * of the {@link Target} - * @param key - * of the meta data element + * @param controllerId of the {@link Target} + * @param key of the meta data element * @return the found TargetMetadata - * - * @throws EntityNotFoundException - * if target with given ID does not exist + * @throws EntityNotFoundException if target with given ID does not exist */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY) Optional getMetaDataByControllerId(@NotEmpty String controllerId, @NotEmpty String key); @@ -975,14 +780,10 @@ public interface TargetManagement { /** * Updates a target meta data value if corresponding entry exists. * - * @param controllerId - * {@link Target} controller id of the metadata entry to be updated - * @param metadata - * meta data entry to be updated + * @param controllerId {@link Target} controller id of the metadata entry to be updated + * @param metadata meta data entry to be updated * @return the updated meta data entry - * - * @throws EntityNotFoundException - * in case the metadata entry does not exist and cannot be updated + * @throws EntityNotFoundException in case the metadata entry does not exist and cannot be updated */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_REPOSITORY) TargetMetadata updateMetadata(@NotEmpty String controllerId, @NotNull MetaData metadata); @@ -993,11 +794,11 @@ public interface TargetManagement { * assigned, they will be. Only if all of them have the tag already assigned * they will be removed instead. * - * @deprecated since 0.6.0 - not very usable with very unclear logic * @param controllerIds to toggle for * @param tagName to toggle * @return TagAssigmentResult with all metadata of the assignment outcome. * @throws EntityNotFoundException if tag with given name does not exist + * @deprecated since 0.6.0 - not very usable with very unclear logic */ @Deprecated @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) @@ -1006,11 +807,11 @@ public interface TargetManagement { /** * Un-assign a {@link TargetTag} assignment to given {@link Target}. * - * @deprecated since 0.6.0 - use {@link #unassignTag(Collection, long)} (List, long)} instead * @param controllerId to un-assign for * @param targetTagId to un-assign * @return the unassigned target or if no target is unassigned * @throws EntityNotFoundException if TAG with given ID does not exist + * @deprecated since 0.6.0 - use {@link #unassignTag(Collection, long)} (List, long)} instead */ @Deprecated(forRemoval = true) @PreAuthorize(SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetTagManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetTagManagement.java index 306eaaf96..1b4e1f25d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetTagManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetTagManagement.java @@ -12,7 +12,6 @@ package org.eclipse.hawkbit.repository; import java.util.Collection; import java.util.List; import java.util.Optional; -import java.util.Set; import jakarta.validation.ConstraintViolationException; import jakarta.validation.Valid; @@ -39,7 +38,7 @@ public interface TargetTagManagement { /** * Count {@link TargetTag}s. - * + * * @return size of {@link TargetTag}s */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -47,7 +46,7 @@ public interface TargetTagManagement { /** * Creates a new {@link TargetTag}. - * + * * @param create to be created * @return the new created {@link TargetTag} * @throws EntityAlreadyExistsException if given object already exists @@ -58,7 +57,7 @@ public interface TargetTagManagement { /** * Created multiple {@link TargetTag}s. - * + * * @param creates to be created * @return the new created {@link TargetTag}s * @throws EntityAlreadyExistsException if given object has already an ID. @@ -69,7 +68,7 @@ public interface TargetTagManagement { /** * Deletes {@link TargetTag} with given name. - * + * * @param targetTagName tag name of the {@link TargetTag} to be deleted * @throws EntityNotFoundException if tag with given name does not exist */ @@ -78,7 +77,7 @@ public interface TargetTagManagement { /** * returns all {@link TargetTag}s. - * + * * @param pageable page parameter * @return all {@link TargetTag}s */ @@ -87,12 +86,12 @@ public interface TargetTagManagement { /** * Retrieves all target tags based on the given specification. - * + * * @param pageable pagination parameter * @param rsqlParam rsql query string * @return the found {@link Target}s, never {@code null} * @throws RSQLParameterUnsupportedFieldException if a field in the RSQL string is used but not provided by the - * given {@code fieldNameProvider} + * given {@code fieldNameProvider} * @throws RSQLParameterSyntaxException if the RSQL syntax is wrong */ @PreAuthorize(SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -130,7 +129,6 @@ public interface TargetTagManagement { * * @param update the {@link TargetTag} with updated values * @return the updated {@link TargetTag} - * * @throws EntityNotFoundException in case the {@link TargetTag} does not exist and cannot be updated * @throws ConstraintViolationException if fields are not filled as specified. Check {@link TagUpdate} for field constraints. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetTypeManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetTypeManagement.java index a92620196..2889fb763 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetTypeManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TargetTypeManagement.java @@ -28,21 +28,18 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Management service for {@link TargetType}s. - * */ public interface TargetTypeManagement { /** - * @param key - * as {@link TargetType#getKey()} + * @param key as {@link TargetType#getKey()} * @return {@link TargetType} */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) Optional getByKey(@NotEmpty String key); /** - * @param name - * as {@link TargetType#getName()} + * @param name as {@link TargetType#getName()} * @return {@link TargetType} */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -55,49 +52,42 @@ public interface TargetTypeManagement { long count(); /** - * @param name - * as {@link TargetType#getName()} + * @param name as {@link TargetType#getName()} * @return total count by name */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) long countByName(String name); /** - * @param create - * TargetTypeCreate + * @param create TargetTypeCreate * @return targetType */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_CREATE_TARGET) TargetType create(@NotNull @Valid TargetTypeCreate create); /** - * @param creates - * List of TargetTypeCreate + * @param creates List of TargetTypeCreate * @return List of targetType */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_CREATE_TARGET) List create(@NotEmpty @Valid Collection creates); /** - * @param id - * targetTypeId + * @param id targetTypeId */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_DELETE_TARGET) void delete(@NotNull Long id); /** - * @param pageable - * Page + * @param pageable Page * @return TargetType page */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findAll(@NotNull Pageable pageable); /** - * @param pageable - * Page - * @param rsqlParam - * query param + * @param pageable Page + * @param rsqlParam query param * @return Target type */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) @@ -106,44 +96,37 @@ public interface TargetTypeManagement { /** * Retrieves {@link TargetType}s by filtering on the given parameters. * - * @param pageable - * page parameter - * @param name - * has text of filters to be applied. + * @param pageable page parameter + * @param name has text of filters to be applied. * @return the page of found {@link TargetType} */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) Slice findByName(@NotNull Pageable pageable, String name); /** - * @param id - * Target type ID + * @param id Target type ID * @return Target Type */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) Optional get(long id); /** - * @param ids - * List of Target type ID + * @param ids List of Target type ID * @return Target type list */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_TARGET) List get(@NotEmpty Collection ids); /** - * @param update - * TargetTypeUpdate + * @param update TargetTypeUpdate * @return Target Type */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_UPDATE_TARGET) TargetType update(@NotNull @Valid TargetTypeUpdate update); /** - * @param id - * Target type ID - * @param distributionSetTypeIds - * Distribution set ID + * @param id Target type ID + * @param distributionSetTypeIds Distribution set ID * @return Target type */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) @@ -151,10 +134,8 @@ public interface TargetTypeManagement { @NotEmpty Collection distributionSetTypeIds); /** - * @param id - * Target type ID - * @param distributionSetTypeIds - * Distribution set ID + * @param id Target type ID + * @param distributionSetTypeIds Distribution set ID * @return Target type */ @PreAuthorize(SpPermission.SpringEvalExpressions.HAS_AUTH_READ_REPOSITORY_AND_UPDATE_TARGET) diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantConfigurationManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantConfigurationManagement.java index b2256b4f1..084247c15 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantConfigurationManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantConfigurationManagement.java @@ -30,25 +30,19 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Management service for tenant configurations. - * */ public interface TenantConfigurationManagement { /** * Adds or updates a specific configuration for a specific tenant. - * - * - * @param configurationKeyName - * the key of the configuration - * @param value - * the configuration value which will be written into the - * database. + * + * @param configurationKeyName the key of the configuration + * @param value the configuration value which will be written into the + * database. * @return the configuration value which was just written into the database. - * @throws TenantConfigurationValidatorException - * if the {@code propertyType} and the value in general does not - * match the expected type and format defined by the Key - * @throws ConversionFailedException - * if the property cannot be converted to the given + * @throws TenantConfigurationValidatorException if the {@code propertyType} and the value in general does not + * match the expected type and format defined by the Key + * @throws ConversionFailedException if the property cannot be converted to the given */ @PreAuthorize(value = SpringEvalExpressions.HAS_AUTH_TENANT_CONFIGURATION) TenantConfigurationValue addOrUpdateConfiguration(String configurationKeyName, T value); @@ -56,25 +50,20 @@ public interface TenantConfigurationManagement { /** * Adds or updates a specific configuration for a specific tenant. * - * - * @param configurations - * map containing the key - value of the configuration + * @param configurations map containing the key - value of the configuration * @return map of all configuration values which were written into the database. - * @throws TenantConfigurationValidatorException - * if the {@code propertyType} and the value in general does not - * match the expected type and format defined by the Key - * @throws ConversionFailedException - * if the property cannot be converted to the given + * @throws TenantConfigurationValidatorException if the {@code propertyType} and the value in general does not + * match the expected type and format defined by the Key + * @throws ConversionFailedException if the property cannot be converted to the given */ @PreAuthorize(value = SpringEvalExpressions.HAS_AUTH_TENANT_CONFIGURATION) - Map> addOrUpdateConfiguration(Map configurations); + Map> addOrUpdateConfiguration(Map configurations); /** * Deletes a specific configuration for the current tenant. Does nothing in * case there is no tenant specific configuration value. * - * @param configurationKey - * the configuration key to be deleted + * @param configurationKey the configuration key to be deleted */ @PreAuthorize(value = SpringEvalExpressions.HAS_AUTH_TENANT_CONFIGURATION) void deleteConfiguration(String configurationKey); @@ -83,19 +72,16 @@ public interface TenantConfigurationManagement { * Retrieves a configuration value from the e.g. tenant overwritten * configuration values or in case the tenant does not a have a specific * configuration the global default value hold in the {@link Environment}. - * - * @param configurationKeyName - * the key of the configuration + * + * @param configurationKeyName the key of the configuration * @return the converted configuration value either from the tenant specific * configuration stored or from the fall back default values or * {@code null} in case key has not been configured and not default * value exists - * @throws TenantConfigurationValidatorException - * if the {@code propertyType} and the value in general does not - * match the expected type and format defined by the Key - * @throws ConversionFailedException - * if the property cannot be converted to the given - * {@code propertyType} + * @throws TenantConfigurationValidatorException if the {@code propertyType} and the value in general does not + * match the expected type and format defined by the Key + * @throws ConversionFailedException if the property cannot be converted to the given + * {@code propertyType} */ @PreAuthorize(value = SpringEvalExpressions.HAS_AUTH_TENANT_CONFIGURATION_READ) TenantConfigurationValue getConfigurationValue(String configurationKeyName); @@ -104,24 +90,19 @@ public interface TenantConfigurationManagement { * Retrieves a configuration value from the e.g. tenant overwritten * configuration values or in case the tenant does not a have a specific * configuration the global default value hold in the {@link Environment}. - * - * @param - * the type of the configuration value - * @param configurationKeyName - * the key of the configuration - * @param propertyType - * the type of the configuration value, e.g. {@code String.class} - * , {@code Integer.class}, etc + * + * @param the type of the configuration value + * @param configurationKeyName the key of the configuration + * @param propertyType the type of the configuration value, e.g. {@code String.class} + * , {@code Integer.class}, etc * @return the converted configuration value either from the tenant specific * configuration stored or from the fallback default values or * {@code null} in case key has not been configured and not default * value exists - * @throws TenantConfigurationValidatorException - * if the {@code propertyType} and the value in general does not - * match the expected type and format defined by the Key - * @throws ConversionFailedException - * if the property cannot be converted to the given - * {@code propertyType} + * @throws TenantConfigurationValidatorException if the {@code propertyType} and the value in general does not + * match the expected type and format defined by the Key + * @throws ConversionFailedException if the property cannot be converted to the given + * {@code propertyType} */ @PreAuthorize(value = SpringEvalExpressions.HAS_AUTH_TENANT_CONFIGURATION_READ) TenantConfigurationValue getConfigurationValue(String configurationKeyName, @@ -130,22 +111,17 @@ public interface TenantConfigurationManagement { /** * returns the global configuration property either defined in the property * file or an default value otherwise. - * - * @param - * the type of the configuration value - * @param configurationKeyName - * the key of the configuration - * @param propertyType - * the type of the configuration value, e.g. {@code String.class} - * , {@code Integer.class}, etc + * + * @param the type of the configuration value + * @param configurationKeyName the key of the configuration + * @param propertyType the type of the configuration value, e.g. {@code String.class} + * , {@code Integer.class}, etc * @return the global configured value - * @throws TenantConfigurationValidatorException - * if the {@code propertyType} and the value in the property - * file or the default value does not match the expected type - * and format defined by the Key - * @throws ConversionFailedException - * if the property cannot be converted to the given - * {@code propertyType} + * @throws TenantConfigurationValidatorException if the {@code propertyType} and the value in the property + * file or the default value does not match the expected type + * and format defined by the Key + * @throws ConversionFailedException if the property cannot be converted to the given + * {@code propertyType} */ @PreAuthorize(value = SpringEvalExpressions.HAS_AUTH_TENANT_CONFIGURATION_READ) T getGlobalConfigurationValue(String configurationKeyName, Class propertyType); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantStatsManagement.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantStatsManagement.java index b5b5e6dd9..d62065d2f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantStatsManagement.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/TenantStatsManagement.java @@ -15,7 +15,6 @@ import org.springframework.security.access.prepost.PreAuthorize; /** * Management service for statistics of a single tenant. - * */ @FunctionalInterface public interface TenantStatsManagement { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/UpdateMode.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/UpdateMode.java index 80ddbed31..854e08876 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/UpdateMode.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/UpdateMode.java @@ -15,7 +15,7 @@ import java.util.Optional; /** * Enumerates the supported update modes. Each mode represents an attribute * update strategy. - * + * * @see ControllerManagement */ public enum UpdateMode { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ValidString.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ValidString.java index 1be82be83..627092b96 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ValidString.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ValidString.java @@ -19,7 +19,6 @@ import jakarta.validation.Payload; /** * Constraint for strings submitted into the repository. - * */ @Constraint(validatedBy = ValidStringValidator.class) @Target({ ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ValidStringValidator.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ValidStringValidator.java index 4ed95658a..03bf5150f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ValidStringValidator.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/ValidStringValidator.java @@ -9,11 +9,10 @@ */ package org.eclipse.hawkbit.repository; -import com.cronutils.utils.StringUtils; - import jakarta.validation.ConstraintValidator; import jakarta.validation.ConstraintValidatorContext; +import com.cronutils.utils.StringUtils; import lombok.extern.slf4j.Slf4j; import org.jsoup.Jsoup; import org.jsoup.nodes.Document; @@ -34,15 +33,6 @@ public class ValidStringValidator implements ConstraintValidator messages); /** - * @param message - * for {@link ActionStatus#getMessages()} + * @param message for {@link ActionStatus#getMessages()} * @return updated {@link ActionStatusCreate} object */ ActionStatusCreate message(String message); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/AutoAssignDistributionSetUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/AutoAssignDistributionSetUpdate.java index eb3495a42..8b48652ce 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/AutoAssignDistributionSetUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/AutoAssignDistributionSetUpdate.java @@ -41,9 +41,8 @@ public class AutoAssignDistributionSetUpdate { /** * Constructor - * - * @param targetFilterId - * ID of {@link TargetFilterQuery} to update + * + * @param targetFilterId ID of {@link TargetFilterQuery} to update */ public AutoAssignDistributionSetUpdate(final long targetFilterId) { this.targetFilterId = targetFilterId; @@ -51,9 +50,8 @@ public class AutoAssignDistributionSetUpdate { /** * Specify {@link DistributionSet} - * - * @param dsId - * ID of the {@link DistributionSet} + * + * @param dsId ID of the {@link DistributionSet} * @return updated builder instance */ public AutoAssignDistributionSetUpdate ds(final Long dsId) { @@ -63,9 +61,8 @@ public class AutoAssignDistributionSetUpdate { /** * Specify {@link DistributionSet} - * - * @param actionType - * {@link ActionType} used for the auto assignment + * + * @param actionType {@link ActionType} used for the auto assignment * @return updated builder instance */ public AutoAssignDistributionSetUpdate actionType(final ActionType actionType) { @@ -75,9 +72,8 @@ public class AutoAssignDistributionSetUpdate { /** * Specify weight of resulting {@link Action} - * - * @param weight - * weight used for the auto assignment + * + * @param weight weight used for the auto assignment * @return updated builder instance */ public AutoAssignDistributionSetUpdate weight(final Integer weight) { @@ -88,9 +84,8 @@ public class AutoAssignDistributionSetUpdate { /** * Specify initial confirmation state of resulting {@link Action} * - * @param confirmationRequired - * if confirmation is required for this auto assignment (considered - * with confirmation flow active) + * @param confirmationRequired if confirmation is required for this auto assignment (considered + * with confirmation flow active) * @return updated builder instance */ public AutoAssignDistributionSetUpdate confirmationRequired(final boolean confirmationRequired) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetBuilder.java index 07965c68f..576cdfc0e 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetBuilder.java @@ -13,13 +13,11 @@ import org.eclipse.hawkbit.repository.model.DistributionSet; /** * Builder for {@link DistributionSet}. - * */ public interface DistributionSetBuilder { /** - * @param id - * of the updatable entity + * @param id of the updatable entity * @return builder instance */ DistributionSetUpdate update(long id); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetCreate.java index db900a51f..afa1cb5c8 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetCreate.java @@ -25,41 +25,35 @@ import org.eclipse.hawkbit.repository.model.NamedVersionedEntity; * Builder to create a new {@link DistributionSet} entry. Defines all fields * that can be set at creation time. Other fields are set by the repository * automatically, e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface DistributionSetCreate { /** - * @param name - * for {@link DistributionSet#getName()} + * @param name for {@link DistributionSet#getName()} * @return updated builder instance */ DistributionSetCreate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** - * @param version - * for {@link DistributionSet#getVersion()} + * @param version for {@link DistributionSet#getVersion()} * @return updated builder instance */ DistributionSetCreate version(@Size(min = 1, max = NamedVersionedEntity.VERSION_MAX_SIZE) @NotNull String version); /** - * @param description - * for {@link DistributionSet#getDescription()} + * @param description for {@link DistributionSet#getDescription()} * @return updated builder instance */ DistributionSetCreate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param typeKey - * for {@link DistributionSet#getType()} + * @param typeKey for {@link DistributionSet#getType()} * @return updated builder instance */ DistributionSetCreate type(@Size(min = 1, max = DistributionSetType.KEY_MAX_SIZE) @NotNull String typeKey); /** - * @param type - * for {@link DistributionSet#getType()} + * @param type for {@link DistributionSet#getType()} * @return updated builder instance */ default DistributionSetCreate type(final DistributionSetType type) { @@ -67,15 +61,13 @@ public interface DistributionSetCreate { } /** - * @param modules - * for {@link DistributionSet#getModules()} + * @param modules for {@link DistributionSet#getModules()} * @return updated builder instance */ DistributionSetCreate modules(Collection modules); /** - * @param requiredMigrationStep - * for {@link DistributionSet#isRequiredMigrationStep()} + * @param requiredMigrationStep for {@link DistributionSet#isRequiredMigrationStep()} * @return updated builder instance */ DistributionSetCreate requiredMigrationStep(Boolean requiredMigrationStep); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeBuilder.java index 696e7a8ad..9fec5c7ac 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeBuilder.java @@ -13,13 +13,11 @@ import org.eclipse.hawkbit.repository.model.DistributionSetType; /** * Builder for {@link DistributionSetType}. - * */ public interface DistributionSetTypeBuilder { /** - * @param id - * of the updatable entity + * @param id of the updatable entity * @return builder instance */ DistributionSetTypeUpdate update(long id); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeCreate.java index f6de13b76..938ac3e84 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeCreate.java @@ -25,48 +25,41 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleType; * Builder to create a new {@link DistributionSetType} entry. Defines all fields * that can be set at creation time. Other fields are set by the repository * automatically, e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface DistributionSetTypeCreate { /** - * @param key - * for {@link DistributionSetType#getKey()} + * @param key for {@link DistributionSetType#getKey()} * @return updated builder instance */ DistributionSetTypeCreate key(@Size(min = 1, max = DistributionSetType.KEY_MAX_SIZE) @NotNull String key); /** - * @param name - * for {@link DistributionSetType#getName()} + * @param name for {@link DistributionSetType#getName()} * @return updated builder instance */ DistributionSetTypeCreate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** - * @param description - * for {@link DistributionSetType#getDescription()} + * @param description for {@link DistributionSetType#getDescription()} * @return updated builder instance */ DistributionSetTypeCreate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param colour - * for {@link DistributionSetType#getColour()} + * @param colour for {@link DistributionSetType#getColour()} * @return updated builder instance */ DistributionSetTypeCreate colour(@Size(max = DistributionSetType.COLOUR_MAX_SIZE) String colour); /** - * @param mandatory - * for {@link DistributionSetType#getMandatoryModuleTypes()} + * @param mandatory for {@link DistributionSetType#getMandatoryModuleTypes()} * @return updated builder instance */ DistributionSetTypeCreate mandatory(Collection mandatory); /** - * @param mandatory - * for {@link DistributionSetType#getMandatoryModuleTypes()} + * @param mandatory for {@link DistributionSetType#getMandatoryModuleTypes()} * @return updated builder instance */ default DistributionSetTypeCreate mandatory(final Long mandatory) { @@ -74,8 +67,7 @@ public interface DistributionSetTypeCreate { } /** - * @param mandatory - * for {@link DistributionSetType#getOptionalModuleTypes()} + * @param mandatory for {@link DistributionSetType#getOptionalModuleTypes()} * @return updated builder instance */ default DistributionSetTypeCreate mandatory(final SoftwareModuleType mandatory) { @@ -83,15 +75,13 @@ public interface DistributionSetTypeCreate { } /** - * @param optional - * for {@link DistributionSetType#getOptionalModuleTypes()} + * @param optional for {@link DistributionSetType#getOptionalModuleTypes()} * @return updated builder instance */ DistributionSetTypeCreate optional(Collection optional); /** - * @param optional - * for {@link DistributionSetType#getOptionalModuleTypes()} + * @param optional for {@link DistributionSetType#getOptionalModuleTypes()} * @return updated builder instance */ default DistributionSetTypeCreate optional(final Long optional) { @@ -99,8 +89,7 @@ public interface DistributionSetTypeCreate { } /** - * @param optional - * for {@link DistributionSetType#getOptionalModuleTypes()} + * @param optional for {@link DistributionSetType#getOptionalModuleTypes()} * @return updated builder instance */ default DistributionSetTypeCreate optional(final SoftwareModuleType optional) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeUpdate.java index de534e520..271bd9eef 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetTypeUpdate.java @@ -19,34 +19,29 @@ import org.eclipse.hawkbit.repository.model.NamedEntity; /** * Builder to update an existing {@link DistributionSetType} entry. Defines all * fields that can be updated. - * */ public interface DistributionSetTypeUpdate { /** - * @param description - * for {@link DistributionSetType#getDescription()} + * @param description for {@link DistributionSetType#getDescription()} * @return updated builder instance */ DistributionSetTypeUpdate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param colour - * for {@link DistributionSetType#getColour()} + * @param colour for {@link DistributionSetType#getColour()} * @return updated builder instance */ DistributionSetTypeUpdate colour(@Size(max = DistributionSetType.COLOUR_MAX_SIZE) String colour); /** - * @param mandatory - * for {@link DistributionSetType#getMandatoryModuleTypes()} + * @param mandatory for {@link DistributionSetType#getMandatoryModuleTypes()} * @return updated builder instance */ DistributionSetTypeUpdate mandatory(Collection mandatory); /** - * @param optional - * for {@link DistributionSetType#getOptionalModuleTypes()} + * @param optional for {@link DistributionSetType#getOptionalModuleTypes()} * @return updated builder instance */ DistributionSetTypeUpdate optional(Collection optional); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetUpdate.java index aeaa2c00b..0d34c669a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DistributionSetUpdate.java @@ -17,14 +17,12 @@ import org.eclipse.hawkbit.repository.model.DistributionSet; import org.eclipse.hawkbit.repository.model.NamedEntity; import org.eclipse.hawkbit.repository.model.NamedVersionedEntity; -import java.util.Optional; - /** * Builder to update an existing {@link DistributionSet} entry. Defines all * fields that can be updated. - * */ public interface DistributionSetUpdate { + /** * @param name for {@link DistributionSet#getName()} * @return updated builder instance diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DynamicRolloutGroupTemplate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DynamicRolloutGroupTemplate.java index 1ce056267..67f557373 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DynamicRolloutGroupTemplate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/DynamicRolloutGroupTemplate.java @@ -10,6 +10,7 @@ package org.eclipse.hawkbit.repository.builder; import jakarta.validation.constraints.NotNull; + import lombok.Builder; import lombok.Data; import org.eclipse.hawkbit.repository.model.RolloutGroupConditions; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutCreate.java index fb2b63a14..134b2be22 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutCreate.java @@ -25,13 +25,12 @@ import org.eclipse.hawkbit.repository.model.TargetFilterQuery; * Builder to create a new {@link Rollout} entry. Defines all fields that can be * set at creation time. Other fields are set by the repository automatically, * e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface RolloutCreate { /** * Set name - * + * * @param name for {@link Rollout#getName()} * @return updated builder instance */ @@ -39,7 +38,7 @@ public interface RolloutCreate { /** * Set description - * + * * @param description for {@link Rollout#getDescription()} * @return updated builder instance */ @@ -47,7 +46,7 @@ public interface RolloutCreate { /** * Set the {@link DistributionSet} - * + * * @param set for {@link Rollout#getDistributionSet()} * @return updated builder instance */ @@ -57,7 +56,7 @@ public interface RolloutCreate { /** * Set the id of the {@link DistributionSet} - * + * * @param distributionSetId for {@link Rollout#getDistributionSet()} * @return updated builder instance */ @@ -65,7 +64,7 @@ public interface RolloutCreate { /** * Set the {@link TargetFilterQuery} - * + * * @param targetFilterQuery for {@link Rollout#getTargetFilterQuery()} * @return updated builder instance */ @@ -74,7 +73,7 @@ public interface RolloutCreate { /** * Set the {@link ActionType} - * + * * @param actionType for {@link Rollout#getActionType()} * @return updated builder instance */ @@ -82,7 +81,7 @@ public interface RolloutCreate { /** * Set the forcedTime of the resulting {@link org.eclipse.hawkbit.repository.model.Action}s - * + * * @param forcedTime for {@link Rollout#getForcedTime()} * @return updated builder instance */ @@ -90,7 +89,7 @@ public interface RolloutCreate { /** * Set the weight of the resulting {@link org.eclipse.hawkbit.repository.model.Action}s - * + * * @param weight for {@link Rollout#getWeight()} * @return updated builder instance */ @@ -106,7 +105,7 @@ public interface RolloutCreate { /** * Set start at - * + * * @param startAt for {@link Rollout#getStartAt()} * @return updated builder instance */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutGroupCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutGroupCreate.java index 0558ecc0f..df7f433f3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutGroupCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutGroupCreate.java @@ -26,6 +26,7 @@ import org.eclipse.hawkbit.repository.model.TargetFilterQuery; * automatically, e.g. {@link BaseEntity#getCreatedAt()}. */ public interface RolloutGroupCreate { + /** * @param name for {@link Rollout#getName()} * @return updated builder instance @@ -59,7 +60,7 @@ public interface RolloutGroupCreate { /** * @param confirmationRequired if confirmation is required for this rollout group (considered - * with confirmation flow active) + * with confirmation flow active) * @return updated builder instance */ RolloutGroupCreate confirmationRequired(boolean confirmationRequired); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutUpdate.java index 290d8cc04..cb5c677dc 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/RolloutUpdate.java @@ -20,9 +20,10 @@ import org.eclipse.hawkbit.repository.model.Rollout; * can be updated. */ public interface RolloutUpdate { + /** * Set name of the {@link Rollout} - * + * * @param name for {@link Rollout#getName()} * @return updated builder instance */ @@ -30,7 +31,7 @@ public interface RolloutUpdate { /** * Set description of the {@link Rollout} - * + * * @param description for {@link Rollout#getDescription()} * @return updated builder instance */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleBuilder.java index 375828c46..6535161f4 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleBuilder.java @@ -13,13 +13,11 @@ import org.eclipse.hawkbit.repository.model.SoftwareModule; /** * Builder for {@link SoftwareModule}. - * */ public interface SoftwareModuleBuilder { /** - * @param id - * of the updatable entity + * @param id of the updatable entity * @return builder instance */ SoftwareModuleUpdate update(long id); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleCreate.java index be44ec7b2..15c224e93 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleCreate.java @@ -24,47 +24,41 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleType; * Builder to create a new {@link SoftwareModule} entry. Defines all fields that * can be set at creation time. Other fields are set by the repository * automatically, e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface SoftwareModuleCreate { + /** - * @param name - * for {@link SoftwareModule#getName()} + * @param name for {@link SoftwareModule#getName()} * @return updated builder instance */ SoftwareModuleCreate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** - * @param version - * for {@link SoftwareModule#getVersion()} + * @param version for {@link SoftwareModule#getVersion()} * @return updated builder instance */ SoftwareModuleCreate version(@Size(min = 1, max = NamedVersionedEntity.VERSION_MAX_SIZE) @NotNull String version); /** - * @param description - * for {@link SoftwareModule#getDescription()} + * @param description for {@link SoftwareModule#getDescription()} * @return updated builder instance */ SoftwareModuleCreate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param vendor - * for {@link SoftwareModule#getVendor()} + * @param vendor for {@link SoftwareModule#getVendor()} * @return updated builder instance */ SoftwareModuleCreate vendor(@Size(max = SoftwareModule.VENDOR_MAX_SIZE) String vendor); /** - * @param typeKey - * for {@link SoftwareModule#getType()} + * @param typeKey for {@link SoftwareModule#getType()} * @return updated builder instance */ SoftwareModuleCreate type(@Size(min = 1, max = SoftwareModuleType.KEY_MAX_SIZE) @NotNull String typeKey); /** - * @param type - * for {@link SoftwareModule#getType()} + * @param type for {@link SoftwareModule#getType()} * @return updated builder instance */ default SoftwareModuleCreate type(final SoftwareModuleType type) { @@ -72,8 +66,7 @@ public interface SoftwareModuleCreate { } /** - * @param encrypted - * if should be encrypted + * @param encrypted if should be encrypted * @return updated builder instance */ SoftwareModuleCreate encrypted(boolean encrypted); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataBuilder.java index 2cc0704fd..5d8b7ca5c 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataBuilder.java @@ -15,22 +15,18 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleMetadata; /** * Builder for {@link SoftwareModuleMetadata}. - * */ public interface SoftwareModuleMetadataBuilder { /** - * @param softwareModuleId - * of the {@link SoftwareModule} the {@link MetaData} belongs to - * @param key - * of {@link MetaData#getKey()} + * @param softwareModuleId of the {@link SoftwareModule} the {@link MetaData} belongs to + * @param key of {@link MetaData#getKey()} * @return builder instance */ SoftwareModuleMetadataUpdate update(long softwareModuleId, String key); /** - * @param softwareModuleId - * of the {@link SoftwareModule} the {@link MetaData} belongs to + * @param softwareModuleId of the {@link SoftwareModule} the {@link MetaData} belongs to * @return builder instance */ SoftwareModuleMetadataCreate create(long softwareModuleId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataCreate.java index e867ad1e2..6e301fc4a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataCreate.java @@ -20,27 +20,23 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleMetadata; * Builder to create a new {@link SoftwareModuleMetadata} entry. Defines all * fields that can be set at creation time. Other fields are set by the * repository automatically, e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface SoftwareModuleMetadataCreate { /** - * @param key - * for {@link MetaData#getKey()} + * @param key for {@link MetaData#getKey()} * @return updated builder instance */ SoftwareModuleMetadataCreate key(@Size(min = 1, max = MetaData.KEY_MAX_SIZE) @NotNull String key); /** - * @param value - * for {@link MetaData#getValue()} + * @param value for {@link MetaData#getValue()} * @return updated builder instance */ SoftwareModuleMetadataCreate value(@Size(max = MetaData.VALUE_MAX_SIZE) String value); /** - * @param visible - * for {@link SoftwareModuleMetadata#isTargetVisible()} + * @param visible for {@link SoftwareModuleMetadata#isTargetVisible()} * @return updated builder instance */ SoftwareModuleMetadataCreate targetVisible(Boolean visible); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataUpdate.java index ef37fd8b2..28a87b2e7 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleMetadataUpdate.java @@ -18,19 +18,17 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleMetadata; /** * Builder to update an existing {@link SoftwareModuleMetadata} entry. Defines * all fields that can be updated. - * */ public interface SoftwareModuleMetadataUpdate { + /** - * @param value - * for {@link MetaData#getValue()} + * @param value for {@link MetaData#getValue()} * @return updated builder instance */ SoftwareModuleMetadataUpdate value(@Size(min = 1, max = MetaData.VALUE_MAX_SIZE) @NotNull String value); /** - * @param visible - * for {@link SoftwareModuleMetadata#isTargetVisible()} + * @param visible for {@link SoftwareModuleMetadata#isTargetVisible()} * @return updated builder instance */ SoftwareModuleMetadataUpdate targetVisible(Boolean visible); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeBuilder.java index d18a47b54..bc4c770e5 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeBuilder.java @@ -13,13 +13,11 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleType; /** * Builder for {@link SoftwareModuleType}. - * */ public interface SoftwareModuleTypeBuilder { /** - * @param id - * of the updatable entity + * @param id of the updatable entity * @return builder instance */ SoftwareModuleTypeUpdate update(long id); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeCreate.java index 2d0300900..a3207bcb4 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeCreate.java @@ -20,40 +20,35 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleType; * Builder to create a new {@link SoftwareModuleType} entry. Defines all fields * that can be set at creation time. Other fields are set by the repository * automatically, e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface SoftwareModuleTypeCreate { + /** - * @param key - * for {@link SoftwareModuleType#getKey()} + * @param key for {@link SoftwareModuleType#getKey()} * @return updated builder instance */ SoftwareModuleTypeCreate key(@Size(min = 1, max = SoftwareModuleType.KEY_MAX_SIZE) @NotNull String key); /** - * @param name - * for {@link SoftwareModuleType#getName()} + * @param name for {@link SoftwareModuleType#getName()} * @return updated builder instance */ SoftwareModuleTypeCreate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** - * @param description - * for {@link SoftwareModuleType#getDescription()} + * @param description for {@link SoftwareModuleType#getDescription()} * @return updated builder instance */ SoftwareModuleTypeCreate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param colour - * for {@link SoftwareModuleType#getColour()} + * @param colour for {@link SoftwareModuleType#getColour()} * @return updated builder instance */ SoftwareModuleTypeCreate colour(@Size(max = SoftwareModuleType.COLOUR_MAX_SIZE) String colour); /** - * @param maxAssignments - * for {@link SoftwareModuleType#getMaxAssignments()} + * @param maxAssignments for {@link SoftwareModuleType#getMaxAssignments()} * @return updated builder instance */ SoftwareModuleTypeCreate maxAssignments(int maxAssignments); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeUpdate.java index 62e487e16..50f216856 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleTypeUpdate.java @@ -17,19 +17,17 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleType; /** * Builder to update an existing {@link SoftwareModuleType} entry. Defines all * fields that can be updated. - * */ public interface SoftwareModuleTypeUpdate { + /** - * @param description - * for {@link SoftwareModuleType#getDescription()} + * @param description for {@link SoftwareModuleType#getDescription()} * @return updated builder instance */ SoftwareModuleTypeUpdate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param colour - * for {@link SoftwareModuleType#getColour()} + * @param colour for {@link SoftwareModuleType#getColour()} * @return updated builder instance */ SoftwareModuleTypeUpdate colour(@Size(max = SoftwareModuleType.COLOUR_MAX_SIZE) String colour); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleUpdate.java index 297238133..b6edcffaf 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/SoftwareModuleUpdate.java @@ -9,7 +9,6 @@ */ package org.eclipse.hawkbit.repository.builder; -import jakarta.annotation.Nullable; import jakarta.validation.constraints.Null; import jakarta.validation.constraints.Size; @@ -19,20 +18,17 @@ import org.eclipse.hawkbit.repository.model.SoftwareModule; /** * Builder to update an existing {@link SoftwareModule} entry. Defines all * fields that can be updated. - * */ public interface SoftwareModuleUpdate { /** - * @param description - * for {@link SoftwareModule#getDescription()} + * @param description for {@link SoftwareModule#getDescription()} * @return updated builder instance */ SoftwareModuleUpdate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param vendor - * for {@link SoftwareModule#getVendor()} + * @param vendor for {@link SoftwareModule#getVendor()} * @return updated builder instance */ SoftwareModuleUpdate vendor(@Size(max = SoftwareModule.VENDOR_MAX_SIZE) String vendor); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagBuilder.java index 9f9c0a927..39f8a0717 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagBuilder.java @@ -13,13 +13,11 @@ import org.eclipse.hawkbit.repository.model.Tag; /** * Builder for {@link Tag}. - * */ public interface TagBuilder { /** - * @param id - * of the updatable entity + * @param id of the updatable entity * @return builder instance */ TagUpdate update(long id); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagCreate.java index f8d80f5fb..d0972d899 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagCreate.java @@ -20,26 +20,23 @@ import org.eclipse.hawkbit.repository.model.Tag; * Builder to create a new {@link Tag} entry. Defines all fields that can be set * at creation time. Other fields are set by the repository automatically, e.g. * {@link BaseEntity#getCreatedAt()}. - * */ public interface TagCreate { + /** - * @param name - * for {@link Tag#getName()} + * @param name for {@link Tag#getName()} * @return updated builder instance */ TagCreate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** - * @param description - * for {@link Tag#getDescription()} + * @param description for {@link Tag#getDescription()} * @return updated builder instance */ TagCreate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param colour - * for {@link Tag#getColour()} + * @param colour for {@link Tag#getColour()} * @return updated builder instance */ TagCreate colour(@Size(max = Tag.COLOUR_MAX_SIZE) String colour); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagUpdate.java index 51ffa1822..b96fd099e 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TagUpdate.java @@ -18,26 +18,23 @@ import org.eclipse.hawkbit.repository.model.Tag; /** * Builder to update an existing {@link Tag} entry. Defines all fields that can * be updated. - * */ public interface TagUpdate { + /** - * @param name - * for {@link Tag#getName()} + * @param name for {@link Tag#getName()} * @return updated builder instance */ TagUpdate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** - * @param description - * for {@link Tag#getDescription()} + * @param description for {@link Tag#getDescription()} * @return updated builder instance */ TagUpdate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param colour - * for {@link Tag#getColour()} + * @param colour for {@link Tag#getColour()} * @return updated builder instance */ TagUpdate colour(@Size(max = Tag.COLOUR_MAX_SIZE) String colour); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetBuilder.java index d28fb8cfc..c3853fd22 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetBuilder.java @@ -15,13 +15,11 @@ import org.eclipse.hawkbit.repository.model.Target; /** * Builder for {@link Target}. - * */ public interface TargetBuilder { /** - * @param controllerId - * of the updatable entity + * @param controllerId of the updatable entity * @return builder instance */ TargetUpdate update(@NotEmpty String controllerId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetCreate.java index 5d2208863..1556247c1 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetCreate.java @@ -21,70 +21,58 @@ import org.eclipse.hawkbit.repository.model.TargetUpdateStatus; * Builder to create a new {@link Target} entry. Defines all fields that can be * set at creation time. Other fields are set by the repository automatically, * e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface TargetCreate { /** - * @param controllerId - * for {@link Target#getControllerId()} + * @param controllerId for {@link Target#getControllerId()} * @return updated builder instance */ TargetCreate controllerId(@Size(min = 1, max = Target.CONTROLLER_ID_MAX_SIZE) @NotNull String controllerId); /** - * @param name - * for {@link Target#getName()} filled with - * {@link #controllerId(String)} as default if not set explicitly + * @param name for {@link Target#getName()} filled with + * {@link #controllerId(String)} as default if not set explicitly * @return updated builder instance */ TargetCreate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** - * @param description - * for {@link Target#getDescription()} + * @param description for {@link Target#getDescription()} * @return updated builder instance */ TargetCreate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param targetTypeId - * for {@link Target#getTargetType()} + * @param targetTypeId for {@link Target#getTargetType()} * @return updated builder instance */ TargetCreate targetType(Long targetTypeId); /** - * @param securityToken - * for {@link Target#getSecurityToken()} is generated with a - * random sequence as default if not set explicitly + * @param securityToken for {@link Target#getSecurityToken()} is generated with a + * random sequence as default if not set explicitly * @return updated builder instance */ TargetCreate securityToken(@Size(min = 1, max = Target.SECURITY_TOKEN_MAX_SIZE) @NotNull String securityToken); /** - * @param address - * for {@link Target#getAddress()} - * - * @throws IllegalArgumentException - * If the given string violates RFC 2396 - * + * @param address for {@link Target#getAddress()} * @return updated builder instance + * @throws IllegalArgumentException If the given string violates RFC 2396 */ TargetCreate address(@Size(max = Target.ADDRESS_MAX_SIZE) String address); /** - * @param lastTargetQuery - * for {@link Target#getLastTargetQuery()} + * @param lastTargetQuery for {@link Target#getLastTargetQuery()} * @return updated builder instance */ TargetCreate lastTargetQuery(Long lastTargetQuery); /** - * @param status - * for {@link Target#getUpdateStatus()} is - * {@link TargetUpdateStatus#UNKNOWN} as default if not set - * explicitly + * @param status for {@link Target#getUpdateStatus()} is + * {@link TargetUpdateStatus#UNKNOWN} as default if not set + * explicitly * @return updated builder instance */ TargetCreate status(@NotNull TargetUpdateStatus status); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryBuilder.java index 8e0964a30..fc106425f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryBuilder.java @@ -13,23 +13,21 @@ import org.eclipse.hawkbit.repository.model.TargetFilterQuery; /** * Builder for {@link TargetFilterQuery}. - * */ public interface TargetFilterQueryBuilder { + /** * Used to update a {@link TargetFilterQuery} - * - * @param id - * of the updatable entity + * + * @param id of the updatable entity * @return builder instance */ TargetFilterQueryUpdate update(long id); /** * Used to update a the auto assignment of a {@link TargetFilterQuery} - * - * @param id - * of the updatable entity + * + * @param id of the updatable entity * @return builder instance */ AutoAssignDistributionSetUpdate updateAutoAssign(long id); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryCreate.java index 44be0b892..6b05a4e3b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryCreate.java @@ -25,32 +25,29 @@ import org.eclipse.hawkbit.repository.model.TargetFilterQuery; * Builder to create a new {@link TargetFilterQuery} entry. Defines all fields * that can be set at creation time. Other fields are set by the repository * automatically, e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface TargetFilterQueryCreate { + /** * Set filter name - * - * @param name - * of {@link TargetFilterQuery#getName()} + * + * @param name of {@link TargetFilterQuery#getName()} * @return updated builder instance */ TargetFilterQueryCreate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** * Set filter query - * - * @param query - * of {@link TargetFilterQuery#getQuery()} + * + * @param query of {@link TargetFilterQuery#getQuery()} * @return updated builder instance */ TargetFilterQueryCreate query(@Size(min = 1, max = TargetFilterQuery.QUERY_MAX_SIZE) @NotNull String query); /** * Set {@link DistributionSet} for auto assignment - * - * @param distributionSet - * for {@link TargetFilterQuery#getAutoAssignDistributionSet()} + * + * @param distributionSet for {@link TargetFilterQuery#getAutoAssignDistributionSet()} * @return updated builder instance */ default TargetFilterQueryCreate autoAssignDistributionSet(final DistributionSet distributionSet) { @@ -59,27 +56,24 @@ public interface TargetFilterQueryCreate { /** * Set ID of {@link DistributionSet} for auto assignment - * - * @param dsId - * for {@link TargetFilterQuery#getAutoAssignDistributionSet()} + * + * @param dsId for {@link TargetFilterQuery#getAutoAssignDistributionSet()} * @return updated builder instance */ TargetFilterQueryCreate autoAssignDistributionSet(Long dsId); /** * Set {@link ActionType} for auto assignment - * - * @param actionType - * for {@link TargetFilterQuery#getAutoAssignActionType()} + * + * @param actionType for {@link TargetFilterQuery#getAutoAssignActionType()} * @return updated builder instance */ TargetFilterQueryCreate autoAssignActionType(ActionType actionType); /** * Set weight of {@link Action} created during auto assignment - * - * @param weight - * weight of {@link Action} generated within auto assignment + * + * @param weight weight of {@link Action} generated within auto assignment * @return updated builder instance */ TargetFilterQueryCreate autoAssignWeight(Integer weight); @@ -88,9 +82,8 @@ public interface TargetFilterQueryCreate { * Specify initial confirmation state of resulting {@link Action} in auto * assignment * - * @param confirmationRequired - * if confirmation is required for configured auto assignment (considered - * with confirmation flow active) + * @param confirmationRequired if confirmation is required for configured auto assignment (considered + * with confirmation flow active) * @return updated builder instance */ TargetFilterQueryCreate confirmationRequired(boolean confirmationRequired); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryUpdate.java index c21c7d546..0ec9baa21 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetFilterQueryUpdate.java @@ -17,19 +17,17 @@ import org.eclipse.hawkbit.repository.model.TargetFilterQuery; /** * Builder to update an existing {@link TargetFilterQuery} entry. Defines all * fields that can be updated. - * */ public interface TargetFilterQueryUpdate { + /** - * @param name - * of {@link TargetFilterQuery#getName()} + * @param name of {@link TargetFilterQuery#getName()} * @return updated builder instance */ TargetFilterQueryUpdate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) String name); /** - * @param query - * of {@link TargetFilterQuery#getQuery()} + * @param query of {@link TargetFilterQuery#getQuery()} * @return updated builder instance */ TargetFilterQueryUpdate query(@Size(min = 1, max = TargetFilterQuery.QUERY_MAX_SIZE) String query); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeBuilder.java index 6208c98e0..6400b0134 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeBuilder.java @@ -13,12 +13,11 @@ import org.eclipse.hawkbit.repository.model.TargetType; /** * Builder for {@link TargetType}. - * */ public interface TargetTypeBuilder { + /** - * @param id - * of the updatable entity + * @param id of the updatable entity * @return builder instance */ TargetTypeUpdate update(long id); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeCreate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeCreate.java index deed045c7..14e4af932 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeCreate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeCreate.java @@ -9,64 +9,58 @@ */ package org.eclipse.hawkbit.repository.builder; +import java.util.Collection; +import java.util.Collections; + +import jakarta.validation.constraints.NotEmpty; +import jakarta.validation.constraints.NotNull; +import jakarta.validation.constraints.Size; + import org.eclipse.hawkbit.repository.model.BaseEntity; import org.eclipse.hawkbit.repository.model.DistributionSetType; import org.eclipse.hawkbit.repository.model.NamedEntity; import org.eclipse.hawkbit.repository.model.TargetType; import org.eclipse.hawkbit.repository.model.Type; -import jakarta.validation.constraints.NotEmpty; -import jakarta.validation.constraints.NotNull; -import jakarta.validation.constraints.Size; -import java.util.Collection; -import java.util.Collections; - /** * Builder to create a new {@link TargetType} entry. Defines all fields * that can be set at creation time. Other fields are set by the repository * automatically, e.g. {@link BaseEntity#getCreatedAt()}. - * */ public interface TargetTypeCreate { /** - * @param name - * for {@link TargetType#getName()} + * @param name for {@link TargetType#getName()} * @return updated builder instance */ TargetTypeCreate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotEmpty String name); /** - * @param description - * for {@link TargetType#getDescription()} + * @param description for {@link TargetType#getDescription()} * @return updated builder instance */ TargetTypeCreate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param key - * for {@link TargetType#getName()} + * @param key for {@link TargetType#getName()} * @return updated builder instance */ TargetTypeCreate key(@Size(min = 1, max = Type.KEY_MAX_SIZE) @NotEmpty String key); /** - * @param colour - * for {@link TargetType#getColour()} + * @param colour for {@link TargetType#getColour()} * @return updated builder instance */ TargetTypeCreate colour(@Size(max = Type.COLOUR_MAX_SIZE) String colour); /** - * @param compatible - * for {@link TargetType#getCompatibleDistributionSetTypes()} + * @param compatible for {@link TargetType#getCompatibleDistributionSetTypes()} * @return updated builder instance */ TargetTypeCreate compatible(@NotEmpty Collection compatible); /** - * @param compatible - * for {@link TargetType#getCompatibleDistributionSetTypes()} + * @param compatible for {@link TargetType#getCompatibleDistributionSetTypes()} * @return updated builder instance */ default TargetTypeCreate compatible(@NotNull final Long compatible) { @@ -74,8 +68,7 @@ public interface TargetTypeCreate { } /** - * @param compatible - * for {@link TargetType#getCompatibleDistributionSetTypes()} + * @param compatible for {@link TargetType#getCompatibleDistributionSetTypes()} * @return updated builder instance */ default TargetTypeCreate compatible(@NotNull final DistributionSetType compatible) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeUpdate.java index 0a8cf21c5..556233bb3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetTypeUpdate.java @@ -9,34 +9,31 @@ */ package org.eclipse.hawkbit.repository.builder; +import jakarta.validation.constraints.Size; + import org.eclipse.hawkbit.repository.model.NamedEntity; import org.eclipse.hawkbit.repository.model.TargetType; -import jakarta.validation.constraints.Size; - /** * Builder to update an existing {@link TargetType} entry. Defines all * fields that can be updated. - * */ public interface TargetTypeUpdate { + /** - * @param description - * for {@link TargetType#getDescription()} + * @param description for {@link TargetType#getDescription()} * @return updated builder instance */ TargetTypeUpdate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param colour - * for {@link TargetType#getColour()} + * @param colour for {@link TargetType#getColour()} * @return updated builder instance */ TargetTypeUpdate colour(@Size(max = TargetType.COLOUR_MAX_SIZE) String colour); /** - * @param name - * Name + * @param name Name * @return updated builder instance */ TargetTypeUpdate name(@Size(max = TargetType.NAME_MAX_SIZE) String name); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetUpdate.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetUpdate.java index 233c977f3..20e451172 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetUpdate.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/builder/TargetUpdate.java @@ -19,59 +19,48 @@ import org.eclipse.hawkbit.repository.model.TargetUpdateStatus; /** * Builder to update an existing {@link Target} entry. Defines all fields that * can be updated. - * */ public interface TargetUpdate { /** - * @param name - * for {@link Target#getName()} + * @param name for {@link Target#getName()} * @return updated builder instance */ TargetUpdate name(@Size(min = 1, max = NamedEntity.NAME_MAX_SIZE) @NotNull String name); /** - * @param description - * for {@link Target#getDescription()} + * @param description for {@link Target#getDescription()} * @return updated builder instance */ TargetUpdate description(@Size(max = NamedEntity.DESCRIPTION_MAX_SIZE) String description); /** - * @param securityToken - * for {@link Target#getSecurityToken()} + * @param securityToken for {@link Target#getSecurityToken()} * @return updated builder instance */ TargetUpdate securityToken(@Size(min = 1, max = Target.SECURITY_TOKEN_MAX_SIZE) @NotNull String securityToken); /** - * @param targetTypeId - * for {@link Target#getTargetType()} + * @param targetTypeId for {@link Target#getTargetType()} * @return updated builder instance */ TargetUpdate targetType(@NotNull Long targetTypeId); /** - * @param address - * for {@link Target#getAddress()} - * - * @throws IllegalArgumentException - * If the given string violates RFC 2396 - * + * @param address for {@link Target#getAddress()} * @return updated builder instance + * @throws IllegalArgumentException If the given string violates RFC 2396 */ TargetUpdate address(@Size(max = Target.ADDRESS_MAX_SIZE) String address); /** - * @param lastTargetQuery - * for {@link Target#getLastTargetQuery()} + * @param lastTargetQuery for {@link Target#getLastTargetQuery()} * @return updated builder instance */ TargetUpdate lastTargetQuery(Long lastTargetQuery); /** - * @param status - * for {@link Target#getUpdateStatus()} + * @param status for {@link Target#getUpdateStatus()} * @return updated builder instance */ TargetUpdate status(@NotNull TargetUpdateStatus status); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/ApplicationEventFilter.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/ApplicationEventFilter.java index 5d5437dcc..dce764cf7 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/ApplicationEventFilter.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/ApplicationEventFilter.java @@ -14,15 +14,12 @@ import org.springframework.context.ApplicationEvent; /** * ApplicationEventFilter for hawkBit internal {@link ApplicationEvent} * publishing. - * */ @FunctionalInterface public interface ApplicationEventFilter { /** - * - * @param event - * to verify + * @param event to verify * @return true if event should be filtered */ boolean filter(final ApplicationEvent event); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/CustomEvents.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/CustomEvents.java index d9f9e0111..376961bb4 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/CustomEvents.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/CustomEvents.java @@ -11,10 +11,6 @@ package org.eclipse.hawkbit.repository.event; /** * Events to be published to refresh data on UI. - * - * - * - * */ public enum CustomEvents { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/TenantAwareEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/TenantAwareEvent.java index 60e17c473..2d81643d2 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/TenantAwareEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/TenantAwareEvent.java @@ -12,7 +12,6 @@ package org.eclipse.hawkbit.repository.event; /** * An event declaration which holds an revision for each event so consumers have * the chance to know if they might already retrieved a newer event. - * */ @FunctionalInterface public interface TenantAwareEvent { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/AbstractAssignmentEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/AbstractAssignmentEvent.java index 0cb14e909..cfa86ec31 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/AbstractAssignmentEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/AbstractAssignmentEvent.java @@ -9,16 +9,16 @@ */ package org.eclipse.hawkbit.repository.event.remote; -import lombok.Data; -import org.eclipse.hawkbit.repository.model.Action; -import org.eclipse.hawkbit.repository.model.ActionProperties; - import java.util.HashMap; import java.util.List; import java.util.Map; import java.util.Optional; import java.util.stream.Collectors; +import lombok.Data; +import org.eclipse.hawkbit.repository.model.Action; +import org.eclipse.hawkbit.repository.model.ActionProperties; + /** * Abstract class providing information about an assignment. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetDeletedEvent.java index 25590edc1..05aa8d8b3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetDeletedEvent.java @@ -29,13 +29,10 @@ public class DistributionSetDeletedEvent extends RemoteIdEvent implements Entity /** * Constructor. - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param applicationId - * the origin application id + * + * @param tenant the tenant + * @param entityId the entity id + * @param applicationId the origin application id */ public DistributionSetDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetTagDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetTagDeletedEvent.java index 02be84e69..479399664 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetTagDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetTagDeletedEvent.java @@ -29,15 +29,11 @@ public class DistributionSetTagDeletedEvent extends RemoteIdEvent implements Ent /** * Constructor for json serialization. - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public DistributionSetTagDeletedEvent(final String tenant, final Long entityId, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetTypeDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetTypeDeletedEvent.java index b16fc67d4..15fbd9b23 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetTypeDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DistributionSetTypeDeletedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.DistributionSetType; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; /** - * * Defines the remote event of deleting a {@link DistributionSetType}. */ public class DistributionSetTypeDeletedEvent extends RemoteIdEvent implements EntityDeletedEvent { @@ -30,15 +29,11 @@ public class DistributionSetTypeDeletedEvent extends RemoteIdEvent implements En /** * Constructor for json serialization. - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public DistributionSetTypeDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DownloadProgressEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DownloadProgressEvent.java index c4d3efa1e..e87154616 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DownloadProgressEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/DownloadProgressEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.ActionStatus; /** * TenantAwareEvent that contains an updated download progress for a given * ActionStatus that was written for a download request. - * */ public class DownloadProgressEvent extends RemoteTenantAwareEvent { @@ -31,15 +30,11 @@ public class DownloadProgressEvent extends RemoteTenantAwareEvent { /** * Constructor. - * - * @param tenant - * the tenant - * @param actionStatusId - * of the {@link ActionStatus} the download belongs to - * @param shippedBytesSinceLast - * the shippedBytesSinceLast - * @param applicationId - * the application id. + * + * @param tenant the tenant + * @param actionStatusId of the {@link ActionStatus} the download belongs to + * @param shippedBytesSinceLast the shippedBytesSinceLast + * @param applicationId the application id. */ public DownloadProgressEvent(final String tenant, final Long actionStatusId, final long shippedBytesSinceLast, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/EventEntityManager.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/EventEntityManager.java index 4faeb81cf..213daf8c6 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/EventEntityManager.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/EventEntityManager.java @@ -19,13 +19,10 @@ public interface EventEntityManager { /** * Find an entity by given id and return it. - * - * @param tenant - * the tenant - * @param id - * the id - * @param entityType - * the entity type + * + * @param tenant the tenant + * @param id the id + * @param entityType the entity type * @return the entity */ E findEntity(String tenant, Long id, Class entityType); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/EventEntityManagerHolder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/EventEntityManagerHolder.java index cab39718d..77b18537a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/EventEntityManagerHolder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/EventEntityManagerHolder.java @@ -14,7 +14,6 @@ import org.springframework.beans.factory.annotation.Autowired; /** * A singleton bean which holds the event entity manager to have autowiring in * the events. - * */ public final class EventEntityManagerHolder { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionAssignEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionAssignEvent.java index d1d744c0c..4851222a3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionAssignEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionAssignEvent.java @@ -9,12 +9,12 @@ */ package org.eclipse.hawkbit.repository.event.remote; +import java.util.List; + import lombok.AccessLevel; import lombok.NoArgsConstructor; import org.eclipse.hawkbit.repository.model.Action; -import java.util.List; - /** * Generic deployment event for the Multi-Assignments feature. The event extends * the {@link MultiActionEvent} and holds a list of controller IDs to identify @@ -30,12 +30,9 @@ public class MultiActionAssignEvent extends MultiActionEvent { /** * Constructor. * - * @param tenant - * tenant the event is scoped to - * @param applicationId - * the application id - * @param actions - * the actions of the deployment action + * @param tenant tenant the event is scoped to + * @param applicationId the application id + * @param actions the actions of the deployment action */ public MultiActionAssignEvent(String tenant, String applicationId, List actions) { super(tenant, applicationId, actions); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionCancelEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionCancelEvent.java index e770749b3..b85047e25 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionCancelEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionCancelEvent.java @@ -34,12 +34,9 @@ public class MultiActionCancelEvent extends MultiActionEvent { /** * Constructor. * - * @param tenant - * tenant the event is scoped to - * @param applicationId - * the application id - * @param actions - * the actions to be canceled + * @param tenant tenant the event is scoped to + * @param applicationId the application id + * @param actions the actions to be canceled */ public MultiActionCancelEvent(String tenant, String applicationId, List actions) { super(tenant, applicationId, actions); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionEvent.java index 5f45e969a..8dabcfb54 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/MultiActionEvent.java @@ -43,12 +43,9 @@ public abstract class MultiActionEvent extends RemoteTenantAwareEvent implements /** * Constructor. * - * @param tenant - * tenant the event is scoped to - * @param applicationId - * the application id - * @param actions - * the actions involved + * @param tenant tenant the event is scoped to + * @param applicationId the application id + * @param actions the actions involved */ protected MultiActionEvent(String tenant, String applicationId, List actions) { super(applicationId, tenant, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RemoteIdEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RemoteIdEvent.java index 96b1d7beb..a9e328fca 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RemoteIdEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RemoteIdEvent.java @@ -9,6 +9,9 @@ */ package org.eclipse.hawkbit.repository.event.remote; +import java.io.Serial; +import java.util.Arrays; + import lombok.AccessLevel; import lombok.EqualsAndHashCode; import lombok.Getter; @@ -16,9 +19,6 @@ import lombok.NoArgsConstructor; import lombok.ToString; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; -import java.io.Serial; -import java.util.Arrays; - /** * An base definition class for an event which contains an id. */ @@ -39,15 +39,11 @@ public class RemoteIdEvent extends RemoteTenantAwareEvent { /** * Constructor for json serialization. - * - * @param entityId - * the entity Id - * @param tenant - * the tenant - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * + * @param entityId the entity Id + * @param tenant the tenant + * @param entityClass the entity class + * @param applicationId the origin application id */ protected RemoteIdEvent(final Long entityId, final String tenant, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RemoteTenantAwareEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RemoteTenantAwareEvent.java index fec102060..e03b1c1fa 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RemoteTenantAwareEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RemoteTenantAwareEvent.java @@ -9,16 +9,15 @@ */ package org.eclipse.hawkbit.repository.event.remote; +import java.io.Serial; + +import com.cronutils.utils.StringUtils; import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.ToString; import org.eclipse.hawkbit.repository.event.TenantAwareEvent; import org.springframework.cloud.bus.event.RemoteApplicationEvent; -import com.cronutils.utils.StringUtils; - -import java.io.Serial; - /** * A distributed tenant aware event. It's the base class of the other * distributed events. All the necessary information of distributing events to @@ -43,13 +42,10 @@ public class RemoteTenantAwareEvent extends RemoteApplicationEvent implements Te /** * Constructor. - * - * @param source - * the for the remote event. - * @param tenant - * the tenant - * @param applicationId - * the applicationId + * + * @param source the for the remote event. + * @param tenant the tenant + * @param applicationId the applicationId */ public RemoteTenantAwareEvent(final Object source, final String tenant, final String applicationId) { // due to a bug in Spring Cloud, we cannot pass null for applicationId diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutDeletedEvent.java index 014851507..2e0912539 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutDeletedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.Rollout; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; /** - * * Defines the remote event of deleting a {@link Rollout}. */ public class RolloutDeletedEvent extends RemoteIdEvent implements EntityDeletedEvent { @@ -30,15 +29,11 @@ public class RolloutDeletedEvent extends RemoteIdEvent implements EntityDeletedE /** * Constructor for json serialization. - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public RolloutDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutGroupDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutGroupDeletedEvent.java index 8cded069a..0798a00dc 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutGroupDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutGroupDeletedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.RolloutGroup; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; /** - * * Defines the remote event of deleting a {@link RolloutGroup}. */ public class RolloutGroupDeletedEvent extends RemoteIdEvent implements EntityDeletedEvent { @@ -30,15 +29,11 @@ public class RolloutGroupDeletedEvent extends RemoteIdEvent implements EntityDel /** * Constructor for json serialization. - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public RolloutGroupDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutStoppedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutStoppedEvent.java index e449e4927..519e5c7de 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutStoppedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/RolloutStoppedEvent.java @@ -15,7 +15,6 @@ import lombok.Data; import org.eclipse.hawkbit.repository.model.DistributionSet; /** - * * Event that is published when a rollout is stopped due to invalidation of a * {@link DistributionSet}. */ @@ -37,14 +36,10 @@ public class RolloutStoppedEvent extends RemoteTenantAwareEvent { /** * Constructor for json serialization. * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public RolloutStoppedEvent(final String tenant, final String applicationId, final long rolloutId, final Collection rolloutGroupIds) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/SoftwareModuleDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/SoftwareModuleDeletedEvent.java index 665df95c2..4ee89db40 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/SoftwareModuleDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/SoftwareModuleDeletedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.SoftwareModule; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; /** - * * Defines the remote event of deleting a {@link SoftwareModule}. */ public class SoftwareModuleDeletedEvent extends RemoteIdEvent implements EntityDeletedEvent { @@ -30,15 +29,11 @@ public class SoftwareModuleDeletedEvent extends RemoteIdEvent implements EntityD /** * Constructor for json serialization. - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public SoftwareModuleDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/SoftwareModuleTypeDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/SoftwareModuleTypeDeletedEvent.java index 3fde104b3..54dfc2557 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/SoftwareModuleTypeDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/SoftwareModuleTypeDeletedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.SoftwareModuleType; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; /** - * * Defines the remote event of deleting a {@link SoftwareModuleType}. */ public class SoftwareModuleTypeDeletedEvent extends RemoteIdEvent implements EntityDeletedEvent { @@ -30,15 +29,11 @@ public class SoftwareModuleTypeDeletedEvent extends RemoteIdEvent implements Ent /** * Constructor for json serialization. - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public SoftwareModuleTypeDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetAssignDistributionSetEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetAssignDistributionSetEvent.java index e082decc6..e50ea5231 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetAssignDistributionSetEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetAssignDistributionSetEvent.java @@ -37,17 +37,12 @@ public class TargetAssignDistributionSetEvent extends AbstractAssignmentEvent { /** * Constructor. - * - * @param tenant - * of the event - * @param distributionSetId - * of the set that was assigned - * @param a - * the actions and the targets - * @param applicationId - * the application id. - * @param maintenanceWindowAvailable - * see {@link Action#isMaintenanceWindowAvailable()} + * + * @param tenant of the event + * @param distributionSetId of the set that was assigned + * @param a the actions and the targets + * @param applicationId the application id. + * @param maintenanceWindowAvailable see {@link Action#isMaintenanceWindowAvailable()} */ public TargetAssignDistributionSetEvent(final String tenant, final long distributionSetId, final List a, final String applicationId, final boolean maintenanceWindowAvailable) { @@ -62,10 +57,8 @@ public class TargetAssignDistributionSetEvent extends AbstractAssignmentEvent { /** * Constructor. * - * @param action - * the action created for this assignment - * @param applicationId - * the application id + * @param action the action created for this assignment + * @param applicationId the application id */ public TargetAssignDistributionSetEvent(final Action action, final String applicationId) { this(action.getTenant(), action.getDistributionSet().getId(), Collections.singletonList(action), applicationId, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetAttributesRequestedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetAttributesRequestedEvent.java index b74ca9e30..da3ee2059 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetAttributesRequestedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetAttributesRequestedEvent.java @@ -9,14 +9,14 @@ */ package org.eclipse.hawkbit.repository.event.remote; +import java.io.Serial; + import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.ToString; import org.eclipse.hawkbit.repository.model.Target; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; -import java.io.Serial; - /** * Defines the remote event of triggering attribute updates of a {@link Target}. */ @@ -41,18 +41,12 @@ public class TargetAttributesRequestedEvent extends RemoteIdEvent { /** * Constructor json serialization * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param controllerId - * the controllerId of the target - * @param targetAddress - * the target address - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * @param tenant the tenant + * @param entityId the entity id + * @param controllerId the controllerId of the target + * @param targetAddress the target address + * @param entityClass the entity class + * @param applicationId the origin application id */ public TargetAttributesRequestedEvent(final String tenant, final Long entityId, final String controllerId, final String targetAddress, final Class entityClass, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetDeletedEvent.java index fcaa6019f..d66d6080d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetDeletedEvent.java @@ -9,6 +9,8 @@ */ package org.eclipse.hawkbit.repository.event.remote; +import java.io.Serial; + import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.ToString; @@ -16,8 +18,6 @@ import org.eclipse.hawkbit.repository.event.entity.EntityDeletedEvent; import org.eclipse.hawkbit.repository.model.Target; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; -import java.io.Serial; - /** * Defines the remote event of deleting a {@link Target}. */ @@ -40,19 +40,12 @@ public class TargetDeletedEvent extends RemoteIdEvent implements EntityDeletedEv } /** - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param controllerId - * the controllerId of the target - * @param targetAddress - * the target address - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * @param tenant the tenant + * @param entityId the entity id + * @param controllerId the controllerId of the target + * @param targetAddress the target address + * @param entityClass the entity class + * @param applicationId the origin application id */ public TargetDeletedEvent(final String tenant, final Long entityId, final String controllerId, final String targetAddress, final Class entityClass, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetFilterQueryDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetFilterQueryDeletedEvent.java index 5d4a0b4b0..5503a8d0a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetFilterQueryDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetFilterQueryDeletedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.TargetFilterQuery; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; /** - * * Defines the remote event of deleting a {@link TargetFilterQuery}. */ public class TargetFilterQueryDeletedEvent extends RemoteIdEvent implements EntityDeletedEvent { @@ -29,15 +28,10 @@ public class TargetFilterQueryDeletedEvent extends RemoteIdEvent implements Enti } /** - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public TargetFilterQueryDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetPollEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetPollEvent.java index 7613ea7de..ea9b0ce22 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetPollEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetPollEvent.java @@ -9,13 +9,13 @@ */ package org.eclipse.hawkbit.repository.event.remote; +import java.io.Serial; + import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.ToString; import org.eclipse.hawkbit.repository.model.Target; -import java.io.Serial; - /** * Event is send in case a target polls either through DDI or DMF. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetTagDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetTagDeletedEvent.java index 1eedb41a0..005e08d72 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetTagDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetTagDeletedEvent.java @@ -15,7 +15,6 @@ import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; /** * Defines the remote event of delete a {@link TargetTag}. - * */ public class TargetTagDeletedEvent extends RemoteIdEvent implements EntityDeletedEvent { @@ -30,15 +29,11 @@ public class TargetTagDeletedEvent extends RemoteIdEvent implements EntityDelete /** * Constructor for json serialization. - * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public TargetTagDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetTypeDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetTypeDeletedEvent.java index 058cfcd92..6f28d1bf0 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetTypeDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TargetTypeDeletedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.TargetType; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; /** - * * Defines the remote event of deleting a {@link TargetType}. */ public class TargetTypeDeletedEvent extends RemoteIdEvent implements EntityDeletedEvent { @@ -31,14 +30,10 @@ public class TargetTypeDeletedEvent extends RemoteIdEvent implements EntityDelet /** * Constructor for json serialization. * - * @param tenant - * the tenant - * @param entityId - * the entity id - * @param entityClass - * the entity class - * @param applicationId - * the origin application id + * @param tenant the tenant + * @param entityId the entity id + * @param entityClass the entity class + * @param applicationId the origin application id */ public TargetTypeDeletedEvent(final String tenant, final Long entityId, final Class entityClass, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TenantConfigurationDeletedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TenantConfigurationDeletedEvent.java index 605eb9074..12025839c 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TenantConfigurationDeletedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/TenantConfigurationDeletedEvent.java @@ -9,6 +9,8 @@ */ package org.eclipse.hawkbit.repository.event.remote; +import java.io.Serial; + import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.NoArgsConstructor; @@ -16,8 +18,6 @@ import lombok.ToString; import org.eclipse.hawkbit.repository.event.entity.EntityDeletedEvent; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; -import java.io.Serial; - /** * Defines the remote event of deleting a {@link org.eclipse.hawkbit.repository.model.TenantConfiguration}. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/AbstractActionEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/AbstractActionEvent.java index 5d68120ef..e7f7469db 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/AbstractActionEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/AbstractActionEvent.java @@ -43,7 +43,7 @@ public abstract class AbstractActionEvent extends RemoteEntityEvent { /** * Constructor - * + * * @param action the created action * @param targetId targetId identifier (optional) * @param rolloutId rollout identifier (optional) diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/AbstractRolloutGroupEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/AbstractRolloutGroupEvent.java index 3222514bc..95decb151 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/AbstractRolloutGroupEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/AbstractRolloutGroupEvent.java @@ -18,6 +18,7 @@ import org.eclipse.hawkbit.repository.model.RolloutGroup; * updated */ public abstract class AbstractRolloutGroupEvent extends RemoteEntityEvent { + private static final long serialVersionUID = 1L; private final Long rolloutId; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/ActionCreatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/ActionCreatedEvent.java index 7bb5ff217..9229ff70a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/ActionCreatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/ActionCreatedEvent.java @@ -16,6 +16,7 @@ import org.eclipse.hawkbit.repository.model.Action; * Defines the remote event of creating a new {@link Action}. */ public class ActionCreatedEvent extends AbstractActionEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 2L; /** @@ -27,17 +28,12 @@ public class ActionCreatedEvent extends AbstractActionEvent implements EntityCre /** * Constructor - * - * @param action - * the created action - * @param targetId - * targetId identifier (optional) - * @param rolloutId - * rollout identifier (optional) - * @param rolloutGroupId - * rollout group identifier (optional) - * @param applicationId - * the origin application id + * + * @param action the created action + * @param targetId targetId identifier (optional) + * @param rolloutId rollout identifier (optional) + * @param rolloutGroupId rollout group identifier (optional) + * @param applicationId the origin application id */ public ActionCreatedEvent(final Action action, final Long targetId, final Long rolloutId, final Long rolloutGroupId, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/ActionUpdatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/ActionUpdatedEvent.java index f58dd0b61..d10ef5a8e 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/ActionUpdatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/ActionUpdatedEvent.java @@ -16,6 +16,7 @@ import org.eclipse.hawkbit.repository.model.Action; * Defines the remote event of updated a {@link Action}. */ public class ActionUpdatedEvent extends AbstractActionEvent implements EntityUpdatedEvent { + private static final long serialVersionUID = 2L; /** @@ -27,17 +28,12 @@ public class ActionUpdatedEvent extends AbstractActionEvent implements EntityUpd /** * Constructor - * - * @param action - * the updated action - * @param targetId - * targetId identifier (optional) - * @param rolloutId - * rollout identifier (optional) - * @param rolloutGroupId - * rollout group identifier (optional) - * @param applicationId - * the origin application id + * + * @param action the updated action + * @param targetId targetId identifier (optional) + * @param rolloutId rollout identifier (optional) + * @param rolloutGroupId rollout group identifier (optional) + * @param applicationId the origin application id */ public ActionUpdatedEvent(final Action action, final Long targetId, final Long rolloutId, final Long rolloutGroupId, final String applicationId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/DistributionSetCreatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/DistributionSetCreatedEvent.java index d10e42a29..97166180d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/DistributionSetCreatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/DistributionSetCreatedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.DistributionSet; /** * Defines the the remote of creating a new {@link DistributionSet}. - * */ public class DistributionSetCreatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { @@ -29,11 +28,9 @@ public class DistributionSetCreatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { @@ -31,11 +30,9 @@ public class DistributionSetTagCreatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -30,11 +29,9 @@ public class DistributionSetTagUpdatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -29,11 +29,9 @@ public class DistributionSetTypeCreatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -31,11 +30,9 @@ public class DistributionSetTypeUpdatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -31,14 +30,11 @@ public class DistributionSetUpdatedEvent extends RemoteEntityEventtrue if {@link DistributionSet} is after the - * update {@link DistributionSet#isComplete()} + * + * @param ds Distribution Set + * @param applicationId the origin application id + * @param complete true if {@link DistributionSet} is after the + * update {@link DistributionSet#isComplete()} */ public DistributionSetUpdatedEvent(final DistributionSet ds, final String applicationId, final boolean complete) { super(ds, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RemoteEntityEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RemoteEntityEvent.java index 9b99f556b..bab42df55 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RemoteEntityEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RemoteEntityEvent.java @@ -12,6 +12,7 @@ package org.eclipse.hawkbit.repository.event.remote.entity; import java.io.Serial; import java.util.Optional; +import com.fasterxml.jackson.annotation.JsonIgnore; import lombok.AccessLevel; import lombok.NoArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -19,8 +20,6 @@ import org.eclipse.hawkbit.repository.event.remote.EventEntityManagerHolder; import org.eclipse.hawkbit.repository.event.remote.RemoteIdEvent; import org.eclipse.hawkbit.repository.model.TenantAwareBaseEntity; -import com.fasterxml.jackson.annotation.JsonIgnore; - /** * A base definition class for remote events which contain a tenant aware base entity. * diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutCreatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutCreatedEvent.java index f5839f1f7..b8f85660a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutCreatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutCreatedEvent.java @@ -14,9 +14,9 @@ import org.eclipse.hawkbit.repository.model.Rollout; /** * Defines the remote event of creating a new {@link Rollout}. - * */ public class RolloutCreatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -28,11 +28,9 @@ public class RolloutCreatedEvent extends RemoteEntityEvent implements E /** * Constructor. - * - * @param baseEntity - * the Rollout - * @param applicationId - * the origin application id + * + * @param baseEntity the Rollout + * @param applicationId the origin application id */ public RolloutCreatedEvent(final Rollout baseEntity, final String applicationId) { super(baseEntity, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutGroupCreatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutGroupCreatedEvent.java index d743d9bb2..7e6bed9b7 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutGroupCreatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutGroupCreatedEvent.java @@ -15,9 +15,9 @@ import org.eclipse.hawkbit.repository.model.RolloutGroup; /** * TenantAwareEvent definition which is been published in case a rollout group * has been created for a specific rollout. - * */ public class RolloutGroupCreatedEvent extends AbstractRolloutGroupEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -29,13 +29,10 @@ public class RolloutGroupCreatedEvent extends AbstractRolloutGroupEvent implemen /** * Constructor - * - * @param rolloutGroup - * the updated rolloutGroup - * @param rolloutId - * of the related rollout - * @param applicationId - * the origin application id + * + * @param rolloutGroup the updated rolloutGroup + * @param rolloutId of the related rollout + * @param applicationId the origin application id */ public RolloutGroupCreatedEvent(final RolloutGroup rolloutGroup, final Long rolloutId, final String applicationId) { super(rolloutGroup, rolloutId, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutGroupUpdatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutGroupUpdatedEvent.java index 4305e67fd..e725e47d7 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutGroupUpdatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutGroupUpdatedEvent.java @@ -28,13 +28,10 @@ public class RolloutGroupUpdatedEvent extends AbstractRolloutGroupEvent implemen /** * Constructor - * - * @param rolloutGroup - * the updated rolloutGroup - * @param rolloutId - * of the related rollout - * @param applicationId - * the origin application id + * + * @param rolloutGroup the updated rolloutGroup + * @param rolloutId of the related rollout + * @param applicationId the origin application id */ public RolloutGroupUpdatedEvent(final RolloutGroup rolloutGroup, final Long rolloutId, final String applicationId) { super(rolloutGroup, rolloutId, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutUpdatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutUpdatedEvent.java index c8b05ecf5..dfcab725f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutUpdatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/RolloutUpdatedEvent.java @@ -16,6 +16,7 @@ import org.eclipse.hawkbit.repository.model.Rollout; * Defines the remote event of updated a {@link Rollout}. */ public class RolloutUpdatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { + private static final long serialVersionUID = 1L; /** @@ -27,11 +28,9 @@ public class RolloutUpdatedEvent extends RemoteEntityEvent implements E /** * Constructor - * - * @param rollout - * the updated rollout - * @param applicationId - * the origin application id + * + * @param rollout the updated rollout + * @param applicationId the origin application id */ public RolloutUpdatedEvent(final Rollout rollout, final String applicationId) { super(rollout, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/SoftwareModuleCreatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/SoftwareModuleCreatedEvent.java index 038895086..7851e3901 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/SoftwareModuleCreatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/SoftwareModuleCreatedEvent.java @@ -14,9 +14,9 @@ import org.eclipse.hawkbit.repository.model.SoftwareModule; /** * Defines the remote event of creating a new {@link SoftwareModule}. - * */ public class SoftwareModuleCreatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -28,11 +28,9 @@ public class SoftwareModuleCreatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -29,11 +29,9 @@ public class SoftwareModuleTypeCreatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -30,11 +29,9 @@ public class SoftwareModuleTypeUpdatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -29,11 +28,9 @@ public class SoftwareModuleUpdatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -28,11 +28,9 @@ public class TargetCreatedEvent extends RemoteEntityEvent implements Ent /** * Constructor. - * - * @param baseEntity - * the target - * @param applicationId - * the origin application id + * + * @param baseEntity the target + * @param applicationId the origin application id */ public TargetCreatedEvent(final Target baseEntity, final String applicationId) { super(baseEntity, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetFilterQueryCreatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetFilterQueryCreatedEvent.java index 96cb8afd1..2ff2c691f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetFilterQueryCreatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetFilterQueryCreatedEvent.java @@ -14,9 +14,9 @@ import org.eclipse.hawkbit.repository.model.TargetFilterQuery; /** * Defines the remote event of creating a new {@link TargetFilterQuery}. - * */ public class TargetFilterQueryCreatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -28,11 +28,9 @@ public class TargetFilterQueryCreatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -29,11 +28,9 @@ public class TargetFilterQueryUpdatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { @@ -29,11 +28,9 @@ public class TargetTagCreatedEvent extends RemoteEntityEvent implemen /** * Constructor. - * - * @param tag - * the tag which is deleted - * @param applicationId - * the origin application id + * + * @param tag the tag which is deleted + * @param applicationId the origin application id */ public TargetTagCreatedEvent(final TargetTag tag, final String applicationId) { super(tag, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTagUpdatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTagUpdatedEvent.java index 108e801ed..17237b2fa 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTagUpdatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTagUpdatedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.TargetTag; /** * Defines the remote event for updating a {@link TargetTag}. - * */ public class TargetTagUpdatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -29,11 +28,9 @@ public class TargetTagUpdatedEvent extends RemoteEntityEvent implemen /** * Constructor. - * - * @param tag - * the tag which is updated - * @param applicationId - * the origin application id + * + * @param tag the tag which is updated + * @param applicationId the origin application id */ public TargetTagUpdatedEvent(final TargetTag tag, final String applicationId) { super(tag, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTypeCreatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTypeCreatedEvent.java index 069e98d03..6aa11ef0b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTypeCreatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTypeCreatedEvent.java @@ -14,10 +14,10 @@ import org.eclipse.hawkbit.repository.model.TargetType; /** * Defines the remote event of creating a new {@link TargetType}. - * */ public class TargetTypeCreatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -30,10 +30,8 @@ public class TargetTypeCreatedEvent extends RemoteEntityEvent /** * Constructor. * - * @param baseEntity - * the TargetType - * @param applicationId - * the origin application id + * @param baseEntity the TargetType + * @param applicationId the origin application id */ public TargetTypeCreatedEvent(final TargetType baseEntity, final String applicationId) { super(baseEntity, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTypeUpdatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTypeUpdatedEvent.java index e2b90d4da..56d4225ec 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTypeUpdatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetTypeUpdatedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.TargetType; /** * Defines the remote event for updating a {@link TargetType}. - * */ public class TargetTypeUpdatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -31,10 +30,8 @@ public class TargetTypeUpdatedEvent extends RemoteEntityEvent /** * Constructor. * - * @param baseEntity - * TargetType - * @param applicationId - * the origin application id + * @param baseEntity TargetType + * @param applicationId the origin application id */ public TargetTypeUpdatedEvent(final TargetType baseEntity, final String applicationId) { super(baseEntity, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetUpdatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetUpdatedEvent.java index 798fb8d89..d65533454 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetUpdatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TargetUpdatedEvent.java @@ -14,7 +14,6 @@ import org.eclipse.hawkbit.repository.model.Target; /** * Defines the remote event for updating a {@link Target}. - * */ public class TargetUpdatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { @@ -29,11 +28,9 @@ public class TargetUpdatedEvent extends RemoteEntityEvent implements Ent /** * Constructor. - * - * @param baseEntity - * Target entity - * @param applicationId - * the origin application id + * + * @param baseEntity Target entity + * @param applicationId the origin application id */ public TargetUpdatedEvent(final Target baseEntity, final String applicationId) { super(baseEntity, applicationId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TenantConfigurationCreatedEvent.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TenantConfigurationCreatedEvent.java index e5a83d267..5179ad51d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TenantConfigurationCreatedEvent.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/event/remote/entity/TenantConfigurationCreatedEvent.java @@ -14,10 +14,10 @@ import org.eclipse.hawkbit.repository.model.TenantConfiguration; /** * Defines the remote event of creating a new {@link TenantConfiguration}. - * */ public class TenantConfigurationCreatedEvent extends RemoteEntityEvent implements EntityCreatedEvent { + private static final long serialVersionUID = 1L; /** @@ -29,11 +29,9 @@ public class TenantConfigurationCreatedEvent extends RemoteEntityEvent implements EntityUpdatedEvent { + private static final long serialVersionUID = 1L; /** @@ -29,11 +29,9 @@ public class TenantConfigurationUpdatedEvent extends RemoteEntityEvent type, final long inserted, final int quota) { @@ -67,13 +61,9 @@ public class AssignmentQuotaExceededException extends AbstractServerRtException } /** - * - * @param type - * that hit quota - * @param inserted - * cause for the hit - * @param quota - * that is defined by the repository + * @param type that hit quota + * @param inserted cause for the hit + * @param quota that is defined by the repository */ public AssignmentQuotaExceededException(final String type, final long inserted, final int quota) { super("Request contains too many entries of {" + type + "}. {" + inserted + "} is beyond the permitted {" @@ -84,19 +74,14 @@ public class AssignmentQuotaExceededException extends AbstractServerRtException * Creates a AssignmentQuotaExceededException which is to be thrown when an * assignment quota is exceeded. * - * @param type - * The type of the entities that shall be assigned to the - * specified parent entity. - * @param parentType - * The type of the parent entity. - * @param parentId - * The ID of the parent entity. - * @param requested - * The number of entities that shall be assigned to the specified - * parent entity. - * @param quota - * The maximum number of entities that can be assigned to the - * parent entity. + * @param type The type of the entities that shall be assigned to the + * specified parent entity. + * @param parentType The type of the parent entity. + * @param parentId The ID of the parent entity. + * @param requested The number of entities that shall be assigned to the specified + * parent entity. + * @param quota The maximum number of entities that can be assigned to the + * parent entity. */ public AssignmentQuotaExceededException(final Class type, final Class parentType, final Long parentId, final long requested, final long quota) { @@ -107,19 +92,14 @@ public class AssignmentQuotaExceededException extends AbstractServerRtException * Creates a AssignmentQuotaExceededException which is to be thrown when an * assignment quota is exceeded. * - * @param type - * The type of the entities that shall be assigned to the - * specified parent entity. - * @param parentType - * The type of the parent entity. - * @param parentId - * The ID of the parent entity. - * @param requested - * The number of entities that shall be assigned to the specified - * parent entity. - * @param quota - * The maximum number of entities that can be assigned to the - * parent entity. + * @param type The type of the entities that shall be assigned to the + * specified parent entity. + * @param parentType The type of the parent entity. + * @param parentId The ID of the parent entity. + * @param requested The number of entities that shall be assigned to the specified + * parent entity. + * @param quota The maximum number of entities that can be assigned to the + * parent entity. */ public AssignmentQuotaExceededException(final String type, final String parentType, final Object parentId, final long requested, final long quota) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/AutoConfirmationAlreadyActiveException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/AutoConfirmationAlreadyActiveException.java index 8bd41d2cc..1de049463 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/AutoConfirmationAlreadyActiveException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/AutoConfirmationAlreadyActiveException.java @@ -32,9 +32,8 @@ public class AutoConfirmationAlreadyActiveException extends AbstractServerRtExce /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public AutoConfirmationAlreadyActiveException(final Throwable cause) { super(THIS_ERROR, cause); @@ -44,8 +43,7 @@ public class AutoConfirmationAlreadyActiveException extends AbstractServerRtExce * Parameterized constructor for auto confirmation is already active for given * controller ID * - * @param controllerId - * of affected device + * @param controllerId of affected device */ public AutoConfirmationAlreadyActiveException(final String controllerId) { super("Auto confirmation is already active for device " + controllerId, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/CancelActionNotAllowedException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/CancelActionNotAllowedException.java index 4bd5400d6..d8101f840 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/CancelActionNotAllowedException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/CancelActionNotAllowedException.java @@ -17,9 +17,9 @@ import org.eclipse.hawkbit.exception.SpServerError; * cancelled (e.g. the action is not active or is already a canceled action) or * controller provides cancellation feedback on an action that is actually not * in canceling state. - * */ public final class CancelActionNotAllowedException extends AbstractServerRtException { + private static final long serialVersionUID = 1L; /** @@ -31,16 +31,14 @@ public final class CancelActionNotAllowedException extends AbstractServerRtExcep } /** - * @param cause - * for the exception + * @param cause for the exception */ public CancelActionNotAllowedException(final Throwable cause) { super(SpServerError.SP_ACTION_NOT_CANCELABLE, cause); } /** - * @param message - * of the error + * @param message of the error */ public CancelActionNotAllowedException(final String message) { super(message, SpServerError.SP_ACTION_NOT_CANCELABLE); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/ConcurrentModificationException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/ConcurrentModificationException.java index e33bc4c52..e8ca81050 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/ConcurrentModificationException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/ConcurrentModificationException.java @@ -16,11 +16,9 @@ import org.eclipse.hawkbit.exception.SpServerError; * {@link ConcurrentModificationException} is thrown when a given entity in's * actual and cannot be stored within the current session. Reason could be that * it has been changed within another session. - * - * - * */ public class ConcurrentModificationException extends AbstractServerRtException { + private static final long serialVersionUID = 1L; private static final SpServerError THIS_ERROR = SpServerError.SP_REPO_CONCURRENT_MODIFICATION; @@ -33,9 +31,8 @@ public class ConcurrentModificationException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public ConcurrentModificationException(final Throwable cause) { super(THIS_ERROR, cause); @@ -43,11 +40,9 @@ public class ConcurrentModificationException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * custom error message - * @param cause - * of the exception + * + * @param message custom error message + * @param cause of the exception */ public ConcurrentModificationException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -55,9 +50,8 @@ public class ConcurrentModificationException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * custom error message + * + * @param message custom error message */ public ConcurrentModificationException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/DeletedException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/DeletedException.java index 3411b27df..d8442b379 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/DeletedException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/DeletedException.java @@ -9,12 +9,12 @@ */ package org.eclipse.hawkbit.repository.exception; +import java.io.Serial; + import org.eclipse.hawkbit.exception.AbstractServerRtException; import org.eclipse.hawkbit.exception.SpServerError; import org.eclipse.hawkbit.repository.model.BaseEntity; -import java.io.Serial; - /** * Thrown if assignment quota is exceeded */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/DistributionSetTypeUndefinedException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/DistributionSetTypeUndefinedException.java index db371162f..66bff2e14 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/DistributionSetTypeUndefinedException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/DistributionSetTypeUndefinedException.java @@ -17,15 +17,12 @@ import org.eclipse.hawkbit.repository.model.DistributionSetType; /** * Thrown if the user tries to assign modules to a {@link DistributionSet} that * has to {@link DistributionSetType} defined. - * - * - * - * */ public class DistributionSetTypeUndefinedException extends AbstractServerRtException { + /** - * - */ + * + */ private static final long serialVersionUID = 1L; /** @@ -37,16 +34,14 @@ public class DistributionSetTypeUndefinedException extends AbstractServerRtExcep } /** - * @param cause - * for the exception + * @param cause for the exception */ public DistributionSetTypeUndefinedException(final Throwable cause) { super(SpServerError.SP_DS_TYPE_UNDEFINED, cause); } /** - * @param message - * of the error + * @param message of the error */ public DistributionSetTypeUndefinedException(final String message) { super(message, SpServerError.SP_DS_TYPE_UNDEFINED); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityAlreadyExistsException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityAlreadyExistsException.java index 7b68c1103..c3d66f633 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityAlreadyExistsException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityAlreadyExistsException.java @@ -30,9 +30,8 @@ public class EntityAlreadyExistsException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public EntityAlreadyExistsException(final Throwable cause) { super(THIS_ERROR, cause); @@ -40,11 +39,9 @@ public class EntityAlreadyExistsException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * of the exception - * @param cause - * of the exception + * + * @param message of the exception + * @param cause of the exception */ public EntityAlreadyExistsException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -52,9 +49,8 @@ public class EntityAlreadyExistsException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * of the exception + * + * @param message of the exception */ public EntityAlreadyExistsException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityNotFoundException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityNotFoundException.java index 711f1d478..789a88fb3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityNotFoundException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityNotFoundException.java @@ -34,6 +34,7 @@ public class EntityNotFoundException extends AbstractServerRtException { private static final long serialVersionUID = 1L; private static final SpServerError THIS_ERROR = SpServerError.SP_REPO_ENTITY_NOT_EXISTS; + private static final int ENTITY_STRING_MAX_LENGTH = 100; /** * Default constructor. @@ -44,7 +45,7 @@ public class EntityNotFoundException extends AbstractServerRtException { /** * Parameterized constructor. - * + * * @param cause of the exception */ public EntityNotFoundException(final Throwable cause) { @@ -53,7 +54,7 @@ public class EntityNotFoundException extends AbstractServerRtException { /** * Parameterized constructor. - * + * * @param message of the exception * @param cause of the exception */ @@ -63,7 +64,7 @@ public class EntityNotFoundException extends AbstractServerRtException { /** * Parameterized constructor. - * + * * @param message of the exception */ protected EntityNotFoundException(final String message) { @@ -72,7 +73,7 @@ public class EntityNotFoundException extends AbstractServerRtException { /** * Parameterized constructor for {@link BaseEntity} not found. - * + * * @param type of the entity that was not found * @param entityId of the {@link BaseEntity} */ @@ -84,7 +85,7 @@ public class EntityNotFoundException extends AbstractServerRtException { /** * Parameterized constructor for {@link MetaData} not found. - * + * * @param type of the entity that was not found * @param entityId of the {@link BaseEntity} the {@link MetaData} was for * @param key for the {@link MetaData} entry @@ -95,7 +96,7 @@ public class EntityNotFoundException extends AbstractServerRtException { /** * Parameterized constructor for {@link MetaData} not found. - * + * * @param type of the entity that was not found * @param entityId of the {@link BaseEntity} the {@link MetaData} was for * @param key for the {@link MetaData} entry @@ -108,7 +109,7 @@ public class EntityNotFoundException extends AbstractServerRtException { /** * Parameterized constructor for a list of {@link BaseEntity}s not found. - * + * * @param type of the entity that was not found * @param expected collection of the {@link BaseEntity#getId()}s * @param found collection of the {@link BaseEntity#getId()}s @@ -116,12 +117,11 @@ public class EntityNotFoundException extends AbstractServerRtException { public EntityNotFoundException(final Class type, final Collection expected, final Collection found) { super(type.getSimpleName() + "s with given identifiers {" + toEntityString(expected.stream().filter(id -> !found.contains(id)) - .map(String::valueOf).collect(Collectors.joining(","))) + "} do not exist.", + .map(String::valueOf).collect(Collectors.joining(","))) + "} do not exist.", THIS_ERROR, Map.of(TYPE, type.getSimpleName(), ENTITY_ID, expected.stream().filter(id -> !found.contains(id)).map(String::valueOf))); } - private static final int ENTITY_STRING_MAX_LENGTH = 100; private static String toEntityString(final Object obj) { final String str = String.valueOf(obj); return str.length() > ENTITY_STRING_MAX_LENGTH ? str.substring(0, ENTITY_STRING_MAX_LENGTH - 3).concat("...") : str; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityReadOnlyException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityReadOnlyException.java index d90a9d79f..d53a2c664 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityReadOnlyException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/EntityReadOnlyException.java @@ -30,9 +30,8 @@ public class EntityReadOnlyException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public EntityReadOnlyException(final Throwable cause) { super(THIS_ERROR, cause); @@ -40,11 +39,9 @@ public class EntityReadOnlyException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * of the exception - * @param cause - * of the exception + * + * @param message of the exception + * @param cause of the exception */ public EntityReadOnlyException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -52,9 +49,8 @@ public class EntityReadOnlyException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * of the exception + * + * @param message of the exception */ public EntityReadOnlyException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/FileSizeQuotaExceededException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/FileSizeQuotaExceededException.java index 8080fa271..553c65ce0 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/FileSizeQuotaExceededException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/FileSizeQuotaExceededException.java @@ -27,8 +27,7 @@ public class FileSizeQuotaExceededException extends AbstractServerRtException { /** * Creates a new FileSizeQuotaExceededException with a quota value. * - * @param exceededQuotaValue - * Value by how much the quota was exceeded + * @param exceededQuotaValue Value by how much the quota was exceeded */ public FileSizeQuotaExceededException(final long exceededQuotaValue) { super(createQuotaErrorMessage(exceededQuotaValue), errorType); @@ -37,7 +36,7 @@ public class FileSizeQuotaExceededException extends AbstractServerRtException { /** * Get a readable string of size quota including unit - * + * * @return file size quota with unit */ public String getExceededQuotaValueString() { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/ForceQuitActionNotAllowedException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/ForceQuitActionNotAllowedException.java index 5b0d43dc0..58a1b64a9 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/ForceQuitActionNotAllowedException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/ForceQuitActionNotAllowedException.java @@ -15,12 +15,12 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * Thrown when force quitting an actions is not allowed. e.g. the action is not * active or it is not canceled before. - * */ public final class ForceQuitActionNotAllowedException extends AbstractServerRtException { + /** - * - */ + * + */ private static final long serialVersionUID = 1L; /** @@ -32,16 +32,14 @@ public final class ForceQuitActionNotAllowedException extends AbstractServerRtEx } /** - * @param cause - * for the exception + * @param cause for the exception */ public ForceQuitActionNotAllowedException(final Throwable cause) { super(SpServerError.SP_ACTION_NOT_FORCE_QUITABLE, cause); } /** - * @param message - * of the error + * @param message of the error */ public ForceQuitActionNotAllowedException(final String message) { super(message, SpServerError.SP_ACTION_NOT_FORCE_QUITABLE); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/IncompatibleTargetTypeException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/IncompatibleTargetTypeException.java index 7a90b0eb5..6999860da 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/IncompatibleTargetTypeException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/IncompatibleTargetTypeException.java @@ -31,11 +31,9 @@ public class IncompatibleTargetTypeException extends AbstractServerRtException { /** * Creates a new IncompatibleTargetTypeException with * {@link SpServerError#SP_TARGET_TYPE_INCOMPATIBLE} error. - * - * @param targetTypeName - * Name of the target type - * @param distributionSetTypeNames - * Names of the distribution set types + * + * @param targetTypeName Name of the target type + * @param distributionSetTypeNames Names of the distribution set types */ public IncompatibleTargetTypeException(final String targetTypeName, final Collection distributionSetTypeNames) { @@ -49,10 +47,8 @@ public class IncompatibleTargetTypeException extends AbstractServerRtException { * Creates a new IncompatibleTargetTypeException with * {@link SpServerError#SP_TARGET_TYPE_INCOMPATIBLE} error. * - * @param targetTypeNames - * Name of the target types - * @param distributionSetTypeName - * Name of the distribution set type + * @param targetTypeNames Name of the target types + * @param distributionSetTypeName Name of the distribution set type */ public IncompatibleTargetTypeException(final Collection targetTypeNames, final String distributionSetTypeName) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/IncompleteDistributionSetException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/IncompleteDistributionSetException.java index fdc88bb3a..3b099fc97 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/IncompleteDistributionSetException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/IncompleteDistributionSetException.java @@ -15,15 +15,12 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * Thrown if a distribution set is assigned to a a target that is incomplete * (i.e. mandatory modules are missing). - * - * - * - * */ public final class IncompleteDistributionSetException extends AbstractServerRtException { + /** - * - */ + * + */ private static final long serialVersionUID = 1L; /** @@ -35,16 +32,14 @@ public final class IncompleteDistributionSetException extends AbstractServerRtEx } /** - * @param cause - * for the exception + * @param cause for the exception */ public IncompleteDistributionSetException(final Throwable cause) { super(SpServerError.SP_DS_INCOMPLETE, cause); } /** - * @param message - * of the error + * @param message of the error */ public IncompleteDistributionSetException(final String message) { super(message, SpServerError.SP_DS_INCOMPLETE); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InsufficientPermissionException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InsufficientPermissionException.java index 1c32e2c9d..13932d864 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InsufficientPermissionException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InsufficientPermissionException.java @@ -15,9 +15,6 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * Exception which is thrown in case the current security context object does * not hold a required authority/permission. - * - * - * */ public class InsufficientPermissionException extends AbstractServerRtException { @@ -25,9 +22,8 @@ public class InsufficientPermissionException extends AbstractServerRtException { /** * creates new InsufficientPermissionException. - * - * @param cause - * the cause of the exception + * + * @param cause the cause of the exception */ public InsufficientPermissionException(final Throwable cause) { super(SpServerError.SP_INSUFFICIENT_PERMISSION, cause); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidDistributionSetException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidDistributionSetException.java index 224703dc9..9ea350cd0 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidDistributionSetException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidDistributionSetException.java @@ -13,9 +13,10 @@ import org.eclipse.hawkbit.exception.AbstractServerRtException; import org.eclipse.hawkbit.exception.SpServerError; public class InvalidDistributionSetException extends AbstractServerRtException { + /** - * - */ + * + */ private static final long serialVersionUID = 1L; /** @@ -27,16 +28,14 @@ public class InvalidDistributionSetException extends AbstractServerRtException { } /** - * @param cause - * for the exception + * @param cause for the exception */ public InvalidDistributionSetException(final Throwable cause) { super(SpServerError.SP_DS_INVALID, cause); } /** - * @param message - * of the error + * @param message of the error */ public InvalidDistributionSetException(final String message) { super(message, SpServerError.SP_DS_INVALID); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidMD5HashException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidMD5HashException.java index 91de43040..355eaf688 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidMD5HashException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidMD5HashException.java @@ -14,15 +14,12 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * Thrown if MD5 checksum check fails. - * - * - * - * */ public class InvalidMD5HashException extends AbstractServerRtException { + /** - * - */ + * + */ private static final long serialVersionUID = 1L; /** @@ -34,18 +31,15 @@ public class InvalidMD5HashException extends AbstractServerRtException { } /** - * @param message - * of the error - * @param cause - * for the exception + * @param message of the error + * @param cause for the exception */ public InvalidMD5HashException(final String message, final Throwable cause) { super(message, SpServerError.SP_ARTIFACT_UPLOAD_FAILED_MD5_MATCH, cause); } /** - * @param message - * of the error + * @param message of the error */ public InvalidMD5HashException(final String message) { super(message, SpServerError.SP_ARTIFACT_UPLOAD_FAILED_MD5_MATCH); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidMaintenanceScheduleException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidMaintenanceScheduleException.java index 978e0997a..94b790491 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidMaintenanceScheduleException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidMaintenanceScheduleException.java @@ -19,6 +19,7 @@ import org.eclipse.hawkbit.exception.SpServerError; * should be at least one valid window after the current time. */ public class InvalidMaintenanceScheduleException extends AbstractServerRtException { + private static final long serialVersionUID = 1L; private final int durationErrorIndex; @@ -26,8 +27,7 @@ public class InvalidMaintenanceScheduleException extends AbstractServerRtExcepti /** * Constructor for {@link InvalidMaintenanceScheduleException}. * - * @param message - * the message for this exception. + * @param message the message for this exception. */ public InvalidMaintenanceScheduleException(final String message) { this(message, -1); @@ -36,10 +36,8 @@ public class InvalidMaintenanceScheduleException extends AbstractServerRtExcepti /** * Constructor for {@link InvalidMaintenanceScheduleException}. * - * @param message - * the message for this exception. - * @param errorIndex - * the error index of maintenance duration. + * @param message the message for this exception. + * @param errorIndex the error index of maintenance duration. */ public InvalidMaintenanceScheduleException(final String message, final int errorIndex) { super(message, SpServerError.SP_MAINTENANCE_SCHEDULE_INVALID); @@ -49,10 +47,8 @@ public class InvalidMaintenanceScheduleException extends AbstractServerRtExcepti /** * Constructor for {@link InvalidMaintenanceScheduleException}. * - * @param message - * the message for this exception - * @param cause - * the cause for this exception. + * @param message the message for this exception + * @param cause the cause for this exception. */ public InvalidMaintenanceScheduleException(final String message, final Throwable cause) { this(message, cause, -1); @@ -61,12 +57,9 @@ public class InvalidMaintenanceScheduleException extends AbstractServerRtExcepti /** * Constructor for {@link InvalidMaintenanceScheduleException}. * - * @param message - * the message for this exception - * @param cause - * the cause for this exception. - * @param errorIndex - * the error index of maintenance duration. + * @param message the message for this exception + * @param cause the cause for this exception. + * @param errorIndex the error index of maintenance duration. */ public InvalidMaintenanceScheduleException(final String message, final Throwable cause, final int errorIndex) { super(message, SpServerError.SP_MAINTENANCE_SCHEDULE_INVALID, cause); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidSHA1HashException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidSHA1HashException.java index 8b0633103..a325012af 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidSHA1HashException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidSHA1HashException.java @@ -14,15 +14,12 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * Thrown if SHA1 checksum check fails. - * - * - * - * */ public class InvalidSHA1HashException extends AbstractServerRtException { + /** - * - */ + * + */ private static final long serialVersionUID = 1L; /** @@ -34,18 +31,15 @@ public class InvalidSHA1HashException extends AbstractServerRtException { } /** - * @param message - * of the error - * @param cause - * for the exception + * @param message of the error + * @param cause for the exception */ public InvalidSHA1HashException(final String message, final Throwable cause) { super(message, SpServerError.SP_ARTIFACT_UPLOAD_FAILED_SHA1_MATCH, cause); } /** - * @param message - * of the error + * @param message of the error */ public InvalidSHA1HashException(final String message) { super(message, SpServerError.SP_ARTIFACT_UPLOAD_FAILED_SHA1_MATCH); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidSHA256HashException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidSHA256HashException.java index cf46f6b49..f67bd71e9 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidSHA256HashException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidSHA256HashException.java @@ -28,18 +28,15 @@ public class InvalidSHA256HashException extends AbstractServerRtException { } /** - * @param message - * of the error - * @param cause - * for the exception + * @param message of the error + * @param cause for the exception */ public InvalidSHA256HashException(final String message, final Throwable cause) { super(message, SpServerError.SP_ARTIFACT_UPLOAD_FAILED_SHA256_MATCH, cause); } /** - * @param message - * of the error + * @param message of the error */ public InvalidSHA256HashException(final String message) { super(message, SpServerError.SP_ARTIFACT_UPLOAD_FAILED_SHA256_MATCH); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidTargetAddressException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidTargetAddressException.java index 62f82dc73..6269f7a1b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidTargetAddressException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidTargetAddressException.java @@ -16,22 +16,19 @@ import org.eclipse.hawkbit.exception.SpServerError; * Exception which is thrown when trying to set an invalid target address. */ public class InvalidTargetAddressException extends AbstractServerRtException { + private static final long serialVersionUID = 1L; /** - * @param message - * the message for this exception + * @param message the message for this exception */ public InvalidTargetAddressException(final String message) { super(message, SpServerError.SP_REPO_INVALID_TARGET_ADDRESS); } /** - * - * @param message - * the message for this exception - * @param cause - * the cause for this exception + * @param message the message for this exception + * @param cause the cause for this exception */ public InvalidTargetAddressException(final String message, final Throwable cause) { super(message, SpServerError.SP_REPO_INVALID_TARGET_ADDRESS, cause); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidTenantConfigurationKeyException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidTenantConfigurationKeyException.java index 89c0e8f99..b122a6715 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidTenantConfigurationKeyException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/InvalidTenantConfigurationKeyException.java @@ -15,7 +15,6 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * The {@link #InvalidTenantConfigurationKeyException} is thrown when an invalid * configuration key is used. - * */ public class InvalidTenantConfigurationKeyException extends AbstractServerRtException { @@ -31,9 +30,8 @@ public class InvalidTenantConfigurationKeyException extends AbstractServerRtExce /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public InvalidTenantConfigurationKeyException(final Throwable cause) { super(THIS_ERROR, cause); @@ -41,11 +39,9 @@ public class InvalidTenantConfigurationKeyException extends AbstractServerRtExce /** * Parameterized constructor. - * - * @param message - * of the exception - * @param cause - * of the exception + * + * @param message of the exception + * @param cause of the exception */ public InvalidTenantConfigurationKeyException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -53,9 +49,8 @@ public class InvalidTenantConfigurationKeyException extends AbstractServerRtExce /** * Parameterized constructor. - * - * @param message - * of the exception + * + * @param message of the exception */ public InvalidTenantConfigurationKeyException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/LockedException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/LockedException.java index ef4517955..aecd4974b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/LockedException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/LockedException.java @@ -9,12 +9,12 @@ */ package org.eclipse.hawkbit.repository.exception; +import java.io.Serial; + import org.eclipse.hawkbit.exception.AbstractServerRtException; import org.eclipse.hawkbit.exception.SpServerError; import org.eclipse.hawkbit.repository.model.BaseEntity; -import java.io.Serial; - /** * Thrown if there is attempt to functionally modify a locked entity */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/MethodNotSupportedException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/MethodNotSupportedException.java index ade5491c2..f76ad43dd 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/MethodNotSupportedException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/MethodNotSupportedException.java @@ -14,12 +14,12 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * Thrown if repository operation is no longer supported. - * */ public final class MethodNotSupportedException extends AbstractServerRtException { + /** - * - */ + * + */ private static final long serialVersionUID = 1L; /** @@ -33,9 +33,8 @@ public final class MethodNotSupportedException extends AbstractServerRtException /** * Creates a new MethodNotSupportedException with * {@link SpServerError#SP_REPO_OPERATION_NOT_SUPPORTED} error. - * - * @param cause - * for the exception + * + * @param cause for the exception */ public MethodNotSupportedException(final Throwable cause) { super(SpServerError.SP_REPO_OPERATION_NOT_SUPPORTED, cause); @@ -44,9 +43,8 @@ public final class MethodNotSupportedException extends AbstractServerRtException /** * Creates a new MethodNotSupportedException with * {@link SpServerError#SP_REPO_OPERATION_NOT_SUPPORTED} error. - * - * @param message - * of the error + * + * @param message of the error */ public MethodNotSupportedException(final String message) { super(message, SpServerError.SP_REPO_OPERATION_NOT_SUPPORTED); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/MultiAssignmentIsNotEnabledException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/MultiAssignmentIsNotEnabledException.java index f6be69d90..379884ecb 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/MultiAssignmentIsNotEnabledException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/MultiAssignmentIsNotEnabledException.java @@ -15,7 +15,6 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * This exception is thrown if an operation requires multiassignments, but the * feature is not enabled. - * */ public class MultiAssignmentIsNotEnabledException extends AbstractServerRtException { @@ -31,9 +30,8 @@ public class MultiAssignmentIsNotEnabledException extends AbstractServerRtExcept /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public MultiAssignmentIsNotEnabledException(final Throwable cause) { super(THIS_ERROR, cause); @@ -41,11 +39,9 @@ public class MultiAssignmentIsNotEnabledException extends AbstractServerRtExcept /** * Parameterized constructor. - * - * @param message - * of the exception - * @param cause - * of the exception + * + * @param message of the exception + * @param cause of the exception */ public MultiAssignmentIsNotEnabledException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -53,9 +49,8 @@ public class MultiAssignmentIsNotEnabledException extends AbstractServerRtExcept /** * Parameterized constructor. - * - * @param message - * of the exception + * + * @param message of the exception */ public MultiAssignmentIsNotEnabledException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/NoWeightProvidedInMultiAssignmentModeException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/NoWeightProvidedInMultiAssignmentModeException.java index 3d0c337cb..d4b7d7395 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/NoWeightProvidedInMultiAssignmentModeException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/NoWeightProvidedInMultiAssignmentModeException.java @@ -15,11 +15,9 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * This exception is thrown if multi assignments is enabled and an target * distribution set assignment request does not contain a weight value - * */ public class NoWeightProvidedInMultiAssignmentModeException extends AbstractServerRtException { - private static final long serialVersionUID = 1L; private static final SpServerError THIS_ERROR = SpServerError.SP_NO_WEIGHT_PROVIDED_IN_MULTIASSIGNMENT_MODE; @@ -32,9 +30,8 @@ public class NoWeightProvidedInMultiAssignmentModeException extends AbstractServ /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public NoWeightProvidedInMultiAssignmentModeException(final Throwable cause) { super(THIS_ERROR, cause); @@ -42,11 +39,9 @@ public class NoWeightProvidedInMultiAssignmentModeException extends AbstractServ /** * Parameterized constructor. - * - * @param message - * of the exception - * @param cause - * of the exception + * + * @param message of the exception + * @param cause of the exception */ public NoWeightProvidedInMultiAssignmentModeException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -54,9 +49,8 @@ public class NoWeightProvidedInMultiAssignmentModeException extends AbstractServ /** * Parameterized constructor. - * - * @param message - * of the exception + * + * @param message of the exception */ public NoWeightProvidedInMultiAssignmentModeException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RSQLParameterSyntaxException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RSQLParameterSyntaxException.java index a03f61798..e5bc99792 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RSQLParameterSyntaxException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RSQLParameterSyntaxException.java @@ -14,16 +14,12 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * Exception used by the REST API in case of RSQL search filter query. - * - * - * - * */ public class RSQLParameterSyntaxException extends AbstractServerRtException { /** - * - */ + * + */ private static final long serialVersionUID = 1L; /** @@ -37,9 +33,8 @@ public class RSQLParameterSyntaxException extends AbstractServerRtException { /** * Creates a new RSQLParameterSyntaxException with * {@link SpServerError#SP_REST_RSQL_SEARCH_PARAM_SYNTAX} error. - * - * @param message - * the message of the exception + * + * @param message the message of the exception */ public RSQLParameterSyntaxException(final String message) { super(message, SpServerError.SP_REST_RSQL_SEARCH_PARAM_SYNTAX); @@ -48,9 +43,8 @@ public class RSQLParameterSyntaxException extends AbstractServerRtException { /** * Creates a new RSQLSyntaxException with * {@link SpServerError#SP_REST_RSQL_SEARCH_PARAM_SYNTAX} error. - * - * @param cause - * the cause of this exception + * + * @param cause the cause of this exception */ public RSQLParameterSyntaxException(final Throwable cause) { super(SpServerError.SP_REST_RSQL_SEARCH_PARAM_SYNTAX, cause); @@ -59,13 +53,11 @@ public class RSQLParameterSyntaxException extends AbstractServerRtException { /** * Creates a new RSQLParameterSyntaxException with * {@link SpServerError#SP_REST_RSQL_SEARCH_PARAM_SYNTAX} error. - * - * @param message - * the message of the exception - * @param cause - * the cause (which is saved for later retrieval by the - * getCause() method). (A null value is permitted, and indicates - * that the cause is nonexistent or unknown.) + * + * @param message the message of the exception + * @param cause the cause (which is saved for later retrieval by the + * getCause() method). (A null value is permitted, and indicates + * that the cause is nonexistent or unknown.) */ public RSQLParameterSyntaxException(final String message, final Throwable cause) { super(message, SpServerError.SP_REST_RSQL_SEARCH_PARAM_SYNTAX, cause); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RSQLParameterUnsupportedFieldException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RSQLParameterUnsupportedFieldException.java index 8916f77d9..199c65d5d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RSQLParameterUnsupportedFieldException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RSQLParameterUnsupportedFieldException.java @@ -9,11 +9,11 @@ */ package org.eclipse.hawkbit.repository.exception; +import java.io.Serial; + import org.eclipse.hawkbit.exception.AbstractServerRtException; import org.eclipse.hawkbit.exception.SpServerError; -import java.io.Serial; - /** * Exception used by the REST API in case of invalid field name in the rsql search parameter. */ @@ -43,10 +43,10 @@ public class RSQLParameterUnsupportedFieldException extends AbstractServerRtExce /** * Creates a new RSQLParameterUnsupportedFieldException with * {@link SpServerError#SP_REST_RSQL_PARAM_INVALID_FIELD} error. - * + * * @param cause the cause (which is saved for later retrieval by the - * getCause() method). (A null value is permitted, and indicates - * that the cause is nonexistent or unknown.) + * getCause() method). (A null value is permitted, and indicates + * that the cause is nonexistent or unknown.) */ public RSQLParameterUnsupportedFieldException(final Throwable cause) { super(SpServerError.SP_REST_RSQL_PARAM_INVALID_FIELD, cause); @@ -55,11 +55,11 @@ public class RSQLParameterUnsupportedFieldException extends AbstractServerRtExce /** * Creates a new RSQLParameterUnsupportedFieldException with * {@link SpServerError#SP_REST_RSQL_PARAM_INVALID_FIELD} error. - * + * * @param message the message of the exception * @param cause the cause (which is saved for later retrieval by the - * getCause() method). (A null value is permitted, and indicates - * that the cause is nonexistent or unknown.) + * getCause() method). (A null value is permitted, and indicates + * that the cause is nonexistent or unknown.) */ public RSQLParameterUnsupportedFieldException(final String message, final Throwable cause) { super(message, SpServerError.SP_REST_RSQL_PARAM_INVALID_FIELD, cause); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RolloutIllegalStateException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RolloutIllegalStateException.java index fda2c3041..33a200e51 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RolloutIllegalStateException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/RolloutIllegalStateException.java @@ -16,7 +16,6 @@ import org.eclipse.hawkbit.exception.SpServerError; * the {@link RolloutIllegalStateException} is thrown when a rollout is changing * it's state which is not valid. E.g. trying to start a already running * rollout, or trying to resume a already finished rollout. - * */ public class RolloutIllegalStateException extends AbstractServerRtException { @@ -32,9 +31,8 @@ public class RolloutIllegalStateException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public RolloutIllegalStateException(final Throwable cause) { super(THIS_ERROR, cause); @@ -42,11 +40,9 @@ public class RolloutIllegalStateException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * of the exception - * @param cause - * of the exception + * + * @param message of the exception + * @param cause of the exception */ public RolloutIllegalStateException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -54,9 +50,8 @@ public class RolloutIllegalStateException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * of the exception + * + * @param message of the exception */ public RolloutIllegalStateException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/SoftwareModuleNotAssignedToTargetException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/SoftwareModuleNotAssignedToTargetException.java index cf0e08df4..0669e56c0 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/SoftwareModuleNotAssignedToTargetException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/SoftwareModuleNotAssignedToTargetException.java @@ -25,12 +25,10 @@ public class SoftwareModuleNotAssignedToTargetException extends EntityNotFoundEx /** * Constructor - * - * @param moduleId - * thats is not assigned to given {@link Target} - * @param controllerId - * of the {@link Target} where given {@link SoftwareModule} is - * not part of + * + * @param moduleId thats is not assigned to given {@link Target} + * @param controllerId of the {@link Target} where given {@link SoftwareModule} is + * not part of */ public SoftwareModuleNotAssignedToTargetException(final Long moduleId, final String controllerId) { super("No assignment found for " + SoftwareModule.class.getSimpleName() + " with id {" + moduleId + "} to " diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/SoftwareModuleTypeNotInDistributionSetTypeException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/SoftwareModuleTypeNotInDistributionSetTypeException.java index a244f79fc..465bafa49 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/SoftwareModuleTypeNotInDistributionSetTypeException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/SoftwareModuleTypeNotInDistributionSetTypeException.java @@ -25,12 +25,10 @@ public class SoftwareModuleTypeNotInDistributionSetTypeException extends EntityN /** * Constructor - * - * @param moduleTypeId - * thats is not part of given {@link DistributionSetType} - * @param distributionSetTypeId - * of the {@link DistributionSetType} where given - * {@link SoftwareModuleType} is not part of + * + * @param moduleTypeId thats is not part of given {@link DistributionSetType} + * @param distributionSetTypeId of the {@link DistributionSetType} where given + * {@link SoftwareModuleType} is not part of */ public SoftwareModuleTypeNotInDistributionSetTypeException(final Long moduleTypeId, final Long distributionSetTypeId) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/StopRolloutException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/StopRolloutException.java index 8dba6ac49..d1f21382b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/StopRolloutException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/StopRolloutException.java @@ -18,6 +18,7 @@ import org.eclipse.hawkbit.exception.SpServerError; * caused by a long ongoing creation of a rollout. */ public class StopRolloutException extends AbstractServerRtException { + private static final long serialVersionUID = 1L; /** @@ -32,8 +33,7 @@ public class StopRolloutException extends AbstractServerRtException { * Creates a new StopRolloutException with * {@link SpServerError#SP_STOP_ROLLOUT_FAILED} error. * - * @param cause - * for the exception + * @param cause for the exception */ public StopRolloutException(final Throwable cause) { super(SpServerError.SP_STOP_ROLLOUT_FAILED, cause); @@ -43,8 +43,7 @@ public class StopRolloutException extends AbstractServerRtException { * Creates a new StopRolloutException with * {@link SpServerError#SP_STOP_ROLLOUT_FAILED} error. * - * @param message - * of the error + * @param message of the error */ public StopRolloutException(final String message) { super(message, SpServerError.SP_STOP_ROLLOUT_FAILED); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/StorageQuotaExceededException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/StorageQuotaExceededException.java index da56278f1..e475bd942 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/StorageQuotaExceededException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/StorageQuotaExceededException.java @@ -27,8 +27,7 @@ public class StorageQuotaExceededException extends AbstractServerRtException { /** * Creates a new StorageQuotaExceededException with a quota value. * - * @param exceededQuotaValue - * Value by how much the quota was exceeded + * @param exceededQuotaValue Value by how much the quota was exceeded */ public StorageQuotaExceededException(final long exceededQuotaValue) { super(createQuotaErrorMessage(exceededQuotaValue), errorType); @@ -37,7 +36,7 @@ public class StorageQuotaExceededException extends AbstractServerRtException { /** * Get a readable string of size quota including unit - * + * * @return file size quota with unit */ public String getExceededQuotaValueString() { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TargetTypeInUseException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TargetTypeInUseException.java index 49b0e388b..9cf502917 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TargetTypeInUseException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TargetTypeInUseException.java @@ -30,8 +30,7 @@ public class TargetTypeInUseException extends AbstractServerRtException { /** * Parameterized constructor. * - * @param cause - * of the exception + * @param cause of the exception */ public TargetTypeInUseException(final Throwable cause) { super(THIS_ERROR, cause); @@ -40,10 +39,8 @@ public class TargetTypeInUseException extends AbstractServerRtException { /** * Parameterized constructor. * - * @param message - * of the exception - * @param cause - * of the exception + * @param message of the exception + * @param cause of the exception */ public TargetTypeInUseException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -52,8 +49,7 @@ public class TargetTypeInUseException extends AbstractServerRtException { /** * Parameterized constructor. * - * @param message - * of the exception + * @param message of the exception */ public TargetTypeInUseException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TargetTypeKeyOrNameRequiredException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TargetTypeKeyOrNameRequiredException.java index 44dd2df23..a6debd91d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TargetTypeKeyOrNameRequiredException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TargetTypeKeyOrNameRequiredException.java @@ -9,11 +9,11 @@ */ package org.eclipse.hawkbit.repository.exception; +import java.io.Serial; + import org.eclipse.hawkbit.exception.AbstractServerRtException; import org.eclipse.hawkbit.exception.SpServerError; -import java.io.Serial; - /** * Thrown if tried creation of type with no key nor name. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TenantConfigurationValueChangeNotAllowedException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TenantConfigurationValueChangeNotAllowedException.java index f4661f965..24d8cb5f8 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TenantConfigurationValueChangeNotAllowedException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TenantConfigurationValueChangeNotAllowedException.java @@ -33,9 +33,8 @@ public class TenantConfigurationValueChangeNotAllowedException extends AbstractS * Creates a new exception for the * {@link SpServerError#SP_CONFIGURATION_VALUE_CHANGE_NOT_ALLOWED} error * case. - * - * @param message - * A custom error message. + * + * @param message A custom error message. */ public TenantConfigurationValueChangeNotAllowedException(final String message) { super(message, SpServerError.SP_CONFIGURATION_VALUE_CHANGE_NOT_ALLOWED); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TenantNotExistException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TenantNotExistException.java index 39b74faf4..bb7efb549 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TenantNotExistException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/TenantNotExistException.java @@ -17,9 +17,6 @@ import org.eclipse.hawkbit.exception.SpServerError; * register itself at SP as plug'n play target and the tenant specified in the * URL for this target does not exist. To avoid that targets could register * automatically new tenants. - * - * - * */ public class TenantNotExistException extends AbstractServerRtException { @@ -35,9 +32,8 @@ public class TenantNotExistException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public TenantNotExistException(final Throwable cause) { super(THIS_ERROR, cause); @@ -45,11 +41,9 @@ public class TenantNotExistException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * of the exception - * @param cause - * of the exception + * + * @param message of the exception + * @param cause of the exception */ public TenantNotExistException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -57,9 +51,8 @@ public class TenantNotExistException extends AbstractServerRtException { /** * Parameterized constructor. - * - * @param message - * of the exception + * + * @param message of the exception */ public TenantNotExistException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/UnsupportedSoftwareModuleForThisDistributionSetException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/UnsupportedSoftwareModuleForThisDistributionSetException.java index cdb2459bd..6709355d1 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/UnsupportedSoftwareModuleForThisDistributionSetException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/exception/UnsupportedSoftwareModuleForThisDistributionSetException.java @@ -33,16 +33,14 @@ public class UnsupportedSoftwareModuleForThisDistributionSetException extends Ab } /** - * @param cause - * for the exception + * @param cause for the exception */ public UnsupportedSoftwareModuleForThisDistributionSetException(final Throwable cause) { super(SpServerError.SP_DS_MODULE_UNSUPPORTED, cause); } /** - * @param message - * of the error + * @param message of the error */ public UnsupportedSoftwareModuleForThisDistributionSetException(final String message) { super(message, SpServerError.SP_DS_MODULE_UNSUPPORTED); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AbstractAssignmentResult.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AbstractAssignmentResult.java index 1bac1fdb0..4fff71503 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AbstractAssignmentResult.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AbstractAssignmentResult.java @@ -14,7 +14,7 @@ import java.util.List; /** * Generic assignment result bean. - * + * * @param type of the assigned and unassigned {@link BaseEntity}s. */ public abstract class AbstractAssignmentResult { @@ -25,12 +25,10 @@ public abstract class AbstractAssignmentResult { /** * Constructor. - * @param alreadyAssigned - * count of already assigned entities - * @param assignedEntity - * {@link List} of assigned entity. - * @param unassignedEntity - * {@link List} of unassigned entity. + * + * @param alreadyAssigned count of already assigned entities + * @param assignedEntity {@link List} of assigned entity. + * @param unassignedEntity {@link List} of unassigned entity. */ protected AbstractAssignmentResult(final int alreadyAssigned, final List assignedEntity, final List unassignedEntity) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Action.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Action.java index 3caeff353..e7ace0b6e 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Action.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Action.java @@ -120,17 +120,16 @@ public interface Action extends TenantAwareBaseEntity { */ String getMaintenanceWindowTimeZone(); - /** - * @param externalRef - * associated with this action - */ - void setExternalRef(@NotEmpty String externalRef); - /** * @return externalRef of the action */ String getExternalRef(); + /** + * @param externalRef associated with this action + */ + void setExternalRef(@NotEmpty String externalRef); + /** * @return the username that initiated this action (directly or indirectly) */ @@ -147,9 +146,8 @@ public interface Action extends TenantAwareBaseEntity { * {@code hitTimeMillis}, by means if the given milliseconds are greater * than the forcedTime. * - * @param hitTimeMillis - * the milliseconds, mostly the - * {@link System#currentTimeMillis()} + * @param hitTimeMillis the milliseconds, mostly the + * {@link System#currentTimeMillis()} * @return {@code true} if this {@link #getActionType()} is in * {@link ActionType#TIMEFORCED} and the given {@code hitTimeMillis} * is greater than the {@link #getForcedTime()} otherwise @@ -173,12 +171,12 @@ public interface Action extends TenantAwareBaseEntity { */ default boolean isForcedOrTimeForced() { switch (getActionType()) { - case FORCED: - return true; - case TIMEFORCED: - return isHitAutoForceTime(System.currentTimeMillis()); - default: - return false; + case FORCED: + return true; + case TIMEFORCED: + return isHitAutoForceTime(System.currentTimeMillis()); + default: + return false; } } @@ -196,13 +194,60 @@ public interface Action extends TenantAwareBaseEntity { return ActionType.DOWNLOAD_ONLY == getActionType(); } + /** + * Returns the start time of next available maintenance window for the + * {@link Action} as {@link ZonedDateTime}. If a maintenance window is + * already active, the start time of currently active window is returned. + * + * @return the start time as { @link Optional}. + */ + Optional getMaintenanceWindowStartTime(); + + /** + * The method checks whether the action has a maintenance schedule defined + * for it. A maintenance schedule defines a set of maintenance windows + * during which actual update can be performed. A valid schedule defines at + * least one maintenance window. + * + * @return true if action has a maintenance schedule, else false. + */ + boolean hasMaintenanceSchedule(); + + /** + * The method checks whether the maintenance schedule has already lapsed for + * the action, i.e. there are no more windows available for maintenance. + * Controller manager uses the method to check if the maintenance schedule + * has lapsed, and automatically cancels the action if it is lapsed. + * + * @return true if maintenance schedule has lapsed, else false. + */ + boolean isMaintenanceScheduleLapsed(); + + /** + * The method checks whether a maintenance window is available for the + * action to proceed. If it is available, a 'true' value is returned. The + * maintenance window is considered available: 1) If there is no maintenance + * schedule at all, in which case device can start update any time after + * download is finished; or 2) the current time is within a scheduled + * maintenance window start and end time. + * + * @return true if maintenance window is available, else false. + */ + boolean isMaintenanceWindowAvailable(); + + /** + * Checks if the action is waiting for confirmation. + * + * @return true if the action is waiting for confirmation, else false + */ + boolean isWaitingConfirmation(); + /** * Action status as reported by the controller. * * Be aware that JPA is persisting the ordinal number of the enum by means * the ordered number in the enum. So don't re-order the enums within the * Status enum declaration! - * */ enum Status { /** @@ -270,7 +315,6 @@ public interface Action extends TenantAwareBaseEntity { /** * The action type for this action relation. - * */ enum ActionType { /** @@ -296,51 +340,4 @@ public interface Action extends TenantAwareBaseEntity { DOWNLOAD_ONLY } - /** - * Returns the start time of next available maintenance window for the - * {@link Action} as {@link ZonedDateTime}. If a maintenance window is - * already active, the start time of currently active window is returned. - * - * @return the start time as { @link Optional}. - */ - Optional getMaintenanceWindowStartTime(); - - /** - * The method checks whether the action has a maintenance schedule defined - * for it. A maintenance schedule defines a set of maintenance windows - * during which actual update can be performed. A valid schedule defines at - * least one maintenance window. - * - * @return true if action has a maintenance schedule, else false. - */ - boolean hasMaintenanceSchedule(); - - /** - * The method checks whether the maintenance schedule has already lapsed for - * the action, i.e. there are no more windows available for maintenance. - * Controller manager uses the method to check if the maintenance schedule - * has lapsed, and automatically cancels the action if it is lapsed. - * - * @return true if maintenance schedule has lapsed, else false. - */ - boolean isMaintenanceScheduleLapsed(); - - /** - * The method checks whether a maintenance window is available for the - * action to proceed. If it is available, a 'true' value is returned. The - * maintenance window is considered available: 1) If there is no maintenance - * schedule at all, in which case device can start update any time after - * download is finished; or 2) the current time is within a scheduled - * maintenance window start and end time. - * - * @return true if maintenance window is available, else false. - */ - boolean isMaintenanceWindowAvailable(); - - /** - * Checks if the action is waiting for confirmation. - * @return true if the action is waiting for confirmation, else false - */ - boolean isWaitingConfirmation(); - } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionProperties.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionProperties.java index a6b312cdf..d45515612 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionProperties.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionProperties.java @@ -9,11 +9,11 @@ */ package org.eclipse.hawkbit.repository.model; +import java.io.Serializable; + import com.fasterxml.jackson.annotation.JsonIgnore; import lombok.Data; -import java.io.Serializable; - /** * Holds properties for {@link Action} */ @@ -34,8 +34,8 @@ public class ActionProperties implements Serializable { /** * Constructor - * @param action - * the action to populate the properties from + * + * @param action the action to populate the properties from */ public ActionProperties(final Action action) { this.id = action.getId(); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionStatus.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionStatus.java index 7a8eeb60f..3e3687c0f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionStatus.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ActionStatus.java @@ -19,7 +19,6 @@ import org.eclipse.hawkbit.repository.model.Action.Status; * {@link Target} or is added by the update server itself. This can be the start * of the {@link Action} life cycle, the end and update notifications in * between. - * */ public interface ActionStatus extends TenantAwareBaseEntity { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Artifact.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Artifact.java index 7f66bdd81..1dc2b6fd2 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Artifact.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Artifact.java @@ -15,9 +15,9 @@ import org.eclipse.hawkbit.artifact.repository.model.AbstractDbArtifact; * Binaries for a {@link SoftwareModule} Note: the decision which artifacts have * to be downloaded are done on the device side. e.g. Full Package, Signatures, * binary deltas - * */ public interface Artifact extends TenantAwareBaseEntity { + /** * @return the filename that was provided during upload. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ArtifactUpload.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ArtifactUpload.java index f9a13f454..cd0bbaa39 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ArtifactUpload.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/ArtifactUpload.java @@ -19,7 +19,6 @@ import org.eclipse.hawkbit.repository.ValidString; /** * Use to create a new artifact. - * */ @Data public class ArtifactUpload { @@ -47,18 +46,13 @@ public class ArtifactUpload { /** * Constructor - * - * @param inputStream - * to read from for artifact binary - * @param moduleId - * to assign the new artifact to - * @param filename - * of the artifact - * @param overrideExisting - * to true if the artifact binary can be overridden - * if it already exists - * @param filesize - * the size of the file in bytes. + * + * @param inputStream to read from for artifact binary + * @param moduleId to assign the new artifact to + * @param filename of the artifact + * @param overrideExisting to true if the artifact binary can be overridden + * if it already exists + * @param filesize the size of the file in bytes. */ public ArtifactUpload(final InputStream inputStream, final long moduleId, final String filename, final boolean overrideExisting, final long filesize) { @@ -67,24 +61,16 @@ public class ArtifactUpload { /** * Constructor - * - * @param inputStream - * to read from for artifact binary - * @param moduleId - * to assign the new artifact to - * @param filename - * of the artifact - * @param providedSha1Sum - * optional sha1 checksum to check the new file against - * @param providedMd5Sum - * optional md5 checksum to check the new file against - * @param overrideExisting - * to true if the artifact binary can be overridden - * if it already exists - * @param contentType - * the contentType of the file - * @param filesize - * the size of the file in bytes. + * + * @param inputStream to read from for artifact binary + * @param moduleId to assign the new artifact to + * @param filename of the artifact + * @param providedSha1Sum optional sha1 checksum to check the new file against + * @param providedMd5Sum optional md5 checksum to check the new file against + * @param overrideExisting to true if the artifact binary can be overridden + * if it already exists + * @param contentType the contentType of the file + * @param filesize the size of the file in bytes. */ public ArtifactUpload(final InputStream inputStream, final long moduleId, final String filename, final String providedMd5Sum, final String providedSha1Sum, final String providedSha256Sum, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AssignedSoftwareModule.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AssignedSoftwareModule.java index ec9b16fc9..59afca525 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AssignedSoftwareModule.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AssignedSoftwareModule.java @@ -14,10 +14,8 @@ import org.eclipse.hawkbit.repository.Identifiable; import java.io.Serializable; - /** * Use to display software modules for the selected distribution. - * */ @Data public class AssignedSoftwareModule implements Serializable, Identifiable { @@ -31,11 +29,9 @@ public class AssignedSoftwareModule implements Serializable, Identifiable /** * Constructor. * - * @param softwareModule - * entity. - * @param assigned - * as true if the software module is assigned and false if not - * assigned. + * @param softwareModule entity. + * @param assigned as true if the software module is assigned and false if not + * assigned. */ public AssignedSoftwareModule(final SoftwareModule softwareModule, final boolean assigned) { this.softwareModule = softwareModule; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AutoConfirmationStatus.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AutoConfirmationStatus.java index ff1abcb08..d4d57229f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AutoConfirmationStatus.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/AutoConfirmationStatus.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * {@link AutoConfirmationStatus} of a {@link Target}. - * */ public interface AutoConfirmationStatus extends BaseEntity { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/BaseEntity.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/BaseEntity.java index 7fd3d0ffc..cb3fe2783 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/BaseEntity.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/BaseEntity.java @@ -9,14 +9,13 @@ */ package org.eclipse.hawkbit.repository.model; -import org.eclipse.hawkbit.repository.Identifiable; - import java.io.Serializable; import java.util.concurrent.TimeUnit; +import org.eclipse.hawkbit.repository.Identifiable; + /** * Core information of all entities. - * */ public interface BaseEntity extends Serializable, Identifiable { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DeploymentRequest.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DeploymentRequest.java index 7dd5c11db..c7bcf6183 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DeploymentRequest.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DeploymentRequest.java @@ -9,8 +9,6 @@ */ package org.eclipse.hawkbit.repository.model; -import java.util.Objects; - import jakarta.validation.Valid; import lombok.Data; @@ -31,43 +29,32 @@ public class DeploymentRequest { * Constructor that also accepts maintenance schedule parameters and checks for * validity of the specified maintenance schedule. * - * @param controllerId - * for which the action is created. - * @param distributionSetId - * of the distribution set that that should be assigned to the - * controller. - * @param actionType - * specified for the action. - * @param forceTime - * at what time the type soft turns into forced. - * @param weight - * the priority of an {@link Action}. - * @param maintenanceSchedule - * is the cron expression to be used for scheduling maintenance - * windows. Expression has 6 mandatory fields and 1 last optional - * field: "second minute hour dayofmonth month weekday year" - * @param maintenanceWindowDuration - * in HH:mm:ss format specifying the duration of a maintenance - * window, for example 00:30:00 for 30 minutes - * @param maintenanceWindowTimeZone - * is the time zone specified as +/-hh:mm offset from UTC, for - * example +02:00 for CET summer time and +00:00 for UTC. The start - * time of a maintenance window calculated based on the cron - * expression is relative to this time zone. - * - * @param confirmationRequired - * is a flag whether the confirmation should be required for the - * resulting {@link Action} or not. In case the confirmation is not - * required, the action will be automatically confirmed and put in - * the - * {@link org.eclipse.hawkbit.repository.model.Action.Status#RUNNING} - * state. Otherwise the confirmation flow will be triggered - * and the {@link Action} will stay in the - * {@link org.eclipse.hawkbit.repository.model.Action.Status#WAIT_FOR_CONFIRMATION} - * state until the confirmation is given. (Only considered - * with CONFIRMATION_FLOW active via tenant configuration) - * @throws InvalidMaintenanceScheduleException - * if the parameters do not define a valid maintenance schedule. + * @param controllerId for which the action is created. + * @param distributionSetId of the distribution set that that should be assigned to the + * controller. + * @param actionType specified for the action. + * @param forceTime at what time the type soft turns into forced. + * @param weight the priority of an {@link Action}. + * @param maintenanceSchedule is the cron expression to be used for scheduling maintenance + * windows. Expression has 6 mandatory fields and 1 last optional + * field: "second minute hour dayofmonth month weekday year" + * @param maintenanceWindowDuration in HH:mm:ss format specifying the duration of a maintenance + * window, for example 00:30:00 for 30 minutes + * @param maintenanceWindowTimeZone is the time zone specified as +/-hh:mm offset from UTC, for + * example +02:00 for CET summer time and +00:00 for UTC. The start + * time of a maintenance window calculated based on the cron + * expression is relative to this time zone. + * @param confirmationRequired is a flag whether the confirmation should be required for the + * resulting {@link Action} or not. In case the confirmation is not + * required, the action will be automatically confirmed and put in + * the + * {@link org.eclipse.hawkbit.repository.model.Action.Status#RUNNING} + * state. Otherwise the confirmation flow will be triggered + * and the {@link Action} will stay in the + * {@link org.eclipse.hawkbit.repository.model.Action.Status#WAIT_FOR_CONFIRMATION} + * state until the confirmation is given. (Only considered + * with CONFIRMATION_FLOW active via tenant configuration) + * @throws InvalidMaintenanceScheduleException if the parameters do not define a valid maintenance schedule. */ public DeploymentRequest(final String controllerId, final Long distributionSetId, final ActionType actionType, final long forceTime, final Integer weight, final String maintenanceSchedule, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DeploymentRequestBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DeploymentRequestBuilder.java index 01fd6da6a..d4c49247b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DeploymentRequestBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DeploymentRequestBuilder.java @@ -13,7 +13,6 @@ import org.eclipse.hawkbit.repository.model.Action.ActionType; /** * Builder for {@link DeploymentRequest} - * */ public class DeploymentRequestBuilder { @@ -30,11 +29,9 @@ public class DeploymentRequestBuilder { /** * Create a builder for a target distribution set assignment with the * mandatory fields - * - * @param controllerId - * ID of the target - * @param distributionSetId - * ID of the distribution set + * + * @param controllerId ID of the target + * @param distributionSetId ID of the distribution set */ public DeploymentRequestBuilder(final String controllerId, final Long distributionSetId) { this.controllerId = controllerId; @@ -43,9 +40,8 @@ public class DeploymentRequestBuilder { /** * Set an other {@link ActionType} than {@link ActionType#FORCED} - * - * @param actionType - * type to used + * + * @param actionType type to used * @return builder */ public DeploymentRequestBuilder setActionType(final ActionType actionType) { @@ -55,9 +51,8 @@ public class DeploymentRequestBuilder { /** * Set a forceTime other than the default one. - * - * @param forceTime - * at what time the type soft turns into forced. + * + * @param forceTime at what time the type soft turns into forced. * @return builder */ public DeploymentRequestBuilder setForceTime(final long forceTime) { @@ -67,9 +62,8 @@ public class DeploymentRequestBuilder { /** * Set the weight of the action. - * - * @param weight - * the priority given to the action. + * + * @param weight the priority given to the action. * @return builder */ public DeploymentRequestBuilder setWeight(final Integer weight) { @@ -79,19 +73,16 @@ public class DeploymentRequestBuilder { /** * Set a maintenanceWindow - * - * @param maintenanceSchedule - * is the cron expression to be used for scheduling maintenance - * windows. Expression has 6 mandatory fields and 1 last optional - * field: "second minute hour dayofmonth month weekday year" - * @param maintenanceWindowDuration - * in HH:mm:ss format specifying the duration of a maintenance - * window, for example 00:30:00 for 30 minutes - * @param maintenanceWindowTimeZone - * is the time zone specified as +/-hh:mm offset from UTC, for - * example +02:00 for CET summer time and +00:00 for UTC. The - * start time of a maintenance window calculated based on the - * cron expression is relative to this time zone. + * + * @param maintenanceSchedule is the cron expression to be used for scheduling maintenance + * windows. Expression has 6 mandatory fields and 1 last optional + * field: "second minute hour dayofmonth month weekday year" + * @param maintenanceWindowDuration in HH:mm:ss format specifying the duration of a maintenance + * window, for example 00:30:00 for 30 minutes + * @param maintenanceWindowTimeZone is the time zone specified as +/-hh:mm offset from UTC, for + * example +02:00 for CET summer time and +00:00 for UTC. The + * start time of a maintenance window calculated based on the + * cron expression is relative to this time zone. * @return builder */ public DeploymentRequestBuilder setMaintenance(final String maintenanceSchedule, @@ -104,9 +95,8 @@ public class DeploymentRequestBuilder { /** * Set if a confirmation is required. - * - * @param confirmationRequired - * if a confirmation is required for the {@link Action} + * + * @param confirmationRequired if a confirmation is required for the {@link Action} * @return builder */ public DeploymentRequestBuilder setConfirmationRequired(final boolean confirmationRequired) { @@ -116,7 +106,7 @@ public class DeploymentRequestBuilder { /** * build the request - * + * * @return the request object */ public DeploymentRequest build() { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSet.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSet.java index dd6ca94df..002570b38 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSet.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSet.java @@ -9,7 +9,6 @@ */ package org.eclipse.hawkbit.repository.model; -import java.util.List; import java.util.Optional; import java.util.Set; @@ -21,7 +20,6 @@ import java.util.Set; *

    * A {@link Target} has exactly one target {@link DistributionSet} assigned. *

    - * */ public interface DistributionSet extends NamedVersionedEntity { @@ -31,7 +29,6 @@ public interface DistributionSet extends NamedVersionedEntity { DistributionSetType getType(); /** - * * @return unmodifiableSet of {@link SoftwareModule}. */ Set getModules(); @@ -71,8 +68,7 @@ public interface DistributionSet extends NamedVersionedEntity { /** * Searches through modules for the given type. * - * @param type - * to search for + * @param type to search for * @return SoftwareModule of given type */ default Optional findFirstModuleByType(final SoftwareModuleType type) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetAssignmentResult.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetAssignmentResult.java index b7b2bf1fa..a6a25e4b1 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetAssignmentResult.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetAssignmentResult.java @@ -9,16 +9,15 @@ */ package org.eclipse.hawkbit.repository.model; -import lombok.Data; - import java.util.Collections; import java.util.List; +import lombok.Data; + /** * A bean which holds a complex result of an service operation to combine the * information of an assignment and how much of the assignment has been done and * how much of the assignments had already been existed. - * */ @Data public class DistributionSetAssignmentResult extends AbstractAssignmentResult { @@ -26,14 +25,11 @@ public class DistributionSetAssignmentResult extends AbstractAssignmentResult assigned) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetFilter.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetFilter.java index e341fa142..6d0df9486 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetFilter.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetFilter.java @@ -9,11 +9,11 @@ */ package org.eclipse.hawkbit.repository.model; +import java.util.Collection; + import lombok.Builder; import lombok.Data; -import java.util.Collection; - /** * Holds distribution set filter parameters. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetInvalidation.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetInvalidation.java index d49a02b07..8316d41ba 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetInvalidation.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetInvalidation.java @@ -9,16 +9,33 @@ */ package org.eclipse.hawkbit.repository.model; -import lombok.Data; - import java.util.Collection; +import lombok.Data; + /** * Holds the information about the invalidation of a distribution set */ @Data public class DistributionSetInvalidation { + private Collection distributionSetIds; + private CancelationType cancelationType; + private boolean cancelRollouts; + /** + * Parametric constructor + * + * @param distributionSetIds defines which distribution sets should be canceled + * @param cancelationType defines if actions should be canceled + * @param cancelRollouts defines if rollouts should be canceled + */ + public DistributionSetInvalidation(final Collection distributionSetIds, final CancelationType cancelationType, + final boolean cancelRollouts) { + this.distributionSetIds = distributionSetIds; + this.cancelationType = cancelationType; + this.cancelRollouts = cancelRollouts; + } + /** * Defines if and how actions should be canceled when invalidating a * distribution set @@ -26,25 +43,4 @@ public class DistributionSetInvalidation { public enum CancelationType { FORCE, SOFT, NONE } - - private Collection distributionSetIds; - private CancelationType cancelationType; - private boolean cancelRollouts; - - /** - * Parametric constructor - * - * @param distributionSetIds - * defines which distribution sets should be canceled - * @param cancelationType - * defines if actions should be canceled - * @param cancelRollouts - * defines if rollouts should be canceled - */ - public DistributionSetInvalidation(final Collection distributionSetIds, final CancelationType cancelationType, - final boolean cancelRollouts) { - this.distributionSetIds = distributionSetIds; - this.cancelationType = cancelationType; - this.cancelRollouts = cancelRollouts; - } } \ No newline at end of file diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetMetadata.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetMetadata.java index 3ad1609d0..bab3ab6e8 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetMetadata.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetMetadata.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * {@link MetaData} of a {@link DistributionSet}. - * */ public interface DistributionSetMetadata extends MetaData { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTag.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTag.java index 7100f6b5b..4473cb71e 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTag.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTag.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * {@link Tag} of a {@link DistributionSet}. - * */ public interface DistributionSetTag extends Tag { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTagAssignmentResult.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTagAssignmentResult.java index ff3120fb0..2e0a55034 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTagAssignmentResult.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetTagAssignmentResult.java @@ -9,10 +9,10 @@ */ package org.eclipse.hawkbit.repository.model; -import lombok.Data; - import java.util.List; +import lombok.Data; + /** * Result object for {@link DistributionSetTag} assignments. * @@ -27,14 +27,10 @@ public class DistributionSetTagAssignmentResult extends AbstractAssignmentResult /** * Constructor. * - * @param alreadyAssigned - * number of already assigned/ignored elements - * @param assigned - * newly assigned elements - * @param unassigned - * unassigned elements - * @param distributionSetTag - * the assigned or unassigned tag + * @param alreadyAssigned number of already assigned/ignored elements + * @param assigned newly assigned elements + * @param unassigned unassigned elements + * @param distributionSetTag the assigned or unassigned tag */ public DistributionSetTagAssignmentResult(final int alreadyAssigned, final List assigned, final List unassigned, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetType.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetType.java index 662d31e2a..d8673a288 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetType.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/DistributionSetType.java @@ -17,7 +17,6 @@ import java.util.Set; * added (optional) to {@link DistributionSet} of that type or have to added * (mandatory) in order to be considered complete. Only complete DS can be * assigned to a {@link Target}. - * */ public interface DistributionSetType extends Type { @@ -38,8 +37,7 @@ public interface DistributionSetType extends Type { * Checks if the given {@link SoftwareModuleType} is in this * {@link DistributionSetType}. * - * @param softwareModuleType - * search for + * @param softwareModuleType search for * @return true if found */ default boolean containsModuleType(final SoftwareModuleType softwareModuleType) { @@ -50,8 +48,7 @@ public interface DistributionSetType extends Type { * Checks if the given {@link SoftwareModuleType} is in this * {@link DistributionSetType}. * - * @param softwareModuleTypeId - * search for by {@link SoftwareModuleType#getId()} + * @param softwareModuleTypeId search for by {@link SoftwareModuleType#getId()} * @return true if found */ default boolean containsModuleType(final Long softwareModuleTypeId) { @@ -62,8 +59,7 @@ public interface DistributionSetType extends Type { * Checks if the given {@link SoftwareModuleType} is in * {@link #getMandatoryModuleTypes()}. * - * @param softwareModuleType - * search for + * @param softwareModuleType search for * @return true if found */ default boolean containsMandatoryModuleType(final SoftwareModuleType softwareModuleType) { @@ -74,8 +70,7 @@ public interface DistributionSetType extends Type { * Checks if the given {@link SoftwareModuleType} is in * {@link #getMandatoryModuleTypes()}. * - * @param softwareModuleTypeId - * search for by {@link SoftwareModuleType#getId()} + * @param softwareModuleTypeId search for by {@link SoftwareModuleType#getId()} * @return true if found */ default boolean containsMandatoryModuleType(final Long softwareModuleTypeId) { @@ -86,8 +81,7 @@ public interface DistributionSetType extends Type { * Checks if the given {@link SoftwareModuleType} is in * {@link #getOptionalModuleTypes()}. * - * @param softwareModuleType - * search for + * @param softwareModuleType search for * @return true if found */ default boolean containsOptionalModuleType(final SoftwareModuleType softwareModuleType) { @@ -98,8 +92,7 @@ public interface DistributionSetType extends Type { * Checks if the given {@link SoftwareModuleType} is in * {@link #getOptionalModuleTypes()}. * - * @param softwareModuleTypeId - * search by {@link SoftwareModuleType#getId()} + * @param softwareModuleTypeId search by {@link SoftwareModuleType#getId()} * @return true if found */ default boolean containsOptionalModuleType(final Long softwareModuleTypeId) { @@ -110,15 +103,13 @@ public interface DistributionSetType extends Type { * Compares the modules of this {@link DistributionSetType} and the given * one. * - * @param dsType - * to compare with + * @param dsType to compare with * @return true if the lists are identical. */ boolean areModuleEntriesIdentical(DistributionSetType dsType); /** - * @param distributionSet - * to check for completeness + * @param distributionSet to check for completeness * @return true if the all mandatory software module types are * in the system. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/MetaData.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/MetaData.java index 5e2b2c33e..7a4d2199a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/MetaData.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/MetaData.java @@ -13,9 +13,9 @@ import java.io.Serializable; /** * Meta data for entities, a (key/value) store. - * */ public interface MetaData extends Serializable { + /** * Maximum length of metadata key. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/NamedEntity.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/NamedEntity.java index cd269f730..77a1fc7c3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/NamedEntity.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/NamedEntity.java @@ -11,9 +11,9 @@ package org.eclipse.hawkbit.repository.model; /** * Entities that have a name and description. - * */ public interface NamedEntity extends TenantAwareBaseEntity { + /** * Maximum length of name. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/NamedVersionedEntity.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/NamedVersionedEntity.java index 1efc9c51f..8464ae8ba 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/NamedVersionedEntity.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/NamedVersionedEntity.java @@ -11,9 +11,9 @@ package org.eclipse.hawkbit.repository.model; /** * Entities that have a name and a description. - * */ public interface NamedVersionedEntity extends NamedEntity { + /** * Maximum length of version. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/PollStatus.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/PollStatus.java index 7579311fb..e6219d66d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/PollStatus.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/PollStatus.java @@ -9,15 +9,14 @@ */ package org.eclipse.hawkbit.repository.model; -import lombok.Data; - import java.time.LocalDateTime; +import lombok.Data; + /** * The poll time object which holds all the necessary information around the * target poll time, e.g. the last poll time, the next poll time and the overdue * poll time. - * */ @Data public class PollStatus { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RepositoryModelConstants.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RepositoryModelConstants.java index c0686daf2..7784a4978 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RepositoryModelConstants.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RepositoryModelConstants.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * Repository model constants. - * */ public final class RepositoryModelConstants { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Rollout.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Rollout.java index 96851a968..f8dd10a35 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Rollout.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Rollout.java @@ -23,7 +23,6 @@ import org.eclipse.hawkbit.repository.model.TotalTargetCountStatus.Status; * time. Monitoring of the rollout progress. Emergency rollout shutdown in case * of problems on to many devices and reporting capabilities for a complete * understanding of the rollout progress at each point in time. - * */ public interface Rollout extends NamedEntity { @@ -119,9 +118,7 @@ public interface Rollout extends NamedEntity { Optional getAccessControlContext(); /** - * * State machine for rollout. - * */ enum RolloutStatus { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroup.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroup.java index 9eb819e58..993e3c6ba 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroup.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroup.java @@ -13,7 +13,6 @@ package org.eclipse.hawkbit.repository.model; * The core functionality of a {@link Rollout} is the cascading processing of * (sub) deployment groups. The group defines under which conditions the * following group is processed. - * */ public interface RolloutGroup extends NamedEntity { @@ -123,7 +122,6 @@ public interface RolloutGroup extends NamedEntity { /** * Rollout group state machine. - * */ enum RolloutGroupStatus { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroupConditionBuilder.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroupConditionBuilder.java index 66882bdde..6ec62c08b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroupConditionBuilder.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroupConditionBuilder.java @@ -16,7 +16,6 @@ import org.eclipse.hawkbit.repository.model.RolloutGroup.RolloutGroupSuccessCond /** * Builder to build easily the {@link RolloutGroupConditions}. - * */ public class RolloutGroupConditionBuilder { @@ -32,10 +31,8 @@ public class RolloutGroupConditionBuilder { /** * Sets the finish condition and expression on the builder. * - * @param condition - * the finish condition - * @param expression - * the finish expression + * @param condition the finish condition + * @param expression the finish expression * @return the builder itself */ public RolloutGroupConditionBuilder successCondition(final RolloutGroupSuccessCondition condition, @@ -48,10 +45,8 @@ public class RolloutGroupConditionBuilder { /** * Sets the success action and expression on the builder. * - * @param action - * the success action - * @param expression - * the error expression + * @param action the success action + * @param expression the error expression * @return the builder itself */ public RolloutGroupConditionBuilder successAction(final RolloutGroupSuccessAction action, final String expression) { @@ -63,10 +58,8 @@ public class RolloutGroupConditionBuilder { /** * Sets the error condition and expression on the builder. * - * @param condition - * the error condition - * @param expression - * the error expression + * @param condition the error condition + * @param expression the error expression * @return the builder itself */ public RolloutGroupConditionBuilder errorCondition(final RolloutGroupErrorCondition condition, @@ -79,10 +72,8 @@ public class RolloutGroupConditionBuilder { /** * Sets the error action and expression on the builder. * - * @param action - * the error action - * @param expression - * the error expression + * @param action the error action + * @param expression the error expression * @return the builder itself */ public RolloutGroupConditionBuilder errorAction(final RolloutGroupErrorAction action, final String expression) { @@ -93,7 +84,7 @@ public class RolloutGroupConditionBuilder { /** * Sets condition defaults. - * + * * @return the builder itself */ public RolloutGroupConditionBuilder withDefaults() { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroupsValidation.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroupsValidation.java index addb4b245..5426f2b7b 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroupsValidation.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/RolloutGroupsValidation.java @@ -12,6 +12,7 @@ package org.eclipse.hawkbit.repository.model; import java.util.List; import jakarta.validation.constraints.NotNull; + import lombok.Data; /** @@ -33,12 +34,10 @@ public class RolloutGroupsValidation { /** * Instantiates a new validation result - * - * @param totalTargets - * The total amount of targets in a {@link Rollout} - * @param targetsPerGroup - * A list containing the count of targets for each - * {@link RolloutGroup} + * + * @param totalTargets The total amount of targets in a {@link Rollout} + * @param targetsPerGroup A list containing the count of targets for each + * {@link RolloutGroup} */ public RolloutGroupsValidation(final long totalTargets, @NotNull final List targetsPerGroup) { this.totalTargets = totalTargets; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModule.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModule.java index 411bab43a..96f743ab3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModule.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModule.java @@ -56,8 +56,7 @@ public interface SoftwareModule extends NamedVersionedEntity { boolean isDeleted(); /** - * @param artifactId - * to look for + * @param artifactId to look for * @return found {@link Artifact} */ default Optional getArtifact(final Long artifactId) { @@ -65,8 +64,7 @@ public interface SoftwareModule extends NamedVersionedEntity { } /** - * @param fileName - * to look for + * @param fileName to look for * @return found {@link Artifact} */ default Optional getArtifactByFilename(final String fileName) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModuleMetadata.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModuleMetadata.java index 42fd93ab6..113f38166 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModuleMetadata.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModuleMetadata.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * {@link MetaData} element of a {@link SoftwareModule}. - * */ public interface SoftwareModuleMetadata extends MetaData { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModuleType.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModuleType.java index 966f11549..7bcf3b92c 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModuleType.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/SoftwareModuleType.java @@ -13,7 +13,6 @@ package org.eclipse.hawkbit.repository.model; * {@link SoftwareModuleType} is an abstract definition used in * {@link DistributionSetType}s and includes additional {@link SoftwareModule} * specific information. - * */ public interface SoftwareModuleType extends Type { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Statistic.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Statistic.java index 30c0df331..a86e2fdff 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Statistic.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Statistic.java @@ -12,15 +12,13 @@ package org.eclipse.hawkbit.repository.model; public interface Statistic { - /** - * - * @return the key of the Statistic entity. - */ - Object getName(); + /** + * @return the key of the Statistic entity. + */ + Object getName(); - /** - * - * @return the value of the Statistic entity. - */ - Object getData(); + /** + * @return the value of the Statistic entity. + */ + Object getData(); } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Tag.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Tag.java index 657a6f6d2..e1ff625c0 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Tag.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Tag.java @@ -11,9 +11,9 @@ package org.eclipse.hawkbit.repository.model; /** * {@link Tag} entry. - * */ public interface Tag extends NamedEntity { + /** * Maximum length of colour in Management UI. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Target.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Target.java index 600292e53..ef7a946c0 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Target.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Target.java @@ -21,6 +21,7 @@ import java.util.concurrent.TimeUnit; *

    */ public interface Target extends NamedEntity { + /** * Maximum length of controllerId. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetFilterQuery.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetFilterQuery.java index e59111924..b9af43c03 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetFilterQuery.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetFilterQuery.java @@ -18,7 +18,7 @@ import org.eclipse.hawkbit.repository.model.Action.ActionType; /** * Managed filter entity. - * + * * Supported operators. *
      *
    • {@code Equal to : ==}
      • @@ -38,9 +38,9 @@ import org.eclipse.hawkbit.repository.model.Action.ActionType; *
    • {@code name==targetId1,description==plugAndPlay,updateStatus==UNKNOWN}
      • *
    • {@code name==targetId1 or description==plugAndPlay or updateStatus==UNKNOWN}
      • *
    - * */ public interface TargetFilterQuery extends TenantAwareBaseEntity { + /** * Maximum length of query filter string. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetMetadata.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetMetadata.java index cca9b85dd..d18ecf545 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetMetadata.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetMetadata.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * {@link MetaData} of a {@link Target}. - * */ public interface TargetMetadata extends MetaData { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTag.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTag.java index 2bca86977..eb0e3cc02 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTag.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTag.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * Target tag element. - * */ public interface TargetTag extends Tag { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTagAssignmentResult.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTagAssignmentResult.java index 628331ec3..b88490d56 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTagAssignmentResult.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTagAssignmentResult.java @@ -9,10 +9,10 @@ */ package org.eclipse.hawkbit.repository.model; -import lombok.Data; - import java.util.List; +import lombok.Data; + /** * Result object for {@link TargetTag} assignments. * @@ -27,14 +27,10 @@ public class TargetTagAssignmentResult extends AbstractAssignmentResult /** * Constructor. * - * @param alreadyAssigned - * count of already assigned (ignored) elements - * @param assigned - * {@link List} of assigned {@link Target}s. - * @param unassigned - * {@link List} of unassigned {@link Target}s. - * @param targetTag - * the assigned or unassigned tag + * @param alreadyAssigned count of already assigned (ignored) elements + * @param assigned {@link List} of assigned {@link Target}s. + * @param unassigned {@link List} of unassigned {@link Target}s. + * @param targetTag the assigned or unassigned tag */ public TargetTagAssignmentResult(final int alreadyAssigned, final List assigned, final List unassigned, final TargetTag targetTag) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetType.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetType.java index efb8cf6af..3ba73b803 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetType.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetType.java @@ -14,7 +14,6 @@ import java.util.Set; /** * A {@link TargetType} is an abstract definition for * {@link Target} - * */ public interface TargetType extends Type { @@ -37,8 +36,7 @@ public interface TargetType extends Type { * Checks if the given {@link DistributionSetType} is in * {@link #getCompatibleDistributionSetTypes()}. * - * @param distributionSetTypeId - * search by {@link DistributionSetType#getId()} + * @param distributionSetTypeId search by {@link DistributionSetType#getId()} * @return true if found */ default boolean containsCompatibleDistributionSetType(final Long distributionSetTypeId) { @@ -47,9 +45,8 @@ public interface TargetType extends Type { /** * Unassigns a {@link DistributionSetType} from {@link TargetType} - * - * @param dsTypeId - * that will be removed from {@link TargetType} + * + * @param dsTypeId that will be removed from {@link TargetType} * @return the resulting target type */ TargetType removeDistributionSetType(final Long dsTypeId); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTypeAssignmentResult.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTypeAssignmentResult.java index c4ad3b0fe..62a5aa74e 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTypeAssignmentResult.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetTypeAssignmentResult.java @@ -9,13 +9,12 @@ */ package org.eclipse.hawkbit.repository.model; -import lombok.Data; - import java.util.List; +import lombok.Data; + /** * Result object for {@link TargetType} assignments. - * */ @Data public class TargetTypeAssignmentResult extends AbstractAssignmentResult { @@ -25,17 +24,13 @@ public class TargetTypeAssignmentResult extends AbstractAssignmentResult /** * Constructor. * - * @param alreadyAssigned - * count of already assigned (ignored) elements - * @param assigned - * {@link List} of assigned {@link Target}s. - * @param unassigned - * {@link List} of unassigned {@link Target}s. - * @param targetType - * the assigned or unassigned tag + * @param alreadyAssigned count of already assigned (ignored) elements + * @param assigned {@link List} of assigned {@link Target}s. + * @param unassigned {@link List} of unassigned {@link Target}s. + * @param targetType the assigned or unassigned tag */ public TargetTypeAssignmentResult(final int alreadyAssigned, final List assigned, - final List unassigned, final TargetType targetType) { + final List unassigned, final TargetType targetType) { super(alreadyAssigned, assigned, unassigned); this.targetType = targetType; } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetUpdateStatus.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetUpdateStatus.java index da1000c5a..1b307747c 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetUpdateStatus.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetUpdateStatus.java @@ -13,7 +13,6 @@ package org.eclipse.hawkbit.repository.model; * The overall {@link TargetUpdateStatus} of a {@link Target} that describes its * status. A {@link Target} can have only one status. independent of the number * of {@link Action}s that have to be applied. - * */ public enum TargetUpdateStatus { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetWithActionType.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetWithActionType.java index 6ff5522fe..6142d06f3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetWithActionType.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TargetWithActionType.java @@ -25,7 +25,8 @@ public class TargetWithActionType { private final String controllerId; private final ActionType actionType; private final long forceTime; - @Min(Action.WEIGHT_MIN) @Max(Action.WEIGHT_MAX) + @Min(Action.WEIGHT_MIN) + @Max(Action.WEIGHT_MAX) private final Integer weight; private final boolean confirmationRequired; private final String maintenanceSchedule; @@ -34,9 +35,8 @@ public class TargetWithActionType { /** * Constructor that uses {@link ActionType#FORCED} - * - * @param controllerId - * ID if the controller + * + * @param controllerId ID if the controller */ public TargetWithActionType(final String controllerId) { this(controllerId, ActionType.FORCED, 0, null, false); @@ -45,18 +45,13 @@ public class TargetWithActionType { /** * Constructor that leaves the maintenance info empty * - * @param controllerId - * for which the action is created. - * @param actionType - * specified for the action. - * @param forceTime - * after that point in time the action is exposed as forced in case - * the type is {@link ActionType#TIMEFORCED} - * @param weight - * the priority of an {@link Action} - * @param confirmationRequired - * sets the confirmation required flag when starting the - * {@link Action} + * @param controllerId for which the action is created. + * @param actionType specified for the action. + * @param forceTime after that point in time the action is exposed as forced in case + * the type is {@link ActionType#TIMEFORCED} + * @param weight the priority of an {@link Action} + * @param confirmationRequired sets the confirmation required flag when starting the + * {@link Action} */ public TargetWithActionType( final String controllerId, final ActionType actionType, final long forceTime, @@ -68,30 +63,21 @@ public class TargetWithActionType { * Constructor that also accepts maintenance schedule parameters and checks * for validity of the specified maintenance schedule. * - * @param controllerId - * for which the action is created. - * @param actionType - * specified for the action. - * @param forceTime - * after that point in time the action is exposed as forced in - * case the type is {@link ActionType#TIMEFORCED} - * @param weight - * the priority of an {@link Action} - * @param maintenanceSchedule - * is the cron expression to be used for scheduling maintenance - * windows. Expression has 6 mandatory fields and 1 last optional - * field: "second minute hour dayofmonth month weekday year" - * @param maintenanceWindowDuration - * in HH:mm:ss format specifying the duration of a maintenance - * window, for example 00:30:00 for 30 minutes - * @param maintenanceWindowTimeZone - * is the time zone specified as +/-hh:mm offset from UTC, for - * example +02:00 for CET summer time and +00:00 for UTC. The - * start time of a maintenance window calculated based on the - * cron expression is relative to this time zone. - * - * @throws InvalidMaintenanceScheduleException - * if the parameters do not define a valid maintenance schedule. + * @param controllerId for which the action is created. + * @param actionType specified for the action. + * @param forceTime after that point in time the action is exposed as forced in + * case the type is {@link ActionType#TIMEFORCED} + * @param weight the priority of an {@link Action} + * @param maintenanceSchedule is the cron expression to be used for scheduling maintenance + * windows. Expression has 6 mandatory fields and 1 last optional + * field: "second minute hour dayofmonth month weekday year" + * @param maintenanceWindowDuration in HH:mm:ss format specifying the duration of a maintenance + * window, for example 00:30:00 for 30 minutes + * @param maintenanceWindowTimeZone is the time zone specified as +/-hh:mm offset from UTC, for + * example +02:00 for CET summer time and +00:00 for UTC. The + * start time of a maintenance window calculated based on the + * cron expression is relative to this time zone. + * @throws InvalidMaintenanceScheduleException if the parameters do not define a valid maintenance schedule. */ public TargetWithActionType( final String controllerId, final ActionType actionType, final long forceTime, final Integer weight, diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantAwareBaseEntity.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantAwareBaseEntity.java index 9d96c8270..7973dd2ee 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantAwareBaseEntity.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantAwareBaseEntity.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * {@link BaseEntity} that distinguishes between tenants. - * */ public interface TenantAwareBaseEntity extends BaseEntity { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantConfiguration.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantConfiguration.java index ed3324b86..d9c4b27fd 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantConfiguration.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantConfiguration.java @@ -12,7 +12,6 @@ package org.eclipse.hawkbit.repository.model; /** * Unstructured tenant configuration elements. Can be used to store arbitrary * tenant configuration elements. - * */ public interface TenantConfiguration extends TenantAwareBaseEntity { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantConfigurationValue.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantConfigurationValue.java index 552494a4a..875c21b48 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantConfigurationValue.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantConfigurationValue.java @@ -9,15 +9,15 @@ */ package org.eclipse.hawkbit.repository.model; -import lombok.Builder; -import lombok.Data; - import java.io.Serial; import java.io.Serializable; +import lombok.Builder; +import lombok.Data; + /** * Represents a tenant configuration value including some meta data - * + * * @param type of the configuration value */ @Data diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantMetaData.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantMetaData.java index f63f11f72..f4ef89266 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantMetaData.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TenantMetaData.java @@ -11,7 +11,6 @@ package org.eclipse.hawkbit.repository.model; /** * MetaData of a tenant account. - * */ public interface TenantMetaData extends BaseEntity { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TotalTargetCountActionStatus.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TotalTargetCountActionStatus.java index dc56664e1..facaec42a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TotalTargetCountActionStatus.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TotalTargetCountActionStatus.java @@ -14,7 +14,6 @@ import lombok.Data; /** * Represents rollout or rollout group statuses and count of targets in each * status. - * */ @Data public class TotalTargetCountActionStatus { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TotalTargetCountStatus.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TotalTargetCountStatus.java index b8229d282..c614128c3 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TotalTargetCountStatus.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/TotalTargetCountStatus.java @@ -15,13 +15,117 @@ import java.util.List; import java.util.Map; /** - * * Store target count of a {@link Rollout} or {@link RolloutGroup} for every * {@link Status}. - * */ public class TotalTargetCountStatus { + private final Map statusTotalCountMap = new EnumMap<>(Status.class); + private final Long totalTargetCount; + private final Action.ActionType rolloutType; + /** + * Create a new states map with the target count for each state. + * + * @param targetCountActionStatus the action state map + * @param totalTargetCount the total target count + * @param rolloutType the type of the rollout + */ + public TotalTargetCountStatus(final List targetCountActionStatus, + final Long totalTargetCount, final Action.ActionType rolloutType) { + this.totalTargetCount = totalTargetCount; + this.rolloutType = rolloutType; + addToTotalCount(targetCountActionStatus); + } + + /** + * Create a new states map with the target count for each state. + * + * @param totalTargetCount the total target count + * @param rolloutType the type of the rollout + */ + public TotalTargetCountStatus(final Long totalTargetCount, final Action.ActionType rolloutType) { + this(Collections.emptyList(), totalTargetCount, rolloutType); + } + + /** + * The current state mape which the total target count + * + * @return the statusTotalCountMap the state map + */ + public Map getStatusTotalCountMap() { + return statusTotalCountMap; + } + + /** + * Gets the total target count from a state. + * + * @param status the state key + * @return the current target count cannot be + */ + public Long getTotalTargetCountByStatus(final Status status) { + final Long count = statusTotalCountMap.get(status); + return count == null ? 0L : count; + } + + /** + * @return finished percentage of targets + */ + public float getFinishedPercent() { + return ((float) getTotalTargetCountByStatus(TotalTargetCountStatus.Status.FINISHED) / totalTargetCount) * 100; + } + + /** + * Populate all target status to a the given map + * + * @param statusTotalCountMap the map + * @param rolloutStatusCountItems all target {@link Status} with total count + */ + private void addToTotalCount(final List targetCountActionStatus) { + if (targetCountActionStatus == null) { + statusTotalCountMap.put(TotalTargetCountStatus.Status.NOTSTARTED, totalTargetCount); + return; + } + statusTotalCountMap.put(Status.RUNNING, 0L); + Long notStartedTargetCount = totalTargetCount; + for (final TotalTargetCountActionStatus item : targetCountActionStatus) { + addToTotalCount(item); + notStartedTargetCount -= item.getCount(); + } + statusTotalCountMap.put(TotalTargetCountStatus.Status.NOTSTARTED, notStartedTargetCount); + } + + private void addToTotalCount(final TotalTargetCountActionStatus item) { + final Status status = convertStatus(item.getStatus()); + statusTotalCountMap.merge(status, item.getCount(), Long::sum); + } + + // Exception squid:MethodCyclomaticComplexity - simple state conversion, not + // really complex. + @SuppressWarnings("squid:MethodCyclomaticComplexity") + private Status convertStatus(final Action.Status status) { + switch (status) { + case SCHEDULED: + return Status.SCHEDULED; + case ERROR: + return Status.ERROR; + case FINISHED: + return Status.FINISHED; + case CANCELED: + return Status.CANCELLED; + case RETRIEVED: + case RUNNING: + case WARNING: + case DOWNLOAD: + case WAIT_FOR_CONFIRMATION: + case CANCELING: + return Status.RUNNING; + case DOWNLOADED: + return Action.ActionType.DOWNLOAD_ONLY == rolloutType ? Status.FINISHED : Status.RUNNING; + default: + throw new IllegalArgumentException("State " + status + "is not valid"); + } + } + /** * Status of the total target counts. */ @@ -56,119 +160,4 @@ public class TotalTargetCountStatus { */ NOTSTARTED } - - private final Map statusTotalCountMap = new EnumMap<>(Status.class); - private final Long totalTargetCount; - private final Action.ActionType rolloutType; - - /** - * Create a new states map with the target count for each state. - * - * @param targetCountActionStatus - * the action state map - * @param totalTargetCount - * the total target count - * @param rolloutType - * the type of the rollout - */ - public TotalTargetCountStatus(final List targetCountActionStatus, - final Long totalTargetCount, final Action.ActionType rolloutType) { - this.totalTargetCount = totalTargetCount; - this.rolloutType = rolloutType; - addToTotalCount(targetCountActionStatus); - } - - /** - * Create a new states map with the target count for each state. - * - * @param totalTargetCount - * the total target count - * @param rolloutType - * the type of the rollout - */ - public TotalTargetCountStatus(final Long totalTargetCount, final Action.ActionType rolloutType) { - this(Collections.emptyList(), totalTargetCount, rolloutType); - } - - /** - * The current state mape which the total target count - * - * @return the statusTotalCountMap the state map - */ - public Map getStatusTotalCountMap() { - return statusTotalCountMap; - } - - /** - * Gets the total target count from a state. - * - * @param status - * the state key - * @return the current target count cannot be - */ - public Long getTotalTargetCountByStatus(final Status status) { - final Long count = statusTotalCountMap.get(status); - return count == null ? 0L : count; - } - - /** - * @return finished percentage of targets - */ - public float getFinishedPercent() { - return ((float) getTotalTargetCountByStatus(TotalTargetCountStatus.Status.FINISHED) / totalTargetCount) * 100; - } - - /** - * Populate all target status to a the given map - * - * @param statusTotalCountMap - * the map - * @param rolloutStatusCountItems - * all target {@link Status} with total count - */ - private void addToTotalCount(final List targetCountActionStatus) { - if (targetCountActionStatus == null) { - statusTotalCountMap.put(TotalTargetCountStatus.Status.NOTSTARTED, totalTargetCount); - return; - } - statusTotalCountMap.put(Status.RUNNING, 0L); - Long notStartedTargetCount = totalTargetCount; - for (final TotalTargetCountActionStatus item : targetCountActionStatus) { - addToTotalCount(item); - notStartedTargetCount -= item.getCount(); - } - statusTotalCountMap.put(TotalTargetCountStatus.Status.NOTSTARTED, notStartedTargetCount); - } - - private void addToTotalCount(final TotalTargetCountActionStatus item) { - final Status status = convertStatus(item.getStatus()); - statusTotalCountMap.merge(status, item.getCount(), Long::sum); - } - - // Exception squid:MethodCyclomaticComplexity - simple state conversion, not - // really complex. - @SuppressWarnings("squid:MethodCyclomaticComplexity") - private Status convertStatus(final Action.Status status) { - switch (status) { - case SCHEDULED: - return Status.SCHEDULED; - case ERROR: - return Status.ERROR; - case FINISHED: - return Status.FINISHED; - case CANCELED: - return Status.CANCELLED; - case RETRIEVED: - case RUNNING: - case WARNING: - case DOWNLOAD: - case WAIT_FOR_CONFIRMATION: - case CANCELING: - return Status.RUNNING; - case DOWNLOADED: - return Action.ActionType.DOWNLOAD_ONLY == rolloutType ? Status.FINISHED : Status.RUNNING; - default: - throw new IllegalArgumentException("State " + status + "is not valid"); - } - } } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Type.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Type.java index 73424f9a6..5da75f454 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Type.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/model/Type.java @@ -14,6 +14,7 @@ package org.eclipse.hawkbit.repository.model; * {@link SoftwareModuleType}s */ public interface Type extends NamedEntity { + /** * Maximum length of key. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/SystemUsageReport.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/SystemUsageReport.java index 61cc6a57a..81e2961ce 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/SystemUsageReport.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/SystemUsageReport.java @@ -13,7 +13,6 @@ import lombok.Data; /** * Bean for holding the system usage stats. - * */ @Data public class SystemUsageReport { @@ -27,16 +26,11 @@ public class SystemUsageReport { /** * Constructor. * - * @param overallTargets - * of the system - * @param overallArtifacts - * of the system - * @param overallActions - * of the system - * @param overallArtifactVolumeInBytes - * of the system - * @param overallTenants - * of the system + * @param overallTargets of the system + * @param overallArtifacts of the system + * @param overallActions of the system + * @param overallArtifactVolumeInBytes of the system + * @param overallTenants of the system */ public SystemUsageReport(final long overallTargets, final long overallArtifacts, final long overallActions, final long overallArtifactVolumeInBytes, final long overallTenants) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/SystemUsageReportWithTenants.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/SystemUsageReportWithTenants.java index 30a92ceeb..99c617009 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/SystemUsageReportWithTenants.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/SystemUsageReportWithTenants.java @@ -15,7 +15,6 @@ import java.util.List; /** * Bean for holding the system usage stats including tenant specific data. - * */ public class SystemUsageReportWithTenants extends SystemUsageReport { @@ -24,14 +23,10 @@ public class SystemUsageReportWithTenants extends SystemUsageReport { /** * Constructor. * - * @param overallTargets - * of the system - * @param overallArtifacts - * of the system - * @param overallActions - * of the system - * @param overallArtifactVolumeInBytes - * of the system + * @param overallTargets of the system + * @param overallArtifacts of the system + * @param overallActions of the system + * @param overallArtifactVolumeInBytes of the system */ public SystemUsageReportWithTenants(final long overallTargets, final long overallArtifacts, final long overallActions, final long overallArtifactVolumeInBytes, final long overallTenants) { @@ -39,8 +34,7 @@ public class SystemUsageReportWithTenants extends SystemUsageReport { } /** - * @param tenantUsage - * of one tenant + * @param tenantUsage of one tenant * @return updated bean */ public SystemUsageReportWithTenants addTenantData(final TenantUsage tenantUsage) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/TenantUsage.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/TenantUsage.java index 89069ab17..b04215c62 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/TenantUsage.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/report/model/TenantUsage.java @@ -9,12 +9,12 @@ */ package org.eclipse.hawkbit.repository.report.model; -import lombok.Data; - import java.util.Collections; import java.util.HashMap; import java.util.Map; +import lombok.Data; + /** * System usage stats element for a tenant. */ @@ -31,8 +31,7 @@ public class TenantUsage { /** * Constructor. * - * @param tenantName - * name of the tenant + * @param tenantName name of the tenant */ public TenantUsage(final String tenantName) { this.tenantName = tenantName; @@ -42,24 +41,22 @@ public class TenantUsage { return Collections.unmodifiableMap(getLazyUsageData()); } - private Map getLazyUsageData() { - if (usageData == null) { - usageData = new HashMap<>(); - } - return usageData; - } - /** * Add a key and value as usage data to the system usage stats. - * - * @param key - * the key to set - * @param value - * the value to set + * + * @param key the key to set + * @param value the value to set * @return tenant stats element with new usage added */ public TenantUsage addUsageData(final String key, final String value) { getLazyUsageData().put(key, value); return this; } + + private Map getLazyUsageData() { + if (usageData == null) { + usageData = new HashMap<>(); + } + return usageData; + } } \ No newline at end of file diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/RsqlValidationOracle.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/RsqlValidationOracle.java index 412c913f0..235b54529 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/RsqlValidationOracle.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/RsqlValidationOracle.java @@ -20,12 +20,10 @@ public interface RsqlValidationOracle { /** * Parses and validates an given RSQL based query syntax and provides * suggestion based on syntax error and cursor positioning. - * - * @param rsqlQuery - * an RSQL based query string to parse. - * @param cursorPosition - * the position of the cursor to retrieve suggestions at the - * position. {@code -1} indicates for no cursor suggestion + * + * @param rsqlQuery an RSQL based query string to parse. + * @param cursorPosition the position of the cursor to retrieve suggestions at the + * position. {@code -1} indicates for no cursor suggestion * @return a validation oracle context providing information about syntax * errors and possible suggestions for fixing the syntax error or at * the cursor position to replace tokens diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/RsqlVisitorFactory.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/RsqlVisitorFactory.java index c2d8640f9..24305f32e 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/RsqlVisitorFactory.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/RsqlVisitorFactory.java @@ -9,10 +9,9 @@ */ package org.eclipse.hawkbit.repository.rsql; -import org.eclipse.hawkbit.repository.RsqlQueryField; - import cz.jirutka.rsql.parser.ast.Node; import cz.jirutka.rsql.parser.ast.RSQLVisitor; +import org.eclipse.hawkbit.repository.RsqlQueryField; /** * Factory to obtain {@link RSQLVisitor} instances that can be used to process @@ -24,12 +23,9 @@ public interface RsqlVisitorFactory { /** * Provides a {@link RSQLVisitor} instance for validating RSQL queries based * on the given {@link RsqlQueryField}. - * - * @param - * The type of the {@link RsqlQueryField}. - * @param fieldNameProvider - * providing accessing to the relevant field names. - * + * + * @param The type of the {@link RsqlQueryField}. + * @param fieldNameProvider providing accessing to the relevant field names. * @return An {@link RSQLVisitor} to validate the {@link Node}s of an RSQL * query. */ diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SuggestToken.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SuggestToken.java index facb1b60c..7c9037557 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SuggestToken.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SuggestToken.java @@ -22,16 +22,12 @@ public class SuggestToken { /** * Constructor. - * - * @param start - * the character position of the start of the token - * @param end - * the character position of the end of the token - * @param tokenImageName - * the entered name of the token, e.g. could be the beginning of - * the suggestion like 'na' or 'name' - * @param suggestion - * the token suggestion + * + * @param start the character position of the start of the token + * @param end the character position of the end of the token + * @param tokenImageName the entered name of the token, e.g. could be the beginning of + * the suggestion like 'na' or 'name' + * @param suggestion the token suggestion */ public SuggestToken(final int start, final int end, final String tokenImageName, final String suggestion) { this.start = start; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SuggestionContext.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SuggestionContext.java index fb9538c02..cbc026e8d 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SuggestionContext.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SuggestionContext.java @@ -30,13 +30,10 @@ public class SuggestionContext { /** * Constructor. - * - * @param rsqlQuery - * the original RSQL based query the suggestions based on - * @param cursorPosition - * the current cursor position - * @param suggestions - * the suggestions for the current cursor position + * + * @param rsqlQuery the original RSQL based query the suggestions based on + * @param cursorPosition the current cursor position + * @param suggestions the suggestions for the current cursor position */ public SuggestionContext(final String rsqlQuery, final int cursorPosition, final List suggestions) { this.rsqlQuery = rsqlQuery; @@ -48,10 +45,18 @@ public class SuggestionContext { return suggestions; } + public void setSuggestions(final List suggestions) { + this.suggestions = suggestions; + } + public int getCursorPosition() { return cursorPosition; } + public void setCursorPosition(final int cursorPosition) { + this.cursorPosition = cursorPosition; + } + public String getRsqlQuery() { return rsqlQuery; } @@ -59,12 +64,4 @@ public class SuggestionContext { public void setRsqlQuery(final String rsqlQuery) { this.rsqlQuery = rsqlQuery; } - - public void setCursorPosition(final int cursorPosition) { - this.cursorPosition = cursorPosition; - } - - public void setSuggestions(final List suggestions) { - this.suggestions = suggestions; - } } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SyntaxErrorContext.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SyntaxErrorContext.java index 24d535ebd..dfedfa342 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SyntaxErrorContext.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/SyntaxErrorContext.java @@ -27,12 +27,10 @@ public class SyntaxErrorContext { /** * Constructor. - * - * @param characterPosition - * the position of the character within the RSQL query string the - * error occurs. - * @param errorMessage - * the error message with further information + * + * @param characterPosition the position of the character within the RSQL query string the + * error occurs. + * @param errorMessage the error message with further information */ public SyntaxErrorContext(final int characterPosition, final String errorMessage) { this.characterPosition = characterPosition; diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/ValidationOracleContext.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/ValidationOracleContext.java index 80fb4b04d..196b1869f 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/ValidationOracleContext.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/ValidationOracleContext.java @@ -25,22 +25,22 @@ public class ValidationOracleContext { return syntaxError; } - public SuggestionContext getSuggestionContext() { - return suggestionContext; - } - - public SyntaxErrorContext getSyntaxErrorContext() { - return syntaxErrorContext; - } - public void setSyntaxError(final boolean syntaxError) { this.syntaxError = syntaxError; } + public SuggestionContext getSuggestionContext() { + return suggestionContext; + } + public void setSuggestionContext(final SuggestionContext suggestionContext) { this.suggestionContext = suggestionContext; } + public SyntaxErrorContext getSyntaxErrorContext() { + return syntaxErrorContext; + } + public void setSyntaxErrorContext(final SyntaxErrorContext syntaxErrorContext) { this.syntaxErrorContext = syntaxErrorContext; } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/VirtualPropertyReplacer.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/VirtualPropertyReplacer.java index 82e57955c..96835b8fb 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/VirtualPropertyReplacer.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/repository/rsql/VirtualPropertyReplacer.java @@ -22,9 +22,8 @@ public interface VirtualPropertyReplacer extends Serializable { /** * Looks up a placeholders and replaces them * - * @param input - * the input string in which virtual properties should be - * replaced + * @param input the input string in which virtual properties should be + * replaced * @return the result of the replacement */ String replace(String input); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/DurationHelper.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/DurationHelper.java index 80739c06f..8805bfcb2 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/DurationHelper.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/DurationHelper.java @@ -19,36 +19,9 @@ import java.time.temporal.TemporalAccessor; * This class is a helper for converting a duration into a string and for the * other way. The string is in the format expected in configuration and database * {@link #DURATION_FORMAT}. - * */ public final class DurationHelper { - /** - * Duration validation utility class. Checks if the requested duration is in - * the defined min/max range. - * - */ - public static final class DurationRangeValidator { - private final Duration min; - private final Duration max; - - private DurationRangeValidator(final Duration min, final Duration max) { - this.min = min; - this.max = max; - } - - /** - * Checks if the requested duration is in the defined min/max range. - * - * @param duration - * to checked - * @return true if in time range - */ - public boolean isWithinRange(final Duration duration) { - return duration.compareTo(min) >= 0 && duration.compareTo(max) <= 0; - } - } - /** * Format of the String expected in configuration file and in the database. */ @@ -60,11 +33,9 @@ public final class DurationHelper { /** * Creates a {@link DurationRangeValidator}. - * - * @param min - * imum of range. - * @param max - * imum of range. + * + * @param min imum of range. + * @param max imum of range. * @return {@link DurationRangeValidator} range. */ public static DurationRangeValidator durationRangeValidator(final Duration min, final Duration max) { @@ -73,9 +44,8 @@ public final class DurationHelper { /** * Converts a Duration into a formatted String - * - * @param duration - * duration, which will be converted into a formatted String + * + * @param duration duration, which will be converted into a formatted String * @return String in the duration format, specified at * {@link #DURATION_FORMAT} */ @@ -89,12 +59,10 @@ public final class DurationHelper { /** * Converts a formatted String into a Duration object. - * - * @param formattedDuration - * String in {@link #DURATION_FORMAT} + * + * @param formattedDuration String in {@link #DURATION_FORMAT} * @return duration - * @throws DateTimeParseException - * when String is in wrong format + * @throws DateTimeParseException when String is in wrong format */ public static Duration formattedStringToDuration(final String formattedDuration) { if (formattedDuration == null) { @@ -107,17 +75,39 @@ public final class DurationHelper { /** * converts values of time constants to a Duration object.. - * - * @param hours - * count of hours - * @param minutes - * count of minutes - * @param seconds - * count of seconds + * + * @param hours count of hours + * @param minutes count of minutes + * @param seconds count of seconds * @return duration */ public static Duration getDurationByTimeValues(final long hours, final long minutes, final long seconds) { return Duration.ofHours(hours).plusMinutes(minutes).plusSeconds(seconds); } + /** + * Duration validation utility class. Checks if the requested duration is in + * the defined min/max range. + */ + public static final class DurationRangeValidator { + + private final Duration min; + private final Duration max; + + private DurationRangeValidator(final Duration min, final Duration max) { + this.min = min; + this.max = max; + } + + /** + * Checks if the requested duration is in the defined min/max range. + * + * @param duration to checked + * @return true if in time range + */ + public boolean isWithinRange(final Duration duration) { + return duration.compareTo(min) >= 0 && duration.compareTo(max) <= 0; + } + } + } diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/TenantConfigurationProperties.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/TenantConfigurationProperties.java index 13cb792a6..1c159f19a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/TenantConfigurationProperties.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/TenantConfigurationProperties.java @@ -167,7 +167,7 @@ public class TenantConfigurationProperties { /** * validates if a object matches the allowed data format of the corresponding key - * + * * @param context application context * @param value which will be validated * @throws TenantConfigurationValidatorException is thrown, when object is invalid diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationPollingDurationValidator.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationPollingDurationValidator.java index 7a515f8de..8c2a0312a 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationPollingDurationValidator.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationPollingDurationValidator.java @@ -19,7 +19,6 @@ import org.springframework.beans.factory.annotation.Autowired; /** * This class is used to validate, that the property is a String and that it is * in the correct duration format. - * */ public class TenantConfigurationPollingDurationValidator implements TenantConfigurationValidator { @@ -29,9 +28,8 @@ public class TenantConfigurationPollingDurationValidator implements TenantConfig /** * Constructor. - * - * @param properties - * property accessor for poll configuration + * + * @param properties property accessor for poll configuration */ @Autowired public TenantConfigurationPollingDurationValidator(final ControllerPollProperties properties) { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidator.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidator.java index 44e3462f6..db1960c12 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidator.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidator.java @@ -11,17 +11,14 @@ package org.eclipse.hawkbit.tenancy.configuration.validator; /** * base interface for clases which can validate tenant configuration values. - * */ public interface TenantConfigurationValidator { /** * validates the tenant configuration value - * - * @param tenantConfigurationValue - * value which will be validated. - * @throws TenantConfigurationValidatorException - * is thrown, when parameter is invalid. + * + * @param tenantConfigurationValue value which will be validated. + * @throws TenantConfigurationValidatorException is thrown, when parameter is invalid. */ default void validate(final Object tenantConfigurationValue) { if (tenantConfigurationValue != null @@ -34,7 +31,7 @@ public interface TenantConfigurationValidator { /** * Return the generic class to check the object - * + * * @return the class to check the value */ default Class validateToClass() { diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidatorException.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidatorException.java index 7ecd18adf..a43bc4d8c 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidatorException.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidatorException.java @@ -15,7 +15,6 @@ import org.eclipse.hawkbit.exception.SpServerError; /** * Exception which is thrown, when the validation of the configuration value has * not been successful. - * */ public class TenantConfigurationValidatorException extends AbstractServerRtException { @@ -31,9 +30,8 @@ public class TenantConfigurationValidatorException extends AbstractServerRtExcep /** * Parameterized constructor. - * - * @param cause - * of the exception + * + * @param cause of the exception */ public TenantConfigurationValidatorException(final Throwable cause) { super(THIS_ERROR, cause); @@ -41,11 +39,9 @@ public class TenantConfigurationValidatorException extends AbstractServerRtExcep /** * Parameterized constructor. - * - * @param message - * of the exception - * @param cause - * of the exception + * + * @param message of the exception + * @param cause of the exception */ public TenantConfigurationValidatorException(final String message, final Throwable cause) { super(message, THIS_ERROR, cause); @@ -53,9 +49,8 @@ public class TenantConfigurationValidatorException extends AbstractServerRtExcep /** * Parameterized constructor. - * - * @param message - * of the exception + * + * @param message of the exception */ public TenantConfigurationValidatorException(final String message) { super(message, THIS_ERROR); diff --git a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/utils/TenantConfigHelper.java b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/utils/TenantConfigHelper.java index 7997c72b1..4a8e6a097 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/utils/TenantConfigHelper.java +++ b/hawkbit-repository/hawkbit-repository-api/src/main/java/org/eclipse/hawkbit/utils/TenantConfigHelper.java @@ -12,14 +12,14 @@ package org.eclipse.hawkbit.utils; import static org.eclipse.hawkbit.tenancy.configuration.TenantConfigurationProperties.TenantConfigurationKey.MULTI_ASSIGNMENTS_ENABLED; import static org.eclipse.hawkbit.tenancy.configuration.TenantConfigurationProperties.TenantConfigurationKey.USER_CONFIRMATION_ENABLED; +import java.io.Serializable; +import java.util.function.Function; + import org.eclipse.hawkbit.repository.TenantConfigurationManagement; import org.eclipse.hawkbit.repository.model.PollStatus; import org.eclipse.hawkbit.repository.model.Target; import org.eclipse.hawkbit.security.SystemSecurityContext; -import java.io.Serializable; -import java.util.function.Function; - /** * A collection of static helper methods for the tenant configuration */ @@ -36,11 +36,9 @@ public final class TenantConfigHelper { /** * Setting the context of the tenant. - * - * @param systemSecurityContext - * Security context used to get the tenant and for execution - * @param tenantConfigurationManagement - * to get the value from + * + * @param systemSecurityContext Security context used to get the tenant and for execution + * @param tenantConfigurationManagement to get the value from * @return is active */ public static TenantConfigHelper usingContext(final SystemSecurityContext systemSecurityContext, @@ -55,7 +53,7 @@ public final class TenantConfigHelper { /** * Is multi-assignments enabled for the current tenant - * + * * @return is active */ public boolean isMultiAssignmentsEnabled() { diff --git a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/ArtifactEncryptionServiceTest.java b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/ArtifactEncryptionServiceTest.java index dee99c4f7..a95884cdd 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/ArtifactEncryptionServiceTest.java +++ b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/ArtifactEncryptionServiceTest.java @@ -12,12 +12,11 @@ package org.eclipse.hawkbit.repository; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatExceptionOfType; -import org.eclipse.hawkbit.repository.exception.ArtifactEncryptionUnsupportedException; -import org.junit.jupiter.api.Test; - import io.qameta.allure.Description; import io.qameta.allure.Feature; import io.qameta.allure.Story; +import org.eclipse.hawkbit.repository.exception.ArtifactEncryptionUnsupportedException; +import org.junit.jupiter.api.Test; /** * Test class to verify that no {@link ArtifactEncryptionService} required beans diff --git a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/MaintenanceScheduleHelperTest.java b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/MaintenanceScheduleHelperTest.java index ffb44767e..0aedc4593 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/MaintenanceScheduleHelperTest.java +++ b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/MaintenanceScheduleHelperTest.java @@ -15,13 +15,11 @@ import static org.assertj.core.api.Assertions.assertThatThrownBy; import java.time.Duration; import java.time.ZonedDateTime; -import org.eclipse.hawkbit.repository.exception.InvalidMaintenanceScheduleException; - import com.cronutils.model.Cron; - import io.qameta.allure.Description; import io.qameta.allure.Feature; import io.qameta.allure.Story; +import org.eclipse.hawkbit.repository.exception.InvalidMaintenanceScheduleException; import org.junit.jupiter.api.Test; @Feature("Unit Tests - Repository") @@ -48,7 +46,7 @@ public class MaintenanceScheduleHelperTest { final String duration = "10"; assertThatThrownBy(() -> MaintenanceScheduleHelper.validateDuration(duration)) .isInstanceOf(InvalidMaintenanceScheduleException.class).hasMessage("Provided duration is not valid") - .extracting("durationErrorIndex").isEqualTo(2); + .extracting("durationErrorIndex").isEqualTo(2); } @Test @@ -91,7 +89,7 @@ public class MaintenanceScheduleHelperTest { final String timezone = ZonedDateTime.now().getOffset().getId().replace("Z", "+00:00"); assertThatThrownBy( () -> MaintenanceScheduleHelper.validateMaintenanceSchedule(cronSchedule, duration, timezone)) - .isInstanceOf(InvalidMaintenanceScheduleException.class) - .hasMessage("No valid maintenance window available after current time"); + .isInstanceOf(InvalidMaintenanceScheduleException.class) + .hasMessage("No valid maintenance window available after current time"); } } diff --git a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/RegexCharTest.java b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/RegexCharTest.java index 5b9193ea5..cdbf3bb35 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/RegexCharTest.java +++ b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/RegexCharTest.java @@ -11,42 +11,40 @@ package org.eclipse.hawkbit.repository; import static org.assertj.core.api.Assertions.assertThat; -import org.eclipse.hawkbit.repository.RegexCharacterCollection.RegexChar; - import io.qameta.allure.Description; import io.qameta.allure.Feature; import io.qameta.allure.Story; +import org.eclipse.hawkbit.repository.RegexCharacterCollection.RegexChar; import org.junit.jupiter.api.Test; @Feature("Unit Tests - Repository") @Story("Regular expression helper") public class RegexCharTest { - private static final String TEST_STRING = getPrintableAsciiCharacters(); - private static final int INDEX_FIRST_PRINTABLE_ASCII_CHAR = 32; private static final int INDEX_LAST_PRINTABLE_ASCII_CHAR = 127; + private static final String TEST_STRING = getPrintableAsciiCharacters(); @Test @Description("Verifies every RegexChar can be used to exclusively find the desired characters in a String.") public void allRegexCharsOnlyFindExpectedChars() { for (final RegexChar character : RegexChar.values()) { switch (character) { - case DIGITS: - assertRegexCharExclusivelyFindsGivenCharacters(character, "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"); - break; - case WHITESPACE: - assertRegexCharExclusivelyFindsGivenCharacters(character, " ", "\t"); - break; - case SLASHES: - assertRegexCharExclusivelyFindsGivenCharacters(character, "/", "\\"); - break; - case QUOTATION_MARKS: - assertRegexCharExclusivelyFindsGivenCharacters(character, "\"", "'"); - break; - default: - assertRegexCharExclusivelyFindsGivenCharacters(character, character.getRegExp()); - break; + case DIGITS: + assertRegexCharExclusivelyFindsGivenCharacters(character, "0", "1", "2", "3", "4", "5", "6", "7", "8", "9"); + break; + case WHITESPACE: + assertRegexCharExclusivelyFindsGivenCharacters(character, " ", "\t"); + break; + case SLASHES: + assertRegexCharExclusivelyFindsGivenCharacters(character, "/", "\\"); + break; + case QUOTATION_MARKS: + assertRegexCharExclusivelyFindsGivenCharacters(character, "\"", "'"); + break; + default: + assertRegexCharExclusivelyFindsGivenCharacters(character, character.getRegExp()); + break; } } } @@ -66,33 +64,6 @@ public class RegexCharTest { assertRegexCharsExclusivelyFindsGivenCharacters(colonAndWhitespace, ":", " ", "\t"); } - private void assertRegexCharExclusivelyFindsGivenCharacters(final RegexChar characterToVerify, - final String... charactersExpectedToBeFoundByRegex) { - assertRegexCharsExclusivelyFindsGivenCharacters(new RegexCharacterCollection(characterToVerify), - charactersExpectedToBeFoundByRegex); - } - - private void assertRegexCharsExclusivelyFindsGivenCharacters(final RegexCharacterCollection regexToVerify, - final String... charactersExpectedToBeFoundByRegex) { - String notMatchingString = TEST_STRING; - for(final String character : charactersExpectedToBeFoundByRegex) { - notMatchingString = notMatchingString.replace(character, ""); - } - for(final String character : charactersExpectedToBeFoundByRegex) { - assertThat(RegexCharacterCollection.stringContainsCharacter("", regexToVerify)).isFalse(); - assertThat(RegexCharacterCollection.stringContainsCharacter(notMatchingString, regexToVerify)).isFalse(); - assertThat(RegexCharacterCollection.stringContainsCharacter(character, regexToVerify)).isTrue(); - assertThat(RegexCharacterCollection - .stringContainsCharacter(insertStringIntoString(notMatchingString, character, 0), regexToVerify)) - .isTrue(); - assertThat(RegexCharacterCollection.stringContainsCharacter( - insertStringIntoString(notMatchingString, character, notMatchingString.length()), regexToVerify)).isTrue(); - assertThat(RegexCharacterCollection.stringContainsCharacter( - insertStringIntoString(notMatchingString, character, notMatchingString.length() / 2), regexToVerify)).isTrue(); - - } - } - private static String getPrintableAsciiCharacters() { final StringBuilder stringBuilder = new StringBuilder(); for (int i = INDEX_FIRST_PRINTABLE_ASCII_CHAR; i < INDEX_LAST_PRINTABLE_ASCII_CHAR; i++) { @@ -107,4 +78,31 @@ public class RegexCharTest { final StringBuilder stringBuilder = new StringBuilder(baseString); return stringBuilder.insert(position, stringToInsert).toString(); } + + private void assertRegexCharExclusivelyFindsGivenCharacters(final RegexChar characterToVerify, + final String... charactersExpectedToBeFoundByRegex) { + assertRegexCharsExclusivelyFindsGivenCharacters(new RegexCharacterCollection(characterToVerify), + charactersExpectedToBeFoundByRegex); + } + + private void assertRegexCharsExclusivelyFindsGivenCharacters(final RegexCharacterCollection regexToVerify, + final String... charactersExpectedToBeFoundByRegex) { + String notMatchingString = TEST_STRING; + for (final String character : charactersExpectedToBeFoundByRegex) { + notMatchingString = notMatchingString.replace(character, ""); + } + for (final String character : charactersExpectedToBeFoundByRegex) { + assertThat(RegexCharacterCollection.stringContainsCharacter("", regexToVerify)).isFalse(); + assertThat(RegexCharacterCollection.stringContainsCharacter(notMatchingString, regexToVerify)).isFalse(); + assertThat(RegexCharacterCollection.stringContainsCharacter(character, regexToVerify)).isTrue(); + assertThat(RegexCharacterCollection + .stringContainsCharacter(insertStringIntoString(notMatchingString, character, 0), regexToVerify)) + .isTrue(); + assertThat(RegexCharacterCollection.stringContainsCharacter( + insertStringIntoString(notMatchingString, character, notMatchingString.length()), regexToVerify)).isTrue(); + assertThat(RegexCharacterCollection.stringContainsCharacter( + insertStringIntoString(notMatchingString, character, notMatchingString.length() / 2), regexToVerify)).isTrue(); + + } + } } diff --git a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/RepositoryManagementMethodPreAuthorizeAnnotatedTest.java b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/RepositoryManagementMethodPreAuthorizeAnnotatedTest.java index 5ea105fe5..06e17dc41 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/RepositoryManagementMethodPreAuthorizeAnnotatedTest.java +++ b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/RepositoryManagementMethodPreAuthorizeAnnotatedTest.java @@ -20,12 +20,11 @@ import java.util.Set; import io.github.classgraph.ClassGraph; import io.github.classgraph.ClassInfo; import io.github.classgraph.ScanResult; -import org.junit.jupiter.api.Test; -import org.springframework.security.access.prepost.PreAuthorize; - import io.qameta.allure.Description; import io.qameta.allure.Feature; import io.qameta.allure.Story; +import org.junit.jupiter.api.Test; +import org.springframework.security.access.prepost.PreAuthorize; @Feature("Unit Tests - Repository") @Story("Security Test") @@ -62,9 +61,8 @@ public class RepositoryManagementMethodPreAuthorizeAnnotatedTest { * {@link PreAuthorize} annotation for security. Inherited methods are not * checked. The following methods are excluded due inherited from * {@link Object}, like equals() or toString(). - * - * @param clazz - * the class to retrieve the public declared methods + * + * @param clazz the class to retrieve the public declared methods */ private static void assertDeclaredMethodsContainsPreAuthorizeAnnotations(final Class clazz) { final Method[] declaredMethods = clazz.getDeclaredMethods(); diff --git a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/model/TotalTargetCountStatusTest.java b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/model/TotalTargetCountStatusTest.java index 85b8ef014..1d5b32887 100644 --- a/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/model/TotalTargetCountStatusTest.java +++ b/hawkbit-repository/hawkbit-repository-api/src/test/java/org/eclipse/hawkbit/repository/model/TotalTargetCountStatusTest.java @@ -9,16 +9,16 @@ */ package org.eclipse.hawkbit.repository.model; -import io.qameta.allure.Description; -import io.qameta.allure.Feature; -import io.qameta.allure.Story; -import org.junit.jupiter.api.Test; +import static org.assertj.core.api.Assertions.assertThat; import java.util.Arrays; import java.util.Collections; import java.util.List; -import static org.assertj.core.api.Assertions.assertThat; +import io.qameta.allure.Description; +import io.qameta.allure.Feature; +import io.qameta.allure.Story; +import org.junit.jupiter.api.Test; @Feature("Component Tests - TotalTargetCountStatus") @Story("TotalTargetCountStatus should correctly present finished DOWNLOAD_ONLY actions")