aboutsummaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/aai/rest/search/GenericQueryProcessor.java
blob: 2431d11d3f095ecab3bb42147d613c7215e2b6c2 (plain)
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
/**
 * ============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 org.apache.tinkerpop.gremlin.process.traversal.P;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.GraphTraversal;
import org.apache.tinkerpop.gremlin.process.traversal.dsl.graph.__;
import org.apache.tinkerpop.gremlin.structure.Graph;
import org.apache.tinkerpop.gremlin.structure.Vertex;
import org.javatuples.Pair;
import org.onap.aai.exceptions.AAIException;
import org.onap.aai.rest.dsl.DslQueryProcessor;
import org.onap.aai.restcore.search.GroovyQueryBuilderSingleton;
import org.onap.aai.restcore.util.URITools;
import org.onap.aai.serialization.engines.TransactionalGraphEngine;
import org.onap.aai.serialization.queryformats.SubGraphStyle;

import javax.ws.rs.core.MultivaluedHashMap;
import javax.ws.rs.core.MultivaluedMap;
import java.io.FileNotFoundException;
import java.net.URI;
import java.util.*;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

public abstract class GenericQueryProcessor {

	protected final Optional<URI> uri;
	protected final MultivaluedMap<String, String> queryParams;
	protected final Optional<Collection<Vertex>> vertices;
	protected static Pattern p = Pattern.compile("query/(.*+)");
	protected Optional<String> gremlin;
	protected final TransactionalGraphEngine dbEngine;
	protected static GroovyQueryBuilderSingleton queryBuilderSingleton = GroovyQueryBuilderSingleton.getInstance();
	protected final boolean isGremlin;
	protected Optional<DslQueryProcessor> dslQueryProcessorOptional;
	/* dsl parameters to store dsl query and to check
	 * if this is a DSL request
	 */
	protected Optional<String> dsl;
	protected final boolean isDsl ;
	
	protected GenericQueryProcessor(Builder builder) {
		this.uri = builder.getUri();
		this.dbEngine = builder.getDbEngine();
		this.vertices = builder.getVertices();
		this.gremlin = builder.getGremlin();
		this.isGremlin = builder.isGremlin();
		this.dsl = builder.getDsl();
		this.isDsl = builder.isDsl();
		this.dslQueryProcessorOptional = builder.getDslQueryProcessor();
		
		if (uri.isPresent()) {
			queryParams = URITools.getQueryMap(uri.get());
		} else {
			queryParams = new MultivaluedHashMap<>();
		}
	}
	
	protected abstract GraphTraversal<?,?> runQuery(String query, Map<String, Object> params);
	
	protected List<Object> processSubGraph(SubGraphStyle style, GraphTraversal<?,?> g) {
		final List<Object> resultVertices = new Vector<>();
		g.store("y");
		
		if (SubGraphStyle.prune.equals(style) || SubGraphStyle.star.equals(style)) {
			g.barrier().bothE();
			if (SubGraphStyle.prune.equals(style)) {
				g.where(__.otherV().where(P.within("y")));
			}
			g.dedup().subgraph("subGraph").cap("subGraph").map(x -> (Graph)x.get()).next().traversal().V().forEachRemaining(x -> {
				resultVertices.add(x);
			});
		} else {
			resultVertices.addAll(g.toList());
		}
		return resultVertices;
	}
	
	public List<Object> execute(SubGraphStyle style) throws FileNotFoundException, AAIException {
		final List<Object> resultVertices;

		Pair<String, Map<String, Object>> tuple = this.createQuery();
		String query = tuple.getValue0();
		Map<String, Object> params = tuple.getValue1();

		if (query.equals("") && (vertices.isPresent() && vertices.get().isEmpty())) {
			//nothing to do, just exit
			return new ArrayList<>();
		}
		GraphTraversal<?,?> g = this.runQuery(query, params);
		
		resultVertices = this.processSubGraph(style, g);
		
		return resultVertices;
	}
	
	protected Pair<String, Map<String, Object>> createQuery() throws AAIException {
		Map<String, Object> params = new HashMap<>();
		String query = "";
		 if (this.isGremlin) {
			query = gremlin.get();
			
		}else if (this.isDsl) {
			String dslUserQuery = dsl.get();
			if(dslQueryProcessorOptional.isPresent()){
				String dslQuery = dslQueryProcessorOptional.get().parseAaiQuery(dslUserQuery);
				query = queryBuilderSingleton.executeTraversal(dbEngine, dslQuery, params);
				String startPrefix = "g.V()";
				query = startPrefix + query;
			}
		}
		
		return new Pair<>(query, params);
	}
	
	public static class Builder {

		private final TransactionalGraphEngine dbEngine;
		private Optional<URI> uri = Optional.empty();
		private Optional<String> gremlin = Optional.empty();
		private boolean isGremlin = false;
		private Optional<Collection<Vertex>> vertices = Optional.empty();
		private QueryProcessorType processorType = QueryProcessorType.GREMLIN_SERVER;
		
		private Optional<String> dsl = Optional.empty();
		private boolean isDsl = false;
		private DslQueryProcessor dslQueryProcessor;

		public Builder(TransactionalGraphEngine dbEngine) {
			this.dbEngine = dbEngine;
		}
		
		public Builder queryFrom(URI uri) {
			this.uri = Optional.of(uri);
			this.isGremlin = false;
			return this;
		}
		
		public Builder startFrom(Collection<Vertex> vertices) {
			this.vertices = Optional.of(vertices);
			return this;
		}
		
		public Builder queryFrom( String query, String queryType) {
			
			if(queryType.equals("gremlin")){
				this.gremlin = Optional.of(query);
				this.isGremlin = true;
			}
			if(queryType.equals("dsl")){
				this.dsl = Optional.of(query);
				this.isDsl = true;
			}
			return this;
		}
		
		public Builder processWith(QueryProcessorType type) {
			this.processorType = type;
			return this;
		}

		public Builder queryProcessor(DslQueryProcessor dslQueryProcessor){
			this.dslQueryProcessor = dslQueryProcessor;
			return this;
		}

		public Optional<DslQueryProcessor> getDslQueryProcessor(){
			return Optional.ofNullable(this.dslQueryProcessor);
		}

		public TransactionalGraphEngine getDbEngine() {
			return dbEngine;
		}

		public Optional<URI> getUri() {
			return uri;
		}

		public Optional<String> getGremlin() {
			return gremlin;
		}

		public boolean isGremlin() {
			return isGremlin;
		}
		
		public Optional<String> getDsl() {
			return dsl;
		}

		public boolean isDsl() {
			return isDsl;
		}

		public Optional<Collection<Vertex>> getVertices() {
			return vertices;
		}
		
		public QueryProcessorType getProcessorType() {
			return processorType;
		}
		
		public GenericQueryProcessor create() {
			return new GroovyShellImpl(this);
		}
		
	}
}