Merge pull request #6218 from matthias-ronge/5760_2a+b

[hibernate-search] Introduce Hibernate Search framework and implement indexing page
kitodo · Nov 26, 2024 · 31829d6 · 31829d6
2 parents ee5fe13 + c1bbea7
commit 31829d6
Show file tree

Hide file tree

Showing 64 changed files with 1,336 additions and 314 deletions.
diff --git a/Kitodo-API/src/main/java/org/kitodo/config/KitodoConfig.java b/Kitodo-API/src/main/java/org/kitodo/config/KitodoConfig.java
@@ -12,7 +12,9 @@
 package org.kitodo.config;
 
 import java.io.File;
+import java.net.MalformedURLException;
 import java.net.URI;
+import java.net.URL;
 import java.nio.file.Paths;
 import java.util.NoSuchElementException;
 import java.util.Optional;
@@ -237,6 +239,27 @@ public static Optional<String> getOptionalString(ParameterInterface key) {
         }
     }
 
+    /**
+     * Returns the URL of the search server.
+     * 
+     * @return the URL
+     * @throws MalformedURLException
+     *             if an unknown protocol, or the port is a negative number
+     *             other than -1
+     */
+    public static URL getSearchServerUrl() throws MalformedURLException {
+        String host = getParameter("elasticsearch.host", "localhost");
+        int port = getIntParameter(new ParameterInterface() {
+            @Override
+            public String getName() {
+                return "elasticsearch.port";
+            }
+        }, 9200);
+        String protocol = getParameter("elasticsearch.protocol", "http");
+        String path = getParameter("elasticsearch.path", "/");
+        return new URL(protocol, host, port, path);
+    }
+
     /**
      * Returns the selected URI from the configuration file. Throws a
      * {@code NoSuchElementException} if no such parameter exists.

diff --git a/Kitodo-DataManagement/hibernate.properties b/Kitodo-DataManagement/hibernate.properties
@@ -0,0 +1,3 @@
+hibernate.search.enabled=true
+hibernate.search.backend.hosts=localhost:9200
+hibernate.search.backend.protocol=http
diff --git a/Kitodo-DataManagement/pom.xml b/Kitodo-DataManagement/pom.xml
@@ -83,6 +83,16 @@
             <groupId>org.hibernate</groupId>
             <artifactId>hibernate-jcache</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.opensearch</groupId>
+            <artifactId>opensearch</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.opensearch.plugin</groupId>
+            <artifactId>transport-netty4-client</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.github.spotbugs</groupId>
             <artifactId>spotbugs-annotations</artifactId>
@@ -121,6 +131,17 @@
             <groupId>org.junit.vintage</groupId>
             <artifactId>junit-vintage-engine</artifactId>
         </dependency>
+        <!-- Hibernate Search dependencies -->
+        <dependency>
+            <groupId>org.hibernate.search</groupId>
+            <artifactId>hibernate-search-mapper-orm</artifactId>
+            <version>${hibernate-search.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.hibernate.search</groupId>
+            <artifactId>hibernate-search-backend-elasticsearch</artifactId>
+            <version>${hibernate-search.version}</version>
+        </dependency>
     </dependencies>
 
     <build>

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/BaseBean.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/BaseBean.java
@@ -22,6 +22,7 @@
 import javax.persistence.MappedSuperclass;
 
 import org.hibernate.Hibernate;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
 import org.kitodo.data.database.persistence.BaseDAO;
 
 /**
@@ -34,6 +35,7 @@ public abstract class BaseBean implements Serializable {
 
     @Id
     @Column(name = "id")
+    @GenericField
     @GeneratedValue(strategy = GenerationType.IDENTITY)
     protected Integer id;
 

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/BaseTemplateBean.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/BaseTemplateBean.java
@@ -17,18 +17,22 @@
 import javax.persistence.Column;
 import javax.persistence.MappedSuperclass;
 
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
+
 /**
  * This bean contains properties common for Template and Process.
  */
 @MappedSuperclass
 public abstract class BaseTemplateBean extends BaseBean {
 
+    @GenericField
     @Column(name = "title")
     protected String title;
 
     @Column(name = "creationDate")
     protected Date creationDate;
 
+    @GenericField
     @Column(name = "sortHelperStatus")
     private String sortHelperStatus;
 

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Batch.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Batch.java
@@ -27,6 +27,9 @@
 import javax.persistence.ManyToMany;
 import javax.persistence.Table;
 
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexedEmbedded;
 import org.kitodo.data.database.enums.BatchType;
 import org.kitodo.data.database.persistence.BatchDAO;
 
@@ -38,13 +41,15 @@
  * multi-journal binding unit.
  */
 @Entity
+@Indexed(index = "kitodo-batch")
 @Table(name = "batch")
 public class Batch extends BaseBean {
 
     /**
      * The batch title. Using titles for batches is optional, the field may be
      * {@code null}. If so, the ID will be shown to the user instead.
      */
+    @GenericField
     @Column(name = "title")
     private String title;
 

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Client.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Client.java
@@ -25,12 +25,14 @@
 import javax.persistence.OneToMany;
 import javax.persistence.Table;
 
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
 import org.kitodo.data.database.persistence.ClientDAO;
 
 @Entity
 @Table(name = "client")
 public class Client extends BaseBean {
 
+    @GenericField
     @Column(name = "name")
     private String name;
 

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Comment.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Comment.java
@@ -22,6 +22,7 @@
 import javax.persistence.ManyToOne;
 import javax.persistence.Table;
 
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
 import org.kitodo.data.database.enums.CommentType;
 
 @Entity
@@ -31,13 +32,15 @@ public class Comment extends BaseBean {
      * The field message holds the comment message.
      */
     @Column(name = "message", columnDefinition = "longtext")
+    @GenericField
     private String message;
 
     /**
      * The field type holds the comment type.
      */
     @Column(name = "type")
     @Enumerated(EnumType.STRING)
+    @GenericField
     private CommentType type;
 
     /**

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Docket.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Docket.java
@@ -20,20 +20,32 @@
 import javax.persistence.ManyToOne;
 import javax.persistence.Table;
 
+import org.hibernate.search.mapper.pojo.automaticindexing.ReindexOnUpdate;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexedEmbedded;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexingDependency;
+
 @Entity
+@Indexed(index = "kitodo-docket")
 @Table(name = "docket")
 public class Docket extends BaseBean {
 
+    @GenericField
     @Column(name = "title")
     private String title;
 
+    @GenericField
     @Column(name = "file")
     private String file;
 
+    @GenericField
     @Column(name = "active")
     private Boolean active = true;
 
     @ManyToOne
+    @IndexedEmbedded(includePaths = {"id", "name"})
+    @IndexingDependency(reindexOnUpdate = ReindexOnUpdate.SHALLOW)
     @JoinColumn(name = "client_id", foreignKey = @ForeignKey(name = "FK_docket_client_id"))
     private Client client;
 

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Filter.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Filter.java
@@ -21,20 +21,28 @@
 import javax.persistence.ManyToOne;
 import javax.persistence.Table;
 
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.Indexed;
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexedEmbedded;
+
 /**
  * Filter bean.
  */
 @Entity
+@Indexed(index = "kitodo-filter")
 @Table(name = "filter")
 public class Filter extends BaseBean {
 
+    @GenericField
     @Column(name = "value", columnDefinition = "longtext")
     private String value;
 
+    @GenericField
     @Column(name = "creationDate")
     private Date creationDate;
 
     @ManyToOne
+    @IndexedEmbedded(includePaths = {"id"})
     @JoinColumn(name = "user_id", foreignKey = @ForeignKey(name = "FK_filter_user_id"))
     private User user;
 

diff --git a/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Folder.java b/Kitodo-DataManagement/src/main/java/org/kitodo/data/database/beans/Folder.java
@@ -29,6 +29,7 @@
 import javax.persistence.Table;
 import javax.persistence.Transient;
 
+import org.hibernate.search.mapper.pojo.mapping.definition.annotation.GenericField;
 import org.kitodo.api.imagemanagement.ImageManagementInterface;
 import org.kitodo.config.ConfigMain;
 import org.kitodo.data.database.enums.LinkingMode;
@@ -104,6 +105,7 @@ public class Folder extends BaseBean {
      * contents of this folder will be linked.
      */
     @Column(name = "fileGroup")
+    @GenericField
     private String fileGroup;
 
     /**
@@ -130,12 +132,14 @@ public class Folder extends BaseBean {
      * @see org.kitodo.config.xml.fileformats.FileFormatsConfig
      */
     @Column(name = "mimeType")
+    @GenericField
     private String mimeType = "image/jpeg";
 
     /**
      * The path to the folder in the process directory of each processes.
      */
     @Column(name = "path")
+    @GenericField
     private String path = "";
 
     /**
@@ -151,6 +155,7 @@ public class Folder extends BaseBean {
      * replaced before concatenation.
      */
     @Column(name = "urlStructure")
+    @GenericField
     private String urlStructure;
 
     /**