FRED Search Toolkit

The SRW FRED LOM Web Service toolkit implements the SRW Search/Retrieve standard, in order to provide Search functionality for repositories as a web service. The implementation follows the profile described in the SRW FRED LOM Service Expression, and the CQL Australian Education IEEE LOM Context Set (profiling the query language).

The implementation was based on the Lucene implementation of SRU/SRW by Ralph LeVan for the OCLC SRU/SRW toolkit, under OCLC Research Public License 2.0.

1. Download

The toolkit is available here (6.8 MB) as version 1.0, 2007-10-06, under Mozilla Public License 1.1. This software is copyrighted to the University of Southern Queensland.

2. Requirements

Apache Tomcat 5.x or later
Note: The Tomcat container that comes with Fedora can also be used
Apache Ant to install from source code
A Lucene index

If using a Fedora repository, the gsearch service can be installed and configured to provide a Lucene index

3. Installation

Currently, this service must be installed from the source code as it requires build time configuration.

Get the source from: http://fred.usq.edu.au/svn/repos/srw-lucene/trunk

 svn co http://fred.usq.edu.au/svn/repos/srw-lucene/trunk srw-lucene

There are 2 configuration files in the src/java directory to modify according to your environment:
- SRWDatabase.props configures database information, for example:
```
    databaseInfo.title=FRED Registry Lucene Database
	databaseInfo.description=An index of the metadata in the FRED Registry
	databaseInfo.contact=Oliver Lucido (lucido@usq.edu.au)
```
- SRWServer.props configures Lucene index(es) to be used for searching. Adding a Lucene index involves setting 3 properties:
```
    db.<IndexName>.class=ORG.oclc.os.SRW.Lucene.SRWLuceneDatabase
	db.<IndexName>.home=<PathToLuceneIndex>
	db.<IndexName>.configuration=SRWDatabase.props
```
  where <IndexName> is an identifier for your index (e.g. FREDRegistry) and <PathToLuceneIndex> is the file system location of the Lucene index to use.
Use Ant to build the web archive package
```
cd srw-lucene
ant dist
```

Copy the package to the Tomcat webapps directory

cp dist/SRWLucene.war /projects/fedora/tomcat/webapps

Test the installation is working by opening a browser the Tomcat server with the path as SRWLucene/search/<IndexName>, e.g. http://localhost:8080/SRWLucene/search/FREDRegistry

Copyright © University of Southern Queensland.

This work is licensed under the Creative Commons Attribution-Share Alike 2.5 Australia License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/2.5/au/

This work created as part of the Federated Repositories for Education (FRED) Project within the Australian ADL Partnership Laboratory. The FRED project was funded from October 2006 to June 2007 by the Australian Commonwealth Department of Education, Science and Training (DEST) under the Framework for Open Learning Programme and from July 2007 to December 2007 by DEST and the Australian Department of Innovation, Industry, Science and Research (DIISR) under the Systemic Infrastructure Initiative (SII) as part of the Commonwealth Government's Backing Australia's Ability - An Innovation Action Plan for the Future (BAA).

The University of Southern Queensland (USQ) provides the Australian ADL Partnership Lab with strategic advice, staff, technical support, administrative support and a corporate legal framework.