--------------------------------------------------------------------------------
Readme for the OAI Harvester servlet
--------------------------------------------------------------------------------

The OAI Harvester servlet is a sample application that will function as a 
OAI Static Repository Gateway.  

This sample application is an example and is not a supported product, please 
see the LICENSE.txt for more information.

--------------------------------------------------------------------------------
Introduction:
--------------------------------------------------------------------------------
The OAI Harvester servlet is intended as a working example of a 
OAI Static Repository Gateway and can be used with OAI Static Repositories. 
There are many OAI Static Repository Gateways freely available on the web 
and we suggest you review your options to best serve your particular needs 
and infrastructure. 



--------------------------------------------------------------------------------
Installing the Servlet:
--------------------------------------------------------------------------------
To install the Harvester:

1. Copy the harvester folder from the installation CD (/examples/oai/harvester) 
    to a location on the server you will be running it from.

2. Locate the Installation directory for Insight 5.x server components.

3. Locate the harvester.xml file 
   " /utilities/examples/oai/tomcat_example" directory.

4. Copy the harvester.xml to the tomcat /tomcat/conf/Catalina/localhost folder

5. Edit the harvester.xml docBase attribute to point at the location in step one

6. Edit the /harvester/WEB-INF/classes/harvester.properties

   Create a folder on your server where the active Static OAI repositories will get 
   cached Modify soai.registry.path=D:\\temp_staticoai to point at the folder you just created

   Note: on windows systems, enter a \\ where the single \ path separators are.

   Enter your http context path to the harvester 
   soai.identify.gateway.url=http://www.anywhere.com:8081/harvester/

   Enter your desired page size. This size will determine how many results will be 
   returned per resumption token request
   fetch.pagesize=100

   All other parameters are not being used for the OAI Static Repository Gateway

7. Restart Tomcat.

8. To access a OAI static repository document, make the document available via URL. 
    
<oai:baseURL>http://www.example.com:8081/harvester/www.example.com/staticoai/1-DALTON -NA.xml</oai:baseURL> 


The following is taken from the official implementation guidelines for the Open Archives Initiative 

# ServerURL
# Static Repository base URL: The base URL that provides access via OAI-PMH to 
# the contents of the Static Repository through intermediation by a Static 
# Repository Gateway. This Static Repository base URL is a concatenation of:
#
#    * The Static Repository Gateway URL: All base URLs of Static Repositories 
#      accessible through a given Static Repository Gateway share a common part 
#      of an HTTP address, which is the URL of the Static Repository Gateway 
#      itself. This URL is of the form http://gateway:port/gatewaypath .
#    * A single forward slash [/] character. If the Static Repository Gateway 
#      URL ends with a forward slash, then an additional one must not be added.
#    * The persistent Static Repository URL , which must be of the form 
#      http://host:port/path/file, stripped of its prefix URI scheme part 
#      (http://). Hence, the resulting sub-string is of the form host:port/path/file .
#
# For example, OAI-PMH requests to a Static Repository at http://an.oai.org/ma/mini.xml 
# using intermediation from a Static Repository Gateway at http://gateway.institution.org/oai 
# must be issued against the Static Repository base URL:
#
#    http://gateway.institution.org/oai/an.oai.org/ma/mini.xml


9. Testing the harvester

    Initialize:
    http://www.example.com:8081/harvester/soai?initiate=http://www.example.com/staticoai/1-DALTON-NA.xml

   List Identifiers:
   http://www.example.com:8081/harvester/soai/http://www.example.com/staticoai/1-DALTON-NA.xml?verb=ListIdentifiers&metadataPrefix=oai_dc

   To evaluate other Static OAI verb functionality, please refer to the official OAI documentation  
    http://www.openarchives.org/OAI/2.0/guidelines-static-repository.htm