1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/* 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;
import java.util.Set;
import javax.jws.WebService;
import compbio.ws.client.Services;
/**
* 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();
/**
* 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> getNonoperatedServices();
/**
* 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();
}
|
