source: other-projects/trunk/gs3-webservices-democlient/docs/GSearchInstaller/doc/org/greenstone/fedora/installer/GSearchInstaller.html@ 15736

Last change on this file since 15736 was 15736, checked in by ak19, 16 years ago

GSearchInstaller.jar executable, src code, docs

File size: 56.4 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.5.0_10) on Tue May 27 15:03:46 NZST 2008 -->
6<TITLE>
7GSearchInstaller
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.fedora.installer.GSearchInstaller class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="GSearchInstaller";
18}
19</SCRIPT>
20<NOSCRIPT>
21</NOSCRIPT>
22
23</HEAD>
24
25<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28<!-- ========= START OF TOP NAVBAR ======= -->
29<A NAME="navbar_top"><!-- --></A>
30<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32<TR>
33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34<A NAME="navbar_top_firstrow"><!-- --></A>
35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/greenstone/fedora/installer/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
43 </TR>
44</TABLE>
45</TD>
46<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
47</EM>
48</TD>
49</TR>
50
51<TR>
52<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
53&nbsp;PREV CLASS&nbsp;
54&nbsp;<A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.IgnoreDTDEntityResolver.html" title="class in org.greenstone.fedora.installer"><B>NEXT CLASS</B></A></FONT></TD>
55<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56 <A HREF="../../../../index.html?org/greenstone/fedora/installer/GSearchInstaller.html" target="_top"><B>FRAMES</B></A> &nbsp;
57&nbsp;<A HREF="GSearchInstaller.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
58&nbsp;<SCRIPT type="text/javascript">
59 <!--
60 if(window==top) {
61 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
62 }
63 //-->
64</SCRIPT>
65<NOSCRIPT>
66 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
67</NOSCRIPT>
68
69
70</FONT></TD>
71</TR>
72<TR>
73<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
76DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
77</TR>
78</TABLE>
79<A NAME="skip-navbar_top"></A>
80<!-- ========= END OF TOP NAVBAR ========= -->
81
82<HR>
83<!-- ======== START OF CLASS DATA ======== -->
84<H2>
85<FONT SIZE="-1">
86org.greenstone.fedora.installer</FONT>
87<BR>
88Class GSearchInstaller</H2>
89<PRE>
90java.lang.Object
91 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.fedora.installer.GSearchInstaller</B>
92</PRE>
93<HR>
94<DL>
95<DT><PRE>public class <B>GSearchInstaller</B><DT>extends java.lang.Object</DL>
96</PRE>
97
98<P>
99This class essentially follows the instructions at
100 http://drama.ramp.org.au/cgi-bin/trac.cgi/wiki/InstallingFedoraGSearch
101 in order to install Fedora Generic Search from their optimised
102 fedoragsearch.war file. (I've also tested it on the original war file
103 fedoragsearch.war available from http://defxws2006.cvt.dk/fedoragsearch/
104 and it works.)
105 It then does a few minor extra things in order to make Fedora Generic
106 Search work specifically with a Fedora repository of Greenstone documents.
107<P>
108
109<P>
110<DL>
111<DT><B>Author:</B></DT>
112 <DD>ak19</DD>
113</DL>
114<HR>
115
116<P>
117<!-- ======== NESTED CLASS SUMMARY ======== -->
118
119<A NAME="nested_class_summary"><!-- --></A>
120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
123<B>Nested Class Summary</B></FONT></TH>
124</TR>
125<TR BGCOLOR="white" CLASS="TableRowColor">
126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127<CODE>(package private) static&nbsp;class</CODE></FONT></TD>
128<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.IgnoreDTDEntityResolver.html" title="class in org.greenstone.fedora.installer">GSearchInstaller.IgnoreDTDEntityResolver</A></B></CODE>
129
130<BR>
131&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This EntityResolver allows the XML parser to ignore validating
132 against the DTD specified in the XML since it is pointing to the
133 wrong location.</TD>
134</TR>
135</TABLE>
136&nbsp;<!-- =========== FIELD SUMMARY =========== -->
137
138<A NAME="field_summary"><!-- --></A>
139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
142<B>Field Summary</B></FONT></TH>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#CATALINA_HOME">CATALINA_HOME</A></B></CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>protected static&nbsp;java.util.Properties</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#defaults">defaults</A></B></CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default initialisation/customisation values.</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#FEDORA_HOME">FEDORA_HOME</A></B></CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
167</TR>
168<TR BGCOLOR="white" CLASS="TableRowColor">
169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
170<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
171<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#FEDORAGSEARCH">FEDORAGSEARCH</A></B></CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
175</TR>
176<TR BGCOLOR="white" CLASS="TableRowColor">
177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
178<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
179<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#fedoraPassword">fedoraPassword</A></B></CODE>
180
181<BR>
182&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
183</TR>
184<TR BGCOLOR="white" CLASS="TableRowColor">
185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
186<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
187<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#fedoraUsername">fedoraUsername</A></B></CODE>
188
189<BR>
190&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>protected &nbsp;java.util.Properties</CODE></FONT></TD>
195<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#gSearchProperties">gSearchProperties</A></B></CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads from gsearch.properties file which contains default
199 directory paths (using variables like FEDORA_HOME and
200 CATALINA_HOME) and HOST and PORT, and sets these to custom values.</TD>
201</TR>
202<TR BGCOLOR="white" CLASS="TableRowColor">
203<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
204<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
205<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#gsearchWarFileName">gsearchWarFileName</A></B></CODE>
206
207<BR>
208&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
209</TR>
210<TR BGCOLOR="white" CLASS="TableRowColor">
211<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
212<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
213<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#host">host</A></B></CODE>
214
215<BR>
216&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
217</TR>
218<TR BGCOLOR="white" CLASS="TableRowColor">
219<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
220<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
221<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#indexName">indexName</A></B></CODE>
222
223<BR>
224&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
229<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#port">port</A></B></CODE>
230
231<BR>
232&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
233</TR>
234<TR BGCOLOR="white" CLASS="TableRowColor">
235<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
236<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
237<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#PROP_FILE">PROP_FILE</A></B></CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
245<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#PROP_HOST">PROP_HOST</A></B></CODE>
246
247<BR>
248&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
249</TR>
250<TR BGCOLOR="white" CLASS="TableRowColor">
251<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
252<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
253<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#PROP_INDEX">PROP_INDEX</A></B></CODE>
254
255<BR>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#PROP_PASSW">PROP_PASSW</A></B></CODE>
262
263<BR>
264&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
265</TR>
266<TR BGCOLOR="white" CLASS="TableRowColor">
267<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
268<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
269<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#PROP_PORT">PROP_PORT</A></B></CODE>
270
271<BR>
272&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
273</TR>
274<TR BGCOLOR="white" CLASS="TableRowColor">
275<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
276<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
277<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#PROP_REPOS">PROP_REPOS</A></B></CODE>
278
279<BR>
280&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
281</TR>
282<TR BGCOLOR="white" CLASS="TableRowColor">
283<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
284<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
285<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#PROP_UNAME">PROP_UNAME</A></B></CODE>
286
287<BR>
288&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
292<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
293<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#repositoryName">repositoryName</A></B></CODE>
294
295<BR>
296&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
297</TR>
298<TR BGCOLOR="white" CLASS="TableRowColor">
299<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
300<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
301<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#scriptExtension">scriptExtension</A></B></CODE>
302
303<BR>
304&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
305</TR>
306<TR BGCOLOR="white" CLASS="TableRowColor">
307<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
308<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
309<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#TOMCAT">TOMCAT</A></B></CODE>
310
311<BR>
312&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
313</TR>
314</TABLE>
315&nbsp;
316<!-- ======== CONSTRUCTOR SUMMARY ======== -->
317
318<A NAME="constructor_summary"><!-- --></A>
319<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
320<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
321<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
322<B>Constructor Summary</B></FONT></TH>
323</TR>
324<TR BGCOLOR="white" CLASS="TableRowColor">
325<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#GSearchInstaller()">GSearchInstaller</A></B>()</CODE>
326
327<BR>
328&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;GSearchInstaller constructor sets all custom values to defaults</TD>
329</TR>
330<TR BGCOLOR="white" CLASS="TableRowColor">
331<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#GSearchInstaller(java.util.Properties)">GSearchInstaller</A></B>(java.util.Properties&nbsp;options)</CODE>
332
333<BR>
334&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;GSearchInstaller constructor sets the custom values</TD>
335</TR>
336</TABLE>
337&nbsp;
338<!-- ========== METHOD SUMMARY =========== -->
339
340<A NAME="method_summary"><!-- --></A>
341<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
342<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
343<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
344<B>Method Summary</B></FONT></TH>
345</TR>
346<TR BGCOLOR="white" CLASS="TableRowColor">
347<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
348<CODE>protected &nbsp;void</CODE></FONT></TD>
349<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#copyPropFile(java.util.Properties, java.lang.String, java.io.File)">copyPropFile</A></B>(java.util.Properties&nbsp;properties,
350 java.lang.String&nbsp;propFileName,
351 java.io.File&nbsp;outputPath)</CODE>
352
353<BR>
354&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Stores the given properties in the file outputPath/propFileName.</TD>
355</TR>
356<TR BGCOLOR="white" CLASS="TableRowColor">
357<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
358<CODE>protected &nbsp;void</CODE></FONT></TD>
359<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#copyTemplateFile(java.lang.String, java.io.File, boolean)">copyTemplateFile</A></B>(java.lang.String&nbsp;src,
360 java.io.File&nbsp;dest,
361 boolean&nbsp;replace)</CODE>
362
363<BR>
364&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies internal template src file (in executable jar) to dest file.</TD>
365</TR>
366<TR BGCOLOR="white" CLASS="TableRowColor">
367<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
368<CODE>protected &nbsp;void</CODE></FONT></TD>
369<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#createLuceneIndexDir()">createLuceneIndexDir</A></B>()</CODE>
370
371<BR>
372&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the Lucene index directory in the right location inside
373 FEDORA_HOME into which FedoraGSearch will store the indexes for
374 the Greenstone contents in the Fedora repository.</TD>
375</TR>
376<TR BGCOLOR="white" CLASS="TableRowColor">
377<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
378<CODE>protected &nbsp;void</CODE></FONT></TD>
379<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#customiseFedoraConfigFile()">customiseFedoraConfigFile</A></B>()</CODE>
380
381<BR>
382&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Makes changes to the fedora.fcfg file located inside FEDORA_HOME.</TD>
383</TR>
384<TR BGCOLOR="white" CLASS="TableRowColor">
385<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
386<CODE>protected &nbsp;java.util.Properties</CODE></FONT></TD>
387<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#customiseProperties(java.lang.String, boolean)">customiseProperties</A></B>(java.lang.String&nbsp;propFileName,
388 boolean&nbsp;display)</CODE>
389
390<BR>
391&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads properties from the property file denoted by propFileName
392 and replaces all place-holders (such as FEDORA_HOME, CATALINA_HOME,
393 HOST, PORT) with the custom values specified for this installation.</TD>
394</TR>
395<TR BGCOLOR="white" CLASS="TableRowColor">
396<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
397<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
398<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#elementToFormattedString(org.w3c.dom.Element, java.lang.String)">elementToFormattedString</A></B>(org.w3c.dom.Element&nbsp;e,
399 java.lang.String&nbsp;dtd_SystemId)</CODE>
400
401<BR>
402&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given an Element, this will return its String representation properly
403 indented for display.</TD>
404</TR>
405<TR BGCOLOR="white" CLASS="TableRowColor">
406<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
407<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
408<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#getSafeValue(javax.swing.JTextField, java.lang.String)">getSafeValue</A></B>(javax.swing.JTextField&nbsp;field,
409 java.lang.String&nbsp;property)</CODE>
410
411<BR>
412&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns the value of the textfield for the given
413 GSearchInstaller initialiser property, if this is not the empty string.</TD>
414</TR>
415<TR BGCOLOR="white" CLASS="TableRowColor">
416<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
417<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
418<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#getValue(org.w3c.dom.Element)">getValue</A></B>(org.w3c.dom.Element&nbsp;e)</CODE>
419
420<BR>
421&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extract the text from an element, if any.</TD>
422</TR>
423<TR BGCOLOR="white" CLASS="TableRowColor">
424<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
425<CODE>&nbsp;void</CODE></FONT></TD>
426<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#indexGreenstoneContents(boolean)">indexGreenstoneContents</A></B>(boolean&nbsp;emptyFirst)</CODE>
427
428<BR>
429&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indexes the contents of the repository(name) specified during Fedora
430 Generic Search installation.</TD>
431</TR>
432<TR BGCOLOR="white" CLASS="TableRowColor">
433<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
434<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
435<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#info()">info</A></B>()</CODE>
436
437<BR>
438&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
439</TR>
440<TR BGCOLOR="white" CLASS="TableRowColor">
441<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
442<CODE>&nbsp;void</CODE></FONT></TD>
443<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#install()">install</A></B>()</CODE>
444
445<BR>
446&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
447</TR>
448<TR BGCOLOR="white" CLASS="TableRowColor">
449<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
450<CODE>static&nbsp;void</CODE></FONT></TD>
451<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
452
453<BR>
454&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The main method creates a GSearchInstaller to install Fedora Generic
455 Search from a (Muradora) fedoragsearch.war file.</TD>
456</TR>
457<TR BGCOLOR="white" CLASS="TableRowColor">
458<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
459<CODE>protected &nbsp;void</CODE></FONT></TD>
460<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#moveUnpackWarFile(java.io.File)">moveUnpackWarFile</A></B>(java.io.File&nbsp;gsearchWarFile)</CODE>
461
462<BR>
463&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Moves the (fedoragsearch.war) war file from the given location
464 into FEDORA_HOME's tomcat folder (i.e.</TD>
465</TR>
466<TR BGCOLOR="white" CLASS="TableRowColor">
467<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
468<CODE>static&nbsp;java.util.Properties</CODE></FONT></TD>
469<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#parseInstallationArgs(java.lang.String[])">parseInstallationArgs</A></B>(java.lang.String[]&nbsp;args)</CODE>
470
471<BR>
472&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called to process multiple command line arguments where these
473 arguments are GSearchInstaller constructor options followed by
474 their values.</TD>
475</TR>
476<TR BGCOLOR="white" CLASS="TableRowColor">
477<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
478<CODE>protected &nbsp;org.w3c.dom.Document</CODE></FONT></TD>
479<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#readXML(java.lang.Object, java.lang.String, java.lang.String)">readXML</A></B>(java.lang.Object&nbsp;xmlSource,
480 java.lang.String&nbsp;dtd_SystemId,
481 java.lang.String&nbsp;sourceFileName)</CODE>
482
483<BR>
484&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reads from an xmlFile.</TD>
485</TR>
486<TR BGCOLOR="white" CLASS="TableRowColor">
487<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
488<CODE>protected &nbsp;boolean</CODE></FONT></TD>
489<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#replaceDir(java.lang.String, java.lang.String, java.lang.String)">replaceDir</A></B>(java.lang.String&nbsp;outputPath,
490 java.lang.String&nbsp;src,
491 java.lang.String&nbsp;dest)</CODE>
492
493<BR>
494&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method that renames folder src in outputPath to dest.</TD>
495</TR>
496<TR BGCOLOR="white" CLASS="TableRowColor">
497<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
498<CODE>protected &nbsp;boolean</CODE></FONT></TD>
499<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#replaceElementWithAttrValue(org.w3c.dom.Document, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)">replaceElementWithAttrValue</A></B>(org.w3c.dom.Document&nbsp;doc,
500 java.lang.String&nbsp;tagName,
501 java.lang.String&nbsp;attrName,
502 java.lang.String&nbsp;attrValueContent,
503 java.lang.String&nbsp;replacementContent,
504 boolean&nbsp;onceOnly,
505 boolean&nbsp;wholeItem)</CODE>
506
507<BR>
508&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given a DOM document, finds the first element where nodeName=tagName
509 where one of the attributes has the name attrName and whose value
510 contains attrValueContent.</TD>
511</TR>
512<TR BGCOLOR="white" CLASS="TableRowColor">
513<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
514<CODE>protected &nbsp;boolean</CODE></FONT></TD>
515<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#replaceElementWithValue(org.w3c.dom.Document, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)">replaceElementWithValue</A></B>(org.w3c.dom.Document&nbsp;doc,
516 java.lang.String&nbsp;tagName,
517 java.lang.String&nbsp;contentValue,
518 java.lang.String&nbsp;replacement,
519 boolean&nbsp;onceOnly,
520 boolean&nbsp;wholeItem)</CODE>
521
522<BR>
523&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Given a DOM document, finds the first element where nodeName=tagName
524 and where the element's inner text contains the string contentValue.</TD>
525</TR>
526<TR BGCOLOR="white" CLASS="TableRowColor">
527<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
528<CODE>protected &nbsp;int</CODE></FONT></TD>
529<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#runProcess(java.lang.String[], boolean)">runProcess</A></B>(java.lang.String[]&nbsp;args,
530 boolean&nbsp;ignoreWindows)</CODE>
531
532<BR>
533&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Method that will run the process associated with the gSearchProperties key.</TD>
534</TR>
535<TR BGCOLOR="white" CLASS="TableRowColor">
536<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
537<CODE>static&nbsp;java.util.Properties</CODE></FONT></TD>
538<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#showInputDialog()">showInputDialog</A></B>()</CODE>
539
540<BR>
541&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Displays a dialog to get user input for
542 - fedora server host, port, username and password,
543 - the names for the fedora generic search index and repository
544 that are to be created, and
545 - for the location of fedoragenericsearch.war (the installer is
546 meant to work specifically with Muradora's fedoragenericsearch.war
547 since they have edited various property and xml files to make it
548 all easier).</TD>
549</TR>
550<TR BGCOLOR="white" CLASS="TableRowColor">
551<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
552<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
553<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#usage()">usage</A></B>()</CODE>
554
555<BR>
556&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If the program is run from the command line and the user executed
557 it with -help or help, then this usage String is displayed.</TD>
558</TR>
559<TR BGCOLOR="white" CLASS="TableRowColor">
560<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
561<CODE>&nbsp;void</CODE></FONT></TD>
562<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#waitForFedoraServer()">waitForFedoraServer</A></B>()</CODE>
563
564<BR>
565&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Waits for the fedora server to be ready after a server start.</TD>
566</TR>
567<TR BGCOLOR="white" CLASS="TableRowColor">
568<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
569<CODE>&nbsp;void</CODE></FONT></TD>
570<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#waitForServerToStop()">waitForServerToStop</A></B>()</CODE>
571
572<BR>
573&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Waits for the fedora server to stop</TD>
574</TR>
575<TR BGCOLOR="white" CLASS="TableRowColor">
576<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
577<CODE>protected &nbsp;void</CODE></FONT></TD>
578<TD><CODE><B><A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.html#writeXML(org.w3c.dom.Document, java.io.File, java.lang.String)">writeXML</A></B>(org.w3c.dom.Document&nbsp;doc,
579 java.io.File&nbsp;xmlFile,
580 java.lang.String&nbsp;dtdToAddBackIn)</CODE>
581
582<BR>
583&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Writes out a DOM structure to a file.</TD>
584</TR>
585</TABLE>
586&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
587<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
588<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
589<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
590</TR>
591<TR BGCOLOR="white" CLASS="TableRowColor">
592<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
593</TR>
594</TABLE>
595&nbsp;
596<P>
597
598<!-- ============ FIELD DETAIL =========== -->
599
600<A NAME="field_detail"><!-- --></A>
601<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
602<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
603<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
604<B>Field Detail</B></FONT></TH>
605</TR>
606</TABLE>
607
608<A NAME="FEDORAGSEARCH"><!-- --></A><H3>
609FEDORAGSEARCH</H3>
610<PRE>
611public static final java.lang.String <B>FEDORAGSEARCH</B></PRE>
612<DL>
613<DL>
614<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.installer.GSearchInstaller.FEDORAGSEARCH">Constant Field Values</A></DL>
615</DL>
616<HR>
617
618<A NAME="TOMCAT"><!-- --></A><H3>
619TOMCAT</H3>
620<PRE>
621public static final java.lang.String <B>TOMCAT</B></PRE>
622<DL>
623<DL>
624<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.greenstone.fedora.installer.GSearchInstaller.TOMCAT">Constant Field Values</A></DL>
625</DL>
626<HR>
627
628<A NAME="FEDORA_HOME"><!-- --></A><H3>
629FEDORA_HOME</H3>
630<PRE>
631public final java.lang.String <B>FEDORA_HOME</B></PRE>
632<DL>
633<DL>
634</DL>
635</DL>
636<HR>
637
638<A NAME="CATALINA_HOME"><!-- --></A><H3>
639CATALINA_HOME</H3>
640<PRE>
641public final java.lang.String <B>CATALINA_HOME</B></PRE>
642<DL>
643<DL>
644</DL>
645</DL>
646<HR>
647
648<A NAME="scriptExtension"><!-- --></A><H3>
649scriptExtension</H3>
650<PRE>
651public final java.lang.String <B>scriptExtension</B></PRE>
652<DL>
653<DL>
654</DL>
655</DL>
656<HR>
657
658<A NAME="gSearchProperties"><!-- --></A><H3>
659gSearchProperties</H3>
660<PRE>
661protected java.util.Properties <B>gSearchProperties</B></PRE>
662<DL>
663<DD>Reads from gsearch.properties file which contains default
664 directory paths (using variables like FEDORA_HOME and
665 CATALINA_HOME) and HOST and PORT, and sets these to custom values.
666 Some of the keys in the properties file include executable
667 processes (such as for starting and stopping tomcat).
668<P>
669<DL>
670</DL>
671</DL>
672<HR>
673
674<A NAME="indexName"><!-- --></A><H3>
675indexName</H3>
676<PRE>
677public final java.lang.String <B>indexName</B></PRE>
678<DL>
679<DL>
680</DL>
681</DL>
682<HR>
683
684<A NAME="repositoryName"><!-- --></A><H3>
685repositoryName</H3>
686<PRE>
687public final java.lang.String <B>repositoryName</B></PRE>
688<DL>
689<DL>
690</DL>
691</DL>
692<HR>
693
694<A NAME="host"><!-- --></A><H3>
695host</H3>
696<PRE>
697public final java.lang.String <B>host</B></PRE>
698<DL>
699<DL>
700</DL>
701</DL>
702<HR>
703
704<A NAME="port"><!-- --></A><H3>
705port</H3>
706<PRE>
707public final java.lang.String <B>port</B></PRE>
708<DL>
709<DL>
710</DL>
711</DL>
712<HR>
713
714<A NAME="fedoraUsername"><!-- --></A><H3>
715fedoraUsername</H3>
716<PRE>
717public final java.lang.String <B>fedoraUsername</B></PRE>
718<DL>
719<DL>
720</DL>
721</DL>
722<HR>
723
724<A NAME="fedoraPassword"><!-- --></A><H3>
725fedoraPassword</H3>
726<PRE>
727public final java.lang.String <B>fedoraPassword</B></PRE>
728<DL>
729<DL>
730</DL>
731</DL>
732<HR>
733
734<A NAME="gsearchWarFileName"><!-- --></A><H3>
735gsearchWarFileName</H3>
736<PRE>
737public final java.lang.String <B>gsearchWarFileName</B></PRE>
738<DL>
739<DL>
740</DL>
741</DL>
742<HR>
743
744<A NAME="PROP_REPOS"><!-- --></A><H3>
745PROP_REPOS</H3>
746<PRE>
747protected static java.lang.String <B>PROP_REPOS</B></PRE>
748<DL>
749<DL>
750</DL>
751</DL>
752<HR>
753
754<A NAME="PROP_INDEX"><!-- --></A><H3>
755PROP_INDEX</H3>
756<PRE>
757protected static java.lang.String <B>PROP_INDEX</B></PRE>
758<DL>
759<DL>
760</DL>
761</DL>
762<HR>
763
764<A NAME="PROP_UNAME"><!-- --></A><H3>
765PROP_UNAME</H3>
766<PRE>
767protected static java.lang.String <B>PROP_UNAME</B></PRE>
768<DL>
769<DL>
770</DL>
771</DL>
772<HR>
773
774<A NAME="PROP_PASSW"><!-- --></A><H3>
775PROP_PASSW</H3>
776<PRE>
777protected static java.lang.String <B>PROP_PASSW</B></PRE>
778<DL>
779<DL>
780</DL>
781</DL>
782<HR>
783
784<A NAME="PROP_HOST"><!-- --></A><H3>
785PROP_HOST</H3>
786<PRE>
787protected static java.lang.String <B>PROP_HOST</B></PRE>
788<DL>
789<DL>
790</DL>
791</DL>
792<HR>
793
794<A NAME="PROP_PORT"><!-- --></A><H3>
795PROP_PORT</H3>
796<PRE>
797protected static java.lang.String <B>PROP_PORT</B></PRE>
798<DL>
799<DL>
800</DL>
801</DL>
802<HR>
803
804<A NAME="PROP_FILE"><!-- --></A><H3>
805PROP_FILE</H3>
806<PRE>
807protected static java.lang.String <B>PROP_FILE</B></PRE>
808<DL>
809<DL>
810</DL>
811</DL>
812<HR>
813
814<A NAME="defaults"><!-- --></A><H3>
815defaults</H3>
816<PRE>
817protected static final java.util.Properties <B>defaults</B></PRE>
818<DL>
819<DD>Default initialisation/customisation values. In case the Installer
820 was not provided all parameters, these are used as fallback values
821<P>
822<DL>
823</DL>
824</DL>
825
826<!-- ========= CONSTRUCTOR DETAIL ======== -->
827
828<A NAME="constructor_detail"><!-- --></A>
829<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
830<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
831<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
832<B>Constructor Detail</B></FONT></TH>
833</TR>
834</TABLE>
835
836<A NAME="GSearchInstaller()"><!-- --></A><H3>
837GSearchInstaller</H3>
838<PRE>
839public <B>GSearchInstaller</B>()
840 throws java.lang.Exception</PRE>
841<DL>
842<DD>GSearchInstaller constructor sets all custom values to defaults
843<P>
844<DL>
845
846<DT><B>Throws:</B>
847<DD><CODE>java.lang.Exception</CODE></DL>
848</DL>
849<HR>
850
851<A NAME="GSearchInstaller(java.util.Properties)"><!-- --></A><H3>
852GSearchInstaller</H3>
853<PRE>
854public <B>GSearchInstaller</B>(java.util.Properties&nbsp;options)
855 throws java.lang.Exception</PRE>
856<DL>
857<DD>GSearchInstaller constructor sets the custom values
858<P>
859<DL>
860
861<DT><B>Throws:</B>
862<DD><CODE>java.lang.Exception</CODE></DL>
863</DL>
864
865<!-- ============ METHOD DETAIL ========== -->
866
867<A NAME="method_detail"><!-- --></A>
868<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
869<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
870<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
871<B>Method Detail</B></FONT></TH>
872</TR>
873</TABLE>
874
875<A NAME="install()"><!-- --></A><H3>
876install</H3>
877<PRE>
878public void <B>install</B>()
879 throws java.lang.Exception</PRE>
880<DL>
881<DD><DL>
882
883<DT><B>Throws:</B>
884<DD><CODE>java.lang.Exception</CODE></DL>
885</DD>
886</DL>
887<HR>
888
889<A NAME="indexGreenstoneContents(boolean)"><!-- --></A><H3>
890indexGreenstoneContents</H3>
891<PRE>
892public void <B>indexGreenstoneContents</B>(boolean&nbsp;emptyFirst)
893 throws java.lang.Exception</PRE>
894<DL>
895<DD>Indexes the contents of the repository(name) specified during Fedora
896 Generic Search installation. To do so, it runs the FedoraGenericSearch's
897 runSOAPClient.sh with "host:port updateIndex fromFoxmlFiles".
898<P>
899<DD><DL>
900<DT><B>Parameters:</B><DD><CODE>emptyFirst</CODE> - means the index will be created from scratch by first
901 executing runSOAPClient.sh with the arguments
902 "host:port updateIndex createEmpty" before updating from FOXML files.
903<DT><B>Throws:</B>
904<DD><CODE>java.lang.Exception</CODE></DL>
905</DD>
906</DL>
907<HR>
908
909<A NAME="runProcess(java.lang.String[], boolean)"><!-- --></A><H3>
910runProcess</H3>
911<PRE>
912protected int <B>runProcess</B>(java.lang.String[]&nbsp;args,
913 boolean&nbsp;ignoreWindows)
914 throws java.lang.Exception</PRE>
915<DL>
916<DD>Method that will run the process associated with the gSearchProperties key.
917 Waits until the process is executed.
918<P>
919<DD><DL>
920<DT><B>Parameters:</B><DD><CODE>args</CODE> - signify the executable process and its arguments. The first element
921 must be the key into gSearchProperties whose value denotes the executable process
922 that is to be run. Subsequent elements are the actual arguments to that process.<DD><CODE>ignoreWindows</CODE> - if true will not plug the cmd /c start "" at the start of
923 the arguments. If false, and only of the OS is windows, then these additional
924 arguments get prepended to those already in the args array.
925<DT><B>Throws:</B>
926<DD><CODE>java.lang.Exception</CODE></DL>
927</DD>
928</DL>
929<HR>
930
931<A NAME="customiseProperties(java.lang.String, boolean)"><!-- --></A><H3>
932customiseProperties</H3>
933<PRE>
934protected java.util.Properties <B>customiseProperties</B>(java.lang.String&nbsp;propFileName,
935 boolean&nbsp;display)
936 throws java.lang.Exception</PRE>
937<DL>
938<DD>Loads properties from the property file denoted by propFileName
939 and replaces all place-holders (such as FEDORA_HOME, CATALINA_HOME,
940 HOST, PORT) with the custom values specified for this installation.
941 These customised properties are returned in the Properties map.
942 Never overwrite the property file given by propFileName!
943 They are defaults, meant to be customised elsewhere.
944<P>
945<DD><DL>
946<DT><B>Parameters:</B><DD><CODE>propFileName</CODE> - is the name of the template properties file
947 to be opened and read from. (Keep it read-only!)<DD><CODE>display</CODE> - - if true, then prints the contents of the properties
948 if false, does not.
949<DT><B>Returns:</B><DD>the properties in the template properties file
950 customised with the values provided during installation.
951<DT><B>Throws:</B>
952<DD><CODE>java.lang.Exception</CODE></DL>
953</DD>
954</DL>
955<HR>
956
957<A NAME="waitForServerToStop()"><!-- --></A><H3>
958waitForServerToStop</H3>
959<PRE>
960public void <B>waitForServerToStop</B>()
961 throws java.lang.Exception</PRE>
962<DL>
963<DD>Waits for the fedora server to stop
964<P>
965<DD><DL>
966
967<DT><B>Throws:</B>
968<DD><CODE>java.lang.Exception</CODE></DL>
969</DD>
970</DL>
971<HR>
972
973<A NAME="waitForFedoraServer()"><!-- --></A><H3>
974waitForFedoraServer</H3>
975<PRE>
976public void <B>waitForFedoraServer</B>()
977 throws java.lang.Exception</PRE>
978<DL>
979<DD>Waits for the fedora server to be ready after a server start.
980<P>
981<DD><DL>
982
983<DT><B>Throws:</B>
984<DD><CODE>java.lang.Exception</CODE></DL>
985</DD>
986</DL>
987<HR>
988
989<A NAME="replaceDir(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
990replaceDir</H3>
991<PRE>
992protected boolean <B>replaceDir</B>(java.lang.String&nbsp;outputPath,
993 java.lang.String&nbsp;src,
994 java.lang.String&nbsp;dest)</PRE>
995<DL>
996<DD>Method that renames folder src in outputPath to dest.
997<P>
998<DD><DL>
999<DT><B>Parameters:</B><DD><CODE>outputPath</CODE> - is the directory in which src resides.<DD><CODE>src</CODE> - is the name of the folder in outputPath that is
1000 to be renamed.<DD><CODE>dest</CODE> - is what src is to be renamed to.</DL>
1001</DD>
1002</DL>
1003<HR>
1004
1005<A NAME="copyPropFile(java.util.Properties, java.lang.String, java.io.File)"><!-- --></A><H3>
1006copyPropFile</H3>
1007<PRE>
1008protected void <B>copyPropFile</B>(java.util.Properties&nbsp;properties,
1009 java.lang.String&nbsp;propFileName,
1010 java.io.File&nbsp;outputPath)
1011 throws java.lang.Exception</PRE>
1012<DL>
1013<DD>Stores the given properties in the file outputPath/propFileName.
1014<P>
1015<DD><DL>
1016<DT><B>Parameters:</B><DD><CODE>properties</CODE> - is the Properties map to be written out to a file.<DD><CODE>propFileName</CODE> - is the name of the output properties file.<DD><CODE>outputPath</CODE> - is the directory into which the properties file
1017 is to be written.
1018<DT><B>Throws:</B>
1019<DD><CODE>java.lang.Exception</CODE></DL>
1020</DD>
1021</DL>
1022<HR>
1023
1024<A NAME="copyTemplateFile(java.lang.String, java.io.File, boolean)"><!-- --></A><H3>
1025copyTemplateFile</H3>
1026<PRE>
1027protected void <B>copyTemplateFile</B>(java.lang.String&nbsp;src,
1028 java.io.File&nbsp;dest,
1029 boolean&nbsp;replace)
1030 throws java.io.IOException</PRE>
1031<DL>
1032<DD>Copies internal template src file (in executable jar) to dest file.
1033 If replace is true, then if the dest file exists, it will be overwritten.
1034 From http://exampledepot.com/egs/java.io/CopyFile.html
1035<P>
1036<DD><DL>
1037<DT><B>Parameters:</B><DD><CODE>src</CODE> - is the internal file (internal to the jar) to be copied
1038 its inputStream is obtained and copied.<DD><CODE>dest</CODE> - is the file into which the contents of src are to be copied<DD><CODE>replace</CODE> - indicates whether dest is to be replaced if it already
1039 exists. If replace is true, then any existing dest is replaced with the
1040 copied output file of the same name. If false, the copy operation does
1041 not take place
1042<DT><B>Throws:</B>
1043<DD><CODE>java.io.IOException</CODE> - if the copying failed.</DL>
1044</DD>
1045</DL>
1046<HR>
1047
1048<A NAME="readXML(java.lang.Object, java.lang.String, java.lang.String)"><!-- --></A><H3>
1049readXML</H3>
1050<PRE>
1051protected org.w3c.dom.Document <B>readXML</B>(java.lang.Object&nbsp;xmlSource,
1052 java.lang.String&nbsp;dtd_SystemId,
1053 java.lang.String&nbsp;sourceFileName)
1054 throws java.lang.Exception</PRE>
1055<DL>
1056<DD>Reads from an xmlFile. If dtd_SystemId is not an empty String,
1057 then the XMLFile is not validated against the doctype statement it
1058 contains (the dtd_SystemId entity in the xmlFile is ignored) so
1059 that parsing still succeeds. However, if the DOM Structure returned
1060 by this method is written back out to a file, then make sure that
1061 this doctype is added back into the output file.
1062<P>
1063<DD><DL>
1064<DT><B>Parameters:</B><DD><CODE>xmlSource</CODE> - is either an xmlFile or xml InputStream (of a jarred
1065 file, for example) to be read into a DOM structure.<DD><CODE>dtd_SystemId</CODE> - - if specified, validation against the given DTD
1066 is ignored. The DOM structure returned will not contain the DOCTYPE
1067 entity with the given dtd file reference. If writing the DOM out to
1068 a file later on, then it is advised that this DOC_TYPE is added back
1069 in. If there is no dtd to be validated or whose validation is to be
1070 ignored, pass the empty string for dtd_SystemId.<DD><CODE>sourceFileName</CODE> - is the name of the (possibly internal) file
1071 that is to be read.
1072<DT><B>Throws:</B>
1073<DD><CODE>java.lang.Exception</CODE> - if an error occurred during parsing.</DL>
1074</DD>
1075</DL>
1076<HR>
1077
1078<A NAME="writeXML(org.w3c.dom.Document, java.io.File, java.lang.String)"><!-- --></A><H3>
1079writeXML</H3>
1080<PRE>
1081protected void <B>writeXML</B>(org.w3c.dom.Document&nbsp;doc,
1082 java.io.File&nbsp;xmlFile,
1083 java.lang.String&nbsp;dtdToAddBackIn)
1084 throws java.lang.Exception</PRE>
1085<DL>
1086<DD>Writes out a DOM structure to a file.
1087<P>
1088<DD><DL>
1089<DT><B>Parameters:</B><DD><CODE>doc</CODE> - is the DOM to be written out to a file<DD><CODE>xmlFile</CODE> - is the file to write the XML out to<DD><CODE>dtdToAddBackIn</CODE> - is "" if there's no special DTD to add
1090 back into the DOCTYPE. If not "", it specifies the dtd file to
1091 be added in the DOCTYPE of the XML output file.
1092<DT><B>Throws:</B>
1093<DD><CODE>java.lang.Exception</CODE></DL>
1094</DD>
1095</DL>
1096<HR>
1097
1098<A NAME="replaceElementWithAttrValue(org.w3c.dom.Document, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
1099replaceElementWithAttrValue</H3>
1100<PRE>
1101protected boolean <B>replaceElementWithAttrValue</B>(org.w3c.dom.Document&nbsp;doc,
1102 java.lang.String&nbsp;tagName,
1103 java.lang.String&nbsp;attrName,
1104 java.lang.String&nbsp;attrValueContent,
1105 java.lang.String&nbsp;replacementContent,
1106 boolean&nbsp;onceOnly,
1107 boolean&nbsp;wholeItem)</PRE>
1108<DL>
1109<DD>Given a DOM document, finds the first element where nodeName=tagName
1110 where one of the attributes has the name attrName and whose value
1111 contains attrValueContent. The <b>portion</b> of the attribute value
1112 that matches is then replaced by replacementContent.
1113 If onceOnly is true, the first replacement is made and the method
1114 returns. If false, all matching replacements are made.
1115<P>
1116<DD><DL>
1117<DT><B>Parameters:</B><DD><CODE>doc</CODE> - is the DOM Document object in which to search for
1118 the element to be replaced<DD><CODE>tagName</CODE> - is the name of the element to search for<DD><CODE>attrName</CODE> - is the name of the attribute of the element to search for<DD><CODE>attrValueContent</CODE> - is the portion of the attribute value that will
1119 be replaced by replacementContent.<DD><CODE>replacementContent</CODE> - is the replacement string that will overwrite
1120 the part of the attrName attribute's value that matched attrValueContent<DD><CODE>onceOnly</CODE> - - if true will look for the first match and perform the
1121 replacement once. If false, it will replace all matches found.<DD><CODE>wholeItem</CODE> - - if true, the entire string containing attrValueContent
1122 will be replaced by the string replacementContent. If false, only the
1123 attrValueContent portion of the original string will be replaced.
1124<DT><B>Returns:</B><DD>true if any replacements have been made.</DL>
1125</DD>
1126</DL>
1127<HR>
1128
1129<A NAME="replaceElementWithValue(org.w3c.dom.Document, java.lang.String, java.lang.String, java.lang.String, boolean, boolean)"><!-- --></A><H3>
1130replaceElementWithValue</H3>
1131<PRE>
1132protected boolean <B>replaceElementWithValue</B>(org.w3c.dom.Document&nbsp;doc,
1133 java.lang.String&nbsp;tagName,
1134 java.lang.String&nbsp;contentValue,
1135 java.lang.String&nbsp;replacement,
1136 boolean&nbsp;onceOnly,
1137 boolean&nbsp;wholeItem)</PRE>
1138<DL>
1139<DD>Given a DOM document, finds the first element where nodeName=tagName
1140 and where the element's inner text contains the string contentValue.
1141 Once found, the <b>entire</b> textnode contents of the matching element
1142 is then replaced with the replacement string.
1143<P>
1144<DD><DL>
1145<DT><B>Parameters:</B><DD><CODE>doc</CODE> - is the DOM Document object in which to search for
1146 the element to be replaced<DD><CODE>tagName</CODE> - is the name of the element to search for<DD><CODE>contentValue</CODE> - is the portion of the textual content of the
1147 element that should match for the replacement to happen<DD><CODE>replacement</CODE> - is value that will overwrite the matching portion
1148 of the element's textual content (it will overwrite contentValue).<DD><CODE>onceOnly</CODE> - - if true will look for the first match and perform the
1149 replacement once. If false, it will replace all matches found.<DD><CODE>wholeItem</CODE> - - if true, the entire string containing attrValueContent
1150 will be replaced by the string replacementContent. If false, only the
1151 attrValueContent portion of the original string will be replaced.
1152<DT><B>Returns:</B><DD>true if any replacements have been made.</DL>
1153</DD>
1154</DL>
1155<HR>
1156
1157<A NAME="getValue(org.w3c.dom.Element)"><!-- --></A><H3>
1158getValue</H3>
1159<PRE>
1160public static java.lang.String <B>getValue</B>(org.w3c.dom.Element&nbsp;e)</PRE>
1161<DL>
1162<DD>Extract the text from an element, if any.
1163<P>
1164<DD><DL>
1165<DT><B>Parameters:</B><DD><CODE>e</CODE> - is the element whose value is to be extracted.
1166<DT><B>Returns:</B><DD>the text that's nested in an element's body or ""
1167 if there's none.</DL>
1168</DD>
1169</DL>
1170<HR>
1171
1172<A NAME="elementToFormattedString(org.w3c.dom.Element, java.lang.String)"><!-- --></A><H3>
1173elementToFormattedString</H3>
1174<PRE>
1175public static java.lang.String <B>elementToFormattedString</B>(org.w3c.dom.Element&nbsp;e,
1176 java.lang.String&nbsp;dtd_SystemId)
1177 throws java.lang.Exception</PRE>
1178<DL>
1179<DD>Given an Element, this will return its String representation properly
1180 indented for display. (The XML declaration will be added at the top
1181 since this method will be used here to write proper XML out to a file.)
1182<P>
1183<DD><DL>
1184<DT><B>Parameters:</B><DD><CODE>e</CODE> - is the element to be converted to its string representation.<DD><CODE>dtd_SystemId</CODE> - (if not "") is any DOCTYPE with systemId that needs
1185 to be added back into the file. If "", then no new DOCTYPE entity is
1186 added into the DOM structure represented by Element e.
1187<DT><B>Returns:</B><DD>a string representation of e, formatted for display.
1188<DT><B>Throws:</B>
1189<DD><CODE>java.lang.Exception</CODE></DL>
1190</DD>
1191</DL>
1192<HR>
1193
1194<A NAME="moveUnpackWarFile(java.io.File)"><!-- --></A><H3>
1195moveUnpackWarFile</H3>
1196<PRE>
1197protected void <B>moveUnpackWarFile</B>(java.io.File&nbsp;gsearchWarFile)
1198 throws java.lang.Exception</PRE>
1199<DL>
1200<DD>Moves the (fedoragsearch.war) war file from the given location
1201 into FEDORA_HOME's tomcat folder (i.e. into CATALINA_HOME) and
1202 unpacks it there. Unpacking is achieved by starting the fedora
1203 server after the move. If a fedoragsearch is already unpacked
1204 in CATALINA_HOME, this method will not move the given
1205 fedoragsearch.war file.
1206 This method does more than merely move fedoragsearch.war:
1207 regardless of whether the war file exists and is moved or not,
1208 the fedora server is first stopped and at the end it is started.
1209<P>
1210<DD><DL>
1211<DT><B>Parameters:</B><DD><CODE>gsearchWarFile</CODE> - the fedoragsearch.war file to be moved and
1212 unpacked.
1213<DT><B>Throws:</B>
1214<DD><CODE>java.lang.Exception</CODE> - if an unpacked fedoragsearch does not exist
1215 in the CATALINA_HOME/webapps folder at the end.</DL>
1216</DD>
1217</DL>
1218<HR>
1219
1220<A NAME="customiseFedoraConfigFile()"><!-- --></A><H3>
1221customiseFedoraConfigFile</H3>
1222<PRE>
1223protected void <B>customiseFedoraConfigFile</B>()
1224 throws java.lang.Exception</PRE>
1225<DL>
1226<DD>Makes changes to the fedora.fcfg file located inside FEDORA_HOME.
1227 It changes the fedora.server.storage.DOManager to the GSearchDOManager
1228 and sets the gSearchRESTURL to the specific fedora host and port values
1229 specified for installation.
1230 This method also checks that "greenstone" is in the list of PIDs that
1231 Fedora recognises. If it's not in the list already, it is added in
1232 there.
1233<P>
1234<DD><DL>
1235
1236<DT><B>Throws:</B>
1237<DD><CODE>java.lang.Exception</CODE></DL>
1238</DD>
1239</DL>
1240<HR>
1241
1242<A NAME="createLuceneIndexDir()"><!-- --></A><H3>
1243createLuceneIndexDir</H3>
1244<PRE>
1245protected void <B>createLuceneIndexDir</B>()
1246 throws java.lang.Exception</PRE>
1247<DL>
1248<DD>Creates the Lucene index directory in the right location inside
1249 FEDORA_HOME into which FedoraGSearch will store the indexes for
1250 the Greenstone contents in the Fedora repository.
1251 If it already exists, the Lucene index directory is not created.
1252<P>
1253<DD><DL>
1254
1255<DT><B>Throws:</B>
1256<DD><CODE>java.lang.Exception</CODE> - if the Lucene index directory cannot be created
1257 in the appropriate location inside FEDORA_HOME</DL>
1258</DD>
1259</DL>
1260<HR>
1261
1262<A NAME="showInputDialog()"><!-- --></A><H3>
1263showInputDialog</H3>
1264<PRE>
1265public static java.util.Properties <B>showInputDialog</B>()</PRE>
1266<DL>
1267<DD>Displays a dialog to get user input for
1268 - fedora server host, port, username and password,
1269 - the names for the fedora generic search index and repository
1270 that are to be created, and
1271 - for the location of fedoragenericsearch.war (the installer is
1272 meant to work specifically with Muradora's fedoragenericsearch.war
1273 since they have edited various property and xml files to make it
1274 all easier).
1275 The dialog displays the default values to the user.
1276<P>
1277<DD><DL>
1278
1279<DT><B>Returns:</B><DD>a Properties map containing the values entered by the
1280 user for the various initialisation parameters required by the
1281 Fedora Generic Search Installer GSearchInstaller.</DL>
1282</DD>
1283</DL>
1284<HR>
1285
1286<A NAME="getSafeValue(javax.swing.JTextField, java.lang.String)"><!-- --></A><H3>
1287getSafeValue</H3>
1288<PRE>
1289protected static java.lang.String <B>getSafeValue</B>(javax.swing.JTextField&nbsp;field,
1290 java.lang.String&nbsp;property)</PRE>
1291<DL>
1292<DD>This method returns the value of the textfield for the given
1293 GSearchInstaller initialiser property, if this is not the empty string.
1294 If it is the empty string, the default value for this property is
1295 returned.
1296<P>
1297<DD><DL>
1298<DT><B>Parameters:</B><DD><CODE>field</CODE> - is the TextField whose value is being extracted<DD><CODE>property</CODE> - is the GSearchInstaller property that the TextField
1299 value maps to.
1300<DT><B>Returns:</B><DD>the contents of the textfield for the property or the defaults
1301 value for the property if the textfield contained "".</DL>
1302</DD>
1303</DL>
1304<HR>
1305
1306<A NAME="info()"><!-- --></A><H3>
1307info</H3>
1308<PRE>
1309public static java.lang.String <B>info</B>()</PRE>
1310<DL>
1311<DD><DL>
1312
1313<DT><B>Returns:</B><DD>a string specifying the requirements of this program.</DL>
1314</DD>
1315</DL>
1316<HR>
1317
1318<A NAME="usage()"><!-- --></A><H3>
1319usage</H3>
1320<PRE>
1321public static java.lang.String <B>usage</B>()</PRE>
1322<DL>
1323<DD>If the program is run from the command line and the user executed
1324 it with -help or help, then this usage String is displayed.
1325<P>
1326<DD><DL>
1327
1328<DT><B>Returns:</B><DD>String describing how to use this program when running it
1329 from the command line.</DL>
1330</DD>
1331</DL>
1332<HR>
1333
1334<A NAME="parseInstallationArgs(java.lang.String[])"><!-- --></A><H3>
1335parseInstallationArgs</H3>
1336<PRE>
1337public static java.util.Properties <B>parseInstallationArgs</B>(java.lang.String[]&nbsp;args)</PRE>
1338<DL>
1339<DD>Called to process multiple command line arguments where these
1340 arguments are GSearchInstaller constructor options followed by
1341 their values.
1342<P>
1343<DD><DL>
1344<DT><B>Parameters:</B><DD><CODE>args</CODE> - are the command-line arguments received by main
1345 which consist of one or more multiple "-option value" pairs.
1346<DT><B>Returns:</B><DD>a Properties map containing (option, value) pairs
1347 that will be used by GSearchInstaller to install Muradora's
1348 Fedora Generic Search. Empty strings for recognised options
1349 are replaced by defaults.</DL>
1350</DD>
1351</DL>
1352<HR>
1353
1354<A NAME="main(java.lang.String[])"><!-- --></A><H3>
1355main</H3>
1356<PRE>
1357public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
1358<DL>
1359<DD>The main method creates a GSearchInstaller to install Fedora Generic
1360 Search from a (Muradora) fedoragsearch.war file.
1361 The program can be run in one of two ways:
1362 - with no arguments: a dialog is displayed requesting inputs for the
1363 parameters used by the GSearchInstaller initialisation.
1364 - with arguments for command-line invocation. (Run with -help or help
1365 to find out what parameter options are there.)
1366<P>
1367<DD><DL>
1368</DL>
1369</DD>
1370</DL>
1371<!-- ========= END OF CLASS DATA ========= -->
1372<HR>
1373
1374
1375<!-- ======= START OF BOTTOM NAVBAR ====== -->
1376<A NAME="navbar_bottom"><!-- --></A>
1377<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1378<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1379<TR>
1380<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1381<A NAME="navbar_bottom_firstrow"><!-- --></A>
1382<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1383 <TR ALIGN="center" VALIGN="top">
1384 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/greenstone/fedora/installer/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1385 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1386 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1387 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1388 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1389 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1390 </TR>
1391</TABLE>
1392</TD>
1393<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1394</EM>
1395</TD>
1396</TR>
1397
1398<TR>
1399<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1400&nbsp;PREV CLASS&nbsp;
1401&nbsp;<A HREF="../../../../org/greenstone/fedora/installer/GSearchInstaller.IgnoreDTDEntityResolver.html" title="class in org.greenstone.fedora.installer"><B>NEXT CLASS</B></A></FONT></TD>
1402<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1403 <A HREF="../../../../index.html?org/greenstone/fedora/installer/GSearchInstaller.html" target="_top"><B>FRAMES</B></A> &nbsp;
1404&nbsp;<A HREF="GSearchInstaller.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
1405&nbsp;<SCRIPT type="text/javascript">
1406 <!--
1407 if(window==top) {
1408 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1409 }
1410 //-->
1411</SCRIPT>
1412<NOSCRIPT>
1413 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
1414</NOSCRIPT>
1415
1416
1417</FONT></TD>
1418</TR>
1419<TR>
1420<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1421 SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1422<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1423DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1424</TR>
1425</TABLE>
1426<A NAME="skip-navbar_bottom"></A>
1427<!-- ======== END OF BOTTOM NAVBAR ======= -->
1428
1429<HR>
1430
1431</BODY>
1432</HTML>
Note: See TracBrowser for help on using the repository browser.