compbio.data.msa
Interface RegistryWS

All Superinterfaces:
JABAService

public interface RegistryWS
extends JABAService

JABAWS services registry

Version:
1.0 June 2011
Author:
pvtroshin

Field Summary
 
Fields inherited from interface compbio.data.msa.JABAService
SERVICE_NAMESPACE, V2_SERVICE_NAMESPACE
 
Method Summary
 int getLastTested(Services service)
          Number of seconds since the last test.
 java.util.Date getLastTestedOn(Services service)
          The date and time the service has been verified to work last time
 java.util.Set<Category> getServiceCategories()
          Gets the list of services per category.
 java.lang.String getServiceDescription(Services service)
          Gives the description of the service.
 java.util.Set<Services> getSupportedServices()
          List of services that are functioning on the server.
 boolean isOperating(Services service)
          Check whether a particular web service is working on this server
 java.lang.String testAllServices()
          Test all JABAWS services on the server
 java.lang.String testService(Services service)
          Test a particular service
 

Method Detail

getSupportedServices

java.util.Set<Services> getSupportedServices()
List of services that are functioning on the server. This function returns the results of testing performed some time ago by testAllServices() or testService(Services) methods. The time of last check can be obtained from getLastTestedOn(Services) method

Returns:
the Set of Services which are functioning on the server
See Also:
testAllServices()

getLastTested

int getLastTested(Services service)
Number of seconds since the last test. Returns 0 if the service was not tested or tested less then a one second ago.

Parameters:
service -
Returns:
when last time tested

getLastTestedOn

java.util.Date getLastTestedOn(Services service)
The date and time the service has been verified to work last time

Parameters:
service -
Returns:
the Date and time on which the service was last tested

testAllServices

java.lang.String testAllServices()
Test all JABAWS services on the server

Returns:
the test log

testService

java.lang.String testService(Services service)
Test a particular service

Parameters:
service -
Returns:
the testing log

isOperating

boolean isOperating(Services service)
Check whether a particular web service is working on this server

Parameters:
service -
Returns:
true if the service was functioning in time of last testing.

getServiceDescription

java.lang.String getServiceDescription(Services service)
Gives the description of the service.

Parameters:
service -
Returns:
String, plain text or html formatted piece, but NOT a full html document

getServiceCategories

java.util.Set<Category> getServiceCategories()
Gets the list of services per category. ServiceClassifier has the method that returns Map>

Returns:
ServiceClassifier the object to represent relation between Services and Categories