2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
6 * Copyright © 2017-2018 European Software Marketing Ltd.
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
21 package org.onap.aai.modelloader.config;
24 import java.nio.file.Path;
25 import java.nio.file.Paths;
26 import java.util.ArrayList;
27 import java.util.List;
28 import java.util.Properties;
30 import org.apache.commons.lang3.StringUtils;
31 import org.eclipse.jetty.util.security.Password;
32 import org.onap.sdc.api.consumer.IConfiguration;
35 * Properties for the Model Loader
38 public class ModelLoaderConfig implements IConfiguration {
40 // Configuration file structure
41 public static final String PREFIX_MODEL_LOADER_CONFIG = "ml";
42 public static final String PREFIX_DISTRIBUTION_CLIENT = PREFIX_MODEL_LOADER_CONFIG + ".distribution.";
43 public static final String PREFIX_AAI = PREFIX_MODEL_LOADER_CONFIG + ".aai.";
44 public static final String PREFIX_BABEL = PREFIX_MODEL_LOADER_CONFIG + ".babel.";
45 public static final String PREFIX_DEBUG = PREFIX_MODEL_LOADER_CONFIG + ".debug.";
47 private static final String SUFFIX_KEYSTORE_FILE = "KEYSTORE_FILE";
48 private static final String SUFFIX_KEYSTORE_PASS = "KEYSTORE_PASSWORD";
50 private static final String SUFFIX_TRUSTSTORE_FILE = "TRUSTSTORE_FILE";
51 private static final String SUFFIX_TRUSTSTORE_PASS = "TRUSTSTORE_PASSWORD";
53 // Configuration file properties
54 protected static final String PROP_ML_DISTRIBUTION_ACTIVE_SERVER_TLS_AUTH =
55 PREFIX_DISTRIBUTION_CLIENT + "ACTIVE_SERVER_TLS_AUTH";
56 protected static final String PROP_ML_DISTRIBUTION_ASDC_CONNECTION_DISABLED =
57 PREFIX_DISTRIBUTION_CLIENT + "ASDC_CONNECTION_DISABLE";
58 protected static final String PROP_ML_DISTRIBUTION_ASDC_ADDRESS = PREFIX_DISTRIBUTION_CLIENT + "ASDC_ADDRESS";
59 protected static final String PROP_ML_DISTRIBUTION_CONSUMER_GROUP = PREFIX_DISTRIBUTION_CLIENT + "CONSUMER_GROUP";
60 protected static final String PROP_ML_DISTRIBUTION_CONSUMER_ID = PREFIX_DISTRIBUTION_CLIENT + "CONSUMER_ID";
61 protected static final String PROP_ML_DISTRIBUTION_ENVIRONMENT_NAME =
62 PREFIX_DISTRIBUTION_CLIENT + "ENVIRONMENT_NAME";
63 protected static final String PROP_ML_DISTRIBUTION_KEYSTORE_PASSWORD =
64 PREFIX_DISTRIBUTION_CLIENT + SUFFIX_KEYSTORE_PASS;
65 protected static final String PROP_ML_DISTRIBUTION_KEYSTORE_FILE =
66 PREFIX_DISTRIBUTION_CLIENT + SUFFIX_KEYSTORE_FILE;
67 protected static final String PROP_ML_DISTRIBUTION_PASSWORD = PREFIX_DISTRIBUTION_CLIENT + "PASSWORD";
68 protected static final String PROP_ML_DISTRIBUTION_POLLING_INTERVAL =
69 PREFIX_DISTRIBUTION_CLIENT + "POLLING_INTERVAL";
70 protected static final String PROP_ML_DISTRIBUTION_POLLING_TIMEOUT = PREFIX_DISTRIBUTION_CLIENT + "POLLING_TIMEOUT";
71 protected static final String PROP_ML_DISTRIBUTION_USER = PREFIX_DISTRIBUTION_CLIENT + "USER";
72 protected static final String PROP_ML_DISTRIBUTION_ARTIFACT_TYPES = PREFIX_DISTRIBUTION_CLIENT + "ARTIFACT_TYPES";
73 protected static final String PROP_ML_DISTRIBUTION_MSG_BUS_ADDRESSES =
74 PREFIX_DISTRIBUTION_CLIENT + "MSG_BUS_ADDRESSES";
75 protected static final String PROP_ML_DISTRIBUTION_HTTPS_WITH_DMAAP =
76 PREFIX_DISTRIBUTION_CLIENT + "USE_HTTPS_WITH_DMAAP";
78 protected static final String PROP_AAI_BASE_URL = PREFIX_AAI + "BASE_URL";
79 protected static final String PROP_AAI_KEYSTORE_FILE = PREFIX_AAI + SUFFIX_KEYSTORE_FILE;
80 protected static final String PROP_AAI_KEYSTORE_PASSWORD = PREFIX_AAI + SUFFIX_KEYSTORE_PASS;
81 protected static final String PROP_AAI_MODEL_RESOURCE_URL = PREFIX_AAI + "MODEL_URL";
82 protected static final String PROP_AAI_NAMED_QUERY_RESOURCE_URL = PREFIX_AAI + "NAMED_QUERY_URL";
83 protected static final String PROP_AAI_VNF_IMAGE_RESOURCE_URL = PREFIX_AAI + "VNF_IMAGE_URL";
84 protected static final String PROP_AAI_AUTHENTICATION_USER = PREFIX_AAI + "AUTH_USER";
85 protected static final String PROP_AAI_AUTHENTICATION_PASSWORD = PREFIX_AAI + "AUTH_PASSWORD";
86 protected static final String PROP_AAI_USE_GIZMO = PREFIX_AAI + "USE_GIZMO";
88 protected static final String PROP_BABEL_BASE_URL = PREFIX_BABEL + "BASE_URL";
89 protected static final String PROP_BABEL_KEYSTORE_FILE = PREFIX_BABEL + SUFFIX_KEYSTORE_FILE;
90 protected static final String PROP_BABEL_KEYSTORE_PASSWORD = PREFIX_BABEL + SUFFIX_KEYSTORE_PASS;
91 protected static final String PROP_BABEL_TRUSTSTORE_FILE = PREFIX_BABEL + SUFFIX_TRUSTSTORE_FILE;
92 protected static final String PROP_BABEL_TRUSTSTORE_PASSWORD = PREFIX_BABEL + SUFFIX_TRUSTSTORE_PASS;
93 protected static final String PROP_BABEL_GENERATE_RESOURCE_URL = PREFIX_BABEL + "GENERATE_ARTIFACTS_URL";
95 protected static final String PROP_DEBUG_INGEST_SIMULATOR = PREFIX_DEBUG + "INGEST_SIMULATOR";
96 protected static final String FILESEP =
97 (System.getProperty("file.separator") == null) ? "/" : System.getProperty("file.separator");
99 private static String configHome;
100 private Properties modelLoaderProperties = null;
101 private String certLocation = ".";
102 private List<String> artifactTypes = null;
103 private List<String> msgBusAddrs = null;
104 private String modelVersion = null;
106 public ModelLoaderConfig(Properties configProperties) {
107 this(configProperties, ModelLoaderConfig.configHome + FILESEP + "auth" + FILESEP);
111 * Original constructor
113 * @param modelLoaderProperties
114 * properties needed to be configured for the model loader
115 * @param certLocation
116 * location of the certificate
118 public ModelLoaderConfig(Properties modelLoaderProperties, String certLocation) {
119 this.modelLoaderProperties = modelLoaderProperties;
120 this.certLocation = certLocation;
122 // Get list of artifacts
123 artifactTypes = new ArrayList<>();
124 if (get(PROP_ML_DISTRIBUTION_ARTIFACT_TYPES) != null) {
125 String[] artTypeList = get(PROP_ML_DISTRIBUTION_ARTIFACT_TYPES).split(",");
126 for (String artType : artTypeList) {
127 artifactTypes.add(artType);
131 // Get list of message bus addresses
132 msgBusAddrs = new ArrayList<>();
133 if (get(PROP_ML_DISTRIBUTION_MSG_BUS_ADDRESSES) != null) {
134 String[] msgBusList = get(PROP_ML_DISTRIBUTION_MSG_BUS_ADDRESSES).split(",");
135 for (String addr : msgBusList) {
136 msgBusAddrs.add(addr);
141 public static void setConfigHome(String configHome) {
142 ModelLoaderConfig.configHome = configHome;
145 public static Path propertiesFile() {
146 return Paths.get(configHome, "model-loader.properties");
150 public boolean activateServerTLSAuth() {
151 String value = get(PROP_ML_DISTRIBUTION_ACTIVE_SERVER_TLS_AUTH);
152 return value != null && Boolean.parseBoolean(value);
156 public String getAsdcAddress() {
157 return get(PROP_ML_DISTRIBUTION_ASDC_ADDRESS);
161 public String getConsumerGroup() {
162 return get(PROP_ML_DISTRIBUTION_CONSUMER_GROUP);
166 public String getConsumerID() {
167 return get(PROP_ML_DISTRIBUTION_CONSUMER_ID);
171 public String getEnvironmentName() {
172 return get(PROP_ML_DISTRIBUTION_ENVIRONMENT_NAME);
176 public String getKeyStorePassword() {
177 return getDeobfuscatedValue(get(PROP_ML_DISTRIBUTION_KEYSTORE_PASSWORD));
181 public String getKeyStorePath() {
182 return certLocation + get(PROP_ML_DISTRIBUTION_KEYSTORE_FILE);
186 public String getPassword() {
187 return getDeobfuscatedValue(get(PROP_ML_DISTRIBUTION_PASSWORD));
191 public int getPollingInterval() {
192 return Integer.parseInt(get(PROP_ML_DISTRIBUTION_POLLING_INTERVAL));
196 public int getPollingTimeout() {
197 return Integer.parseInt(get(PROP_ML_DISTRIBUTION_POLLING_TIMEOUT));
201 public List<String> getRelevantArtifactTypes() {
202 return artifactTypes;
206 public String getUser() {
207 return get(PROP_ML_DISTRIBUTION_USER);
211 public boolean isFilterInEmptyResources() {
216 public Boolean isUseHttpsWithDmaap() {
217 String useHTTPS = get(PROP_ML_DISTRIBUTION_HTTPS_WITH_DMAAP);
218 return useHTTPS != null && Boolean.valueOf(useHTTPS);
222 public List<String> getMsgBusAddress() {
226 public String getAaiKeyStorePath() {
227 return certLocation + File.separator + modelLoaderProperties.getProperty(PROP_AAI_KEYSTORE_FILE);
230 public String getBabelKeyStorePath() {
231 String filename = get(PROP_BABEL_KEYSTORE_FILE);
232 if (filename == null) {
235 return certLocation + File.separator + filename;
239 public String getAaiKeyStorePassword() {
240 return getDeobfuscatedValue(get(PROP_AAI_KEYSTORE_PASSWORD));
243 public String getBabelKeyStorePassword() {
244 return getDeobfuscatedValue(get(PROP_BABEL_KEYSTORE_PASSWORD));
247 public String getBabelTrustStorePath() {
248 String filename = get(PROP_BABEL_TRUSTSTORE_FILE);
249 if (filename == null) {
252 return certLocation + File.separator + filename;
256 public String getBabelTrustStorePassword() {
257 return getDeobfuscatedValue(get(PROP_BABEL_TRUSTSTORE_PASSWORD));
260 public String getAaiBaseUrl() {
261 return get(PROP_AAI_BASE_URL);
264 public String getBabelBaseUrl() {
265 return get(PROP_BABEL_BASE_URL);
268 public String getBabelGenerateArtifactsUrl() {
269 return get(PROP_BABEL_GENERATE_RESOURCE_URL);
272 public String getAaiModelUrl(String version) {
273 setModelVersion(version);
274 return updatePropertyOXMVersion(modelLoaderProperties, PROP_AAI_MODEL_RESOURCE_URL, version);
277 public String getAaiNamedQueryUrl(String version) {
278 return updatePropertyOXMVersion(modelLoaderProperties, PROP_AAI_NAMED_QUERY_RESOURCE_URL, version);
281 public String getAaiVnfImageUrl() {
282 return updatePropertyOXMVersion(modelLoaderProperties, PROP_AAI_VNF_IMAGE_RESOURCE_URL, getModelVersion());
285 public String getAaiAuthenticationUser() {
286 return get(PROP_AAI_AUTHENTICATION_USER);
289 public String getModelVersion() {
293 public void setModelVersion(String modelVersion) {
294 this.modelVersion = modelVersion;
297 public boolean useGizmo() {
298 String useGizmo = get(PROP_AAI_USE_GIZMO);
299 return useGizmo != null && useGizmo.equalsIgnoreCase("true");
303 * @return password for AAI authentication that has been reverse-engineered from its obfuscated form.
305 public String getAaiAuthenticationPassword() {
306 String password = getDeobfuscatedValue(get(PROP_AAI_AUTHENTICATION_PASSWORD));
308 if (password != null && password.isEmpty()) {
316 * @return a boolean value indicating whether the simulator is enabled.
318 public boolean getIngestSimulatorEnabled() {
319 String propValue = get(PROP_DEBUG_INGEST_SIMULATOR);
320 return propValue != null && "enabled".equalsIgnoreCase(propValue);
324 * @return a String value of the defined property with the oxm version
326 private String updatePropertyOXMVersion(Properties modelLoaderProperties, String propertyName, String version) {
328 return get(propertyName).replace("v*", version);
330 return get(propertyName);
334 * @return a boolean value indicating whether model loader is connected to ASDC.
336 public boolean getASDCConnectionDisabled() {
337 String propValue = get(PROP_ML_DISTRIBUTION_ASDC_CONNECTION_DISABLED);
338 return propValue != null && "true".equalsIgnoreCase(propValue);
342 private String getDeobfuscatedValue(String property) {
343 if (property.startsWith("OBF:")) {
344 return Password.deobfuscate(property);
347 // Property is not obfuscated
351 private String get(String key) {
352 String value = modelLoaderProperties.getProperty(key);
354 if(value!= null && value.startsWith("ENV:")) {
355 value = System.getenv(StringUtils.removeStart(value, "ENV:"));