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.sparky.aggregatevnf.search;
27 import javax.json.Json;
28 import javax.json.JsonArray;
29 import javax.json.JsonArrayBuilder;
30 import javax.json.JsonObject;
31 import javax.json.JsonObjectBuilder;
33 import org.onap.aai.sparky.dataintegrity.config.DiUiConstants;
36 * Build a JSON payload to send to elastic search to get vnf search data.
39 public class VnfSearchQueryBuilder {
40 static final String SEVERITY = DiUiConstants.SEVERITY;
41 static final String TIMESTAMP = DiUiConstants.KEY_TIMESTAMP;
42 static final String VIOLATIONS = DiUiConstants.VIOLATIONS;
43 static final String CATEGORY = DiUiConstants.CATEGORY;
44 static final String ENTITY_TYPE = DiUiConstants.ENTITY_TYPE;
46 static final String ITEM = DiUiConstants.KEY_ITEM;
47 static final String ITEM_AGG = DiUiConstants.KEY_ITEM_AGG;
48 static final String BY_ITEM = DiUiConstants.KEY_BY_ITEM;
49 static final String BUCKETS = DiUiConstants.KEY_BUCKETS;
52 * Creates the suggestions query.
54 * @param maxResults maximum number of suggestions to fetch
55 * @param queryStr query string
56 * @return the json object
60 * { "vnfs" : { "text" : "VNFs", "completion" : { "field" : "entity_suggest", "size": 1 } } }
62 public static JsonObject createSuggestionsQuery(String maxResults, String queryStr) {
63 JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
65 JsonObjectBuilder completionBlob = Json.createObjectBuilder();
66 completionBlob.add("field", "entity_suggest");
67 completionBlob.add("size", maxResults);
69 JsonObjectBuilder jsonAllBuilder = Json.createObjectBuilder();
70 jsonAllBuilder.add("text", queryStr);
71 jsonAllBuilder.add("completion", completionBlob);
73 jsonBuilder.add("vnfs", jsonAllBuilder.build());
74 return jsonBuilder.build();
77 public static JsonObject getTermBlob(String key, String value) {
78 JsonObjectBuilder termBlobBuilder = Json.createObjectBuilder();
79 JsonObjectBuilder jsonBuilder = Json.createObjectBuilder().add(key, value);
80 return termBlobBuilder.add("term", jsonBuilder.build()).build();
83 public static void getSummaryAggsBlob(JsonObjectBuilder aggsBlobBuilder, String aggsKey,
85 JsonObjectBuilder fieldBuilder =
86 Json.createObjectBuilder().add("field", aggsKey).add("size", resultSize);
87 JsonObject aggsFieldBlob = fieldBuilder.build();
88 JsonObjectBuilder defaultBlobBuilder = Json.createObjectBuilder().add("terms", aggsFieldBlob);
89 JsonObject defaultBlob = defaultBlobBuilder.build();
90 aggsBlobBuilder.add("default", defaultBlob);
93 public static void buildSingleTermCountQuery(JsonObjectBuilder jsonBuilder, String key,
95 jsonBuilder.add("query", getTermBlob(key, value));
98 public static void buildSingleTermSummaryQuery(JsonObjectBuilder jsonBuilder, String key,
99 String value, String groupByKey) {
100 JsonObjectBuilder queryBlobBuilder = Json.createObjectBuilder();
101 JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
103 queryBlobBuilder.add("constant_score",
104 Json.createObjectBuilder().add("filter", getTermBlob(key, value)));
106 getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
108 jsonBuilder.add("query", queryBlobBuilder.build());
109 jsonBuilder.add("aggs", aggsBlobBuilder.build());
112 public static void buildMultiTermSummaryQuery(JsonObjectBuilder jsonBuilder,
113 Map<String, String> attributes, String groupByKey) {
114 JsonObjectBuilder queryBlobBuilder = Json.createObjectBuilder();
115 JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
116 JsonArrayBuilder mustBlobBuilder = Json.createArrayBuilder();
117 for (String key : attributes.keySet()) {
118 mustBlobBuilder.add(getTermBlob(key, attributes.get(key)));
120 JsonArray mustBlob = mustBlobBuilder.build();
122 queryBlobBuilder.add("constant_score", Json.createObjectBuilder().add("filter",
123 Json.createObjectBuilder().add("bool", Json.createObjectBuilder().add("must", mustBlob))));
125 getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
127 jsonBuilder.add("query", queryBlobBuilder.build());
128 jsonBuilder.add("aggs", aggsBlobBuilder.build());
131 public static void buildZeroTermSummaryQuery(JsonObjectBuilder jsonBuilder, String groupByKey) {
132 JsonObjectBuilder aggsBlobBuilder = Json.createObjectBuilder();
134 getSummaryAggsBlob(aggsBlobBuilder, groupByKey, 0);
136 jsonBuilder.add("aggs", aggsBlobBuilder.build());
139 public static void buildMultiTermCountQuery(JsonObjectBuilder jsonBuilder,
140 Map<String, String> attributes) {
141 JsonArrayBuilder mustBlobBuilder = Json.createArrayBuilder();
142 for (String key : attributes.keySet()) {
143 mustBlobBuilder.add(getTermBlob(key, attributes.get(key)));
145 jsonBuilder.add("query", Json.createObjectBuilder().add("bool",
146 Json.createObjectBuilder().add("must", mustBlobBuilder)));
151 public static JsonObject createSummaryByEntityTypeQuery(Map<String, String> attributes,
153 JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
154 jsonBuilder.add("size", "0"); // avoid source data
155 if (attributes.size() == 0) {
156 buildZeroTermSummaryQuery(jsonBuilder, groupByKey);
157 } else if (attributes.size() == 1) {
158 Map.Entry<String, String> entry = attributes.entrySet().iterator().next();
159 buildSingleTermSummaryQuery(jsonBuilder, entry.getKey(), entry.getValue(), groupByKey);
161 buildMultiTermSummaryQuery(jsonBuilder, attributes, groupByKey);
163 return jsonBuilder.build();
166 public static JsonObject createEntityCountsQuery(Map<String, String> attributes) {
167 JsonObjectBuilder jsonBuilder = Json.createObjectBuilder();
168 if (attributes.size() == 1) {
169 Map.Entry<String, String> entry = attributes.entrySet().iterator().next();
170 buildSingleTermCountQuery(jsonBuilder, entry.getKey(), entry.getValue());
172 buildMultiTermCountQuery(jsonBuilder, attributes);
174 return jsonBuilder.build();
177 public static JsonArray getSortCriteria(String sortFieldName, String sortOrder) {
178 JsonArrayBuilder jsonBuilder = Json.createArrayBuilder();
179 jsonBuilder.add(Json.createObjectBuilder().add(sortFieldName,
180 Json.createObjectBuilder().add("order", sortOrder)));
182 return jsonBuilder.build();