* ============LICENSE_START=======================================================
* org.onap.aai
* ================================================================================
- * Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
+ * Copyright © 2024 Deutsche Telekom SA.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* limitations under the License.
* ============LICENSE_END=========================================================
*/
+
package org.onap.aai.rest.dsl;
-import java.io.ByteArrayInputStream;
-import java.io.InputStream;
-import java.io.InputStreamReader;
-import java.lang.reflect.InvocationTargetException;
-import java.nio.charset.StandardCharsets;
-import java.util.HashMap;
-import java.util.List;
+import java.io.IOException;
import java.util.Map;
-import org.antlr.v4.runtime.*;
+import org.antlr.v4.runtime.CommonTokenStream;
+import org.antlr.v4.runtime.Token;
import org.antlr.v4.runtime.misc.ParseCancellationException;
-import org.antlr.v4.runtime.tree.ParseTree;
-import org.antlr.v4.runtime.tree.ParseTreeListener;
-import org.antlr.v4.runtime.tree.ParseTreeWalker;
import org.onap.aai.exceptions.AAIException;
-import org.onap.aai.rest.dsl.v2.DslListener;
-import org.onap.aai.rest.dsl.validation.DslValidator;
import org.onap.aai.rest.enums.QueryVersion;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-/**
- * The Class DslQueryProcessor.
- */
-public class DslQueryProcessor {
+public abstract class DslQueryProcessor {
- private static final Logger LOGGER = LoggerFactory.getLogger(DslQueryProcessor.class);
-
- private Map<QueryVersion, ParseTreeListener> dslListeners;
- private boolean startNodeValidationFlag = true;
- private String validationRules = "";
- private static final String DSL_BASE_PACKAGE = "org.onap.aai.dsl.";
- private static final String LEXER = "AAIDslLexer";
- private static final String PARSER = "AAIDslParser";
private static final String EOF_TOKEN = "<EOF>";
+ private boolean hasStartNodeValidationFlag = true;
private boolean isAggregate = false;
+ private String validationRules = "";
- public DslQueryProcessor(Map<QueryVersion, ParseTreeListener> dslListeners) {
- this.dslListeners = dslListeners;
- }
+ protected abstract Map<String, Object> getQueryResultMap(String aaiQuery) throws IOException, AAIException;
public Map<String, Object> parseAaiQuery(QueryVersion version, String aaiQuery)
throws AAIException {
- Map<String, Object> resultMap = new HashMap<>();
try {
- // Create a input stream that reads our string
- InputStream stream =
- new ByteArrayInputStream(aaiQuery.getBytes(StandardCharsets.UTF_8));
-
- String packageName = DSL_BASE_PACKAGE + version.toString().toLowerCase() + ".";
- Class<?> lexerClass = Class.forName(packageName + LEXER);
- Class<?> parserClass = Class.forName(packageName + PARSER);
-
- Lexer lexer = (Lexer) lexerClass.getConstructor(CharStream.class)
- .newInstance(CharStreams.fromStream(stream, StandardCharsets.UTF_8));
- lexer.removeErrorListeners();
- lexer.addErrorListener(new AAIDslErrorListener());
- CommonTokenStream tokens = new CommonTokenStream(lexer);
-
- // Parser that feeds off of the tokens buffer
- Parser parser =
- (Parser) parserClass.getConstructor(TokenStream.class).newInstance(tokens);
- parser.removeErrorListeners();
- parser.addErrorListener(new AAIDslErrorListener());
- ParseTreeListener dslListener = dslListeners.get(version);
- dslListener.getClass().getMethod("setValidationFlag", boolean.class).invoke(dslListener,
- isStartNodeValidationFlag());
- dslListener.getClass().getMethod("setAggregateFlag", boolean.class).invoke(dslListener,
- isAggregate());
-
- if (!getValidationRules().isEmpty() && !"none".equals(getValidationRules())) {
- DslValidator validator = new DslValidator.Builder().create();
- dslListener.getClass()
- .getMethod("setQueryValidator", DslValidator.class, String.class)
- .invoke(dslListener, validator, getValidationRules());
- }
-
- // Specify our entry point
- ParseTree ptree = (ParseTree) parserClass.getMethod("aaiquery").invoke(parser);
-
- // Check if there is no EOF token at the end of the parsed aaiQuery
- // If none, DSL query may have not been parsed correctly and omitted part of the query
- // out. If so error out.
- // If it wasn't expecting a opening parens after a closing bracket for union, it will
- // drop the proceeding part of the query.
- Token eofToken = tokens.get(tokens.size() - 1);
- if (eofToken != null && !eofToken.getText().equals(EOF_TOKEN)) {
- if (eofToken.getText().equals("(")) {
- throw new AAIException("AAI_6153",
- "DSL Syntax Error while processing the query: DSL Query could not be parsed correctly. Please check your syntax.");
- }
- }
-
- if (LOGGER.isInfoEnabled()) {
- LOGGER.info("QUERY-interim {}", ptree.toStringTree(parser));
- }
-
- // Walk it and attach our listener
- ParseTreeWalker walker = new ParseTreeWalker();
-
- walker.walk(dslListener, ptree);
- String query =
- (String) dslListener.getClass().getMethod("getQuery").invoke(dslListener);
- resultMap.put("query", query);
- if (version.equals(QueryVersion.V2)) {
- Map<String, List<String>> selectKeys = ((DslListener) dslListener).getSelectKeys();
- if (selectKeys != null && !selectKeys.isEmpty()) {
- resultMap.put("propertiesMap", selectKeys);
- }
- }
- LOGGER.info("Final QUERY {}", query);
- return resultMap;
- } catch (InvocationTargetException e) {
- if (e.getTargetException() instanceof ParseCancellationException) {
- throw new AAIException("AAI_6153", "DSL Syntax Error while processing the query :"
- + e.getTargetException().getMessage());
- } else if (e.getTargetException() instanceof AAIException) {
- AAIException ex = (AAIException) e.getTargetException();
- throw new AAIException((ex.getCode().isEmpty() ? "AAI_6149" : ex.getCode()),
- "DSL Error while processing the query :" + ex.getMessage());
- } else {
- throw new AAIException("AAI_6152", "Exception while processing DSL query");
- }
-
+ return getQueryResultMap(aaiQuery);
+ } catch(AAIException ex) {
+ throw new AAIException((ex.getCode().isEmpty() ? "AAI_6149" : ex.getCode()),
+ "DSL Error while processing the query :" + ex.getMessage());
} catch (ParseCancellationException e) {
throw new AAIException("AAI_6153",
"DSL Syntax Error while processing the query: " + e.getMessage());
} catch (Exception e) {
throw new AAIException("AAI_6152",
"Error while processing the query: " + e.getMessage());
+ }
+ }
+ /**
+ * Check if there is no EOF token at the end of the parsed aaiQuery
+ * If none, DSL query may have not been parsed correctly and omitted part of the query
+ * out. If so error out.
+ * If it wasn't expecting an opening parenthesis after a closing bracket for union, it will
+ * drop the proceeding part of the query.
+ * @param tokens
+ * @throws AAIException
+ */
+ protected void validateQueryIsParsable(CommonTokenStream tokens) throws AAIException {
+
+ Token eofToken = tokens.get(tokens.size() - 1);
+ if (eofToken != null && !eofToken.getText().equals(EOF_TOKEN)) {
+ if (eofToken.getText().equals("(")) {
+ throw new AAIException("AAI_6153",
+ "DSL Syntax Error while processing the query: DSL Query could not be parsed correctly. Please check your syntax.");
+ }
}
}
- public boolean isStartNodeValidationFlag() {
- return startNodeValidationFlag;
+ public boolean hasStartNodeValidationFlag() {
+ return hasStartNodeValidationFlag;
}
public void setStartNodeValidationFlag(boolean startNodeValidationFlag) {
- this.startNodeValidationFlag = startNodeValidationFlag;
+ this.hasStartNodeValidationFlag = startNodeValidationFlag;
}
public boolean isAggregate() {
public void setValidationRules(String validationRules) {
this.validationRules = validationRules;
}
-}
+
+}
\ No newline at end of file
Code Review / aai / traversal.git / blobdiff