blob: 19bb6bf531f1428fbd9a1489e21a4ba2eff4cd75 (
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
package com.wireguard.android.configStore;
import com.wireguard.config.Config;
import java.util.Set;
import java9.util.concurrent.CompletionStage;
/**
* Interface for persistent storage providers for WireGuard configurations.
*/
public interface ConfigStore {
/**
* Create a persistent tunnel, which must have a unique name within the persistent storage
* medium.
*
* @param name The name of the tunnel to create.
* @param config Configuration for the new tunnel.
* @return A future completed when the tunnel and its configuration have been saved to
* persistent storage. This future encapsulates the configuration that was actually saved to
* persistent storage. This future will always be completed on the main thread.
*/
CompletionStage<Config> create(final String name, final Config config);
/**
* Delete a persistent tunnel.
*
* @param name The name of the tunnel to delete.
* @return A future completed when the tunnel and its configuration have been deleted. This
* future will always be completed on the main thread.
*/
CompletionStage<Void> delete(final String name);
/**
* Enumerate the names of tunnels present in persistent storage.
*
* @return A future completed when the set of present tunnel names is available. This future
* will always be completed on the main thread.
*/
CompletionStage<Set<String>> enumerate();
/**
* Load the configuration for the tunnel given by {@code name}.
*
* @param name The identifier for the configuration in persistent storage (i.e. the name of the
* tunnel).
* @return A future completed when an in-memory representation of the configuration is
* available. This future encapsulates the configuration loaded from persistent storage. This
* future will always be completed on the main thread.
*/
CompletionStage<Config> load(final String name);
/**
* Save the configuration for an existing tunnel given by {@code name}.
*
* @param name The identifier for the configuration in persistent storage (i.e. the name of
* the tunnel).
* @param config An updated configuration object for the tunnel.
* @return A future completed when the configuration has been saved to persistent storage. This
* future encapsulates the configuration that was actually saved to persistent storage. This
* future will always be completed on the main thread.
*/
CompletionStage<Config> save(final String name, final Config config);
}
|
