Menu
▾
▴
[Dlese-oai-project] CVS: oai-project/web/docs CHANGES.txt, 1.22, 1.23 configuring_joai.jsp, 1.6, 1.7 harvester.jsp, 1.15, 1.16 provider.jsp, 1.21, 1.22
|
From: John W. <jwe...@us...> - 2006-09-20 00:04:59
|
Update of /cvsroot/dlese/oai-project/web/docs In directory sc8-pr-cvs12.sourceforge.net:/tmp/cvs-serv3009/oai-project/web/docs Modified Files: CHANGES.txt configuring_joai.jsp harvester.jsp provider.jsp Log Message: -more documentation and FAQ Index: CHANGES.txt =================================================================== RCS file: /cvsroot/dlese/oai-project/web/docs/CHANGES.txt,v retrieving revision 1.22 retrieving revision 1.23 diff -C2 -r1.22 -r1.23 *** CHANGES.txt 15 Sep 2006 19:47:08 -0000 1.22 --- CHANGES.txt 20 Sep 2006 00:04:54 -0000 1.23 *************** *** 11,14 **** --- 11,15 ---- service responses as HTML comments rather than to the user + -Added additional FAQ and configuration documentation v3.0.4 Changes Index: configuring_joai.jsp =================================================================== RCS file: /cvsroot/dlese/oai-project/web/docs/configuring_joai.jsp,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -r1.6 -r1.7 *** configuring_joai.jsp 8 Sep 2006 01:24:29 -0000 1.6 --- configuring_joai.jsp 20 Sep 2006 00:04:54 -0000 1.7 *************** *** 98,101 **** --- 98,107 ---- </blockquote> <p>The value should be an absolute directory path.</p> + <p class="style2">zippedHarvestsDirectory</p> + <p>This parameter defines where zipped harvest files are saved to. The path specified should be relative to the context root.<br> + An absolute path may also be specified, however the zip files will not be available for download via the web-based UI.</p> + <blockquote> + <p class="code"><Parameter name="zippedHarvestsDirectory" value="admin/zipped_harvests" override="false"/></p> + </blockquote> <p> </p> <p><strong>Additional configuration opations </strong></p> Index: harvester.jsp =================================================================== RCS file: /cvsroot/dlese/oai-project/web/docs/harvester.jsp,v retrieving revision 1.15 retrieving revision 1.16 diff -C2 -r1.15 -r1.16 *** harvester.jsp 10 Sep 2006 19:13:46 -0000 1.15 --- harvester.jsp 20 Sep 2006 00:04:54 -0000 1.16 *************** *** 112,121 **** <a name="program"></a> <h3><strong>Use the harvester programmatically </strong></h3> ! <p>The harvester can be used programmatically within Java code. Examples and documentation are available in the <a href="<c:url value='/docs/javadoc/org/dlese/dpc/oai/harvester/Harvester.html'/>"> Harvester Javadoc</a>. To use, include DLESETools.jar, found in the lib directory of this distribution, in the classpath.</p> <p><a href="harvester.jsp#top"><img src="<c:url value='/images/arrowup.gif'/>" alt="top" width="9" height="11" border="0" title="back to top"></a></p> <hr> <h3><a name="faq" id="faq"></a>Frequently Asked Questions (FAQ) </h3> ! <p><strong>Can I use jOAI to import records into a database?</strong></p> ! <p>The jOAI harvester saves all harvested records to individual files on the file system. To import records into a database, first configure the harvester to save files to a convenient directory at regular intervals, such as once a day. Write a routine to monitor the file directory and add, update or delete the corresponding records to the database when changes occur in the files. </p> <p><strong>Does the harvester support selective or incremental harvesting?</strong></p> <p>Yes. When an automatic harvest is conducted at regular intervals, the harvester checks if the data provider supports deleted records. If deletions are supported, a <a href="http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm#Datestamp" target="_blank">selective harvest</a> --- 112,123 ---- <a name="program"></a> <h3><strong>Use the harvester programmatically </strong></h3> ! <p>The Harvester API may be used programmatically within Java code. Examples and documentation are available in the <a href="<c:url value='/docs/javadoc/org/dlese/dpc/oai/harvester/Harvester.html'/>"> Harvester Javadoc</a>. To use, include DLESETools.jar, found in the lib directory of this distribution, in the classpath.</p> <p><a href="harvester.jsp#top"><img src="<c:url value='/images/arrowup.gif'/>" alt="top" width="9" height="11" border="0" title="back to top"></a></p> <hr> <h3><a name="faq" id="faq"></a>Frequently Asked Questions (FAQ) </h3> ! <p><strong>Can I use jOAI to harvest records into a database?</strong></p> ! <p>There are two ways in which the harvester may be used to import records into a database.</p> ! <p>The first method, which uses the regular jOAI web application, requires two parts. First, configure the jOAI harvester to save files to a convenient directory at regular intervals, such as once a day. Then, write a routine to monitor the file directory and add, update or delete the corresponding records to the database when changes occur in the files. </p> ! <p>Another method uses the Harvester API from within native Java code to perform harvests and import metadata records directly into a database. See the section titled <a href="#program">Use the harvester programmatically</a> above. </p> <p><strong>Does the harvester support selective or incremental harvesting?</strong></p> <p>Yes. When an automatic harvest is conducted at regular intervals, the harvester checks if the data provider supports deleted records. If deletions are supported, a <a href="http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm#Datestamp" target="_blank">selective harvest</a> Index: provider.jsp =================================================================== RCS file: /cvsroot/dlese/oai-project/web/docs/provider.jsp,v retrieving revision 1.21 retrieving revision 1.22 diff -C2 -r1.21 -r1.22 *** provider.jsp 9 Sep 2006 02:24:17 -0000 1.21 --- provider.jsp 20 Sep 2006 00:04:54 -0000 1.22 *************** *** 207,213 **** <p><strong>How many records can the data provider scale to?</strong></p> <p>The jOAI data provider is designed for small to medium size data repositories. The software has been tested successfully with repositories up to 300,000 records. The number of records the software can support depends on the amount of memory available to the Java JVM, the speed of the host machine and the size of the individual records in the repository.</p> <p><strong>The baseURL that is shown uses the local machine name, but it should use the domain name for the server instead. How can I change it?</strong></p> ! <p>The base URL that is shown on the <a href="<c:url value='/'/>">front page</a> and <a href="<c:url value='/admin/data-provider-info.do'/>">Repository Information page</a> of jOAI and elsewhere reflects the URL that was entered into the web browser when connecting to the software. For example, if a user accesses jOAI using the web address http://localhost:8080${pageContext.request.contextPath}, the baseURL will be shown as 'http://localhost:8080${pageContext.request.contextPath}/${initParam.dataProviderBaseUrlPathEnding}'. If the user connects to the same instance of jOAI using the Internet address http://myserver.somewhere.edu${pageContext.request.contextPath}, the baseURL will be shown as ! 'http://myserver.somewhere.edu${pageContext.request.contextPath}/${initParam.dataProviderBaseUrlPathEnding}'. </p> <p> </p> <p><a href="provider.jsp#top"> <img src="<c:url value='/images/arrowup.gif'/>" alt="top" width="9" height="11" border="0" title="back to top"></a></p> --- 207,215 ---- <p><strong>How many records can the data provider scale to?</strong></p> <p>The jOAI data provider is designed for small to medium size data repositories. The software has been tested successfully with repositories up to 300,000 records. The number of records the software can support depends on the amount of memory available to the Java JVM, the speed of the host machine and the size of the individual records in the repository.</p> + <p><strong>Can jOAI be configured to run from a virtual host that is served by apache (httpd)?</strong></p> + <p>In some cases it may be desirable to map jOAI to a virtual host web address and have it served by an apache web server (httpd). For example, a virtual host web address such as http://oai.somewhere.edu may be preferred to a standard Tomcat address such as http://somewhere.edu:8080/oai/, and functionality available from the apache web server such as consistent web logging or SSL may also be desired. </p> + <p>The <a href="http://tomcat.apache.org/connectors-doc/" target="_blank">Apache Tomcat Connector</a> (mod_jk) is used for this purpose by proxing requests made to an apache web server through to Tomcat. Using the connector, a rule may be set up that says, in effect, 'for all requests that come to http://oai.somewhere.edu, serve them from the Tomcat context http://somewhere.edu:8080/oai/'. Setting up mod_jk takes some work, which is described in the <a href="http://tomcat.apache.org/connectors-doc/" target="_blank">Apache Tomcat Connector documentation</a>. </p> <p><strong>The baseURL that is shown uses the local machine name, but it should use the domain name for the server instead. How can I change it?</strong></p> ! <p>The base URL that is shown on the <a href="<c:url value='/'/>">front page</a> and <a href="<c:url value='/admin/data-provider-info.do'/>">Repository Information page</a> of jOAI and elsewhere reflects the URL that was entered into the web browser when connecting to the software. For example, if a user accesses jOAI using the web address http://localhost:8080${pageContext.request.contextPath}, the baseURL will be shown as 'http://localhost:8080${pageContext.request.contextPath}/${initParam.dataProviderBaseUrlPathEnding}'. If the user connects to the same instance of jOAI using the Internet address http://myserver.somewhere.edu${pageContext.request.contextPath}, the baseURL will be shown as 'http://myserver.somewhere.edu${pageContext.request.contextPath}/${initParam.dataProviderBaseUrlPathEnding}'. </p> <p> </p> <p><a href="provider.jsp#top"> <img src="<c:url value='/images/arrowup.gif'/>" alt="top" width="9" height="11" border="0" title="back to top"></a></p> |