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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
/**
* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
* Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.aai.rest.search;
import io.micrometer.core.annotation.Timed;
import org.onap.aai.aailog.logs.AaiDBTraversalMetricLog;
import org.onap.aai.concurrent.AaiCallable;
import org.onap.aai.dbgraphmap.SearchGraph;
import org.onap.aai.exceptions.AAIException;
import org.onap.aai.introspection.Loader;
import org.onap.aai.introspection.LoaderFactory;
import org.onap.aai.introspection.ModelType;
import org.onap.aai.logging.ErrorLogHelper;
import org.onap.aai.restcore.HttpMethod;
import org.onap.aai.restcore.RESTAPI;
import org.onap.aai.serialization.db.DBSerializer;
import org.onap.aai.serialization.engines.JanusGraphDBEngine;
import org.onap.aai.serialization.engines.QueryStyle;
import org.onap.aai.serialization.engines.TransactionalGraphEngine;
import org.onap.aai.serialization.queryformats.utils.UrlBuilder;
import org.onap.aai.setup.SchemaVersion;
import org.onap.aai.setup.SchemaVersions;
import org.onap.aai.util.AAIConstants;
import org.onap.aai.util.GenericQueryBuilder;
import org.onap.aai.util.NodesQueryBuilder;
import org.onap.aai.util.TraversalConstants;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.*;
import javax.ws.rs.core.*;
import javax.ws.rs.core.Response.Status;
import java.net.URI;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
/**
* Implements the search subdomain in the REST API. All API calls must include X-FromAppId and
* X-TransactionId in the header.
*/
@Path("/{version: v[1-9][0-9]*|latest}/search")
@Timed
public class SearchProvider extends RESTAPI {
private static final Logger LOGGER = LoggerFactory.getLogger(SearchProvider.class);
public static final String GENERIC_QUERY = "/generic-query";
public static final String NODES_QUERY = "/nodes-query";
private SearchGraph searchGraph;
private LoaderFactory loaderFactory;
private SchemaVersions schemaVersions;
private String basePath;
@Autowired
public SearchProvider(LoaderFactory loaderFactory, SearchGraph searchGraph, SchemaVersions schemaVersions,
@Value("${schema.uri.base.path}") String basePath) {
this.loaderFactory = loaderFactory;
this.searchGraph = searchGraph;
this.schemaVersions = schemaVersions;
this.basePath = basePath;
}
/**
* Gets the generic query response.
*
* @param headers the headers
* @param req the req
* @param startNodeType the start node type
* @param startNodeKeyParams the start node key params
* @param includeNodeTypes the include node types
* @param depth the depth
* @return the generic query response
*/
/* ---------------- Start Generic Query --------------------- */
@GET
@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
@Path(GENERIC_QUERY)
public Response getGenericQueryResponse(@Context HttpHeaders headers, @Context HttpServletRequest req,
@QueryParam("start-node-type") final String startNodeType,
@QueryParam("key") final List<String> startNodeKeyParams,
@QueryParam("include") final List<String> includeNodeTypes, @QueryParam("depth") final int depth,
@PathParam("version") String versionParam, @Context UriInfo info) {
return runner(TraversalConstants.AAI_TRAVERSAL_TIMEOUT_ENABLED, TraversalConstants.AAI_TRAVERSAL_TIMEOUT_APP,
TraversalConstants.AAI_TRAVERSAL_TIMEOUT_LIMIT, headers, info, HttpMethod.GET,
new AaiCallable<Response>() {
@Override
public Response process() {
return processGenericQueryResponse(headers, req, startNodeType, startNodeKeyParams,
includeNodeTypes, depth, versionParam);
}
});
}
public Response processGenericQueryResponse(@Context HttpHeaders headers, @Context HttpServletRequest req,
@QueryParam("start-node-type") final String startNodeType,
@QueryParam("key") final List<String> startNodeKeyParams,
@QueryParam("include") final List<String> includeNodeTypes, @QueryParam("depth") final int depth,
@PathParam("version") String versionParam) {
AAIException ex = null;
Response searchResult;
String fromAppId;
ArrayList<String> templateVars = new ArrayList<>();
try {
fromAppId = getFromAppId(headers);
getTransId(headers);
// only consider header value for search
final SchemaVersion version = new SchemaVersion(versionParam);
final ModelType factoryType = ModelType.MOXY;
Loader loader = loaderFactory.createLoaderForVersion(factoryType, version);
TransactionalGraphEngine dbEngine = new JanusGraphDBEngine(QueryStyle.TRAVERSAL, loader);
DBSerializer dbSerializer = new DBSerializer(version, dbEngine, factoryType, fromAppId);
UrlBuilder urlBuilder = new UrlBuilder(version, dbSerializer, schemaVersions, this.basePath);
AaiDBTraversalMetricLog metricLog = new AaiDBTraversalMetricLog (AAIConstants.AAI_TRAVERSAL_MS);
metricLog.pre(Optional.of(new URI(req.getRequestURI())));
searchResult = searchGraph
.runGenericQuery(new GenericQueryBuilder().setHeaders(headers).setStartNodeType(startNodeType)
.setStartNodeKeyParams(startNodeKeyParams).setIncludeNodeTypes(includeNodeTypes)
.setDepth(depth).setDbEngine(dbEngine).setLoader(loader).setUrlBuilder(urlBuilder));
metricLog.post();
} catch (AAIException e) {
// send error response
ex = e;
templateVars.add("GET Search");
templateVars.add("getGenericQueryResponse");
searchResult = Response.status(e.getErrorObject().getHTTPResponseCode())
.entity(ErrorLogHelper.getRESTAPIErrorResponse(headers.getAcceptableMediaTypes(), e, templateVars))
.build();
} catch (Exception e) {
// send error response
ex = new AAIException("AAI_4000", e);
templateVars.add("GET Search");
templateVars.add("getGenericQueryResponse");
searchResult = Response.status(Status.INTERNAL_SERVER_ERROR)
.entity(ErrorLogHelper.getRESTAPIErrorResponse(headers.getAcceptableMediaTypes(), ex, templateVars))
.build();
} finally {
// log success or failure
if (ex != null) {
ErrorLogHelper.logException(ex);
}
}
return searchResult;
}
/* ---------------- End Generic Query --------------------- */
/**
* Gets the nodes query response.
*
* @param headers the headers
* @param req the req
* @param searchNodeType the search node type
* @param edgeFilterList the edge filter list
* @param filterList the filter list
* @return the nodes query response
*/
/* ---------------- Start Nodes Query --------------------- */
@GET
@Produces({MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
@Path(NODES_QUERY)
public Response getNodesQueryResponse(@Context HttpHeaders headers, @Context HttpServletRequest req,
@QueryParam("search-node-type") final String searchNodeType,
@QueryParam("edge-filter") final List<String> edgeFilterList,
@QueryParam("filter") final List<String> filterList, @PathParam("version") String versionParam,
@Context UriInfo info)
{
return runner(TraversalConstants.AAI_TRAVERSAL_TIMEOUT_ENABLED, TraversalConstants.AAI_TRAVERSAL_TIMEOUT_APP,
TraversalConstants.AAI_TRAVERSAL_TIMEOUT_LIMIT, headers, info, HttpMethod.GET,
new AaiCallable<Response>() {
@Override
public Response process() {
return processNodesQueryResponse(headers, req, searchNodeType, edgeFilterList, filterList,
versionParam);
}
});
}
public Response processNodesQueryResponse(@Context HttpHeaders headers, @Context HttpServletRequest req,
@QueryParam("search-node-type") final String searchNodeType,
@QueryParam("edge-filter") final List<String> edgeFilterList,
@QueryParam("filter") final List<String> filterList, @PathParam("version") String versionParam) {
AAIException ex = null;
Response searchResult;
String fromAppId;
ArrayList<String> templateVars = new ArrayList<>();
try {
fromAppId = getFromAppId(headers);
getTransId(headers);
// only consider header value for search
final SchemaVersion version = new SchemaVersion(versionParam);
final ModelType factoryType = ModelType.MOXY;
Loader loader = loaderFactory.createLoaderForVersion(factoryType, version);
TransactionalGraphEngine dbEngine = new JanusGraphDBEngine(QueryStyle.TRAVERSAL, loader);
DBSerializer dbSerializer = new DBSerializer(version, dbEngine, factoryType, fromAppId);
UrlBuilder urlBuilder = new UrlBuilder(version, dbSerializer, schemaVersions, this.basePath);
AaiDBTraversalMetricLog metricLog = new AaiDBTraversalMetricLog (AAIConstants.AAI_TRAVERSAL_MS);
metricLog.pre(Optional.of(new URI(req.getRequestURI())));
searchResult = searchGraph.runNodesQuery(new NodesQueryBuilder().setHeaders(headers)
.setTargetNodeType(searchNodeType).setEdgeFilterParams(edgeFilterList).setFilterParams(filterList)
.setDbEngine(dbEngine).setLoader(loader).setUrlBuilder(urlBuilder));
metricLog.post();
} catch (AAIException e) {
// send error response
ex = e;
templateVars.add("GET Search");
templateVars.add("getNodesQueryResponse");
searchResult = Response.status(e.getErrorObject().getHTTPResponseCode())
.entity(ErrorLogHelper.getRESTAPIErrorResponse(headers.getAcceptableMediaTypes(), e, templateVars))
.build();
} catch (Exception e) {
// send error response
ex = new AAIException("AAI_4000", e);
templateVars.add("GET Search");
templateVars.add("getNodesQueryResponse");
searchResult = Response.status(Status.INTERNAL_SERVER_ERROR)
.entity(ErrorLogHelper.getRESTAPIErrorResponse(headers.getAcceptableMediaTypes(), ex, templateVars))
.build();
} finally {
// log success or failure
if (ex != null) {
ErrorLogHelper.logException(ex);
}
}
return searchResult;
}
}
|
