Skip to content

Commit

Permalink
HSEARCH-2989 Move hibernate-search-orm out of hibernate-search-module…
Browse files Browse the repository at this point in the history
…s to a separate JBoss module distribution zip
  • Loading branch information
yrodiere committed Jan 19, 2018
1 parent dcccc2d commit 4eadf45
Show file tree
Hide file tree
Showing 14 changed files with 217 additions and 72 deletions.
6 changes: 6 additions & 0 deletions distribution/pom.xml
Expand Up @@ -120,6 +120,12 @@
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>hibernate-search-jbossmodules-orm</artifactId>
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
</dependency>
<dependency>
<groupId>${project.groupId}</groupId>
<artifactId>hibernate-search-jbossmodules-elasticsearch</artifactId>
Expand Down
24 changes: 19 additions & 5 deletions documentation/src/main/asciidoc/configuration.asciidoc
Expand Up @@ -1481,10 +1481,8 @@ See also link:https://docs.jboss.org/author/display/WFLY/JPA+Reference+Guide#JPA

This package includes all the main modules:

* _org.hibernate.search.orm_, for users of Hibernate Search with Hibernate; this will transitively include Hibernate ORM.
* _org.hibernate.search.engine_, for projects depending on the internal indexing engine that don't require other dependencies to Hibernate.
* _org.hibernate.search.backend-jms_, in case you want to use the JMS backend described in <<search-architecture-jms, JMS Architecture>>.
* _org.hibernate.search.jsr352_, to use the JSR-352 integration.

The package includes several more modules but you should not need to refer to the other ones directly.

Expand All @@ -1493,9 +1491,6 @@ and is also published as a Maven artifact: link:$$https://repository.jboss.org/n

When installing this package, do not forget to also install the dependencies:

* Hibernate ORM version `5.2.3.Final` or a later version of the 5.2 branch, such as `{hibernateVersion}`.
When in doubt, refer to the http://hibernate.org/search/releases/#compatibility-matrix[compatibility matrix on the website].
The Hibernate ORM / WildFly update instructions can be found http://docs.jboss.org/hibernate/orm/5.2/topical/html_single/wildfly/Wildfly.html[here].
* Lucene version `{luceneVersion}`.
The Hibernate team publishes JBoss modules of Lucene as part of
https://github.com/hibernate/lucene-jbossmodules[this project].
Expand All @@ -1504,6 +1499,25 @@ When installing this package, do not forget to also install the dependencies:
(see https://repository.jboss.org/nexus/content/groups/public/org/hibernate/lucene-jbossmodules/lucene-jbossmodules/[here] for downloads),
and can be deployed to your WildFly instance by unpacking the ZIPs to the WildFly `modules` directory.

[[hibernatesearch-jboss-modules-packages-orm]]
===== ORM package

This package includes the following modules:

* _org.hibernate.search.orm_, for users of Hibernate Search with Hibernate ORM.
* _org.hibernate.search.jsr352_, to use the JSR-352 integration.

The package can be downloaded from http://sourceforge.net/projects/hibernate/files/hibernate-search/{hibernateSearchVersion}/hibernate-search-jbossmodules-orm-{hibernateSearchVersion}-wildfly-11-dist.zip/download[Sourceforge],
and is also published as a Maven artifact: link:$$https://repository.jboss.org/nexus/index.html#nexus-search;gav~org.hibernate~hibernate-search-jbossmodules-orm~{hibernateSearchVersion}~~$$[org.hibernate:hibernate-search-jbossmodules-orm-{hibernateSearchVersion}-wildfly-11-dist:zip].

When installing this package, do not forget to also install the dependencies:

* The <<main Hibernate Search package,hibernatesearch-jboss-modules-packages-main>>,
along with each of its own dependencies.
* Hibernate ORM version `5.2.3.Final` or a later version of the 5.2 branch, such as `{hibernateVersion}`.
When in doubt, refer to the http://hibernate.org/search/releases/#compatibility-matrix[compatibility matrix on the website].
The Hibernate ORM / WildFly update instructions can be found http://docs.jboss.org/hibernate/orm/5.2/topical/html_single/wildfly/Wildfly.html[here].

[[hibernatesearch-jboss-modules-packages-elasticsearch]]
===== Elasticsearch package

Expand Down
16 changes: 16 additions & 0 deletions integrationtest/performance/orm/pom.xml
Expand Up @@ -250,6 +250,15 @@
<overWrite>true</overWrite>
<outputDirectory>${jbosshome}/modules</outputDirectory>
</artifactItem>
<artifactItem>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jbossmodules-orm</artifactId>
<version>${project.version}</version>
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
<overWrite>true</overWrite>
<outputDirectory>${jbosshome}/modules</outputDirectory>
</artifactItem>
<artifactItem>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-orm-modules</artifactId>
Expand Down Expand Up @@ -305,6 +314,13 @@
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jbossmodules-orm</artifactId>
<version>${project.version}</version>
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
</dependency>
</dependencies>
</plugin>
</plugins>
Expand Down
25 changes: 25 additions & 0 deletions integrationtest/wildfly/pom.xml
Expand Up @@ -428,6 +428,24 @@
<overWrite>true</overWrite>
<outputDirectory>${jbossHome.node2}/modules</outputDirectory>
</artifactItem>
<artifactItem>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jbossmodules-orm</artifactId>
<version>${project.version}</version>
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
<overWrite>true</overWrite>
<outputDirectory>${jbossHome.node1}/modules</outputDirectory>
</artifactItem>
<artifactItem>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jbossmodules-orm</artifactId>
<version>${project.version}</version>
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
<overWrite>true</overWrite>
<outputDirectory>${jbossHome.node2}/modules</outputDirectory>
</artifactItem>
<artifactItem>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jbossmodules-elasticsearch</artifactId>
Expand Down Expand Up @@ -616,6 +634,13 @@
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jbossmodules-orm</artifactId>
<version>${project.version}</version>
<classifier>wildfly-11-dist</classifier>
<type>zip</type>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jbossmodules-testing</artifactId>
Expand Down
26 changes: 0 additions & 26 deletions jbossmodules/core/pom.xml
Expand Up @@ -32,36 +32,10 @@
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-backend-jms</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-orm</artifactId>
<exclusions>
<exclusion>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-commons-annotations</artifactId>
</exclusion>
<exclusion>
<groupId>org.jboss.logging</groupId>
<artifactId>jboss-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-backend-jgroups</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jsr352-core</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jsr352-jberet</artifactId>
</dependency>
</dependencies>

<build>
Expand Down
41 changes: 0 additions & 41 deletions jbossmodules/core/src/main/assembly/dist.xml
Expand Up @@ -28,16 +28,6 @@
<outputDirectory>org/hibernate/search/engine/${hibernate.search.module.slot}</outputDirectory>
<filtered>true</filtered>
</file>
<file>
<source>${module.xml.basedir}/search/orm/module.xml</source>
<outputDirectory>org/hibernate/search/orm/${hibernate.search.version}</outputDirectory>
<filtered>true</filtered>
</file>
<file>
<source>${aliases.xml.basedir}/search/orm/module.xml</source>
<outputDirectory>org/hibernate/search/orm/${hibernate.search.module.slot}</outputDirectory>
<filtered>true</filtered>
</file>
<file>
<source>${module.xml.basedir}/search/backend-jms/module.xml</source>
<outputDirectory>org/hibernate/search/backend-jms/${hibernate.search.version}</outputDirectory>
Expand All @@ -53,16 +43,6 @@
<outputDirectory>org/hibernate/search/backend-jgroups/${hibernate.search.version}</outputDirectory>
<filtered>true</filtered>
</file>
<file>
<source>${module.xml.basedir}/search/jsr352/module.xml</source>
<outputDirectory>org/hibernate/search/jsr352/${hibernate.search.version}</outputDirectory>
<filtered>true</filtered>
</file>
<file>
<source>${aliases.xml.basedir}/search/jsr352/module.xml</source>
<outputDirectory>org/hibernate/search/jsr352/${hibernate.search.module.slot}</outputDirectory>
<filtered>true</filtered>
</file>
</files>

<dependencySets>
Expand Down Expand Up @@ -96,16 +76,6 @@
</includes>
</dependencySet>

<dependencySet>
<useProjectArtifact>false</useProjectArtifact>
<outputDirectory>org/hibernate/search/orm/${hibernate.search.version}</outputDirectory>
<useTransitiveFiltering>false</useTransitiveFiltering>
<unpack>false</unpack>
<includes>
<include>org.hibernate:hibernate-search-orm</include>
</includes>
</dependencySet>

<dependencySet>
<useProjectArtifact>false</useProjectArtifact>
<outputDirectory>org/hibernate/search/backend-jms/${hibernate.search.version}</outputDirectory>
Expand All @@ -116,16 +86,5 @@
</includes>
</dependencySet>

<dependencySet>
<useProjectArtifact>false</useProjectArtifact>
<outputDirectory>org/hibernate/search/jsr352/${hibernate.search.version}</outputDirectory>
<useTransitiveFiltering>false</useTransitiveFiltering>
<unpack>false</unpack>
<includes>
<include>org.hibernate:hibernate-search-jsr352-core</include>
<include>org.hibernate:hibernate-search-jsr352-jberet</include>
</includes>
</dependencySet>

</dependencySets>
</assembly>
77 changes: 77 additions & 0 deletions jbossmodules/orm/pom.xml
@@ -0,0 +1,77 @@
<!--
~ Hibernate Search, full-text search for your domain model
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jbossmodules-parent</artifactId>
<version>5.9.0-SNAPSHOT</version>
</parent>

<artifactId>hibernate-search-jbossmodules-orm</artifactId>
<packaging>pom</packaging>

<name>Hibernate Search ORM JBoss Module</name>
<description>Hibernate Search ORM modules creation to use in JBoss AS / Wildfly</description>

<properties>
<module.xml.basedir>src/main/modules</module.xml.basedir>
<aliases.xml.basedir>src/main/aliases</aliases.xml.basedir>
</properties>

<dependencies>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-orm</artifactId>
<exclusions>
<exclusion>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-commons-annotations</artifactId>
</exclusion>
<exclusion>
<groupId>org.jboss.logging</groupId>
<artifactId>jboss-logging</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jsr352-core</artifactId>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-search-jsr352-jberet</artifactId>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<finalName>${project.artifactId}-${project.version}</finalName>
<descriptors>
<descriptor>${basedir}/src/main/assembly/dist.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<id>make-assembly</id>
<phase>package</phase>
<goals>
<goal>single</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
66 changes: 66 additions & 0 deletions jbossmodules/orm/src/main/assembly/dist.xml
@@ -0,0 +1,66 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Hibernate Search, full-text search for your domain model
~
~ License: GNU Lesser General Public License (LGPL), version 2.1 or later
~ See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
-->
<assembly>
<id>wildfly-11-dist</id>
<formats>
<format>zip</format>
<!-- Uncomment the following line to simplify content inspection: -->
<!--
<format>dir</format>
-->
</formats>
<includeBaseDirectory>false</includeBaseDirectory>
<baseDirectory>/</baseDirectory>

<files>
<file>
<source>${module.xml.basedir}/search/orm/module.xml</source>
<outputDirectory>org/hibernate/search/orm/${hibernate.search.version}</outputDirectory>
<filtered>true</filtered>
</file>
<file>
<source>${aliases.xml.basedir}/search/orm/module.xml</source>
<outputDirectory>org/hibernate/search/orm/${hibernate.search.module.slot}</outputDirectory>
<filtered>true</filtered>
</file>
<file>
<source>${module.xml.basedir}/search/jsr352/module.xml</source>
<outputDirectory>org/hibernate/search/jsr352/${hibernate.search.version}</outputDirectory>
<filtered>true</filtered>
</file>
<file>
<source>${aliases.xml.basedir}/search/jsr352/module.xml</source>
<outputDirectory>org/hibernate/search/jsr352/${hibernate.search.module.slot}</outputDirectory>
<filtered>true</filtered>
</file>
</files>

<dependencySets>
<dependencySet>
<useProjectArtifact>false</useProjectArtifact>
<outputDirectory>org/hibernate/search/orm/${hibernate.search.version}</outputDirectory>
<useTransitiveFiltering>false</useTransitiveFiltering>
<unpack>false</unpack>
<includes>
<include>org.hibernate:hibernate-search-orm</include>
</includes>
</dependencySet>

<dependencySet>
<useProjectArtifact>false</useProjectArtifact>
<outputDirectory>org/hibernate/search/jsr352/${hibernate.search.version}</outputDirectory>
<useTransitiveFiltering>false</useTransitiveFiltering>
<unpack>false</unpack>
<includes>
<include>org.hibernate:hibernate-search-jsr352-core</include>
<include>org.hibernate:hibernate-search-jsr352-jberet</include>
</includes>
</dependencySet>

</dependencySets>
</assembly>
1 change: 1 addition & 0 deletions jbossmodules/pom.xml
Expand Up @@ -20,6 +20,7 @@

<modules>
<module>core</module>
<module>orm</module>
<module>elasticsearch</module>
<module>elasticsearch-aws</module>
<module>testing</module>
Expand Down

0 comments on commit 4eadf45

Please sign in to comment.