blob: 492020b7ae469a3479909b0c38350a51e37218b1 (
plain) (
blame)
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
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.node.admin.component;
/**
* <p>This class is thread unsafe: All method calls MUST be exclusive and serialized.</p>
*
* <dl>
* <dt>In a specialized environment it is possible to provide a richer context than TaskContext:</dt>
* <dd>- Define a subclass T of TaskContext with the additional functionality.</dd>
* <dd>- Define task classes that implement IdempotentTask<T>.</dd>
* </dl>
*/
public interface IdempotentTask<T extends TaskContext> {
/**
* <p>A short id of the task to e.g. identify the task in the log.</p>
*
* <p>Prefer PascalCase and without white-space.</p>
*
* <p>Example: "EnableDocker"</p>
*/
default String name() { return getClass().getSimpleName(); }
/**
* <p>Execute an administrative task to converge towards some ideal state, whether it is
* system state or in-memory Java state.</p>
*
* <p>converge() must be idempotent: it may be called any number of times, or
* interrupted at any time e.g. by `kill -9`.</p>
*
* <p>converge() is not thread safe: The caller must ensure there is at most one invocation
* of converge() at any given time.</p>
*
* @return false if already converged, i.e. was a no-op. A typical sequence of converge()
* calls on a IdempotentTask will consist of:
* - Any number of calls that throws an exception due to some issues. Assuming
* no exceptions were thrown, or the issue eventually resolved itself...
* (convergence failure)
* - Returns true once (converged just now)
* - Returns false for all further calls (already converged)
* @throws RuntimeException (or a subclass) if the task is unable to converge.
*/
boolean converge(T context);
}
|