source: TI01-discovery/dist/docs/api/ndg/services/XMLDBMessageService.html @ 1471

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI01-discovery/dist/docs/api/ndg/services/XMLDBMessageService.html@1471
Revision 1471, 12.9 KB checked in by mpritcha, 13 years ago (diff)
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_08) on Mon Sep 04 12:45:55 BST 2006 -->
6<TITLE>
7XMLDBMessageService
8</TITLE>
9
10<META NAME="keywords" CONTENT="ndg.services.XMLDBMessageService 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="XMLDBMessageService";
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="../../ndg/services/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="../../ndg/services/XMLDBMessageService.MyAuthenticator.html" title="class in ndg.services"><B>NEXT CLASS</B></A></FONT></TD>
55<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56  <A HREF="../../index.html?ndg/services/XMLDBMessageService.html" target="_top"><B>FRAMES</B></A>  &nbsp;
57&nbsp;<A HREF="XMLDBMessageService.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;FIELD&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;FIELD&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">
86ndg.services</FONT>
87<BR>
88Class XMLDBMessageService</H2>
89<PRE>
90java.lang.Object
91  <IMG SRC="../../resources/inherit.gif" ALT="extended by "><B>ndg.services.XMLDBMessageService</B>
92</PRE>
93<HR>
94<DL>
95<DT><PRE>public class <B>XMLDBMessageService</B><DT>extends java.lang.Object</DL>
96</PRE>
97
98<P>
99Message-style service class acting as XML:DB client to XML database.
100<P>
101
102<P>
103<HR>
104
105<P>
106<!-- ======== NESTED CLASS SUMMARY ======== -->
107
108<A NAME="nested_class_summary"><!-- --></A>
109<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
110<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
111<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
112<B>Nested Class Summary</B></FONT></TH>
113</TR>
114<TR BGCOLOR="white" CLASS="TableRowColor">
115<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
116<CODE>&nbsp;class</CODE></FONT></TD>
117<TD><CODE><B><A HREF="../../ndg/services/XMLDBMessageService.MyAuthenticator.html" title="class in ndg.services">XMLDBMessageService.MyAuthenticator</A></B></CODE>
118
119<BR>
120&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Authenticator to be used with present() in retrieving document
121 from eXist REST interface.</TD>
122</TR>
123<TR BGCOLOR="white" CLASS="TableRowColor">
124<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
125<CODE>&nbsp;class</CODE></FONT></TD>
126<TD><CODE><B><A HREF="../../ndg/services/XMLDBMessageService.NamespaceContextImpl.html" title="class in ndg.services">XMLDBMessageService.NamespaceContextImpl</A></B></CODE>
127
128<BR>
129&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;NamespaceContext implementation to be used with XPath expression
130 Namespace URI loaded from properties file</TD>
131</TR>
132</TABLE>
133&nbsp;
134<!-- ======== CONSTRUCTOR SUMMARY ======== -->
135
136<A NAME="constructor_summary"><!-- --></A>
137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
139<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
140<B>Constructor Summary</B></FONT></TH>
141</TR>
142<TR BGCOLOR="white" CLASS="TableRowColor">
143<TD><CODE><B><A HREF="../../ndg/services/XMLDBMessageService.html#XMLDBMessageService()">XMLDBMessageService</A></B>()</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Default no-arg constructor to load properties needed for everything else</TD>
147</TR>
148</TABLE>
149&nbsp;
150<!-- ========== METHOD SUMMARY =========== -->
151
152<A NAME="method_summary"><!-- --></A>
153<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
154<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
155<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
156<B>Method Summary</B></FONT></TH>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
160<CODE>&nbsp;void</CODE></FONT></TD>
161<TD><CODE><B><A HREF="../../ndg/services/XMLDBMessageService.html#fullText(javax.xml.soap.SOAPEnvelope, javax.xml.soap.SOAPEnvelope)">fullText</A></B>(javax.xml.soap.SOAPEnvelope&nbsp;request,
162         javax.xml.soap.SOAPEnvelope&nbsp;response)</CODE>
163
164<BR>
165&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Executes full text XQuery and returns result from DB.</TD>
166</TR>
167<TR BGCOLOR="white" CLASS="TableRowColor">
168<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
169<CODE>&nbsp;void</CODE></FONT></TD>
170<TD><CODE><B><A HREF="../../ndg/services/XMLDBMessageService.html#present(javax.xml.soap.SOAPEnvelope, javax.xml.soap.SOAPEnvelope)">present</A></B>(javax.xml.soap.SOAPEnvelope&nbsp;request,
171        javax.xml.soap.SOAPEnvelope&nbsp;response)</CODE>
172
173<BR>
174&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Retrieves a document, by accessing XML document at a URL.</TD>
175</TR>
176</TABLE>
177&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
178<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
179<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
180<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
181</TR>
182<TR BGCOLOR="white" CLASS="TableRowColor">
183<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
184</TR>
185</TABLE>
186&nbsp;
187<P>
188
189<!-- ========= CONSTRUCTOR DETAIL ======== -->
190
191<A NAME="constructor_detail"><!-- --></A>
192<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
193<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
194<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
195<B>Constructor Detail</B></FONT></TH>
196</TR>
197</TABLE>
198
199<A NAME="XMLDBMessageService()"><!-- --></A><H3>
200XMLDBMessageService</H3>
201<PRE>
202public <B>XMLDBMessageService</B>()</PRE>
203<DL>
204<DD>Default no-arg constructor to load properties needed for everything else
205<P>
206</DL>
207
208<!-- ============ METHOD DETAIL ========== -->
209
210<A NAME="method_detail"><!-- --></A>
211<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
212<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
213<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
214<B>Method Detail</B></FONT></TH>
215</TR>
216</TABLE>
217
218<A NAME="fullText(javax.xml.soap.SOAPEnvelope, javax.xml.soap.SOAPEnvelope)"><!-- --></A><H3>
219fullText</H3>
220<PRE>
221public void <B>fullText</B>(javax.xml.soap.SOAPEnvelope&nbsp;request,
222                     javax.xml.soap.SOAPEnvelope&nbsp;response)
223              throws javax.xml.soap.SOAPException</PRE>
224<DL>
225<DD>Executes full text XQuery and returns result from DB.
226 <p>Requires request message containing search term as follows:
227 <pre>
228&lt;m:fullText xmlns:m="http://ndg.nerc.ac.uk/query"&gt;
229  &lt;m:term&gt;badc&lt;/m:term&gt;
230&lt;/m:fullText&gt;
231 </pre>
232 <p>Conforms to axis 1.x message service signature:<br>
233 <code>public void method(SOAPEnvelope req, SOAPEnvelope resp)</code>.
234<P>
235<DD><DL>
236
237<DT><B>Throws:</B>
238<DD><CODE>javax.xml.soap.SOAPException</CODE></DL>
239</DD>
240</DL>
241<HR>
242
243<A NAME="present(javax.xml.soap.SOAPEnvelope, javax.xml.soap.SOAPEnvelope)"><!-- --></A><H3>
244present</H3>
245<PRE>
246public void <B>present</B>(javax.xml.soap.SOAPEnvelope&nbsp;request,
247                    javax.xml.soap.SOAPEnvelope&nbsp;response)
248             throws javax.xml.soap.SOAPException</PRE>
249<DL>
250<DD>Retrieves a document, by accessing XML document at a URL.
251 <p>Requires request message containing document URL to retrieve:
252 <pre>
253&lt;m:present xmlns:m="http://ndg.nerc.ac.uk/query"&gt;
254  &lt;m:present&gt;
255    &lt;m:documentURL&gt;http://glue.badc.rl.ac.uk:8080/exist/rest/db/dif/nocs/NOCSDAT114.xml&lt;/m:documentURL&gt;
256  &lt;/m:present&gt;
257&lt;/m:present&gt;
258 </pre>
259 <p>Conforms to axis 1.x message service signature:<br>
260 <code>public void method(SOAPEnvelope req, SOAPEnvelope resp)</code>.
261 <p>Handles documents behind password-protected URLs by using custom
262 <code>Authenticator</code> loaded with username and password
263 read from properties file (<code>db.username</code>, <code>db.password</code>).
264<P>
265<DD><DL>
266
267<DT><B>Throws:</B>
268<DD><CODE>javax.xml.soap.SOAPException</CODE></DL>
269</DD>
270</DL>
271<!-- ========= END OF CLASS DATA ========= -->
272<HR>
273
274
275<!-- ======= START OF BOTTOM NAVBAR ====== -->
276<A NAME="navbar_bottom"><!-- --></A>
277<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
278<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
279<TR>
280<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
281<A NAME="navbar_bottom_firstrow"><!-- --></A>
282<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
283  <TR ALIGN="center" VALIGN="top">
284  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../ndg/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
285  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
286  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
287  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
288  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
289  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
290  </TR>
291</TABLE>
292</TD>
293<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
294</EM>
295</TD>
296</TR>
297
298<TR>
299<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
300&nbsp;PREV CLASS&nbsp;
301&nbsp;<A HREF="../../ndg/services/XMLDBMessageService.MyAuthenticator.html" title="class in ndg.services"><B>NEXT CLASS</B></A></FONT></TD>
302<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
303  <A HREF="../../index.html?ndg/services/XMLDBMessageService.html" target="_top"><B>FRAMES</B></A>  &nbsp;
304&nbsp;<A HREF="XMLDBMessageService.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
305&nbsp;<SCRIPT type="text/javascript">
306  <!--
307  if(window==top) {
308    document.writeln('<A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>');
309  }
310  //-->
311</SCRIPT>
312<NOSCRIPT>
313  <A HREF="../../allclasses-noframe.html"><B>All Classes</B></A>
314</NOSCRIPT>
315
316
317</FONT></TD>
318</TR>
319<TR>
320<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
321  SUMMARY:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
322<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
323DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
324</TR>
325</TABLE>
326<A NAME="skip-navbar_bottom"></A>
327<!-- ======== END OF BOTTOM NAVBAR ======= -->
328
329<HR>
330
331</BODY>
332</HTML>
Note: See TracBrowser for help on using the repository browser.