X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Ffull_javadoc%2Fcompbio%2Fws%2Fserver%2FRegistryWS.html;fp=website%2Ffull_javadoc%2Fcompbio%2Fws%2Fserver%2FRegistryWS.html;h=7eacf2986c79697421cc595b3476cffd4b5d8028;hb=da8c820a7fb2edecb190589f3dc9c362e57a2f24;hp=0000000000000000000000000000000000000000;hpb=0bbebf27d045b1345bc042bdf24ef2e6808df251;p=jabaws.git diff --git a/website/full_javadoc/compbio/ws/server/RegistryWS.html b/website/full_javadoc/compbio/ws/server/RegistryWS.html new file mode 100644 index 0000000..7eacf29 --- /dev/null +++ b/website/full_javadoc/compbio/ws/server/RegistryWS.html @@ -0,0 +1,477 @@ + + + + + + +RegistryWS + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +compbio.ws.server +
+Class RegistryWS

+
+java.lang.Object
+  extended by compbio.ws.server.RegistryWS
+
+
+
All Implemented Interfaces:
JABAService, RegistryWS
+
+
+
+
public class RegistryWS
extends Object
implements RegistryWS, JABAService
+ + +

+JABAWS services registry +

+ +

+

+
Author:
+
pvtroshin
+
+
+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from interface compbio.data.msa.JABAService
SERVICE_NAMESPACE, V2_SERVICE_NAMESPACE
+  + + + + + + + + + + +
+Constructor Summary
RegistryWS() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ intgetLastTested(Services service) + +
+          Number of seconds since the last test.
+ DategetLastTestedOn(Services service) + +
+          Can potentially return null if the service has not been tested yet.
+ Set<Category>getServiceCategories() + +
+          Gets the list of services per category.
+ StringgetServiceDescription(Services service) + +
+          Gives the description of the service.
+ Set<Services>getSupportedServices() + +
+          List of services that are functioning on the server.
+ booleanisOperating(Services service) + +
+          Check whether a particular web service is working on this server
+ StringtestAllServices() + +
+          TODO improve reporting.
+ StringtestService(Services service) + +
+          Test a particular service
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+RegistryWS

+
+public RegistryWS()
+
+
+ + + + + + + + +
+Method Detail
+ +

+getSupportedServices

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

+

+
Specified by:
getSupportedServices in interface RegistryWS
+
+
+ +
Returns:
the Set of Services which are functioning on the server
See Also:
RegistryWS.testAllServices()
+
+
+
+ +

+getLastTested

+
+public int getLastTested(Services service)
+
+
Description copied from interface: RegistryWS
+
Number of seconds since the last test. Returns 0 if the service was not + tested or tested less then a one second ago. +

+

+
Specified by:
getLastTested in interface RegistryWS
+
+
+ +
Returns:
when last time tested
+
+
+
+ +

+getLastTestedOn

+
+public Date getLastTestedOn(Services service)
+
+
Can potentially return null if the service has not been tested yet. +

+

+
Specified by:
getLastTestedOn in interface RegistryWS
+
+
+ +
Returns:
the Date and time on which the service was last tested
+
+
+
+ +

+testAllServices

+
+public String testAllServices()
+
+
TODO improve reporting. stop testing service on unsupported runtime env + exception +

+

+
Specified by:
testAllServices in interface RegistryWS
+
+
+ +
Returns:
the test log
+
+
+
+ +

+testService

+
+public String testService(Services service)
+
+
Description copied from interface: RegistryWS
+
Test a particular service +

+

+
Specified by:
testService in interface RegistryWS
+
+
+ +
Returns:
the testing log
+
+
+
+ +

+isOperating

+
+public boolean isOperating(Services service)
+
+
Description copied from interface: RegistryWS
+
Check whether a particular web service is working on this server +

+

+
Specified by:
isOperating in interface RegistryWS
+
+
+ +
Returns:
true if the service was functioning in time of last testing.
+
+
+
+ +

+getServiceDescription

+
+public String getServiceDescription(Services service)
+
+
Description copied from interface: RegistryWS
+
Gives the description of the service. +

+

+
Specified by:
getServiceDescription in interface RegistryWS
+
+
+ +
Returns:
String, plain text or html formatted piece, but NOT a full html + document
+
+
+
+ +

+getServiceCategories

+
+public Set<Category> getServiceCategories()
+
+
Description copied from interface: RegistryWS
+
Gets the list of services per category. ServiceClassifier has the method + that returns Map> +

+

+
Specified by:
getServiceCategories in interface RegistryWS
+
+
+ +
Returns:
ServiceClassifier the object to represent relation between + Services and Categories
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +