source: other-projects/trunk/gs3-webservices-democlient/docs/GS3DemoClient/org/greenstone/gs3services/AdminSOAPServer.html@ 15222

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

Greenstone3 web services demo-clientadded to GS3's other-projects

File size: 27.6 KB
RevLine 
[15222]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 Sun Apr 27 20:47:19 NZST 2008 -->
6<TITLE>
7AdminSOAPServer
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3services.AdminSOAPServer 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="AdminSOAPServer";
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="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45</TABLE>
46</TD>
47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48</EM>
49</TD>
50</TR>
51
52<TR>
53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54&nbsp;PREV CLASS&nbsp;
55&nbsp;<A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html" title="class in org.greenstone.gs3services"><B>NEXT CLASS</B></A></FONT></TD>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../index.html?org/greenstone/gs3services/AdminSOAPServer.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="AdminSOAPServer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59&nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
63 }
64 //-->
65</SCRIPT>
66<NOSCRIPT>
67 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
68</NOSCRIPT>
69
70
71</FONT></TD>
72</TR>
73<TR>
74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY:&nbsp;NESTED&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>
76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77DETAIL:&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>
78</TR>
79</TABLE>
80<A NAME="skip-navbar_top"></A>
81<!-- ========= END OF TOP NAVBAR ========= -->
82
83<HR>
84<!-- ======== START OF CLASS DATA ======== -->
85<H2>
86<FONT SIZE="-1">
87org.greenstone.gs3services</FONT>
88<BR>
89Class AdminSOAPServer</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3services.AdminSOAPServer</B>
93</PRE>
94<HR>
95<DL>
96<DT><PRE>public class <B>AdminSOAPServer</B><DT>extends java.lang.Object</DL>
97</PRE>
98
99<P>
100A beginning to the AdminSOAPServer class which will contain management/admin
101 related web services such as adding new documents, creating, building and
102 importing collections and configuring Greenstone modules.
103
104 NOTE: to run this class, the folder containing this web service class'
105 properties helpFile should be on the classpath.
106<P>
107
108<P>
109<HR>
110
111<P>
112<!-- =========== FIELD SUMMARY =========== -->
113
114<A NAME="field_summary"><!-- --></A>
115<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
116<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
117<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
118<B>Field Summary</B></FONT></TH>
119</TR>
120<TR BGCOLOR="white" CLASS="TableRowColor">
121<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
122<CODE>protected &nbsp;org.greenstone.gsdl3.util.XMLConverter</CODE></FONT></TD>
123<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#converter">converter</A></B></CODE>
124
125<BR>
126&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A converter class to parse XML and create Docs</TD>
127</TR>
128<TR BGCOLOR="white" CLASS="TableRowColor">
129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
130<CODE>protected &nbsp;org.w3c.dom.Document</CODE></FONT></TD>
131<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#doc">doc</A></B></CODE>
132
133<BR>
134&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Container Document to create XML Nodes</TD>
135</TR>
136<TR BGCOLOR="white" CLASS="TableRowColor">
137<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
138<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
139<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#helpErrormessage">helpErrormessage</A></B></CODE>
140
141<BR>
142&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Error message loading helpFile.</TD>
143</TR>
144<TR BGCOLOR="white" CLASS="TableRowColor">
145<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
146<CODE>protected static&nbsp;java.lang.String</CODE></FONT></TD>
147<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#helpFile">helpFile</A></B></CODE>
148
149<BR>
150&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The help properties file describing the web service operations</TD>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>protected &nbsp;org.greenstone.gsdl3.core.MessageRouter</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#mr">mr</A></B></CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Message Router object to pass requests messages to and which
159 will process them.</TD>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>protected static&nbsp;java.util.Properties</CODE></FONT></TD>
164<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#properties">properties</A></B></CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Properties map with mappings from methodname to help
168 description string</TD>
169</TR>
170<TR BGCOLOR="white" CLASS="TableRowColor">
171<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
173<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#site_name">site_name</A></B></CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;site_name the MessageRouter works with, here set to "localsite"</TD>
177</TR>
178</TABLE>
179&nbsp;
180<!-- ======== CONSTRUCTOR SUMMARY ======== -->
181
182<A NAME="constructor_summary"><!-- --></A>
183<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
186<B>Constructor Summary</B></FONT></TH>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#AdminSOAPServer()">AdminSOAPServer</A></B>()</CODE>
190
191<BR>
192&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that initializes the web services' MessageRouter object
193 Reads from GlobalProperties to get gsdl3_home and set the sitename.</TD>
194</TR>
195</TABLE>
196&nbsp;
197<!-- ========== METHOD SUMMARY =========== -->
198
199<A NAME="method_summary"><!-- --></A>
200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
203<B>Method Summary</B></FONT></TH>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#activate(java.lang.String, java.lang.String)">activate</A></B>(java.lang.String&nbsp;systemModuleType,
209 java.lang.String&nbsp;systemModuleName)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a (re-)activate system-type message to activate a Greenstone module.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#deactivate(java.lang.String, java.lang.String)">deactivate</A></B>(java.lang.String&nbsp;systemModuleType,
218 java.lang.String&nbsp;systemModuleName)</CODE>
219
220<BR>
221&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a deactivate system-type message to activate a Greenstone module.</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#error(java.lang.String)">error</A></B>(java.lang.String&nbsp;errorMessage)</CODE>
227
228<BR>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a String response message to represent an XML error response
230 message using the error specified in the message parameter.</TD>
231</TR>
232<TR BGCOLOR="white" CLASS="TableRowColor">
233<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
234<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
235<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#format(java.lang.String, java.lang.String, java.lang.String)">format</A></B>(java.lang.String&nbsp;collection,
236 java.lang.String&nbsp;service,
237 java.lang.String&nbsp;language)</CODE>
238
239<BR>
240&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a format-type message to a Service containing format (Greenstone
241 Format, GSF) XSLT statements to specify how a collection looks.</TD>
242</TR>
243<TR BGCOLOR="white" CLASS="TableRowColor">
244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
245<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
246<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#help()">help</A></B>()</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
250</TR>
251<TR BGCOLOR="white" CLASS="TableRowColor">
252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
254<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#helpWithMethod(java.lang.String)">helpWithMethod</A></B>(java.lang.String&nbsp;methodname)</CODE>
255
256<BR>
257&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
258</TR>
259<TR BGCOLOR="white" CLASS="TableRowColor">
260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261<CODE>static&nbsp;void</CODE></FONT></TD>
262<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#main(java.lang.String[])">main</A></B>(java.lang.String[]&nbsp;args)</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#processInternal(org.w3c.dom.Element)">processInternal</A></B>(org.w3c.dom.Element&nbsp;message)</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by most other methods in order to send the constructed message
274 to the Greenstone's MessageRouter, intercept the response and return it.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#reconfigure(java.lang.String)">reconfigure</A></B>(java.lang.String&nbsp;subset)</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a configure system-type message to configure the Message Router.</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#reconfigureMessageRouter()">reconfigureMessageRouter</A></B>()</CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a configure system-type message to configure all of the Message Router.</TD>
291</TR>
292<TR BGCOLOR="white" CLASS="TableRowColor">
293<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
294<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
295<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#status(java.lang.String, java.lang.String, java.lang.String)">status</A></B>(java.lang.String&nbsp;to,
296 java.lang.String&nbsp;language,
297 java.lang.String&nbsp;pid)</CODE>
298
299<BR>
300&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sends a status-type message to poll the status of a process that was
301 initiated but which may not yet have terminated.</TD>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
306<TD><CODE><B><A HREF="../../../org/greenstone/gs3services/AdminSOAPServer.html#system(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">system</A></B>(java.lang.String&nbsp;type,
307 java.lang.String&nbsp;subset,
308 java.lang.String&nbsp;systemModuleType,
309 java.lang.String&nbsp;systemModuleName)</CODE>
310
311<BR>
312&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;For sending system-type messages.</TD>
313</TR>
314</TABLE>
315&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
316<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
317<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
318<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
319</TR>
320<TR BGCOLOR="white" CLASS="TableRowColor">
321<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
322</TR>
323</TABLE>
324&nbsp;
325<P>
326
327<!-- ============ FIELD DETAIL =========== -->
328
329<A NAME="field_detail"><!-- --></A>
330<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
331<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
332<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
333<B>Field Detail</B></FONT></TH>
334</TR>
335</TABLE>
336
337<A NAME="helpErrormessage"><!-- --></A><H3>
338helpErrormessage</H3>
339<PRE>
340protected static java.lang.String <B>helpErrormessage</B></PRE>
341<DL>
342<DD>Error message loading helpFile. Remains at "" if everything is fine
343<P>
344<DL>
345</DL>
346</DL>
347<HR>
348
349<A NAME="properties"><!-- --></A><H3>
350properties</H3>
351<PRE>
352protected static java.util.Properties <B>properties</B></PRE>
353<DL>
354<DD>Properties map with mappings from methodname to help
355 description string
356<P>
357<DL>
358</DL>
359</DL>
360<HR>
361
362<A NAME="helpFile"><!-- --></A><H3>
363helpFile</H3>
364<PRE>
365protected static java.lang.String <B>helpFile</B></PRE>
366<DL>
367<DD>The help properties file describing the web service operations
368<P>
369<DL>
370</DL>
371</DL>
372<HR>
373
374<A NAME="site_name"><!-- --></A><H3>
375site_name</H3>
376<PRE>
377protected java.lang.String <B>site_name</B></PRE>
378<DL>
379<DD>site_name the MessageRouter works with, here set to "localsite"
380<P>
381<DL>
382</DL>
383</DL>
384<HR>
385
386<A NAME="mr"><!-- --></A><H3>
387mr</H3>
388<PRE>
389protected org.greenstone.gsdl3.core.MessageRouter <B>mr</B></PRE>
390<DL>
391<DD>Message Router object to pass requests messages to and which
392 will process them.
393<P>
394<DL>
395</DL>
396</DL>
397<HR>
398
399<A NAME="doc"><!-- --></A><H3>
400doc</H3>
401<PRE>
402protected org.w3c.dom.Document <B>doc</B></PRE>
403<DL>
404<DD>Container Document to create XML Nodes
405<P>
406<DL>
407</DL>
408</DL>
409<HR>
410
411<A NAME="converter"><!-- --></A><H3>
412converter</H3>
413<PRE>
414protected org.greenstone.gsdl3.util.XMLConverter <B>converter</B></PRE>
415<DL>
416<DD>A converter class to parse XML and create Docs
417<P>
418<DL>
419</DL>
420</DL>
421
422<!-- ========= CONSTRUCTOR DETAIL ======== -->
423
424<A NAME="constructor_detail"><!-- --></A>
425<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
426<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
427<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
428<B>Constructor Detail</B></FONT></TH>
429</TR>
430</TABLE>
431
432<A NAME="AdminSOAPServer()"><!-- --></A><H3>
433AdminSOAPServer</H3>
434<PRE>
435public <B>AdminSOAPServer</B>()</PRE>
436<DL>
437<DD>Constructor that initializes the web services' MessageRouter object
438 Reads from GlobalProperties to get gsdl3_home and set the sitename.
439<P>
440</DL>
441
442<!-- ============ METHOD DETAIL ========== -->
443
444<A NAME="method_detail"><!-- --></A>
445<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
446<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
447<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
448<B>Method Detail</B></FONT></TH>
449</TR>
450</TABLE>
451
452<A NAME="status(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
453status</H3>
454<PRE>
455public java.lang.String <B>status</B>(java.lang.String&nbsp;to,
456 java.lang.String&nbsp;language,
457 java.lang.String&nbsp;pid)</PRE>
458<DL>
459<DD>Sends a status-type message to poll the status of a process that was
460 initiated but which may not yet have terminated.
461<P>
462<DD><DL>
463<DT><B>Parameters:</B><DD><CODE>to</CODE> - - the processing service to send this status message to.<DD><CODE>language</CODE> - - the preferred language of the display content in the
464 response.<DD><CODE>pid</CODE> - - the process id of the process whose status is requested.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pages 42, 43</a></DL>
465</DD>
466</DL>
467<HR>
468
469<A NAME="reconfigureMessageRouter()"><!-- --></A><H3>
470reconfigureMessageRouter</H3>
471<PRE>
472public java.lang.String <B>reconfigureMessageRouter</B>()</PRE>
473<DL>
474<DD>Sends a configure system-type message to configure all of the Message Router.
475<P>
476<DD><DL>
477<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pp. 13, 41, 42</a></DL>
478</DD>
479</DL>
480<HR>
481
482<A NAME="reconfigure(java.lang.String)"><!-- --></A><H3>
483reconfigure</H3>
484<PRE>
485public java.lang.String <B>reconfigure</B>(java.lang.String&nbsp;subset)</PRE>
486<DL>
487<DD>Sends a configure system-type message to configure the Message Router.
488<P>
489<DD><DL>
490<DT><B>Parameters:</B><DD><CODE>subset</CODE> - - the particular subset of the module which is to be
491 reconfigured. For a collection/serviceRack it can be metadataList,
492 serviceList. For the MessageRouter this can be siteList, collectionList,
493 clusterList, serviceList<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pp. 13, 41, 42</a></DL>
494</DD>
495</DL>
496<HR>
497
498<A NAME="activate(java.lang.String, java.lang.String)"><!-- --></A><H3>
499activate</H3>
500<PRE>
501public java.lang.String <B>activate</B>(java.lang.String&nbsp;systemModuleType,
502 java.lang.String&nbsp;systemModuleName)</PRE>
503<DL>
504<DD>Sends a (re-)activate system-type message to activate a Greenstone module.
505<P>
506<DD><DL>
507<DT><B>Parameters:</B><DD><CODE>systemModuleName</CODE> - - name of the module to be (re-)activated.<DD><CODE>systemModuleType</CODE> - - type of the module. For instance, this may be
508 site or collection.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pp. 13, 41, 42</a></DL>
509</DD>
510</DL>
511<HR>
512
513<A NAME="deactivate(java.lang.String, java.lang.String)"><!-- --></A><H3>
514deactivate</H3>
515<PRE>
516public java.lang.String <B>deactivate</B>(java.lang.String&nbsp;systemModuleType,
517 java.lang.String&nbsp;systemModuleName)</PRE>
518<DL>
519<DD>Sends a deactivate system-type message to activate a Greenstone module.
520<P>
521<DD><DL>
522<DT><B>Parameters:</B><DD><CODE>systemModuleName</CODE> - - name of the module to be deactivated.<DD><CODE>systemModuleType</CODE> - - type of the module. For instance, this may be
523 site or collection.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - pp. 13, 41, 42</a></DL>
524</DD>
525</DL>
526<HR>
527
528<A NAME="system(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
529system</H3>
530<PRE>
531protected java.lang.String <B>system</B>(java.lang.String&nbsp;type,
532 java.lang.String&nbsp;subset,
533 java.lang.String&nbsp;systemModuleType,
534 java.lang.String&nbsp;systemModuleName)</PRE>
535<DL>
536<DD>For sending system-type messages.
537 For parameter type=configure, the subset value is set (or "").
538 For parameter type=(de)activate, the systemModuleName and systemModuleType
539 are set.
540<P>
541<DD><DL>
542<DT><B>Parameters:</B><DD><CODE>type</CODE> - - one of GSXML.SYSTEM_TYPE_CONFIGURE,
543 GSXML.SYSTEM_TYPE_ACTIVATE, GSXML.SYSTEM_TYPE_DEACTIVATE
544 (configure, activate or deactivate, respectively).<DD><CODE>subset</CODE> - - for system type configure, this can specify the To module's
545 subset that needs to be reconfigured.<DD><CODE>systemModuleName</CODE> - - for system type (de)activate, this specifies the
546 name of the module to be (de)activated.<DD><CODE>systemModuleType</CODE> - - for system type (de)activate, this specifies the
547 type of the module to be (de)activated. For instance, this may be
548 site or collection.</DL>
549</DD>
550</DL>
551<HR>
552
553<A NAME="format(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
554format</H3>
555<PRE>
556public java.lang.String <B>format</B>(java.lang.String&nbsp;collection,
557 java.lang.String&nbsp;service,
558 java.lang.String&nbsp;language)</PRE>
559<DL>
560<DD>Sends a format-type message to a Service containing format (Greenstone
561 Format, GSF) XSLT statements to specify how a collection looks.
562<P>
563<DD><DL>
564<DT><B>Parameters:</B><DD><CODE>collection</CODE> - - the name of the collection this message is sent to.<DD><CODE>service</CODE> - - name of the service this format message is to be sent to.<DD><CODE>language</CODE> - - the preferred language of the display content in the
565 response.<DT><B>See Also:</B><DD><a href="http://wiki.greenstone.org/wiki/index.php/Greenstone3">The Greenstone 3 Developer's Manual - page 42</a></DL>
566</DD>
567</DL>
568<HR>
569
570<A NAME="processInternal(org.w3c.dom.Element)"><!-- --></A><H3>
571processInternal</H3>
572<PRE>
573protected java.lang.String <B>processInternal</B>(org.w3c.dom.Element&nbsp;message)</PRE>
574<DL>
575<DD>Called by most other methods in order to send the constructed message
576 to the Greenstone's MessageRouter, intercept the response and return it.
577<P>
578<DD><DL>
579<DT><B>Parameters:</B><DD><CODE>message</CODE> - is the XML message Element to send to GS3's MessageRouter.
580<DT><B>Returns:</B><DD>the XML response in String format.</DL>
581</DD>
582</DL>
583<HR>
584
585<A NAME="error(java.lang.String)"><!-- --></A><H3>
586error</H3>
587<PRE>
588protected java.lang.String <B>error</B>(java.lang.String&nbsp;errorMessage)</PRE>
589<DL>
590<DD>Creates a String response message to represent an XML error response
591 message using the error specified in the message parameter. A String is
592 created because this method ensures that a response message is reliably
593 constructed (no exceptions are thrown) that can be sent to clients.
594<P>
595<DD><DL>
596<DT><B>Parameters:</B><DD><CODE>errorMessage</CODE> - - the errormessage to be conveyed
597<DT><B>Returns:</B><DD>an XML response message containing an GS3 error element.</DL>
598</DD>
599</DL>
600<HR>
601
602<A NAME="help()"><!-- --></A><H3>
603help</H3>
604<PRE>
605public static java.lang.String <B>help</B>()</PRE>
606<DL>
607<DD><DL>
608
609<DT><B>Returns:</B><DD>a help string for listing all the web service methods.</DL>
610</DD>
611</DL>
612<HR>
613
614<A NAME="helpWithMethod(java.lang.String)"><!-- --></A><H3>
615helpWithMethod</H3>
616<PRE>
617public static java.lang.String <B>helpWithMethod</B>(java.lang.String&nbsp;methodname)</PRE>
618<DL>
619<DD><DL>
620<DT><B>Parameters:</B><DD><CODE>methodname</CODE> - is the name of the method to be described.
621<DT><B>Returns:</B><DD>a help string for the given method, explaining what the method
622 does, what parameters it expects and their types and what it returns.</DL>
623</DD>
624</DL>
625<HR>
626
627<A NAME="main(java.lang.String[])"><!-- --></A><H3>
628main</H3>
629<PRE>
630public static void <B>main</B>(java.lang.String[]&nbsp;args)</PRE>
631<DL>
632<DD><DL>
633</DL>
634</DD>
635</DL>
636<!-- ========= END OF CLASS DATA ========= -->
637<HR>
638
639
640<!-- ======= START OF BOTTOM NAVBAR ====== -->
641<A NAME="navbar_bottom"><!-- --></A>
642<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
643<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
644<TR>
645<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
646<A NAME="navbar_bottom_firstrow"><!-- --></A>
647<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
648 <TR ALIGN="center" VALIGN="top">
649 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
650 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
651 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
652 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
653 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
654 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
655 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
656 </TR>
657</TABLE>
658</TD>
659<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
660</EM>
661</TD>
662</TR>
663
664<TR>
665<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
666&nbsp;PREV CLASS&nbsp;
667&nbsp;<A HREF="../../../org/greenstone/gs3services/QBRSOAPServer.html" title="class in org.greenstone.gs3services"><B>NEXT CLASS</B></A></FONT></TD>
668<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
669 <A HREF="../../../index.html?org/greenstone/gs3services/AdminSOAPServer.html" target="_top"><B>FRAMES</B></A> &nbsp;
670&nbsp;<A HREF="AdminSOAPServer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
671&nbsp;<SCRIPT type="text/javascript">
672 <!--
673 if(window==top) {
674 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
675 }
676 //-->
677</SCRIPT>
678<NOSCRIPT>
679 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
680</NOSCRIPT>
681
682
683</FONT></TD>
684</TR>
685<TR>
686<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
687 SUMMARY:&nbsp;NESTED&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>
688<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
689DETAIL:&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>
690</TR>
691</TABLE>
692<A NAME="skip-navbar_bottom"></A>
693<!-- ======== END OF BOTTOM NAVBAR ======= -->
694
695<HR>
696
697</BODY>
698</HTML>
Note: See TracBrowser for help on using the repository browser.