source: other-projects/trunk/gs3-webservices-democlient/docs/GS3Fedora/org/greenstone/fedora/services/package-summary.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: 11.6 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 Sun Apr 27 20:42:39 NZST 2008 -->
6<TITLE>
7org.greenstone.fedora.services
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.fedora.services package">
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="org.greenstone.fedora.services";
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/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</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 PACKAGE&nbsp;
54&nbsp;NEXT PACKAGE</FONT></TD>
55<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56 <A HREF="../../../../index.html?org/greenstone/fedora/services/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
57&nbsp;<A HREF="package-summary.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</TABLE>
73<A NAME="skip-navbar_top"></A>
74<!-- ========= END OF TOP NAVBAR ========= -->
75
76<HR>
77<H2>
78Package org.greenstone.fedora.services
79</H2>
80
81<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
82<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
83<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
84<B>Interface Summary</B></FONT></TH>
85</TR>
86<TR BGCOLOR="white" CLASS="TableRowColor">
87<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3DL.html" title="interface in org.greenstone.fedora.services">FedoraGS3DL</A></B></TD>
88<TD>Defines the methods that must be provided to retrieve the datastreams
89 specific to Greenstone documents stored in a Fedora repository.</TD>
90</TR>
91<TR BGCOLOR="white" CLASS="TableRowColor">
92<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.html" title="interface in org.greenstone.fedora.services">FedoraToGS3Interface</A></B></TD>
93<TD>The following methods return the same data as FedoraGS3DL, but formatted as
94 Greenstone Response-Message XML.</TD>
95</TR>
96<TR BGCOLOR="white" CLASS="TableRowColor">
97<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraToGS3Interface.Constants.html" title="interface in org.greenstone.fedora.services">FedoraToGS3Interface.Constants</A></B></TD>
98<TD>Interface declaring some string constants of literals to look for</TD>
99</TR>
100</TABLE>
101&nbsp;
102
103<P>
104
105<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
106<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
107<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
108<B>Class Summary</B></FONT></TH>
109</TR>
110<TR BGCOLOR="white" CLASS="TableRowColor">
111<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraCommons.html" title="class in org.greenstone.fedora.services">FedoraCommons</A></B></TD>
112<TD>Methods common to both Fedora(GS3)Connection and GSearchConnection.</TD>
113</TR>
114<TR BGCOLOR="white" CLASS="TableRowColor">
115<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraConnection.html" title="class in org.greenstone.fedora.services">FedoraConnection</A></B></TD>
116<TD>Class that establishes a connection with Fedora's web services (via
117 Java stub classes for the same) and then provides methods to retrieve
118 Greenstone-specific data, such as the TOC, EX, DC,and Section
119 datastreams of the Greenstone documents stored in Fedora's repository.</TD>
120</TR>
121<TR BGCOLOR="white" CLASS="TableRowColor">
122<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Connection.html" title="class in org.greenstone.fedora.services">FedoraGS3Connection</A></B></TD>
123<TD>Class that extends FedoraConnection in order to be able to use
124 Fedora's web services to retrieve the specific datastreams of
125 Greenstone documents stored in Fedora's repository.</TD>
126</TR>
127<TR BGCOLOR="white" CLASS="TableRowColor">
128<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/GSearchConnection.html" title="class in org.greenstone.fedora.services">GSearchConnection</A></B></TD>
129<TD>Class GSearchConnection connects to FedoraGSearch's web services.</TD>
130</TR>
131</TABLE>
132&nbsp;
133
134<P>
135
136<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
137<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
138<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
139<B>Exception Summary</B></FONT></TH>
140</TR>
141<TR BGCOLOR="white" CLASS="TableRowColor">
142<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception</A></B></TD>
143<TD>The exceptions that can be thrown by FedoraGS3.</TD>
144</TR>
145<TR BGCOLOR="white" CLASS="TableRowColor">
146<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.AuthenticationFailedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.AuthenticationFailedException</A></B></TD>
147<TD>This AuthenticationFailedException can be thrown when the user enters
148 an invalid username and password into the FedoraConnection Authentication
149 popup dialog (displayed upon FedoraConnection object construction).</TD>
150</TR>
151<TR BGCOLOR="white" CLASS="TableRowColor">
152<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.CancelledException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.CancelledException</A></B></TD>
153<TD>When the user chooses to cancel out of the FedoraConnection dialog of
154 the constructor (where they have to enter authentication information),
155 this exception is thrown, so that classes making use of FedoraConnection
156 may choose whether to exit their program or deal with it differently.</TD>
157</TR>
158<TR BGCOLOR="white" CLASS="TableRowColor">
159<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraGS3InitFailureException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraGS3InitFailureException</A></B></TD>
160<TD>Static inner class FedoraGS3InitFailureException is an Exception
161 that is thrown when no connection can be made to the Fedora server
162 and therefore the FedoraGS3 object construction failed.</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraGS3RunException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraGS3RunException</A></B></TD>
166<TD>Represents an exception that occurs when FedoraGS3 is running
167 A subclass of FedoraGS3Exception</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.FedoraVersionNotSupportedException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.FedoraVersionNotSupportedException</A></B></TD>
171<TD>Certain functionality in Fedora - in particular fielded search - is
172 implemented differently or uses slightly different Fedora types in older
173 versions of Fedora (fielded search in 2.0 uses a different Condition class).</TD>
174</TR>
175<TR BGCOLOR="white" CLASS="TableRowColor">
176<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.NotAFedoraServerException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.NotAFedoraServerException</A></B></TD>
177<TD>This AuthenticationFailedException can be thrown when there is some
178 server listening at the host and port values entered by the user, but
179 when this server is (most likely) not a Fedora Server.</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD WIDTH="15%"><B><A HREF="../../../../org/greenstone/fedora/services/FedoraGS3Exception.ServerNotFoundException.html" title="class in org.greenstone.fedora.services">FedoraGS3Exception.ServerNotFoundException</A></B></TD>
183<TD>This ServerNotFoundException can be thrown when the user enters
184 there is no (Fedora) server listening at a given host and port.</TD>
185</TR>
186</TABLE>
187&nbsp;
188
189<P>
190<DL>
191</DL>
192<HR>
193
194
195<!-- ======= START OF BOTTOM NAVBAR ====== -->
196<A NAME="navbar_bottom"><!-- --></A>
197<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
198<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
199<TR>
200<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
201<A NAME="navbar_bottom_firstrow"><!-- --></A>
202<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
203 <TR ALIGN="center" VALIGN="top">
204 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../org/greenstone/fedora/services/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
205 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
206 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
207 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
208 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
209 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
210 </TR>
211</TABLE>
212</TD>
213<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
214</EM>
215</TD>
216</TR>
217
218<TR>
219<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
220&nbsp;PREV PACKAGE&nbsp;
221&nbsp;NEXT PACKAGE</FONT></TD>
222<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
223 <A HREF="../../../../index.html?org/greenstone/fedora/services/package-summary.html" target="_top"><B>FRAMES</B></A> &nbsp;
224&nbsp;<A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
225&nbsp;<SCRIPT type="text/javascript">
226 <!--
227 if(window==top) {
228 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
229 }
230 //-->
231</SCRIPT>
232<NOSCRIPT>
233 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
234</NOSCRIPT>
235
236
237</FONT></TD>
238</TR>
239</TABLE>
240<A NAME="skip-navbar_bottom"></A>
241<!-- ======== END OF BOTTOM NAVBAR ======= -->
242
243<HR>
244
245</BODY>
246</HTML>
Note: See TracBrowser for help on using the repository browser.