.

Configuring jOAI

This page describes optional configuration options that are available in the jOAI software. These instructions assume the software has already been installed according to the installation instructions.

 

Enabling access control in Tomcat

Restrict access to the software administrative pages so that the public does not have access to sensitive information or can change administrative settings. To enable password protection for the administrative pages, do the following (this assumes use of at least Tomcat v 5.x):

1. Uncomment the 'security-constraint' and 'login-config' elements found in the oai "WEB-INF/web.xml" file. Assuming a default installation, this would be located at $CATALINA_HOME/webapps/oai/WEB-INF/web.xml($CATALINA_HOME refers to the location of the Tomcat installation).

2. Copy the following Context and Realm elements into the <Host> element of the 'server.xml' configuration file found in the Tomcat 5.x 'conf' directory (the configuration below assumes the OAI context and directory name is 'oai'):

<Realm className="org.apache.catalina.realm.MemoryRealm" pathname="webapps/oai/WEB-INF/users.xml"/>

<Context path="/oai" docBase="oai" debug="0" reloadable="true"/>

3. Edit the file 'WEB-INF/users.xml' to define the user names and passwords for those you wish to grant access to the OAI administration pages. An example user and instructions are provided in that file.

4. Start or restart Tomcat.

Note that this type of authentication does not provide encryption for user names and passwords sent over the Internet.


Configure multiple formats in the Provider

The jOAI data provider can disseminate any given metadata file in multiple formats. See Providing files in multiple formats for information about configuring this functionality.

 

Search client template

A search client template is available in this software that can be used to implement a custom search page for the DLESE jOAI data provider. See the search client template section in the ODL documentation for information about using and customizing the template.

 

Configure software settings

Change certain behaviors in the data provider and harvester by editing the following parameters in the "web.xml" or "server.xml" files. Changes made in web.xml are overwritten when the software is re-installed. Changes made in server.xml are not overwritten. The following assumes the use of at least Tomcat 5.x.

To make "web.xml" changes, use the OAI "WEB-INF/web.xml" file. Assuming a default installation, this would be located at $CATALINA_HOME/webapps/oai/WEB-INF/web.xml ($CATALINA_HOME refers to the location of the Tomcat installation).

To make "server.xml" changes, use the file in the Tomcat "conf" directory. Set up a <Context> definition inside the <Host> element for jOAI, and add context parameters as needed. For example:


	<Context path="/oai" docBase="oai" debug="0" reloadable="true">

		<Parameter

			name="repositoryData"

			value="/path/to/repository_settings_and_data"

			override="false" />

		<Parameter

			name="harvesterData"

			value="/path/to/harvester_settings_and_data"

			override="false" />

	</Context>

Any changes to these parameters requires a restart of Tomcat.

updateFrequency

This parameter defines the indexing interval for synching the data provider index with the files.

<Parameter name="updateFrequency" value="1440" override="false"/>

The value is in minutes.

hideAdminMenus

This parameter may be used to hide the 'Provider' and 'Harvester' administrative menus in the user interface, which may be desirable for some public installations of the software. Note that this only hides but does not disable or restrict access to those pages. See Enableing access control in Tomcat.

<Parameter name="hideAdminMenus" value="true" override="false"/>

Set to 'true' to hide the administrative menus from users.

dataProviderAccessLogLevel

This parameter controls when to log client (harvester) requests made to the data provider. The log is stored as an index and can be viewed from the provider status page (see Reports). The index is stored on disc and over time can grow large. To reduce or eliminate the write operations to this index use the 'FinalResumption' or 'NoLog' settings.

<Parameter name="dataProviderAccessLogLevel" value="FinalResumption" override="false"/>

Set to 'Full' to log all client interactions with the data provider. Set to 'FinalResumption' to log only client requests for the final segment of a ListRecords or ListIdentifiers request, indicating a complete harvest. Set to 'NoLog' to have no log written for client interactions with the data provider (this is the default if not set).

repositoryData

This parameter defines where the repository information is located on disc. Repository information includes the index of metadata files, metadata files configuration, sets information, repository name and email and other persistent data used by the data provider.

<Parameter name="repositoryData" value="/absolute/directory/path" override="false"/>

The value should be an absolute directory path.

harvesterData

This parameter defines where harvester information is located on disc. Harvester information includes an index of harvest history, the harvest configuration and other persistent data used by the harvester.

<Parameter name="harvesterData" value="/absolute/directory/path" override="false"/>

The value should be an absolute directory path.

zippedHarvestsDirectory

This parameter defines where zipped harvest files are saved to. The path specified should be relative to the context root.
An absolute path may also be specified, however this will mean the zip files will not be available for download via the web-based UI.

<Parameter name="zippedHarvestsDirectory" value="admin/zipped_harvests" override="false"/>

 

Additional configuration opations

See the jOAI web.xml file for notes and comments that describe additional configuration options.

 

Building from source

This software can be built directly from source. Obtain the current source distribution from the jOAI download page at DLESE (recommended). Alternatively, the latest development tree is available via anonymous CVS at the Digital Learning Sciences CVS repository on SourceForge. If obtaining from CVS, note that both the joai-project and dlese-tools-project are needed.

The BUILD_INSTRUCTIONS.txt contains detailed instructions about building jOAI from source.

 

 
University Corporation for Atmospheric Research (UCAR) National Science Foundation (NSF) Digital Library for Earth System Education (DLESE)