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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.model;
import com.yahoo.config.ConfigBuilder;
import com.yahoo.config.ConfigInstance;
import com.yahoo.config.ConfigurationRuntimeException;
import com.yahoo.config.codegen.CNode;
import com.yahoo.config.codegen.InnerCNode;
import com.yahoo.config.codegen.LeafCNode;
import com.yahoo.vespa.config.ConfigDefinitionKey;
import com.yahoo.yolean.Exceptions;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.List;
import java.util.Map;
/**
* <p>
* This class is capable of resolving config from a config model for a given request. It will handle
* incompatibilities of the def version in the request and the version of the config classes the model
* is using.
* </p>
* <p>
* This class is agnostic of transport protocol and server implementation.
* </p>
* <p>
* Thread safe.
* </p>
*
* @author Vegard Havdal
*/
// TODO: Most of this has been copied to ConfigInstance.Builder.buildInstance() and can be removed from here
// when Model.getConfig is removed
class InstanceResolver {
private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(InstanceResolver.class.getName());
/**
* Resolves this config key into a correctly typed ConfigInstance using the given config builder.
* FIXME: Make private once config overrides are deprecated.?
*
* @param builder a ConfigBuilder to create the instance from.
* @param targetDef the def to use
* @return the config instance or null of no producer for this found in model
*/
static ConfigInstance resolveToInstance(ConfigInstance.Builder builder, InnerCNode targetDef) {
try {
if (targetDef != null) applyDef(builder, targetDef);
Class<? extends ConfigInstance> clazz = getConfigClass(builder.getClass());
return clazz.getConstructor(builder.getClass()).newInstance(builder);
} catch (Exception e) {
throw new ConfigurationRuntimeException(e);
}
}
/**
* If some fields on the builder are null now, set them from the def. Do recursively.
* <p>
* If the targetDef has some schema incompatibilities, they are not handled here
* (except logging in some cases), but in ConfigInstance.serialize().
*
* @param builder a {@link com.yahoo.config.ConfigBuilder}
* @param targetDef a config definition
* @throws Exception if applying values form config definitions fails
*/
static void applyDef(ConfigBuilder builder, InnerCNode targetDef) throws Exception {
for (Map.Entry<String, CNode> e: targetDef.children().entrySet()) {
CNode node = e.getValue();
if (node instanceof LeafCNode) {
setLeafValueIfUnset(targetDef, builder, (LeafCNode)node);
} else if (node instanceof InnerCNode) {
// Is there a private field on the builder that matches this inner node in the def?
if (hasField(builder.getClass(), node.getName())) {
Field innerField = builder.getClass().getDeclaredField(node.getName());
innerField.setAccessible(true);
Object innerFieldVal = innerField.get(builder);
if (innerFieldVal instanceof List) {
// inner array? Check that list elems are ConfigBuilder
List<?> innerList = (List<?>) innerFieldVal;
for (Object b : innerList) {
if (b instanceof ConfigBuilder) {
applyDef((ConfigBuilder) b, (InnerCNode) node);
}
}
} else if (innerFieldVal instanceof ConfigBuilder) {
// Struct perhaps
applyDef((ConfigBuilder) innerFieldVal, (InnerCNode) node);
} else {
// Likely a config value mismatch. That is handled in ConfigInstance.serialize() (error message, omit from response.)
}
}
}
}
}
private static boolean hasField(Class<?> aClass, String name) {
for (Field field : aClass.getDeclaredFields()) {
if (name.equals(field.getName())) {
return true;
}
}
return false;
}
private static void setLeafValueIfUnset(InnerCNode targetDef, Object builder, LeafCNode node) throws Exception {
if (hasField(builder.getClass(), node.getName())) {
Field field = builder.getClass().getDeclaredField(node.getName());
field.setAccessible(true);
Object val = field.get(builder);
if (val==null) {
// Not set on builder, if the leaf node has a default value, try the private setter that takes String
try {
if (node.getDefaultValue()!=null) {
Method setter = builder.getClass().getDeclaredMethod(node.getName(), String.class);
setter.setAccessible(true);
setter.invoke(builder, node.getDefaultValue().getValue());
}
} catch (Exception e) {
log.severe("For config '"+targetDef.getFullName()+"': Unable to apply the default value for field '"+node.getName()+
"' to config Builder (where it wasn't set): "+
Exceptions.toMessageString(e));
}
}
}
}
@SuppressWarnings("unchecked")
private static Class<? extends ConfigInstance> getConfigClass(Class<? extends ConfigInstance.Builder> builderClass) {
Class<?> configClass = builderClass.getEnclosingClass();
if (configClass == null || ! ConfigInstance.class.isAssignableFrom(configClass)) {
throw new ConfigurationRuntimeException("Builder class " + builderClass + " has enclosing class " + configClass + ", which is not a ConfigInstance");
}
return (Class<? extends ConfigInstance>) configClass;
}
static String packageName(ConfigDefinitionKey cKey, PackagePrefix packagePrefix) {
return packagePrefix.value + cKey.getNamespace();
}
enum PackagePrefix {
COM_YAHOO("com.yahoo."),
NONE("");
final String value;
PackagePrefix (String value) {
this.value = value;
}
}
}
|
