X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=webservices%2Fcompbio%2Fdata%2Fmsa%2FRegistryWS.java;h=71a25194370e85baea728a09b3ba15abdfc58661;hb=140e024c6b00451dd933a9c25feac2d170d5f9f6;hp=3dd89b5defd2b4be681f0aa2a040b82d0b5c3b21;hpb=a2619dbd95b874abd03ae551c02524fe09e9f631;p=jabaws.git

diff --git a/webservices/compbio/data/msa/RegistryWS.java b/webservices/compbio/data/msa/RegistryWS.java
index 3dd89b5..71a2519 100644
--- a/webservices/compbio/data/msa/RegistryWS.java
+++ b/webservices/compbio/data/msa/RegistryWS.java
@@ -1,3 +1,20 @@
+/* Copyright (c) 2011 Peter Troshin
+ *  
+ *  JAva Bioinformatics Analysis Web Services (JABAWS) @version: 2.0     
+ * 
+ *  This library is free software; you can redistribute it and/or modify it under the terms of the
+ *  Apache License version 2 as published by the Apache Software Foundation
+ * 
+ *  This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
+ *  even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache 
+ *  License for more details.
+ * 
+ *  A copy of the license is in apache_license.txt. It is also available here:
+ * @see: http://www.apache.org/licenses/LICENSE-2.0.txt
+ * 
+ * Any republication or derived work distributed in source code form
+ * must include this copyright and license notice.
+ */
 package compbio.data.msa;
 
 import java.util.Date;
@@ -6,13 +23,80 @@ import java.util.Set;
 import javax.jws.WebService;
 
 import compbio.ws.client.Services;
+import compbio.ws.server.Category;
 
-@WebService(targetNamespace = "http://msa.data.compbio/01/12/2010/")
+/**
+ * JABAWS services registry
+ * 
+ * @author pvtroshin
+ * @version 1.0 June 2011
+ */
+@WebService(targetNamespace = JABAService.V2_SERVICE_NAMESPACE)
 public interface RegistryWS extends JABAService {
+
+	/**
+	 * List of services that are functioning on the server. This function
+	 * returns the results of testing performed some time ago by
+	 * {@link #testAllServices} or {@link #testService(Services)} methods. The
+	 * time of last check can be obtained from
+	 * {@link #getLastTestedOn(Services)} method
+	 * 
+	 * @return the Set of Services which are functioning on the server
+	 * @see #testAllServices()
+	 */
 	Set<Services> getSupportedServices();
+	/**
+	 * Number of seconds since the last test. Returns 0 if the service was not
+	 * tested or tested less then a one second ago.
+	 * 
+	 * @param service
+	 * @return when last time tested
+	 */
+	int getLastTested(Services service);
+	/**
+	 * The date and time the service has been verified to work last time
+	 * 
+	 * @param service
+	 * @return the Date and time on which the service was last tested
+	 */
 	Date getLastTestedOn(Services service);
+	/**
+	 * Test all JABAWS services on the server
+	 * 
+	 * @return the test log
+	 */
 	String testAllServices();
+	/**
+	 * Test a particular service
+	 * 
+	 * @param service
+	 * @return the testing log
+	 */
 	String testService(Services service);
+	/**
+	 * Check whether a particular web service is working on this server
+	 * 
+	 * @param service
+	 * @return true if the service was functioning in time of last testing.
+	 */
 	boolean isOperating(Services service);
 
+	/**
+	 * Gives the description of the service.
+	 * 
+	 * @param service
+	 * @return String, plain text or html formatted piece, but NOT a full html
+	 *         document
+	 */
+	String getServiceDescription(Services service);
+
+	/**
+	 * Gets the list of services per category. ServiceClassifier has the method
+	 * that returns Map<Category, Set<Services>>
+	 * 
+	 * @return ServiceClassifier the object to represent relation between
+	 *         Services and Categories
+	 */
+	Set<Category> getServiceCategories();
+
 }