The Lucene plugin comes in fedoragsearch.war as the java package dk.defxws.fgslucene together with the Apache Lucene java libraries.
-The Lucene plugin is used by configuration as explained below.
+The Lucene plugin is configured during + Edit and use the basic property values below, + resulting in the set of GSearch configuration files.
Lucene has a very rich functionality, and this plugin - exploits a small fraction of it. As a java programmer, you may + allows you to configure many of its options, while all the other options + are used with their default values. + As a java programmer, you may have ideas for further exploitation, which you may realize by implementing an enhanced version of the plugin. Please, share such ideas and implementations with the Fedora community.
The Solr server is downloaded, installed and configured as described at the Solr web site.
-The Solr plugin comes in fedoragsearch.war as the java package dk.defxws.fgssolr.
-The Solr plugin is used by configuration as explained below. - It has dependencies on the configuration of the Solr server.
+The Solr server uses the Lucene java libraries for indexing and search.
+The Solr plugin comes in fedoragsearch.war as the java package dk.defxws.fgssolr
+The Solr plugin is configured during + Edit and use the basic property values below, + resulting in the set of GSearch configuration files.
+The Solr plugin has dependencies on the configuration of the Solr server. + You should begin with the schema.xml file provided by GSearch in + FgsConfig/FgsConfigIndexTemplate/Solr/conf/schema-3.6.0-for-fgs-2.4.2.xml . + It has a few modifications aimed at the Fedora demo objects. + You should also consider the autoCommit element in solrconfig.xml . + Besides, you need to go through all the Solr conf files + and make sure they match the index documents generated by your GSearch indexing stylesheet.
This plugin indexes documents via the HTTP POST interface of Solr. Searches may be performed via the Solr native HTTP GET to the Solr server - and via gfindObjects, which accesses the Lucene index directly. - Solr functionality does not include browsing, however, this is offered - by the plugin via the browseIndex operation.
+ and via gfindObjects, which accesses the Lucene index directly. +Solr functionality does not include browsing, however, this is offered + by the plugin via the browseIndex operation, + which also accesses the Lucene index directly.
+If you run Islandora
The Zebra plugin comes in fedoragsearch.war as the java package dk.defxws.fgszebra .
@@ -362,12 +378,13 @@>ant generateIndexingXslt
- As of version 2.1, GSearch has the ability to listen to update messages - provided by Fedora. These messages are sent via JMS, so a JMS provider - must be available (a JMS provider is included with Fedora 3.0). In order - to configure the update listener, open updater.properties and set the - following property values. These values will most likely be the same - as those specified in your Fedora configuration.
-- If you decide not to use the automatic updates feature in GSearch, you'll need to open fedoragsearch.properties - and remove (or comment out) the line specifying fedoragsearch.updaternames. This will disable the update - listener. -
-- Fedora 3.0 added the ability to send a message whenever a change is made to the - content of the repository (through API-M.) This messaging capability must be - enabled and configured to work properly. See the Fedora documentation for - instructions on configuring messaging. -
-- As an alternative to updates via messaging, it is possible to configure Fedora to - send a signal via REST to GSearch when objects are added, modified, - and purged. Using messaging is the preferred method for automatic updates, and this - technique, while still available, should be considered deprecated. It it not recommended - to use both the update listener and REST-based updates. -
-+
+ By default, GSearch is configured for automatic updates through Fedora notifications. + For deeper understanding and modification, + see the property fedoragsearch.updaternames in fedoragsearch.properties, + and updater.properties in config/updater/FgsUpdaters +
++ By default, Fedora is NOT configured for automatic updates through notifications to GSearch. +
+
+ In order to configure Fedora for automatic updates through notifications to GSearch,
+ set the value of the param enabled to true for the Messaging module in fedora.fcfg:
+
<module role="org.fcrepo.server.messaging.Messaging" class="org.fcrepo.server.messaging.MessagingModule"> + <comment>Fedora's Java Messaging Service (JMS) Module</comment> + <param name="enabled" value="true"/>+ + +
As a deprecated alternative to updates via messaging,
+ it is possible to configure Fedora to
+ send a signal via REST to GSearch, when objects are added, modified,
+ and purged. Do NOT enable both alternatives.
+
To enable REST-based updates, edit your fedora.fcfg file
and change the class of the fedora.server.storage.DOManager
module to org.fcrepo.server.storage.GSearchDOManager.
@@ -768,7 +739,7 @@
git clone https://github.com/fcrepo/gsearch.git-
To build fedoragsearch.war in FgsBuild/fromsource:
+To build fedoragsearch.war in FgsBuild/fromsource for normal installation:
cd FedoraGenericSearch ant buildfromsource @@ -778,6 +749,10 @@+Zebra
cd FedoraGenericSearch ant -Dlocal.PROTOCOL=<protocol> -Dlocal.HOSTPORT=<hostport> -Dlocal.FEDORA_HOME=<location> -Dlocal.SOLR_HOME=<location> -Dlocal.SOLR_SERVER=<url> buildforlocaltest
The fedoragsearch.war for local testing contains a set of configurations + that are used by the test operations below. + You may want to run the test operations, if you are customizing the GSearch code. +
To run tests in tomcat at <protocol>://<hostport>/fedoragsearch install a Fedora repository with demo objects with MessagingModule enabled, and create a test user in fedora-users.xml : @@ -797,6 +772,8 @@
Test operations on the solr plugin, after startup of the solr server:
@@ -817,6 +794,43 @@exts:getDatastreamXML($PID, $REPOSNAME, $DSID, $FEDORASOAP, $FEDORAUSER, $FEDORAPASS, $TRUSTSTOREPATH, $TRUSTSTOREPASS)
+ The Fedora Generic Search Service, abbreviated GSearch, is part of the Fedora Service Framework.
-The primary feature of GSearch is that it makes it easy - to make your digital contents in Fedora searchable for yourself and your end-users.
GSearch was developed by Gert Schmeltz Pedersen at the Technical University of Denmark, @@ -1042,6 +1054,7 @@