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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
|
/*
* ============LICENSE_START=======================================================
* PROJECT
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* Copyright (C) 2018 - 2019 Nokia. All rights reserved.s
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.dcae;
import com.google.common.annotations.VisibleForTesting;
import com.networknt.schema.JsonSchema;
import io.vavr.Function1;
import io.vavr.collection.HashMap;
import io.vavr.collection.List;
import io.vavr.collection.Map;
import org.apache.commons.configuration.ConfigurationException;
import org.apache.commons.configuration.PropertiesConfiguration;
import org.onap.dcae.common.configuration.AuthMethodType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.annotation.Nullable;
import java.nio.file.Path;
import java.nio.file.Paths;
import static java.lang.String.format;
/**
* Abstraction over application configuration.
* Its job is to provide easily discoverable (by method names lookup) and type safe access to configuration properties.
*/
public class ApplicationSettings {
private static final Logger log = LoggerFactory.getLogger(ApplicationSettings.class);
private static final String FALLBACK_VES_VERSION = "v5";
private final String appInvocationDir;
private final String configurationFileLocation;
private final PropertiesConfiguration properties = new PropertiesConfiguration();
private final JSonSchemasSupplier jSonSchemasSupplier = new JSonSchemasSupplier();
private final Map<String, JsonSchema> loadedJsonSchemas;
public ApplicationSettings(String[] args, Function1<String[], Map<String, String>> argsParser) {
this(args, argsParser, System.getProperty("user.dir"));
}
public ApplicationSettings(String[] args, Function1<String[], Map<String, String>> argsParser, String appInvocationDir) {
this.appInvocationDir = appInvocationDir;
properties.setDelimiterParsingDisabled(true);
Map<String, String> parsedArgs = argsParser.apply(args);
configurationFileLocation = findOutConfigurationFileLocation(parsedArgs);
loadPropertiesFromFile();
parsedArgs.filterKeys(k -> !"c".equals(k)).forEach(this::addOrUpdate);
String collectorSchemaFile = properties.getString("collector.schema.file",
format("{\"%s\":\"etc/CommonEventFormat_28.4.1.json\"}", FALLBACK_VES_VERSION));
loadedJsonSchemas = jSonSchemasSupplier.loadJsonSchemas(collectorSchemaFile);
}
public void reloadProperties() {
try {
properties.load(configurationFileLocation);
properties.refresh();
} catch (ConfigurationException ex) {
log.error("Cannot load properties cause:", ex);
throw new ApplicationException(ex);
}
}
public Map<String, String> validAuthorizationCredentials() {
return prepareUsersMap(properties.getString("header.authlist", null));
}
public Path configurationFileLocation() {
return Paths.get(configurationFileLocation);
}
public boolean jsonSchemaValidationEnabled() {
return properties.getInt("collector.schema.checkflag", -1) > 0;
}
public JsonSchema jsonSchema(String version) {
return loadedJsonSchemas.get(version)
.orElse(loadedJsonSchemas.get(FALLBACK_VES_VERSION))
.getOrElseThrow(() -> new IllegalStateException("No fallback schema present in application."));
}
public boolean isVersionSupported(String version){
return loadedJsonSchemas.containsKey(version);
}
public int httpPort() {
return properties.getInt("collector.service.port", 8080);
}
public int httpsPort() {
return properties.getInt("collector.service.secure.port", 8443);
}
public int configurationUpdateFrequency() {
return properties.getInt("collector.dynamic.config.update.frequency", 5);
}
public boolean httpsEnabled() {
return httpsPort() > 0;
}
public boolean eventTransformingEnabled() {
return properties.getInt("event.transform.flag", 1) > 0;
}
public String keystorePasswordFileLocation() {
return prependWithUserDirOnRelative(properties.getString("collector.keystore.passwordfile", "etc/passwordfile"));
}
public String keystoreFileLocation() {
return prependWithUserDirOnRelative(properties.getString("collector.keystore.file.location", "etc/keystore"));
}
public String truststorePasswordFileLocation() {
return prependWithUserDirOnRelative(properties.getString("collector.truststore.passwordfile", "etc/trustpasswordfile"));
}
public String truststoreFileLocation() {
return prependWithUserDirOnRelative(properties.getString("collector.truststore.file.location", "etc/truststore"));
}
public String exceptionConfigFileLocation() {
return properties.getString("exceptionConfig", null);
}
public String dMaaPConfigurationFileLocation() {
return prependWithUserDirOnRelative(properties.getString("collector.dmaapfile", "etc/DmaapConfig.json"));
}
public String certSubjectMatcher(){
return prependWithUserDirOnRelative(properties.getString("collector.cert.subject.matcher", "etc/certSubjectMatcher.properties"));
}
public String authMethod(){
return properties.getString("auth.method", AuthMethodType.NO_AUTH.value());
}
public Map<String, String[]> dMaaPStreamsMapping() {
String streamIdsProperty = properties.getString("collector.dmaap.streamid", null);
if (streamIdsProperty == null) {
return HashMap.empty();
} else {
return convertDMaaPStreamsPropertyToMap(streamIdsProperty);
}
}
private void loadPropertiesFromFile() {
try {
properties.load(configurationFileLocation);
} catch (ConfigurationException ex) {
log.error("Cannot load properties cause:", ex);
throw new ApplicationException(ex);
}
}
private void addOrUpdate(String key, String value) {
if (properties.containsKey(key)) {
properties.setProperty(key, value);
} else {
properties.addProperty(key, value);
}
}
private String findOutConfigurationFileLocation(Map<String, String> parsedArgs) {
return prependWithUserDirOnRelative(parsedArgs.get("c").getOrElse("etc/collector.properties"));
}
private Map<String, String> prepareUsersMap(@Nullable String allowedUsers) {
return allowedUsers == null ? HashMap.empty()
: List.of(allowedUsers.split("\\|"))
.map(t->t.split(","))
.toMap(t-> t[0].trim(), t -> t[1].trim());
}
private Map<String, String[]> convertDMaaPStreamsPropertyToMap(String streamIdsProperty) {
java.util.HashMap<String, String[]> domainToStreamIdsMapping = new java.util.HashMap<>();
String[] topics = streamIdsProperty.split("\\|");
for (String t : topics) {
String domain = t.split("=")[0];
String[] streamIds = t.split("=")[1].split(",");
domainToStreamIdsMapping.put(domain, streamIds);
}
return HashMap.ofAll(domainToStreamIdsMapping);
}
private String prependWithUserDirOnRelative(String filePath) {
if (!Paths.get(filePath).isAbsolute()) {
filePath = Paths.get(appInvocationDir, filePath).toString();
}
return filePath;
}
@VisibleForTesting
String getStringDirectly(String key) {
return properties.getString(key);
}
}
|
