website/docs/full_javadoc/compbio/data/msa/RegistryWS.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
   2 <!-- NewPage -->
   3 <html lang="en">
   4 <head>
   5 <!-- Generated by javadoc (1.8.0_121) on Fri Apr 21 15:32:50 BST 2017 -->
   6 <title>RegistryWS</title>
   7 <meta name="date" content="2017-04-21">
   8 <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
   9 <script type="text/javascript" src="../../../script.js"></script>
  10 </head>
  11 <body>
  12 <script type="text/javascript"><!--
  13     try {
  14         if (location.href.indexOf('is-external=true') == -1) {
  15             parent.document.title="RegistryWS";
  16         }
  17     }
  18     catch(err) {
  19     }
  20 //-->
  21 var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6};
  22 var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23 var altColor = "altColor";
  24 var rowColor = "rowColor";
  25 var tableTab = "tableTab";
  26 var activeTableTab = "activeTableTab";
  27 </script>
  28 <noscript>
  29 <div>JavaScript is disabled on your browser.</div>
  30 </noscript>
  31 <!-- ========= START OF TOP NAVBAR ======= -->
  32 <div class="topNav"><a name="navbar.top">
  33 <!--   -->
  34 </a>
  35 <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36 <a name="navbar.top.firstrow">
  37 <!--   -->
  38 </a>
  39 <ul class="navList" title="Navigation">
  40 <li><a href="../../../overview-summary.html">Overview</a></li>
  41 <li><a href="package-summary.html">Package</a></li>
  42 <li class="navBarCell1Rev">Class</li>
  43 <li><a href="class-use/RegistryWS.html">Use</a></li>
  44 <li><a href="package-tree.html">Tree</a></li>
  45 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  46 <li><a href="../../../index-files/index-1.html">Index</a></li>
  47 <li><a href="../../../help-doc.html">Help</a></li>
  48 </ul>
  49 </div>
  50 <div class="subNav">
  51 <ul class="navList">
  52 <li><a href="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53 <li><a href="../../../compbio/data/msa/SequenceAnnotation.html" title="interface in compbio.data.msa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54 </ul>
  55 <ul class="navList">
  56 <li><a href="../../../index.html?compbio/data/msa/RegistryWS.html" target="_top">Frames</a></li>
  57 <li><a href="RegistryWS.html" target="_top">No&nbsp;Frames</a></li>
  58 </ul>
  59 <ul class="navList" id="allclasses_navbar_top">
  60 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61 </ul>
  62 <div>
  63 <script type="text/javascript"><!--
  64   allClassesLink = document.getElementById("allclasses_navbar_top");
  65   if(window==top) {
  66     allClassesLink.style.display = "block";
  67   }
  68   else {
  69     allClassesLink.style.display = "none";
  70   }
  71   //-->
  72 </script>
  73 </div>
  74 <div>
  75 <ul class="subNavList">
  76 <li>Summary:&nbsp;</li>
  77 <li>Nested&nbsp;|&nbsp;</li>
  78 <li>Field&nbsp;|&nbsp;</li>
  79 <li>Constr&nbsp;|&nbsp;</li>
  80 <li><a href="#method.summary">Method</a></li>
  81 </ul>
  82 <ul class="subNavList">
  83 <li>Detail:&nbsp;</li>
  84 <li>Field&nbsp;|&nbsp;</li>
  85 <li>Constr&nbsp;|&nbsp;</li>
  86 <li><a href="#method.detail">Method</a></li>
  87 </ul>
  88 </div>
  89 <a name="skip.navbar.top">
  90 <!--   -->
  91 </a></div>
  92 <!-- ========= END OF TOP NAVBAR ========= -->
  93 <!-- ======== START OF CLASS DATA ======== -->
  94 <div class="header">
  95 <div class="subTitle">compbio.data.msa</div>
  96 <h2 title="Interface RegistryWS" class="title">Interface RegistryWS</h2>
  97 </div>
  98 <div class="contentContainer">
  99 <div class="description">
 100 <ul class="blockList">
 101 <li class="blockList">
 102 <dl>
 103 <dt>All Superinterfaces:</dt>
 104 <dd><a href="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</a></dd>
 105 </dl>
 106 <dl>
 107 <dt>All Known Implementing Classes:</dt>
 108 <dd><a href="../../../compbio/ws/server/RegistryWS.html" title="class in compbio.ws.server">RegistryWS</a></dd>
 109 </dl>
 110 <hr>
 111 <br>
 112 <pre>public interface <span class="typeNameLabel">RegistryWS</span>
 113 extends <a href="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</a></pre>
 114 <div class="block">JABAWS services registry</div>
 115 <dl>
 116 <dt><span class="simpleTagLabel">Version:</span></dt>
 117 <dd>1.0 June 2011</dd>
 118 <dt><span class="simpleTagLabel">Author:</span></dt>
 119 <dd>pvtroshin</dd>
 120 </dl>
 121 </li>
 122 </ul>
 123 </div>
 124 <div class="summary">
 125 <ul class="blockList">
 126 <li class="blockList">
 127 <!-- =========== FIELD SUMMARY =========== -->
 128 <ul class="blockList">
 129 <li class="blockList"><a name="field.summary">
 130 <!--   -->
 131 </a>
 132 <h3>Field Summary</h3>
 133 <ul class="blockList">
 134 <li class="blockList"><a name="fields.inherited.from.class.compbio.data.msa.JABAService">
 135 <!--   -->
 136 </a>
 137 <h3>Fields inherited from interface&nbsp;compbio.data.msa.<a href="../../../compbio/data/msa/JABAService.html" title="interface in compbio.data.msa">JABAService</a></h3>
 138 <code><a href="../../../compbio/data/msa/JABAService.html#JABAWS_VERSION">JABAWS_VERSION</a>, <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>, <a href="../../../compbio/data/msa/JABAService.html#V3_SERVICE_NAMESPACE">V3_SERVICE_NAMESPACE</a></code></li>
 139 </ul>
 140 </li>
 141 </ul>
 142 <!-- ========== METHOD SUMMARY =========== -->
 143 <ul class="blockList">
 144 <li class="blockList"><a name="method.summary">
 145 <!--   -->
 146 </a>
 147 <h3>Method Summary</h3>
 148 <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 149 <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
 150 <tr>
 151 <th class="colFirst" scope="col">Modifier and Type</th>
 152 <th class="colLast" scope="col">Method and Description</th>
 153 </tr>
 154 <tr id="i0" class="altColor">
 155 <td class="colFirst"><code>int</code></td>
 156 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/RegistryWS.html#getLastTested-compbio.ws.client.Services-">getLastTested</a></span>(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</code>
 157 <div class="block">Number of seconds since the last test.</div>
 158 </td>
 159 </tr>
 160 <tr id="i1" class="rowColor">
 161 <td class="colFirst"><code>java.util.Date</code></td>
 162 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/RegistryWS.html#getLastTestedOn-compbio.ws.client.Services-">getLastTestedOn</a></span>(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</code>
 163 <div class="block">The date and time the service has been verified to work last time</div>
 164 </td>
 165 </tr>
 166 <tr id="i2" class="altColor">
 167 <td class="colFirst"><code>java.util.Set&lt;<a href="../../../compbio/data/msa/Category.html" title="class in compbio.data.msa">Category</a>&gt;</code></td>
 168 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/RegistryWS.html#getServiceCategories--">getServiceCategories</a></span>()</code>
 169 <div class="block">Gets the list of services per category.</div>
 170 </td>
 171 </tr>
 172 <tr id="i3" class="rowColor">
 173 <td class="colFirst"><code>java.lang.String</code></td>
 174 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/RegistryWS.html#getServiceDescription-compbio.ws.client.Services-">getServiceDescription</a></span>(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</code>
 175 <div class="block">Gives the description of the service.</div>
 176 </td>
 177 </tr>
 178 <tr id="i4" class="altColor">
 179 <td class="colFirst"><code>java.util.Set&lt;<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&gt;</code></td>
 180 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/RegistryWS.html#getSupportedServices--">getSupportedServices</a></span>()</code>
 181 <div class="block">List of services that are functioning on the server.</div>
 182 </td>
 183 </tr>
 184 <tr id="i5" class="rowColor">
 185 <td class="colFirst"><code>boolean</code></td>
 186 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/RegistryWS.html#isOperating-compbio.ws.client.Services-">isOperating</a></span>(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</code>
 187 <div class="block">Check whether a particular web service is working on this server</div>
 188 </td>
 189 </tr>
 190 <tr id="i6" class="altColor">
 191 <td class="colFirst"><code>java.lang.String</code></td>
 192 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/RegistryWS.html#testAllServices--">testAllServices</a></span>()</code>
 193 <div class="block">Test all JABAWS services on the server</div>
 194 </td>
 195 </tr>
 196 <tr id="i7" class="rowColor">
 197 <td class="colFirst"><code>java.lang.String</code></td>
 198 <td class="colLast"><code><span class="memberNameLink"><a href="../../../compbio/data/msa/RegistryWS.html#testService-compbio.ws.client.Services-">testService</a></span>(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</code>
 199 <div class="block">Test a particular service</div>
 200 </td>
 201 </tr>
 202 </table>
 203 </li>
 204 </ul>
 205 </li>
 206 </ul>
 207 </div>
 208 <div class="details">
 209 <ul class="blockList">
 210 <li class="blockList">
 211 <!-- ============ METHOD DETAIL ========== -->
 212 <ul class="blockList">
 213 <li class="blockList"><a name="method.detail">
 214 <!--   -->
 215 </a>
 216 <h3>Method Detail</h3>
 217 <a name="getSupportedServices--">
 218 <!--   -->
 219 </a>
 220 <ul class="blockList">
 221 <li class="blockList">
 222 <h4>getSupportedServices</h4>
 223 <pre>java.util.Set&lt;<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&gt;&nbsp;getSupportedServices()</pre>
 224 <div class="block">List of services that are functioning on the server. This function
 225  returns the results of testing performed some time ago by
 226  <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
 227  time of last check can be obtained from
 228  <a href="../../../compbio/data/msa/RegistryWS.html#getLastTestedOn-compbio.ws.client.Services-"><code>getLastTestedOn(Services)</code></a> method</div>
 229 <dl>
 230 <dt><span class="returnLabel">Returns:</span></dt>
 231 <dd>the Set of Services which are functioning on the server</dd>
 232 <dt><span class="seeLabel">See Also:</span></dt>
 233 <dd><a href="../../../compbio/data/msa/RegistryWS.html#testAllServices--"><code>testAllServices()</code></a></dd>
 234 </dl>
 235 </li>
 236 </ul>
 237 <a name="getLastTested-compbio.ws.client.Services-">
 238 <!--   -->
 239 </a>
 240 <ul class="blockList">
 241 <li class="blockList">
 242 <h4>getLastTested</h4>
 243 <pre>int&nbsp;getLastTested(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</pre>
 244 <div class="block">Number of seconds since the last test. Returns 0 if the service was not
 245  tested or tested less then a one second ago.</div>
 246 <dl>
 247 <dt><span class="paramLabel">Parameters:</span></dt>
 248 <dd><code>service</code> - </dd>
 249 <dt><span class="returnLabel">Returns:</span></dt>
 250 <dd>when last time tested</dd>
 251 </dl>
 252 </li>
 253 </ul>
 254 <a name="getLastTestedOn-compbio.ws.client.Services-">
 255 <!--   -->
 256 </a>
 257 <ul class="blockList">
 258 <li class="blockList">
 259 <h4>getLastTestedOn</h4>
 260 <pre>java.util.Date&nbsp;getLastTestedOn(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</pre>
 261 <div class="block">The date and time the service has been verified to work last time</div>
 262 <dl>
 263 <dt><span class="paramLabel">Parameters:</span></dt>
 264 <dd><code>service</code> - </dd>
 265 <dt><span class="returnLabel">Returns:</span></dt>
 266 <dd>the Date and time on which the service was last tested</dd>
 267 </dl>
 268 </li>
 269 </ul>
 270 <a name="testAllServices--">
 271 <!--   -->
 272 </a>
 273 <ul class="blockList">
 274 <li class="blockList">
 275 <h4>testAllServices</h4>
 276 <pre>java.lang.String&nbsp;testAllServices()</pre>
 277 <div class="block">Test all JABAWS services on the server</div>
 278 <dl>
 279 <dt><span class="returnLabel">Returns:</span></dt>
 280 <dd>the test log</dd>
 281 </dl>
 282 </li>
 283 </ul>
 284 <a name="testService-compbio.ws.client.Services-">
 285 <!--   -->
 286 </a>
 287 <ul class="blockList">
 288 <li class="blockList">
 289 <h4>testService</h4>
 290 <pre>java.lang.String&nbsp;testService(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</pre>
 291 <div class="block">Test a particular service</div>
 292 <dl>
 293 <dt><span class="paramLabel">Parameters:</span></dt>
 294 <dd><code>service</code> - </dd>
 295 <dt><span class="returnLabel">Returns:</span></dt>
 296 <dd>the testing log</dd>
 297 </dl>
 298 </li>
 299 </ul>
 300 <a name="isOperating-compbio.ws.client.Services-">
 301 <!--   -->
 302 </a>
 303 <ul class="blockList">
 304 <li class="blockList">
 305 <h4>isOperating</h4>
 306 <pre>boolean&nbsp;isOperating(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</pre>
 307 <div class="block">Check whether a particular web service is working on this server</div>
 308 <dl>
 309 <dt><span class="paramLabel">Parameters:</span></dt>
 310 <dd><code>service</code> - </dd>
 311 <dt><span class="returnLabel">Returns:</span></dt>
 312 <dd>true if the service was functioning in time of last testing.</dd>
 313 </dl>
 314 </li>
 315 </ul>
 316 <a name="getServiceDescription-compbio.ws.client.Services-">
 317 <!--   -->
 318 </a>
 319 <ul class="blockList">
 320 <li class="blockList">
 321 <h4>getServiceDescription</h4>
 322 <pre>java.lang.String&nbsp;getServiceDescription(<a href="../../../compbio/ws/client/Services.html" title="enum in compbio.ws.client">Services</a>&nbsp;service)</pre>
 323 <div class="block">Gives the description of the service.</div>
 324 <dl>
 325 <dt><span class="paramLabel">Parameters:</span></dt>
 326 <dd><code>service</code> - </dd>
 327 <dt><span class="returnLabel">Returns:</span></dt>
 328 <dd>String, plain text or html formatted piece, but NOT a full html
 329          document</dd>
 330 </dl>
 331 </li>
 332 </ul>
 333 <a name="getServiceCategories--">
 334 <!--   -->
 335 </a>
 336 <ul class="blockListLast">
 337 <li class="blockList">
 338 <h4>getServiceCategories</h4>
 339 <pre>java.util.Set&lt;<a href="../../../compbio/data/msa/Category.html" title="class in compbio.data.msa">Category</a>&gt;&nbsp;getServiceCategories()</pre>
 340 <div class="block">Gets the list of services per category. ServiceClassifier has the method
 341  that returns Map<Category, Set<Services>></div>
 342 <dl>
 343 <dt><span class="returnLabel">Returns:</span></dt>
 344 <dd>ServiceClassifier the object to represent relation between
 345          Services and Categories</dd>
 346 </dl>
 347 </li>
 348 </ul>
 349 </li>
 350 </ul>
 351 </li>
 352 </ul>
 353 </div>
 354 </div>
 355 <!-- ========= END OF CLASS DATA ========= -->
 356 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 357 <div class="bottomNav"><a name="navbar.bottom">
 358 <!--   -->
 359 </a>
 360 <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
 361 <a name="navbar.bottom.firstrow">
 362 <!--   -->
 363 </a>
 364 <ul class="navList" title="Navigation">
 365 <li><a href="../../../overview-summary.html">Overview</a></li>
 366 <li><a href="package-summary.html">Package</a></li>
 367 <li class="navBarCell1Rev">Class</li>
 368 <li><a href="class-use/RegistryWS.html">Use</a></li>
 369 <li><a href="package-tree.html">Tree</a></li>
 370 <li><a href="../../../deprecated-list.html">Deprecated</a></li>
 371 <li><a href="../../../index-files/index-1.html">Index</a></li>
 372 <li><a href="../../../help-doc.html">Help</a></li>
 373 </ul>
 374 </div>
 375 <div class="subNav">
 376 <ul class="navList">
 377 <li><a href="../../../compbio/data/msa/MsaWS.html" title="interface in compbio.data.msa"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
 378 <li><a href="../../../compbio/data/msa/SequenceAnnotation.html" title="interface in compbio.data.msa"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
 379 </ul>
 380 <ul class="navList">
 381 <li><a href="../../../index.html?compbio/data/msa/RegistryWS.html" target="_top">Frames</a></li>
 382 <li><a href="RegistryWS.html" target="_top">No&nbsp;Frames</a></li>
 383 </ul>
 384 <ul class="navList" id="allclasses_navbar_bottom">
 385 <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
 386 </ul>
 387 <div>
 388 <script type="text/javascript"><!--
 389   allClassesLink = document.getElementById("allclasses_navbar_bottom");
 390   if(window==top) {
 391     allClassesLink.style.display = "block";
 392   }
 393   else {
 394     allClassesLink.style.display = "none";
 395   }
 396   //-->
 397 </script>
 398 </div>
 399 <div>
 400 <ul class="subNavList">
 401 <li>Summary:&nbsp;</li>
 402 <li>Nested&nbsp;|&nbsp;</li>
 403 <li>Field&nbsp;|&nbsp;</li>
 404 <li>Constr&nbsp;|&nbsp;</li>
 405 <li><a href="#method.summary">Method</a></li>
 406 </ul>
 407 <ul class="subNavList">
 408 <li>Detail:&nbsp;</li>
 409 <li>Field&nbsp;|&nbsp;</li>
 410 <li>Constr&nbsp;|&nbsp;</li>
 411 <li><a href="#method.detail">Method</a></li>
 412 </ul>
 413 </div>
 414 <a name="skip.navbar.bottom">
 415 <!--   -->
 416 </a></div>
 417 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 418 </body>
 419 </html>