2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
6 * Copyright © 2017 Amdocs
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 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
23 package org.onap.aai.sa.rest;
25 import com.fasterxml.jackson.databind.ObjectMapper;
27 import org.onap.aai.sa.searchdbabstraction.logging.SearchDbMsgs;
28 import org.onap.aai.sa.searchdbabstraction.util.SearchDbConstants;
29 import org.onap.aai.cl.api.Logger;
30 import org.onap.aai.cl.eelf.LoggerFactory;
31 import org.onap.aai.sa.rest.AnalyzerSchema;
32 import org.onap.aai.sa.rest.FilterSchema;
35 import java.io.IOException;
36 import java.util.concurrent.atomic.AtomicBoolean;
39 * This class encapsulates the configuration of the predefined
40 * Analyzer and Filter behaviours that help to tell the document
41 * store how to index the documents that are provided to it.
43 public class AnalysisConfiguration {
46 * Contains all of the predefined indexing filters.
48 private FilterSchema[] customFilters;
51 * Contains all of the predefined indexing analyzers.
53 private AnalyzerSchema[] customAnalysers;
56 * Indicates whether or not we have imported the filter and
57 * analyzer configurations.
59 private AtomicBoolean configured = new AtomicBoolean(false);
62 * A json format string which is readable by Elastic Search and defines
63 * all of the custom filters and analyzers that we need Elastic Search
66 private static String esSettings = null;
68 private static Logger logger = LoggerFactory.getInstance()
69 .getLogger(AnalysisConfiguration.class.getName());
73 * Imports the filter and analyzer configuration files and
74 * builds an Elastic Search readable settings file from the
77 * @param filterConfigFile - Location of filter configuration json file
78 * @param analyzerConfigFile - Location of analyzer configuration json file
80 public void init(String filterConfigFile, String analyzerConfigFile) {
82 if (configured.compareAndSet(false, true)) {
83 ObjectMapper mapper = new ObjectMapper();
85 File filtersConfig = new File(filterConfigFile);
87 customFilters = mapper.readValue(filtersConfig, FilterSchema[].class);
88 } catch (IOException e) {
91 logger.warn(SearchDbMsgs.FILTERS_CONFIG_FAILURE, filterConfigFile, e.getMessage());
94 File analysersConfig = new File(analyzerConfigFile);
96 customAnalysers = mapper.readValue(analysersConfig, AnalyzerSchema[].class);
97 } catch (IOException e) {
100 logger.warn(SearchDbMsgs.ANALYSYS_CONFIG_FAILURE, analyzerConfigFile, e.getMessage());
103 esSettings = buildEsIndexSettings();
109 * Returns the set of pre-configured filters.
111 * @return - An array of filters.
113 public FilterSchema[] getFilters() {
114 return customFilters;
119 * Returns the set of pre-configured analyzers.
121 * @return - An array of analyzers.
123 public AnalyzerSchema[] getAnalyzers() {
124 init(SearchDbConstants.SDB_FILTER_CONFIG_FILE, SearchDbConstants.SDB_ANALYSIS_CONFIG_FILE);
125 return customAnalysers;
130 * Imports the filter and analyzer configurations and translates those
131 * into a settings string that will be parseable by Elastic Search.
133 * @return - Elastic Search formatted settings string.
135 public String getEsIndexSettings() {
137 // Generate the es-settings string from our filter and analyzer
138 // configurations if we have not already done so.
139 init(SearchDbConstants.SDB_FILTER_CONFIG_FILE, SearchDbConstants.SDB_ANALYSIS_CONFIG_FILE);
141 // Now, return the es-settings string.
147 * Constructs a settings string that is readable by Elastic Search based
148 * on the contents of the filter and analyzer configuration files.
150 * @return Elastic Search formatted settings string.
152 public String buildEsIndexSettings() {
154 StringBuilder sb = new StringBuilder();
157 sb.append("\"analysis\": {");
159 // Define the custom filters.
160 boolean atLeastOneFilter = false;
161 sb.append("\"filter\": {");
162 AtomicBoolean firstFilter = new AtomicBoolean(true);
163 for (FilterSchema filter : customFilters) {
165 // Append a comma before the next entry, unless it is the
167 if (!firstFilter.compareAndSet(true, false)) {
171 // Now, build the filter entry.
172 buildFilterEntry(filter, sb);
173 atLeastOneFilter = true;
175 sb.append((atLeastOneFilter) ? "}," : "}");
177 // Define the custom analyzers.
178 sb.append("\"analyzer\": {");
179 AtomicBoolean firstAnalyzer = new AtomicBoolean(true);
180 for (AnalyzerSchema analyzer : customAnalysers) {
182 // Prepend a comma before the entry, unless it is the
184 if (!firstAnalyzer.compareAndSet(true, false)) {
188 // Now, construct the entry for this analyzer.
189 buildAnalyzerEntry(analyzer, sb);
196 return sb.toString();
201 * Constructs an ElasticSearch friendly custom filter definition.
203 * @param filter - The filter to generate ElasticSearch json for.
204 * @param sb - The string builder to append the filter definition
207 private void buildFilterEntry(FilterSchema filter, StringBuilder sb) {
209 sb.append("\"" + filter.getName()).append("\": {");
211 sb.append(filter.getConfiguration());
218 * Constructs an ElasticSearch friendly custom analyzer definition.
220 * @param analyzer - The analyzer to generate ElasticSearch json for.
221 * @param sb - The string builder to append the analyzer definition
224 private void buildAnalyzerEntry(AnalyzerSchema analyzer, StringBuilder sb) {
226 sb.append("\"").append(analyzer.getName()).append("\": {");
227 sb.append("\"type\": \"custom\",");
228 sb.append("\"tokenizer\": ").append("\"").append(analyzer.getTokenizer()).append("\",");
229 sb.append("\"filter\": [");
230 boolean firstFilter = true;
231 for (String filter : analyzer.getFilters()) {
237 sb.append("\"").append(filter).append("\"");