blob: 0c038077fe48a2adcf951d310c9ea1709370bc26 (
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
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
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.config.model.api;
import com.yahoo.config.provision.ProvisionInfo;
import com.yahoo.vespa.config.ConfigKey;
import com.yahoo.vespa.config.ConfigPayload;
import com.yahoo.vespa.config.buildergen.ConfigDefinition;
import java.time.Clock;
import java.time.Instant;
import java.util.Optional;
import java.util.Set;
import java.util.Collection;
/**
* A {@link Model} represents the interface towards the model of an entire tenant, and defines methods
* for querying this model.
*
* @author lulf
* @since 5.1
*/
public interface Model {
/**
* Resolves config for a given key and config definition
*
* @param configKey The key to resolve
* @param configDefinition The config definition to use for the schema
*/
ConfigPayload getConfig(ConfigKey<?> configKey, ConfigDefinition configDefinition);
/**
* Produces a set of the valid config keys for this model.
*/
Set<ConfigKey<?>> allConfigsProduced();
/**
* Returns information about all hosts used in this model.
*/
Collection<HostInfo> getHosts();
/**
* Returns all the config ids available for this model.
*/
Set<String> allConfigIds();
/**
* Asks the {@link Model} instance to distribute files using provided filedistribution instance.
* @param fileDistribution {@link com.yahoo.config.model.api.FileDistribution} instance that can be called to distribute files.
*/
void distributeFiles(FileDistribution fileDistribution);
/**
* Tells file distributor to rescan all files. At the moment this is a very expensive operation, so should only be done
* once per deployment.
* @param fileDistribution {@link com.yahoo.config.model.api.FileDistribution} instance.
*/
default void reloadDeployFileDistributor(FileDistribution fileDistribution) { }
/**
* Get the provisioning info for this model.
* @return {@link ProvisionInfo} instance, if available.
*/
Optional<ProvisionInfo> getProvisionInfo();
/**
* Returns whether this application allows serving config request for a different version.
* This is a validation override which is useful when we skip loading old config models
* due to some problem, or when we need to try a newer version of the platform on some node.
*/
default boolean allowModelVersionMismatch(Instant now) { return false; }
/** @deprecated pass now. */
// TODO: Remove this when no version older than 6.115 is deployed anywhere
@Deprecated
default boolean allowModelVersionMismatch() { return allowModelVersionMismatch(Clock.systemUTC().instant()); }
/**
* Returns whether old config models should be loaded (default) or not.
* Skipping old config models is a validation override which is useful when the old model
* version is known to contain some incompatibility with the application package
* and it is believed that the latest model version will deliver usable config for old versions
* requesting config.
* <p>
* If a model returns true to this it should also return true to {@link #allowModelVersionMismatch}
* or clients requesting config for those old models will not get config at all.
*/
default boolean skipOldConfigModels(Instant now) { return false; }
/** @deprecated pass now. */
// TODO: Remove this when no version older than 6.115 is deployed anywhere
@Deprecated
default boolean skipOldConfigModels() { return skipOldConfigModels(Clock.systemUTC().instant()); }
}
|