[hibernate-commits] Hibernate SVN: r20246 - search/trunk/hibernate-search/src/main/docbook/en-US/modules.
hibernate-commits at lists.jboss.org
hibernate-commits at lists.jboss.org
Tue Aug 24 09:00:42 EDT 2010
Author: epbernard
Date: 2010-08-24 09:00:42 -0400 (Tue, 24 Aug 2010)
New Revision: 20246
Modified:
search/trunk/hibernate-search/src/main/docbook/en-US/modules/configuration.xml
Log:
Minor doc style fixes
Modified: search/trunk/hibernate-search/src/main/docbook/en-US/modules/configuration.xml
===================================================================
--- search/trunk/hibernate-search/src/main/docbook/en-US/modules/configuration.xml 2010-08-24 13:00:12 UTC (rev 20245)
+++ search/trunk/hibernate-search/src/main/docbook/en-US/modules/configuration.xml 2010-08-24 13:00:42 UTC (rev 20246)
@@ -344,8 +344,8 @@
“Animal”. Both entities will then be stored in the Animal
directory</para>
- <para><programlisting><code>hibernate.search.org.hibernate.search.test.shards.Furniture.indexName = Animal
-hibernate.search.org.hibernate.search.test.shards.Animal.indexName = Animal</code></programlisting></para>
+ <para><programlisting>hibernate.search.org.hibernate.search.test.shards.Furniture.indexName = Animal
+hibernate.search.org.hibernate.search.test.shards.Animal.indexName = Animal</programlisting></para>
</listitem>
<listitem>
@@ -577,12 +577,15 @@
<example>
<title>Message Driven Bean processing the indexing queue</title>
- <programlisting>@MessageDriven(activationConfig = {
- @ActivationConfigProperty(propertyName="destinationType", propertyValue="javax.jms.Queue"),
- @ActivationConfigProperty(propertyName="destination", propertyValue="queue/hibernatesearch"),
+ <programlisting language="JAVA" role="JAVA">@MessageDriven(activationConfig = {
+ @ActivationConfigProperty(propertyName="destinationType",
+ propertyValue="javax.jms.Queue"),
+ @ActivationConfigProperty(propertyName="destination",
+ propertyValue="queue/hibernatesearch"),
@ActivationConfigProperty(propertyName="DLQMaxResent", propertyValue="1")
} )
-public class MDBSearchController extends AbstractJMSHibernateSearchController implements MessageListener {
+public class MDBSearchController extends AbstractJMSHibernateSearchController
+ implements MessageListener {
@PersistenceContext EntityManager em;
//method retrieving the appropriate session
@@ -663,7 +666,7 @@
<example>
<title>JGroups transport protocols configuration</title>
- <programlisting>
+ <programlisting language="XML">
## configuration
#udp.xml file needs to be located in the classpath
hibernate.search.worker.backend.jgroups.configurationFile = udp.xml
@@ -1027,12 +1030,15 @@
<section id="search-configuration-directory-lockfactories" revision="1">
<title>LockFactory configuration</title>
+
<para>Lucene Directories have default locking strategies which work well
for most cases, but it's possible to specify for each index managed by
Hibernate Search which LockingFactory you want to use.</para>
+
<para>Some of these locking strategies require a filesystem level lock and
may be used even on RAM based indexes, but this is not recommended and of
no practical use.</para>
+
<para>To select a locking factory, set the
<literal>hibernate.search.<index>.locking_strategy</literal> option
to one of <literal>simple</literal>, <literal>native</literal>,
@@ -1040,68 +1046,76 @@
fully qualified name of an implementation of
<literal>org.hibernate.search.store.LockFactoryFactory</literal>;
Implementing this interface you can provide a custom
- <literal>org.apache.lucene.store.LockFactory</literal>.</para>
+ <literal>org.apache.lucene.store.LockFactory</literal>.</para>
+
<table id="search-configuration-directory-lockfactories-table">
- <title>List of available LockFactory implementations</title>
- <tgroup cols="3">
- <thead>
- <row>
- <entry align="center">name</entry>
- <entry align="center">Class</entry>
- <entry align="center">Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>simple</entry>
- <entry>org.apache.lucene.store.SimpleFSLockFactory</entry>
- <entry>
- <para>Safe implementation based on Java's File API, it marks
- the usage of the index by creating a marker file.</para>
- <para>If for some reason you had to kill your application, you
- will need to remove this file before restarting it.</para>
- <para>This is the default implementation for
- <literal>FSDirectoryProvider</literal>,<literal>FSMasterDirectoryProvider</literal>
- and <literal>FSSlaveDirectoryProvider</literal>.</para>
- </entry>
- </row>
- <row>
- <entry>native</entry>
- <entry>org.apache.lucene.store.NativeFSLockFactory</entry>
- <entry>
- <para>As does <literal>simple</literal> this also marks the
- usage of the index by creating a marker file, but this one is
- using native OS file locks so that even if your application
- crashes the locks will be cleaned up.</para>
- <para>This implementation has known problems on NFS.</para>
- </entry>
- </row>
- <row>
- <entry>single</entry>
- <entry>org.apache.lucene.store.SingleInstanceLockFactory</entry>
- <entry>
- <para>This LockFactory doesn't use a file marker but is a Java
- object lock held in memory; therefore it's possible to use it
- only when you are sure the index is not going to be shared by
- any other process.</para>
- <para>This is the default implementation for
- <literal>RAMDirectoryProvider</literal>.</para>
- </entry>
- </row>
- <row>
- <entry>none</entry>
- <entry>org.apache.lucene.store.NoLockFactory</entry>
- <entry>
- <para>All changes to this index are not coordinated by any
- lock; test your application carefully and make sure you know
- what it means.</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>
- Configuration example:</para>
+ <title>List of available LockFactory implementations</title>
+
+ <tgroup cols="3">
+ <thead>
+ <row>
+ <entry align="center">name</entry>
+
+ <entry align="center">Class</entry>
+
+ <entry align="center">Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>simple</entry>
+
+ <entry>org.apache.lucene.store.SimpleFSLockFactory</entry>
+
+ <entry><para>Safe implementation based on Java's File API, it
+ marks the usage of the index by creating a marker file.</para>
+ <para>If for some reason you had to kill your application, you
+ will need to remove this file before restarting it.</para>
+ <para>This is the default implementation for
+ <literal>FSDirectoryProvider</literal>,<literal>FSMasterDirectoryProvider</literal>
+ and <literal>FSSlaveDirectoryProvider</literal>.</para></entry>
+ </row>
+
+ <row>
+ <entry>native</entry>
+
+ <entry>org.apache.lucene.store.NativeFSLockFactory</entry>
+
+ <entry><para>As does <literal>simple</literal> this also marks the
+ usage of the index by creating a marker file, but this one is
+ using native OS file locks so that even if your application
+ crashes the locks will be cleaned up.</para> <para>This
+ implementation has known problems on NFS.</para></entry>
+ </row>
+
+ <row>
+ <entry>single</entry>
+
+ <entry>org.apache.lucene.store.SingleInstanceLockFactory</entry>
+
+ <entry><para>This LockFactory doesn't use a file marker but is a
+ Java object lock held in memory; therefore it's possible to use it
+ only when you are sure the index is not going to be shared by any
+ other process.</para> <para>This is the default implementation for
+ <literal>RAMDirectoryProvider</literal>.</para></entry>
+ </row>
+
+ <row>
+ <entry>none</entry>
+
+ <entry>org.apache.lucene.store.NoLockFactory</entry>
+
+ <entry><para>All changes to this index are not coordinated by any
+ lock; test your application carefully and make sure you know what
+ it means.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>Configuration example:</para>
+
<programlisting>hibernate.search.default.locking_strategy simple
hibernate.search.Animals.locking_strategy native
hibernate.search.Books.locking_strategy org.custom.components.MyLockingFactory</programlisting>
More information about the hibernate-commits
mailing list