1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
\r
5 <!-- Generated by javadoc (build 1.6.0_24) on Wed Dec 07 12:08:24 GMT 2011 -->
\r
10 <META NAME="date" CONTENT="2011-12-07">
\r
12 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
\r
14 <SCRIPT type="text/javascript">
\r
15 function windowTitle()
\r
17 if (location.href.indexOf('is-external=true') == -1) {
\r
18 parent.document.title="RegistryWS";
\r
27 <BODY BGCOLOR="white" onload="windowTitle();">
\r
31 <!-- ========= START OF TOP NAVBAR ======= -->
\r
32 <A NAME="navbar_top"><!-- --></A>
\r
33 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
\r
34 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
36 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
37 <A NAME="navbar_top_firstrow"><!-- --></A>
\r
38 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
39 <TR ALIGN="center" VALIGN="top">
\r
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RegistryWS.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
51 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
57 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
58 <A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>
\r
59 <A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="interface in compbio.data.msa"><B>NEXT CLASS</B></A></FONT></TD>
\r
60 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
61 <A HREF="../../../index.html?compbio/data/msa/RegistryWS.html" target="_top"><B>FRAMES</B></A>
\r
62 <A HREF="RegistryWS.html" target="_top"><B>NO FRAMES</B></A>
\r
63 <SCRIPT type="text/javascript">
\r
66 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
71 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
79 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
80 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
81 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
84 <A NAME="skip-navbar_top"></A>
\r
85 <!-- ========= END OF TOP NAVBAR ========= -->
\r
88 <!-- ======== START OF CLASS DATA ======== -->
\r
91 compbio.data.msa</FONT>
\r
93 Interface RegistryWS</H2>
\r
95 <DT><B>All Superinterfaces:</B> <DD><A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A></DD>
\r
99 <DT><PRE>public interface <B>RegistryWS</B><DT>extends <A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A></DL>
\r
103 JABAWS services registry
\r
108 <DT><B>Version:</B></DT>
\r
109 <DD>1.0 June 2011</DD>
\r
110 <DT><B>Author:</B></DT>
\r
116 <!-- =========== FIELD SUMMARY =========== -->
\r
118 <A NAME="field_summary"><!-- --></A>
\r
119 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
120 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
121 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
122 <B>Field Summary</B></FONT></TH>
\r
125 <A NAME="fields_inherited_from_class_compbio.data.msa.JABAService"><!-- --></A>
\r
126 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
127 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
\r
128 <TH ALIGN="left"><B>Fields inherited from interface compbio.data.msa.<A HREF="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</A></B></TH>
\r
130 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
131 <TD><CODE><A HREF="../../../compbio/data/msa/JABAService.html#SERVICE_NAMESPACE">SERVICE_NAMESPACE</A>, <A HREF="../../../compbio/data/msa/JABAService.html#V2_SERVICE_NAMESPACE">V2_SERVICE_NAMESPACE</A></CODE></TD>
\r
135 <!-- ========== METHOD SUMMARY =========== -->
\r
137 <A NAME="method_summary"><!-- --></A>
\r
138 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
139 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
140 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
\r
141 <B>Method Summary</B></FONT></TH>
\r
143 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
144 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
145 <CODE> int</CODE></FONT></TD>
\r
146 <TD><CODE><B><A HREF="../../../compbio/data/msa/RegistryWS.html#getLastTested(compbio.ws.client.Services)">getLastTested</A></B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</CODE>
\r
149 Number of seconds since the last test.</TD>
\r
151 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
153 <CODE> java.util.Date</CODE></FONT></TD>
\r
154 <TD><CODE><B><A HREF="../../../compbio/data/msa/RegistryWS.html#getLastTestedOn(compbio.ws.client.Services)">getLastTestedOn</A></B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</CODE>
\r
157 The date and time the service has been verified to work last time</TD>
\r
159 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
160 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
161 <CODE> java.util.Set<<A HREF="../../../compbio/data/msa/Category.html" title="class in compbio.data.msa">Category</A>></CODE></FONT></TD>
\r
162 <TD><CODE><B><A HREF="../../../compbio/data/msa/RegistryWS.html#getServiceCategories()">getServiceCategories</A></B>()</CODE>
\r
165 Gets the list of services per category.</TD>
\r
167 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
168 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
169 <CODE> java.lang.String</CODE></FONT></TD>
\r
170 <TD><CODE><B><A HREF="../../../compbio/data/msa/RegistryWS.html#getServiceDescription(compbio.ws.client.Services)">getServiceDescription</A></B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</CODE>
\r
173 Gives the description of the service.</TD>
\r
175 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
176 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
177 <CODE> java.util.Set<<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>></CODE></FONT></TD>
\r
178 <TD><CODE><B><A HREF="../../../compbio/data/msa/RegistryWS.html#getSupportedServices()">getSupportedServices</A></B>()</CODE>
\r
181 List of services that are functioning on the server.</TD>
\r
183 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
184 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
185 <CODE> boolean</CODE></FONT></TD>
\r
186 <TD><CODE><B><A HREF="../../../compbio/data/msa/RegistryWS.html#isOperating(compbio.ws.client.Services)">isOperating</A></B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</CODE>
\r
189 Check whether a particular web service is working on this server</TD>
\r
191 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
192 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
193 <CODE> java.lang.String</CODE></FONT></TD>
\r
194 <TD><CODE><B><A HREF="../../../compbio/data/msa/RegistryWS.html#testAllServices()">testAllServices</A></B>()</CODE>
\r
197 Test all JABAWS services on the server</TD>
\r
199 <TR BGCOLOR="white" CLASS="TableRowColor">
\r
200 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
\r
201 <CODE> java.lang.String</CODE></FONT></TD>
\r
202 <TD><CODE><B><A HREF="../../../compbio/data/msa/RegistryWS.html#testService(compbio.ws.client.Services)">testService</A></B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</CODE>
\r
205 Test a particular service</TD>
\r
211 <!-- ============ METHOD DETAIL ========== -->
\r
213 <A NAME="method_detail"><!-- --></A>
\r
214 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
\r
215 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
\r
216 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
\r
217 <B>Method Detail</B></FONT></TH>
\r
221 <A NAME="getSupportedServices()"><!-- --></A><H3>
\r
222 getSupportedServices</H3>
\r
224 java.util.Set<<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A>> <B>getSupportedServices</B>()</PRE>
\r
226 <DD>List of services that are functioning on the server. This function
227 returns the results of testing performed some time ago by
228 <A HREF="../../../compbio/data/msa/RegistryWS.html#testAllServices()"><CODE>testAllServices()</CODE></A> or <A HREF="../../../compbio/data/msa/RegistryWS.html#testService(compbio.ws.client.Services)"><CODE>testService(Services)</CODE></A> methods. The
229 time of last check can be obtained from
230 <A HREF="../../../compbio/data/msa/RegistryWS.html#getLastTestedOn(compbio.ws.client.Services)"><CODE>getLastTestedOn(Services)</CODE></A> method
\r
237 <DT><B>Returns:</B><DD>the Set of Services which are functioning on the server<DT><B>See Also:</B><DD><A HREF="../../../compbio/data/msa/RegistryWS.html#testAllServices()"><CODE>testAllServices()</CODE></A></DL>
\r
242 <A NAME="getLastTested(compbio.ws.client.Services)"><!-- --></A><H3>
\r
245 int <B>getLastTested</B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</PRE>
\r
247 <DD>Number of seconds since the last test. Returns 0 if the service was not
248 tested or tested less then a one second ago.
\r
254 <DT><B>Parameters:</B><DD><CODE>service</CODE> -
\r
255 <DT><B>Returns:</B><DD>when last time tested</DL>
\r
260 <A NAME="getLastTestedOn(compbio.ws.client.Services)"><!-- --></A><H3>
\r
261 getLastTestedOn</H3>
\r
263 java.util.Date <B>getLastTestedOn</B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</PRE>
\r
265 <DD>The date and time the service has been verified to work last time
\r
271 <DT><B>Parameters:</B><DD><CODE>service</CODE> -
\r
272 <DT><B>Returns:</B><DD>the Date and time on which the service was last tested</DL>
\r
277 <A NAME="testAllServices()"><!-- --></A><H3>
\r
278 testAllServices</H3>
\r
280 java.lang.String <B>testAllServices</B>()</PRE>
\r
282 <DD>Test all JABAWS services on the server
\r
289 <DT><B>Returns:</B><DD>the test log</DL>
\r
294 <A NAME="testService(compbio.ws.client.Services)"><!-- --></A><H3>
\r
297 java.lang.String <B>testService</B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</PRE>
\r
299 <DD>Test a particular service
\r
305 <DT><B>Parameters:</B><DD><CODE>service</CODE> -
\r
306 <DT><B>Returns:</B><DD>the testing log</DL>
\r
311 <A NAME="isOperating(compbio.ws.client.Services)"><!-- --></A><H3>
\r
314 boolean <B>isOperating</B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</PRE>
\r
316 <DD>Check whether a particular web service is working on this server
\r
322 <DT><B>Parameters:</B><DD><CODE>service</CODE> -
\r
323 <DT><B>Returns:</B><DD>true if the service was functioning in time of last testing.</DL>
\r
328 <A NAME="getServiceDescription(compbio.ws.client.Services)"><!-- --></A><H3>
\r
329 getServiceDescription</H3>
\r
331 java.lang.String <B>getServiceDescription</B>(<A HREF="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</A> service)</PRE>
\r
333 <DD>Gives the description of the service.
\r
339 <DT><B>Parameters:</B><DD><CODE>service</CODE> -
\r
340 <DT><B>Returns:</B><DD>String, plain text or html formatted piece, but NOT a full html
346 <A NAME="getServiceCategories()"><!-- --></A><H3>
\r
347 getServiceCategories</H3>
\r
349 java.util.Set<<A HREF="../../../compbio/data/msa/Category.html" title="class in compbio.data.msa">Category</A>> <B>getServiceCategories</B>()</PRE>
\r
351 <DD>Gets the list of services per category. ServiceClassifier has the method
352 that returns Map<Category, Set<Services>>
\r
359 <DT><B>Returns:</B><DD>ServiceClassifier the object to represent relation between
360 Services and Categories</DL>
\r
363 <!-- ========= END OF CLASS DATA ========= -->
\r
367 <!-- ======= START OF BOTTOM NAVBAR ====== -->
\r
368 <A NAME="navbar_bottom"><!-- --></A>
\r
369 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
\r
370 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
\r
372 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
\r
373 <A NAME="navbar_bottom_firstrow"><!-- --></A>
\r
374 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
\r
375 <TR ALIGN="center" VALIGN="top">
\r
376 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
\r
377 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
\r
378 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
\r
379 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/RegistryWS.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
\r
380 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
\r
381 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
\r
382 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
\r
383 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
\r
387 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
\r
393 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
394 <A HREF="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa"><B>PREV CLASS</B></A>
\r
395 <A HREF="../../../compbio/data/msa/SequenceAnnotation.html" title="interface in compbio.data.msa"><B>NEXT CLASS</B></A></FONT></TD>
\r
396 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
\r
397 <A HREF="../../../index.html?compbio/data/msa/RegistryWS.html" target="_top"><B>FRAMES</B></A>
\r
398 <A HREF="RegistryWS.html" target="_top"><B>NO FRAMES</B></A>
\r
399 <SCRIPT type="text/javascript">
\r
402 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
\r
407 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
\r
414 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
415 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
\r
416 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
\r
417 DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
\r
420 <A NAME="skip-navbar_bottom"></A>
\r
421 <!-- ======== END OF BOTTOM NAVBAR ======= -->
\r