webservices/compbio/data/msa/RegistryWS.java

   1 package compbio.data.msa;\r
   2 \r
   3 import java.util.Date;\r
   4 import java.util.Set;\r
   5 \r
   6 import javax.jws.WebService;\r
   7 \r
   8 import compbio.ws.client.Services;\r
   9 \r
  10 /**\r
  11  * JABAWS services registry\r
  12  * \r
  13  * @author pvtroshin\r
  14  * @version 1.0 June 2011\r
  15  */\r
  16 @WebService(targetNamespace = JABAService.V2_SERVICE_NAMESPACE)\r
  17 public interface RegistryWS extends JABAService {\r
  18 \r
  19         /**\r
  20          * List of services that are functioning on the server. This function\r
  21          * returns the results of testing performed some time ago by\r
  22          * {@link #testAllServices} or {@link #testService(Services)} methods. The\r
  23          * time of last check can be obtained from\r
  24          * {@link #getLastTestedOn(Services)} method\r
  25          * \r
  26          * @return the Set of Services which are functioning on the server\r
  27          * @see #testAllServices()\r
  28          */\r
  29         Set<Services> getSupportedServices();\r
  30         /**\r
  31          * Number of seconds since the last test. Returns 0 if the service was not\r
  32          * tested or tested less then a one second ago.\r
  33          * \r
  34          * @param service\r
  35          * @return\r
  36          */\r
  37         int getLastTested(Services service);\r
  38         /**\r
  39          * The date and time the service has been verified to work last time\r
  40          * \r
  41          * @param service\r
  42          * @return the Date and time on which the service was last tested\r
  43          */\r
  44         Date getLastTestedOn(Services service);\r
  45         /**\r
  46          * Test all JABAWS services on the server\r
  47          * \r
  48          * @return the test log\r
  49          */\r
  50         String testAllServices();\r
  51         /**\r
  52          * Test a particular service\r
  53          * \r
  54          * @param service\r
  55          * @return the testing log\r
  56          */\r
  57         String testService(Services service);\r
  58         /**\r
  59          * Check whether a particular web service is working on this server\r
  60          * \r
  61          * @param service\r
  62          * @return true if the service was functioning in time of last testing.\r
  63          */\r
  64         boolean isOperating(Services service);\r
  65 \r
  66 }\r