Merge branch 'develop' into renovate/antora-cli-3.x

Author: JohannesRabauer

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.10
+
+* Optimistic locking with @Version now possible
+
 # 1.0.9
 
 * Inherited entities with repositories are now realized by reading (finding coherent repositories) and not by writing

docs/package.json

@@ -4,6 +4,6 @@
   },
   "devDependencies": {
     "@antora/cli": "3.1.9",
-    "@antora/site-generator": "3.1.8"
+    "@antora/site-generator": "3.1.9"
   }
 }

pom.xml

@@ -75,7 +75,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-pmd-plugin</artifactId>
-						<version>3.23.0</version>
+						<version>3.24.0</version>
 						<configuration>
 							<includeTests>true</includeTests>
 							<printFailingErrors>true</printFailingErrors>

spring-data-eclipse-store-demo/pom.xml

@@ -123,7 +123,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-surefire-plugin</artifactId>
-				<version>3.3.0</version>
+				<version>3.3.1</version>
 				<configuration>
 					<argLine>
 						--add-opens java.base/java.util=ALL-UNNAMED

spring-data-eclipse-store/pom.xml

@@ -202,7 +202,7 @@
 				<plugin>
 					<groupId>org.apache.maven.plugins</groupId>
 					<artifactId>maven-project-info-reports-plugin</artifactId>
-					<version>3.6.1</version>
+					<version>3.6.2</version>
 				</plugin>
 			</plugins>
 		</pluginManagement>
@@ -269,7 +269,7 @@
 			<plugin>
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-surefire-plugin</artifactId>
-				<version>3.3.0</version>
+				<version>3.3.1</version>
 				<configuration>
 					<argLine>
 						--add-exports java.base/jdk.internal.misc=ALL-UNNAMED
@@ -393,7 +393,7 @@
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>
 						<artifactId>maven-pmd-plugin</artifactId>
-						<version>3.23.0</version>
+						<version>3.24.0</version>
 						<configuration>
 							<includeTests>true</includeTests>
 							<printFailingErrors>true</printFailingErrors>

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/exceptions/InvalidVersionException.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright © 2024 XDEV Software (https://xdev.software)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package software.xdev.spring.data.eclipse.store.exceptions;
+
+public class InvalidVersionException extends RuntimeException
+{
+	public InvalidVersionException(final String message)
+	{
+		super(message);
+	}
+}

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/importer/EclipseStoreDataImporter.java

@@ -263,6 +263,7 @@ private <T> void createRepositoryForType(
 				storageInstance.getRegistry(),
 				storageInstance,
 				storageInstance,
+				storageInstance,
 				new SupportedChecker.Implementation(),
 				storageInstance
 			),

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/EclipseStoreStorage.java

@@ -41,17 +41,30 @@
 import software.xdev.spring.data.eclipse.store.repository.support.concurrency.ReadWriteLock;
 import software.xdev.spring.data.eclipse.store.repository.support.concurrency.ReentrantJavaReadWriteLock;
 import software.xdev.spring.data.eclipse.store.repository.support.copier.id.IdManager;
+import software.xdev.spring.data.eclipse.store.repository.support.copier.id.IdManagerProvider;
 import software.xdev.spring.data.eclipse.store.repository.support.copier.id.IdSetter;
+import software.xdev.spring.data.eclipse.store.repository.support.copier.version.EntityVersionIncrementer;
+import software.xdev.spring.data.eclipse.store.repository.support.copier.version.VersionManager;
+import software.xdev.spring.data.eclipse.store.repository.support.copier.version.VersionManagerProvider;
 import software.xdev.spring.data.eclipse.store.repository.support.reposyncer.RepositorySynchronizer;
 import software.xdev.spring.data.eclipse.store.repository.support.reposyncer.SimpleRepositorySynchronizer;
 
 
 public class EclipseStoreStorage
-	implements EntityListProvider, IdManagerProvider, PersistableChecker, ObjectSwizzling
+	implements EntityListProvider, IdManagerProvider, VersionManagerProvider, PersistableChecker, ObjectSwizzling
 {
 	private static final Logger LOG = LoggerFactory.getLogger(EclipseStoreStorage.class);
 	private final Map<Class<?>, SimpleEclipseStoreRepository<?, ?>> entityClassToRepository = new HashMap<>();
+	/**
+	 * "Why are the IdManagers seperated from the repositories?" - Because there might be entities for which there are
+	 * no repositories, but they still have IDs.
+	 */
 	private final Map<Class<?>, IdManager<?, ?>> idManagers = new ConcurrentHashMap<>();
+	/**
+	 * "Why are the VersionManagers seperated from the repositories?" - Because there might be entities for which there
+	 * are no repositories, but they still have Versions.
+	 */
+	private final Map<Class<?>, VersionManager<?>> versionManagers = new ConcurrentHashMap<>();
 	private final EclipseStoreStorageFoundationProvider foundationProvider;
 	private EntitySetCollector entitySetCollector;
 	private PersistableChecker persistenceChecker;
@@ -311,6 +324,7 @@ public synchronized void stop()
 					this.root = null;
 					this.registry.reset();
 					this.idManagers.clear();
+					this.versionManagers.clear();
 					LOG.info("Stopped storage.");
 				}
 				else
@@ -323,23 +337,37 @@ public synchronized void stop()
 
 	@Override
 	@SuppressWarnings("unchecked")
-	public <T, ID> IdManager<T, ID> ensureIdManager(final Class<T> domainClass)
+	public <T, ID> IdManager<T, ID> ensureIdManager(final Class<T> classPossiblyWithId)
 	{
 		return (IdManager<T, ID>)this.idManagers.computeIfAbsent(
-			domainClass,
+			classPossiblyWithId,
 			clazz ->
 				new IdManager<>(
-					domainClass,
+					classPossiblyWithId,
 					(IdSetter<T>)IdSetter.createIdSetter(
 						clazz,
-						id -> this.setLastId(clazz, id),
-						() -> this.getLastId(clazz)
+						id -> this.setLastId(classPossiblyWithId, id),
+						() -> this.getLastId(classPossiblyWithId)
 					),
 					this
 				)
 		);
 	}
 
+	@Override
+	@SuppressWarnings("unchecked")
+	public <T> VersionManager<T> ensureVersionManager(final Class<T> possiblyVersionedClass)
+	{
+		return (VersionManager<T>)this.versionManagers.computeIfAbsent(
+			possiblyVersionedClass,
+			clazz ->
+				new VersionManager<>(
+					possiblyVersionedClass,
+					EntityVersionIncrementer.createVersionSetter(possiblyVersionedClass)
+				)
+		);
+	}
+	
 	public Object getLastId(final Class<?> entityClass)
 	{
 		return this.readWriteLock.read(() -> this.root.getLastId(entityClass));

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/IdFieldFinder.java renamed to spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/AnnotatedFieldFinder.java

@@ -15,16 +15,18 @@
  */
 package software.xdev.spring.data.eclipse.store.repository.support;
 
+import java.lang.annotation.Annotation;
 import java.lang.reflect.Field;
 import java.util.Collection;
+import java.util.List;
 import java.util.Optional;
 
 import software.xdev.spring.data.eclipse.store.repository.access.AccessHelper;
 
 
-public final class IdFieldFinder
+public final class AnnotatedFieldFinder
 {
-	private IdFieldFinder()
+	private AnnotatedFieldFinder()
 	{
 	}
 
@@ -35,16 +37,45 @@ private IdFieldFinder()
 	 * @return field with ID-Annotation. Is {@link Optional#empty()} if no field was found.
 	 */
 	public static Optional<Field> findIdField(final Class<?> domainClass)
+	{
+		return findAnnotatedField(
+			domainClass,
+			List.of(jakarta.persistence.Id.class, org.springframework.data.annotation.Id.class)
+		);
+	}
+	
+	/**
+	 * Finds any field in a class with an Version-Annotation ({@link jakarta.persistence.Version} or
+	 * {@link org.springframework.data.annotation.Version}). Finds this field recursively in the Hierarchy-tree.
+	 *
+	 * @return field with Version-Annotation. Is {@link Optional#empty()} if no field was found.
+	 */
+	public static Optional<Field> findVersionField(final Class<?> domainClass)
+	{
+		return findAnnotatedField(
+			domainClass,
+			List.of(jakarta.persistence.Version.class, org.springframework.data.annotation.Version.class)
+		);
+	}
+	
+	/**
+	 * Finds any field in a class with specified annotations. Finds this field recursively in the Hierarchy-tree.
+	 *
+	 * @return field with annotation. Is {@link Optional#empty()} if no field was found.
+	 */
+	public static Optional<Field> findAnnotatedField(
+		final Class<?> domainClass,
+		final Collection<Class<? extends Annotation>> annotations)
 	{
 		final Collection<Field> classFields = AccessHelper.getInheritedPrivateFieldsByName(domainClass).values();
 		for(final Field currentField : classFields)
 		{
-			if(
-				currentField.getAnnotationsByType(jakarta.persistence.Id.class).length > 0
-					|| currentField.getAnnotationsByType(org.springframework.data.annotation.Id.class).length > 0
-			)
+			for(final Class<? extends Annotation> annotation : annotations)
 			{
-				return Optional.of(currentField);
+				if(currentField.getAnnotationsByType(annotation).length > 0)
+				{
+					return Optional.of(currentField);
+				}
 			}
 		}
 		return Optional.empty();

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/EclipseStoreRepositoryFactory.java

@@ -79,6 +79,7 @@ private <T> WorkingCopier<T> createWorkingCopier(
 			storage.getRegistry(),
 			storage,
 			storage,
+			storage,
 			new SupportedChecker.Implementation(),
 			storage
 		);

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/copier/id/IdManager.java

@@ -28,26 +28,26 @@
 import software.xdev.spring.data.eclipse.store.exceptions.NoIdFieldFoundException;
 import software.xdev.spring.data.eclipse.store.repository.EclipseStoreStorage;
 import software.xdev.spring.data.eclipse.store.repository.access.modifier.FieldAccessModifier;
-import software.xdev.spring.data.eclipse.store.repository.support.IdFieldFinder;
+import software.xdev.spring.data.eclipse.store.repository.support.AnnotatedFieldFinder;
 
 
 public class IdManager<T, ID> implements EntityGetterById<T, ID>, IdGetter<T, ID>
 {
-	private final Class<T> domainClass;
+	private final Class<T> classWithId;
 	private final IdSetter<T> idSetter;
 	private final Optional<Field> idField;
 	private final EclipseStoreStorage storage;
 
 	public IdManager(
-		final Class<T> domainClass,
+		final Class<T> classWithId,
 		final IdSetter<T> idSetter,
 		final EclipseStoreStorage storage
 	)
 	{
-		this.domainClass = domainClass;
+		this.classWithId = classWithId;
 		this.idSetter = idSetter;
 		this.storage = storage;
-		this.idField = IdFieldFinder.findIdField(this.domainClass);
+		this.idField = AnnotatedFieldFinder.findIdField(this.classWithId);
 	}
 
 	public Field ensureIdField()
@@ -56,7 +56,7 @@ public Field ensureIdField()
 		{
 			throw new NoIdFieldFoundException(String.format(
 				"Could not find id field in class %s",
-				this.domainClass.getSimpleName()));
+				this.classWithId.getSimpleName()));
 		}
 		return this.idField.get();
 	}
@@ -67,7 +67,7 @@ public Optional<T> findById(@Nonnull final ID id)
 		this.ensureIdField();
 		return (Optional<T>)this.storage.getReadWriteLock().read(
 			() -> this.storage
-				.getEntityProvider(this.domainClass)
+				.getEntityProvider(this.classWithId)
 				.stream()
 				.filter(entity -> id.equals(this.getId(entity)))
 				.findAny()
@@ -79,7 +79,7 @@ public List<T> findAllById(@Nonnull final Iterable<ID> idsToFind)
 		this.ensureIdField();
 		return (List<T>)this.storage.getReadWriteLock().read(
 			() -> this.storage
-				.getEntityProvider(this.domainClass)
+				.getEntityProvider(this.classWithId)
 				.stream()
 				.filter(
 					entity ->

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/IdManagerProvider.java renamed to spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/copier/id/IdManagerProvider.java

@@ -13,10 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package software.xdev.spring.data.eclipse.store.repository;
-
-import software.xdev.spring.data.eclipse.store.repository.support.copier.id.IdManager;
-
+package software.xdev.spring.data.eclipse.store.repository.support.copier.id;
 
 public interface IdManagerProvider
 {

spring-data-eclipse-store/src/main/java/software/xdev/spring/data/eclipse/store/repository/support/copier/id/IdSetter.java

@@ -23,7 +23,7 @@
 
 import jakarta.persistence.GeneratedValue;
 
-import software.xdev.spring.data.eclipse.store.repository.support.IdFieldFinder;
+import software.xdev.spring.data.eclipse.store.repository.support.AnnotatedFieldFinder;
 import software.xdev.spring.data.eclipse.store.repository.support.copier.id.strategy.IdFinder;
 
 
@@ -41,7 +41,7 @@ static <T> IdSetter<T> createIdSetter(
 		Objects.requireNonNull(classWithId);
 		Objects.requireNonNull(lastIdPersister);
 		Objects.requireNonNull(lastIdGetter);
-		final Optional<Field> idField = IdFieldFinder.findIdField(classWithId);
+		final Optional<Field> idField = AnnotatedFieldFinder.findIdField(classWithId);
 		if(idField.isEmpty())
 		{
 			return new NotSettingIdSetter<>();