1 package jalview.workers;
3 import java.util.HashMap;
6 import java.util.NoSuchElementException;
7 import java.util.Objects;
8 import java.util.WeakHashMap;
9 import java.util.concurrent.CopyOnWriteArrayList;
10 import java.util.concurrent.Executors;
11 import java.util.concurrent.Future;
12 import java.util.concurrent.ScheduledExecutorService;
13 import java.util.concurrent.TimeUnit;
15 import static java.lang.String.format;
16 import static java.util.Collections.synchronizedMap;
17 import static java.util.Collections.unmodifiableList;
19 import java.util.ArrayList;
21 import jalview.api.AlignCalcListener;
22 import jalview.api.AlignCalcManagerI2;
23 import jalview.api.AlignCalcWorkerI;
24 import jalview.api.PollableAlignCalcWorkerI;
25 import jalview.bin.Cache;
26 import jalview.datamodel.AlignmentAnnotation;
28 public class AlignCalcManager2 implements AlignCalcManagerI2
30 private abstract class WorkerManager
32 protected volatile boolean enabled = true;
34 protected AlignCalcWorkerI worker;
36 WorkerManager(AlignCalcWorkerI worker)
41 protected AlignCalcWorkerI getWorker()
51 void setEnabled(boolean enabled)
53 this.enabled = enabled;
56 synchronized void restart()
73 protected boolean isRestartable()
75 return registered.containsKey(getWorker());
78 abstract boolean isWorking();
80 protected abstract void submit();
82 abstract void cancel();
85 private class SimpleWorkerManager extends WorkerManager
87 private Future<?> task = null;
89 SimpleWorkerManager(AlignCalcWorkerI worker)
97 return task != null && !task.isDone();
101 protected void submit()
103 if (task != null && !(task.isDone() || task.isCancelled()))
105 throw new IllegalStateException(
106 "Cannot submit new task if the prevoius one is still running");
109 format("Worker %s queued", getWorker().getClass().getName()));
110 task = executor.submit(() -> {
113 Cache.log.debug(format("Worker %s started",
114 getWorker().getClass().getName()));
116 Cache.log.debug(format("Worker %s finished",
117 getWorker().getClass().getName()));
118 } catch (InterruptedException e)
120 Cache.log.debug(format("Worker %s interrupted",
121 getWorker().getClass().getName()));
122 } catch (Throwable th)
124 Cache.log.debug(format("Worker %s failed",
125 getWorker().getClass().getName()), th);
128 if (!isRestartable())
130 // delete worker reference so garbage collector can remove it
138 synchronized void cancel()
144 Cache.log.debug(format("Cancelling worker %s",
145 getWorker().getClass().getName()));
150 private class PollableWorkerManager extends WorkerManager
152 private Future<?> task = null;
154 PollableWorkerManager(PollableAlignCalcWorkerI worker)
160 protected PollableAlignCalcWorkerI getWorker()
162 return (PollableAlignCalcWorkerI) super.getWorker();
168 return task != null && !task.isDone();
171 protected void submit()
173 if (task != null && !(task.isDone() || task.isCancelled()))
175 throw new IllegalStateException(
176 "Cannot submit new task if the prevoius one is still running");
179 format("Worker %s queued", getWorker().getClass().getName()));
180 final var runnable = new Runnable()
182 private boolean started = false;
184 private boolean completed = false;
186 Future<?> future = null;
195 Cache.log.debug(format("Worker %s started",
196 getWorker().getClass().getName()));
197 getWorker().startUp();
202 Cache.log.debug(format("Polling worker %s",
203 getWorker().getClass().getName()));
204 if (getWorker().poll())
206 Cache.log.debug(format("Worker %s finished",
207 getWorker().getClass().getName()));
211 } catch (Throwable th)
213 Cache.log.debug(format("Worker %s failed",
214 getWorker().getClass().getName()), th);
219 final var worker = getWorker();
220 if (!isRestartable())
221 PollableWorkerManager.super.worker = null;
222 Cache.log.debug(format("Finalizing completed worker %s",
223 worker.getClass().getName()));
225 // almost impossible, but the future may be null at this point
226 // let it throw NPE to cancel forcefully
227 future.cancel(false);
231 runnable.future = task = executor.scheduleWithFixedDelay(runnable, 10,
232 1000, TimeUnit.MILLISECONDS);
235 synchronized protected void cancel()
241 Cache.log.debug(format("Cancelling worker %s",
242 getWorker().getClass().getName()));
244 executor.submit(() -> {
245 final var worker = getWorker();
246 if (!isRestartable())
247 PollableWorkerManager.super.worker = null;
251 Cache.log.debug(format("Finalizing cancelled worker %s",
252 worker.getClass().getName()));
259 private final ScheduledExecutorService executor = Executors
260 .newSingleThreadScheduledExecutor();
262 private final Map<AlignCalcWorkerI, WorkerManager> registered = synchronizedMap(
265 private final Map<AlignCalcWorkerI, WorkerManager> oneshot = synchronizedMap(
266 new WeakHashMap<>());
268 private final List<AlignCalcListener> listeners = new CopyOnWriteArrayList<>();
270 private WorkerManager createManager(AlignCalcWorkerI worker)
272 if (worker instanceof PollableAlignCalcWorkerI)
274 return new PollableWorkerManager((PollableAlignCalcWorkerI) worker);
278 return new SimpleWorkerManager(worker);
283 public void registerWorker(AlignCalcWorkerI worker)
285 Objects.requireNonNull(worker);
286 WorkerManager manager = createManager(worker);
287 registered.putIfAbsent(worker, manager);
292 public List<AlignCalcWorkerI> getWorkers()
294 List<AlignCalcWorkerI> result = new ArrayList<>(registered.size());
295 result.addAll(registered.keySet());
300 public List<AlignCalcWorkerI> getWorkersOfClass(
301 Class<? extends AlignCalcWorkerI> cls)
303 List<AlignCalcWorkerI> collected = new ArrayList<>();
304 for (var worker : getWorkers())
306 if (worker.getClass().equals(cls))
308 collected.add(worker);
311 return unmodifiableList(collected);
315 public void removeWorker(AlignCalcWorkerI worker)
317 registered.remove(worker);
321 public void removeWorkerForAnnotation(AlignmentAnnotation annot)
323 synchronized (registered)
325 for (var worker : getWorkers())
327 if (worker.involves(annot) && worker.isDeletable())
329 removeWorker(worker);
336 public void removeWorkersOfClass(Class<? extends AlignCalcWorkerI> cls)
338 synchronized (registered)
340 for (var worker : getWorkers())
342 if (worker.getClass().equals(cls))
344 removeWorker(worker);
351 public void disableWorker(AlignCalcWorkerI worker)
353 // Null pointer check might be needed
354 registered.get(worker).setEnabled(false);
358 public void enableWorker(AlignCalcWorkerI worker)
360 // Null pointer check might be needed
361 registered.get(worker).setEnabled(true);
365 public boolean isDisabled(AlignCalcWorkerI worker)
367 if (registered.containsKey(worker))
369 return !registered.get(worker).isEnabled();
378 public boolean isWorking(AlignCalcWorkerI worker)
380 var manager = registered.get(worker);
382 manager = oneshot.get(worker);
386 return manager.isWorking();
390 public boolean isWorkingWithAnnotation(AlignmentAnnotation annot)
392 synchronized (registered)
394 for (var entry : registered.entrySet())
395 if (entry.getKey().involves(annot) && entry.getValue().isWorking())
398 synchronized (oneshot)
400 for (var entry : registered.entrySet())
401 if (entry.getKey().involves(annot) && entry.getValue().isWorking())
408 public boolean isWorking()
410 synchronized (registered)
412 for (var manager : registered.values())
413 if (manager.isWorking())
416 synchronized (oneshot)
418 for (var manager : oneshot.values())
419 if (manager.isWorking())
426 public void startWorker(AlignCalcWorkerI worker)
428 Objects.requireNonNull(worker);
429 var manager = registered.get(worker);
432 Cache.log.warn("Starting unregistered worker " + worker);
433 manager = createManager(worker);
434 oneshot.put(worker, manager);
440 public void restartWorkers()
442 synchronized (registered)
444 for (var manager : registered.values())
452 public void cancelWorker(AlignCalcWorkerI worker)
454 Objects.requireNonNull(worker);
455 var manager = registered.get(worker);
457 manager = oneshot.get(worker);
460 throw new NoSuchElementException();
465 private void notifyQueued(AlignCalcWorkerI worker)
467 for (AlignCalcListener listener : listeners)
469 listener.workerQueued(worker);
473 private void notifyStarted(AlignCalcWorkerI worker)
475 for (AlignCalcListener listener : listeners)
477 listener.workerStarted(worker);
481 private void notifyCompleted(AlignCalcWorkerI worker)
483 for (AlignCalcListener listener : listeners)
487 listener.workerCompleted(worker);
488 } catch (RuntimeException e)
495 private void notifyCancelled(AlignCalcWorkerI worker)
497 for (AlignCalcListener listener : listeners)
501 listener.workerCancelled(worker);
502 } catch (RuntimeException e)
509 private void notifyExceptional(AlignCalcWorkerI worker,
512 for (AlignCalcListener listener : listeners)
516 listener.workerExceptional(worker, throwable);
517 } catch (RuntimeException e)
525 public void addAlignCalcListener(AlignCalcListener listener)
527 listeners.add(listener);
531 public void removeAlignCalcListener(AlignCalcListener listener)
533 listeners.remove(listener);
537 public void shutdown()
539 executor.shutdownNow();