From hibernate-commits at lists.jboss.org Tue Aug 24 09:00:43 2010
Content-Type: multipart/mixed; boundary="===============2278094712981230783=="
MIME-Version: 1.0
From: hibernate-commits at lists.jboss.org
To: hibernate-commits at lists.jboss.org
Subject: [hibernate-commits] Hibernate SVN: r20246 -
search/trunk/hibernate-search/src/main/docbook/en-US/modules.
Date: Tue, 24 Aug 2010 09:00:42 -0400
Message-ID: <201008241300.o7OD0gaS002806@svn01.web.mwc.hst.phx2.redhat.com>
--===============2278094712981230783==
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
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/configurati=
on.xml
Log:
Minor doc style fixes
Modified: search/trunk/hibernate-search/src/main/docbook/en-US/modules/conf=
iguration.xml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
--- search/trunk/hibernate-search/src/main/docbook/en-US/modules/configurat=
ion.xml 2010-08-24 13:00:12 UTC (rev 20245)
+++ search/trunk/hibernate-search/src/main/docbook/en-US/modules/configurat=
ion.xml 2010-08-24 13:00:42 UTC (rev 20246)
@@ -344,8 +344,8 @@
=E2=80=9CAnimal=E2=80=9D. Both entities will then be stored in the=
Animal
directory
=
- hibernate.search.org.hibernate.search.=
test.shards.Furniture.indexName =3D Animal
-hibernate.search.org.hibernate.search.test.shards.Animal.indexName =3D Ani=
mal
+ hibernate.search.org.hibernate.search.test.s=
hards.Furniture.indexName =3D Animal
+hibernate.search.org.hibernate.search.test.shards.Animal.indexName =3D Ani=
mal
=
@@ -577,12 +577,15 @@
Message Driven Bean processing the indexing queue
=
- @MessageDriven(activationConfig =3D {
- @ActivationConfigProperty(propertyName=3D"destinationType", property=
Value=3D"javax.jms.Queue"),
- @ActivationConfigProperty(propertyName=3D"destination", propertyValu=
e=3D"queue/hibernatesearch"),
+ @MessageDriven(act=
ivationConfig =3D {
+ @ActivationConfigProperty(propertyName=3D"destinationType", =
+ propertyValue=3D"javax.jms.Queue"),
+ @ActivationConfigProperty(propertyName=3D"destination", =
+ propertyValue=3D"queue/hibernatesearch"),
@ActivationConfigProperty(propertyName=3D"DLQMaxResent", propertyVal=
ue=3D"1")
} )
-public class MDBSearchController extends AbstractJMSHibernateSearchControl=
ler implements MessageListener {
+public class MDBSearchController extends AbstractJMSHibernateSearchControl=
ler =
+ implements MessageListener {
@PersistenceContext EntityManager em;
=
//method retrieving the appropriate session
@@ -663,7 +666,7 @@
JGroups transport protocols configuration
=
-
+
## configuration
#udp.xml file needs to be located in the classpath
hibernate.search.worker.backend.jgroups.configurationFile =3D udp.xml
@@ -1027,12 +1030,15 @@
=
LockFactory configuration
+
Lucene Directories have default locking strategies which work we=
ll
for most cases, but it's possible to specify for each index managed by
Hibernate Search which LockingFactory you want to use.
+
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.
+
To select a locking factory, set the
hibernate.search.<index>.locking_strategy opt=
ion
to one of simple, native,
@@ -1040,68 +1046,76 @@
fully qualified name of an implementation of
org.hibernate.search.store.LockFactoryFactory;
Implementing this interface you can provide a custom
- org.apache.lucene.store.LockFactory. =
+ org.apache.lucene.store.LockFactory.
+
- List of available LockFactory implementations
-
-
-
- name
- Class
- Description
-
-
-
-
- simple
- org.apache.lucene.store.SimpleFSLockFactory
-
- Safe implementation based on Java's File API, it mar=
ks
- the usage of the index by creating a marker file.
- If for some reason you had to kill your application,=
you
- will need to remove this file before restarting it.
- This is the default implementation for
- FSDirectoryProvider,FSMasterDi=
rectoryProvider
- and FSSlaveDirectoryProvider.
-
-
-
- native
- org.apache.lucene.store.NativeFSLockFactory
-
- As does simple 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.
- This implementation has known problems on NFS.
-
-
-
- single
- org.apache.lucene.store.SingleInstanceLockFactory
-
- 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.
- This is the default implementation for
- RAMDirectoryProvider.
-
-
-
- none
- org.apache.lucene.store.NoLockFactory
-
- All changes to this index are not coordinated by any
- lock; test your application carefully and make sure you kn=
ow
- what it means.
-
-
-
-
-
-
- Configuration example:
+ List of available LockFactory implementations
+
+
+
+
+ name
+
+ Class
+
+ Description
+
+
+
+
+
+ simple
+
+ org.apache.lucene.store.SimpleFSLockFactory
+
+ Safe implementation based on Java's File API, it
+ marks the usage of the index by creating a marker file.
+ If for some reason you had to kill your application, you
+ will need to remove this file before restarting it.
+ This is the default implementation for
+ FSDirectoryProvider,FSMasterDirect=
oryProvider
+ and FSSlaveDirectoryProvider.
+
+
+
+ native
+
+ org.apache.lucene.store.NativeFSLockFactory
+
+ As does simple 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. This
+ implementation has known problems on NFS.
+
+
+
+ single
+
+ org.apache.lucene.store.SingleInstanceLockFactory
+
+ This LockFactory doesn't use a file marker but is=
a
+ Java object lock held in memory; therefore it's possible to us=
e it
+ only when you are sure the index is not going to be shared by =
any
+ other process. This is the default implementation=
for
+ RAMDirectoryProvider.
+
+
+
+ none
+
+ org.apache.lucene.store.NoLockFactory
+
+ All changes to this index are not coordinated by =
any
+ lock; test your application carefully and make sure you know w=
hat
+ it means.
+
+
+
+
+
+ Configuration example:
+
hibernate.search.default.locking_strategy simple
hibernate.search.Animals.locking_strategy native
hibernate.search.Books.locking_strategy org.custom.components.MyLockingFac=
tory
--===============2278094712981230783==--