SEARCH-1264 Document usage of JBoss AS 7 module #378

Closed
wants to merge 1 commit into
from

Projects

None yet

2 participants

@Sanne Sanne commented on an outdated diff Jan 25, 2013
...on/src/main/docbook/en-US/modules/getting-started.xml
@@ -180,6 +180,65 @@ mvn archetype:generate \
</section>
<section>
+ <title>Using JBoss Modules</title>
+
+ <para>Provided you're deploying on JBoss 7.1.x or EAP6, there is an additional way to add the search dependencies to your application.</para>
@Sanne
Sanne Jan 25, 2013

If you want to spell it out fully then it should be JBoss AS 7.1.x or JBoss EAP6

@Sanne Sanne commented on an outdated diff Jan 25, 2013
...on/src/main/docbook/en-US/modules/getting-started.xml
@@ -180,6 +180,65 @@ mvn archetype:generate \
</section>
<section>
+ <title>Using JBoss Modules</title>
+
+ <para>Provided you're deploying on JBoss 7.1.x or EAP6, there is an additional way to add the search dependencies to your application.</para>
+
+ <para>In JBoss AS 7 class loading is based on modules that have to define explicit dependencies on other modules.
+ Modules allow to share the same artifacts across multiple applications getting you smaller and quicker deloyments.</para>
+
+ <para>More details about modules are described in <ulink url="https://docs.jboss.org/author/display/AS72/Class+Loading+in+AS7">Class Loading in AS7</ulink>.</para>
+
+ <para>You can download the pre-packaged Hibernate Search modules from:</para>
+ <itemizedlist>
+ <listitem>
+ <para><ulink url="http://downloads.sourceforge.net/project/hibernate/hibernate-search/&version;/hibernate-serach-modules-&version;-jbossas-71-dist.zip">Sourceforge</ulink></para>
@Sanne Sanne commented on an outdated diff Jan 25, 2013
...on/src/main/docbook/en-US/modules/getting-started.xml
@@ -180,6 +180,65 @@ mvn archetype:generate \
</section>
<section>
@Sanne
Sanne Jan 25, 2013

I'm not sure this should fit in the "getting started" section. WDYT about creating a "Deploying Search applictions on JBoss" section?

@Sanne
Hibernate member

thanks. weird I didn't see the notification from your last change, I just happened to browse here to have another look.

@Sanne Sanne commented on an outdated diff Jan 27, 2013
...tion/src/main/docbook/en-US/modules/configuration.xml
+ <listitem>
+ <para><emphasis>org.hibernate.search.orm:main</emphasis>, for users of Hibernate Search with Hibernate; this will transitively include Hibernate ORM.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>org.hibernate.search.engine:main</emphasis>, for projects depending on the internal indexing engine that don't require other dependencies to Hibernate.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>There are two ways to include the dependencies in your project:</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>Using the manifest</term>
+ <listitem>
+ <para>Add this entry to the MANIFEST.MF in your archive:</para>
+ <programlisting>Dependencies org.hibernate.search.orm services</programlisting>
@Sanne
Sanne Jan 27, 2013

tested.. it's actually wrong :)
should be:

Dependencies: org.hibernate.search.orm services

note the separator between the attribute key and value: ":"

@DavideD
Hibernate member

Fixed, ":" added

@Sanne
Hibernate member

note the JIRA code is HSEARCH, not SEARCH.
The sourceforge link was not going to work, it needs to be httpS
I've added a section label, that provides nice linkable anchors in the docs.

merged

@Sanne Sanne closed this Jan 28, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment