Classes

Class	Line #	Total Statements	Complexity	TOTAL Coverage	Actions
AbstractWebServiceDiscoverer	18	72	29	0.00%	Show methods

Class AbstractWebServiceDiscoverer

Class AbstractWebServiceDiscoverer	Line # 18	Total Statements 72	Complexity 29	TOTAL Coverage 0.00%
getServices() : List<WebService<?>>   getServices() : List<WebService<?>>	2323	1.01	1.01	0.0 0.00%
getServices(Class<A>) : List<WebService<A>>   getServices(Class<A>) : List<WebService<A>>	2929	6.06	2.02	0.0 0.00%
getUrls() : List<URL>   getUrls() : List<URL>	4545	14.014	4.04	0.0 0.00%
setUrls(List<URL>) : void   setUrls(List<URL>) : void	7575	10.010	5.05	0.0 0.00%
hasServices() : boolean   hasServices() : boolean	110110	1.01	1.01	0.0 0.00%
isRunning() : boolean   isRunning() : boolean	122122	1.01	1.01	0.0 0.00%
isDone() : boolean   isDone() : boolean	128128	1.01	1.01	0.0 0.00%
startDiscoverer() : CompletableFuture<List<WebService<?>>>   startDiscoverer() : CompletableFuture<List<WebService<?>>>	134134	31.031	9.09	0.0 0.00%
fireServicesChanged(List<WebService<?>>) : void   fireServicesChanged(List<WebService<?>>) : void	193193	4.04	2.02	0.0 0.00%
addServicesChangeListener(ServicesChangeListener) : void   addServicesChangeListener(ServicesChangeListener) : void	208208	1.01	1.01	0.0 0.00%
removeServicesChangeListener(ServicesChangeListener) : void   removeServicesChangeListener(ServicesChangeListener) : void	214214	1.01	1.01	0.0 0.00%
toString() : String   toString() : String	220220	1.01	1.01	0.0 0.00%

 

Contributing tests

Source view

1		package jalview.ws2.client.api;
2
3		import java.io.IOException;
4		import java.net.MalformedURLException;
5		import java.net.URL;
6		import java.util.ArrayList;
7		import java.util.Collections;
8		import java.util.List;
9		import java.util.Objects;
10		import java.util.concurrent.CompletableFuture;
11		import java.util.concurrent.atomic.AtomicInteger;
12
13		import jalview.bin.Cache;
14		import jalview.bin.Console;
15		import jalview.ws2.actions.api.ActionI;
16		import jalview.ws2.api.WebService;
17
		0% Uncovered Elements: 106 (106) Complexity: 29 Complexity Density: 0.4
18		public abstract class AbstractWebServiceDiscoverer implements WebServiceDiscovererI
19		{
20		// TODO: we can use linked hash map to group and retrieve services by type.
21		protected List<WebService<?>> services = List.of();
22
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
23	0	@Override...
24		public List<WebService<?>> getServices()
25		{
26	0	return services;
27		}
28
		0% Uncovered Elements: 8 (8) Complexity: 2 Complexity Density: 0.33
29	0	@Override...
30		public <A extends ActionI<?>> List<WebService<A>> getServices(Class<A> type)
31		{
32	0	List<WebService<A>> list = new ArrayList<>();
33	0	for (WebService<?> service : services)
34		{
35	0	if (service.getActionClass().equals(type))
36		{
37	0	@SuppressWarnings("unchecked")
38		WebService<A> _service = (WebService<A>) service;
39	0	list.add(_service);
40		}
41		}
42	0	return list;
43		}
44
		0% Uncovered Elements: 18 (18) Complexity: 4 Complexity Density: 0.29
45	0	@Override...
46		public List<URL> getUrls()
47		{
48	0	String key = getUrlsPropertyKey();
49	0	if (key == null)
50		// unmodifiable urls list, return default
51	0	return List.of(getDefaultUrl());
52	0	String surls = Cache.getProperty(key);
53	0	if (surls == null)
54	0	return List.of(getDefaultUrl());
55	0	String[] urls = surls.split(",");
56	0	ArrayList<URL> valid = new ArrayList<>(urls.length);
57	0	for (String url : urls)
58		{
59	0	try
60		{
61	0	valid.add(new URL(url));
62		} catch (MalformedURLException e)
63		{
64	0	Console.warn(String.format(
65		"Problem whilst trying to make a URL from '%s'. " +
66		"This was probably due to malformed comma-separated-list " +
67		"in the %s entry of ${HOME}/.jalview-properties",
68		Objects.toString(url, "<null>"), key));
69	0	Console.debug("Exception occurred while reading url list", e);
70		}
71		}
72	0	return valid;
73		}
74
		0% Uncovered Elements: 16 (16) Complexity: 5 Complexity Density: 0.5
75	0	@Override...
76		public void setUrls(List<URL> wsUrls)
77		{
78	0	String key = getUrlsPropertyKey();
79	0	if (key == null)
80	0	throw new UnsupportedOperationException("setting urls not supported");
81	0	if (wsUrls != null && !wsUrls.isEmpty())
82		{
83	0	String[] surls = new String[wsUrls.size()];
84	0	var iter = wsUrls.iterator();
85	0	for (int i = 0; iter.hasNext(); i++)
86	0	surls[i] = iter.next().toString();
87	0	Cache.setProperty(key, String.join(",", surls));
88		}
89		else
90		{
91	0	Cache.removeProperty(key);
92		}
93		}
94
95		/**
96		* Get the key in jalview property file where the urls for this discoverer are
97		* stored. Return null if modifying urls is not supported.
98		*
99		* @return urls entry key
100		*/
101		protected abstract String getUrlsPropertyKey();
102
103		/**
104		* Get the default url for web service discovery for this discoverer.
105		*
106		* @return default discovery url
107		*/
108		protected abstract URL getDefaultUrl();
109
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
110	0	@Override...
111		public boolean hasServices()
112		{
113	0	return !isRunning() && services.size() > 0;
114		}
115
116		private static final int END = 0x01;
117		private static final int BEGIN = 0x02;
118		private static final int AGAIN = 0x04;
119		private final AtomicInteger state = new AtomicInteger(END);
120		private CompletableFuture<List<WebService<?>>> discoveryTask = new CompletableFuture<>();
121
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
122	0	@Override...
123		public boolean isRunning()
124		{
125	0	return (state.get() & (BEGIN | AGAIN)) != 0;
126		}
127
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
128	0	@Override...
129		public boolean isDone()
130		{
131	0	return state.get() == END && discoveryTask.isDone();
132		}
133
		0% Uncovered Elements: 41 (41) Complexity: 9 Complexity Density: 0.29
134	0	@Override...
135		public synchronized final CompletableFuture<List<WebService<?>>> startDiscoverer()
136		{
137	0	Console.debug("Requesting service discovery");
138	0	while (true)
139		{
140	0	if (state.get() == AGAIN)
141		{
142	0	return discoveryTask;
143		}
144	0	if (state.compareAndSet(END, BEGIN) || state.compareAndSet(BEGIN, AGAIN))
145		{
146	0	Console.debug("State changed to " + state.get());
147	0	final var oldTask = discoveryTask;
148	0	CompletableFuture<List<WebService<?>>> task = oldTask
149		.handleAsync((_r, _e) -> {
150	0	Console.info("Reloading services for " + this);
151	0	fireServicesChanged(services = Collections.emptyList());
152	0	var allServices = new ArrayList<WebService<?>>();
153	0	for (var url : getUrls())
154		{
155	0	Console.info("Fetching list of services from " + url);
156	0	try
157		{
158	0	allServices.addAll(fetchServices(url));
159		}
160		catch (IOException e)
161		{
162	0	Console.error("Failed to get services from " + url, e);
163		}
164		}
165	0	return services = allServices;
166		});
167	0	task.<Void>handle((services, exception) -> {
168	0	while (true)
169		{
170	0	if (state.get() == END)
171		// should never happen, throw exception to break the loop just in case
172	0	throw new AssertionError();
173	0	if (state.compareAndSet(BEGIN, END) || state.compareAndSet(AGAIN, BEGIN))
174	0	Console.debug("Discovery ended, state is " + state.get());
175	0	break;
176		}
177	0	if (services != null)
178	0	fireServicesChanged(services);
179	0	return null;
180		});
181	0	Console.debug("Spawned task " + task);
182	0	Console.debug("Killing task " + oldTask);
183	0	oldTask.cancel(false);
184	0	return discoveryTask = task;
185		}
186		}
187		}
188
189		protected abstract List<WebService<?>> fetchServices(URL url) throws IOException;
190
191		private List<ServicesChangeListener> listeners = new ArrayList<>();
192
		0% Uncovered Elements: 4 (4) Complexity: 2 Complexity Density: 0.5
193	0	private void fireServicesChanged(List<WebService<?>> services)...
194		{
195	0	for (var listener : listeners)
196		{
197	0	try
198		{
199	0	listener.servicesChanged(this, services);
200		}
201		catch (Exception e)
202		{
203	0	Console.warn(e.toString(), e);
204		}
205		}
206		}
207
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
208	0	@Override...
209		public final void addServicesChangeListener(ServicesChangeListener listener)
210		{
211	0	listeners.add(listener);
212		}
213
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
214	0	@Override...
215		public final void removeServicesChangeListener(ServicesChangeListener listener)
216		{
217	0	listeners.remove(listener);
218		}
219
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
220	0	@Override...
221		public String toString()
222		{
223	0	return getClass().getName();
224		}
225		}