Add instructions to invoke the linter and code formatter plugins to the README and invoke the formatter

Issue-ID: AAI-3526

Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de>
Change-Id: Ibd383994732cea6460153704a1153beb530dc6c3

3 files changed, 169 insertions, 166 deletions

diff --git a/aai-queries/src/main/java/org/onap/aai/queries/CustomQueryConfig.java b/aai-queries/src/main/java/org/onap/aai/queries/CustomQueryConfig.java
index 664c9ca..1b9e833 100644
--- a/aai-queries/src/main/java/org/onap/aai/queries/CustomQueryConfig.java
+++ b/aai-queries/src/main/java/org/onap/aai/queries/CustomQueryConfig.java
@@ -8,7 +8,7 @@
  * 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
+ * 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,
@@ -17,37 +17,41 @@
  * limitations under the License.
  * ============LICENSE_END=========================================================
  */
+
 package org.onap.aai.queries;
 
 import java.util.List;
 
 public class CustomQueryConfig {
-  public CustomQueryConfig() {
-    // used by GetCustomQueryConfig
-  }
-
-
-  private String query;
-  private List<String> queryOptionalProperties;
-  private List<String> queryRequiredProperties;
-
-  public void setQuery(String query) {
-    this.query = query;
-  }
-  public String getQuery() {
-    return this.query;
-  }
-
-  public void setQueryOptionalProperties( List<String> queryOptionalProperties) {
-    this.queryOptionalProperties = queryOptionalProperties;
-  }
-  public List<String> getQueryOptionalProperties( ) {
-    return queryOptionalProperties;
-  }
-  public void setQueryRequiredProperties( List<String> queryRequiredProperties) {
-    this.queryRequiredProperties = queryRequiredProperties;
-  }
-  public List<String> getQueryRequiredProperties( ) {
-    return queryRequiredProperties;
-  }
+    public CustomQueryConfig() {
+        // used by GetCustomQueryConfig
+    }
+
+    private String query;
+    private List<String> queryOptionalProperties;
+    private List<String> queryRequiredProperties;
+
+    public void setQuery(String query) {
+        this.query = query;
+    }
+
+    public String getQuery() {
+        return this.query;
+    }
+
+    public void setQueryOptionalProperties(List<String> queryOptionalProperties) {
+        this.queryOptionalProperties = queryOptionalProperties;
+    }
+
+    public List<String> getQueryOptionalProperties() {
+        return queryOptionalProperties;
+    }
+
+    public void setQueryRequiredProperties(List<String> queryRequiredProperties) {
+        this.queryRequiredProperties = queryRequiredProperties;
+    }
+
+    public List<String> getQueryRequiredProperties() {
+        return queryRequiredProperties;
+    }
 }
diff --git a/aai-queries/src/main/java/org/onap/aai/queries/GetCustomQueryConfig.java b/aai-queries/src/main/java/org/onap/aai/queries/GetCustomQueryConfig.java
index c726c76..07f7724 100644
--- a/aai-queries/src/main/java/org/onap/aai/queries/GetCustomQueryConfig.java
+++ b/aai-queries/src/main/java/org/onap/aai/queries/GetCustomQueryConfig.java
@@ -8,7 +8,7 @@
  * 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
+ * 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,
@@ -17,6 +17,7 @@
  * limitations under the License.
  * ============LICENSE_END=========================================================
  */
+
 package org.onap.aai.queries;
 
 import com.google.gson.*;
@@ -28,122 +29,119 @@ import java.util.List;
 
 public class GetCustomQueryConfig {
 
-  private JsonArray storedQueries = null;
-  private CustomQueryConfig customQueryConfig;
+    private JsonArray storedQueries = null;
+    private CustomQueryConfig customQueryConfig;
 
+    private final static String QUERY_CONFIG = "query";
+    private final static String REQUIRED_CONFIG = "required-properties";
+    private final static String OPTIONAL_CONFIG = "optional-properties";
+    private final static String STORED_QUERIES_CONFIG = "stored-queries";
+    private final static String STORED_QUERY_CONFIG = "stored-query";
 
-  private final static String QUERY_CONFIG = "query";
-  private final static String REQUIRED_CONFIG = "required-properties";
-  private final static String OPTIONAL_CONFIG = "optional-properties";
-  private final static String STORED_QUERIES_CONFIG = "stored-queries";
-  private final static String STORED_QUERY_CONFIG = "stored-query";
+    // public static final String AAI_HOME_ETC_QUERY_JSON = AAIConstants.AAI_HOME_ETC + "query" +
+    // AAIConstants.AAI_FILESEP + "stored-queries.json";
 
-//  public static final String AAI_HOME_ETC_QUERY_JSON = AAIConstants.AAI_HOME_ETC + "query" + AAIConstants.AAI_FILESEP + "stored-queries.json";
+    public GetCustomQueryConfig(String customQueryJson) {
+        init(customQueryJson);
+    }
 
-  public GetCustomQueryConfig(String customQueryJson ) {
-    init(customQueryJson);
-  }
+    private void init(String customQueryJson) {
+        JsonParser parser = new JsonParser();
+        JsonObject queriesObject = parser.parse(customQueryJson).getAsJsonObject();
+        if (queriesObject.has(STORED_QUERIES_CONFIG)) {
 
-  private void init( String customQueryJson) {
-    JsonParser parser = new JsonParser();
-    JsonObject queriesObject = parser.parse(customQueryJson).getAsJsonObject();
-    if (queriesObject.has(STORED_QUERIES_CONFIG)) {
+            storedQueries = queriesObject.getAsJsonArray(STORED_QUERIES_CONFIG);
+        }
+    }
 
-      storedQueries = queriesObject.getAsJsonArray(STORED_QUERIES_CONFIG);
+    private List<String> toStringList(JsonArray array) {
+        Gson converter = new Gson();
+        Type listType = new TypeToken<List<String>>() {}.getType();
+        return converter.fromJson(array, listType);
     }
-  }
-
-  private List<String> toStringList(JsonArray array) {
-     Gson converter = new Gson();
-     Type listType = new TypeToken<List<String>>() {}.getType();
-     return converter.fromJson(array, listType);
-  }
-
-  private List<String> getPropertyList(JsonObject configObject, String config ) {
-    JsonElement subqueryConfig;
-    JsonArray props;
-
-    if ( configObject.has(config)) {
-      subqueryConfig = configObject.get(config);
-      if ( subqueryConfig != null && !subqueryConfig.isJsonNull() ) {
-        props = subqueryConfig.getAsJsonArray();
-        if ( props != null ) {
-          return toStringList(props);
+
+    private List<String> getPropertyList(JsonObject configObject, String config) {
+        JsonElement subqueryConfig;
+        JsonArray props;
+
+        if (configObject.has(config)) {
+            subqueryConfig = configObject.get(config);
+            if (subqueryConfig != null && !subqueryConfig.isJsonNull()) {
+                props = subqueryConfig.getAsJsonArray();
+                if (props != null) {
+                    return toStringList(props);
+                }
+            }
         }
-      }
+        return toStringList(null);
     }
-    return toStringList(null);
-  }
 
-  private String getPropertyString(JsonObject configObject, String config) {
-    JsonElement subqueryConfig;
+    private String getPropertyString(JsonObject configObject, String config) {
+        JsonElement subqueryConfig;
 
-    if ( configObject.has(config)) {
-      subqueryConfig = configObject.get(config);
-      if ( subqueryConfig != null && !subqueryConfig.isJsonNull() ) {
-        return subqueryConfig.getAsString();
-      }
-    }
-    return null;
-  }
-
-  private void getStoredQueryBlock( JsonObject configObject, String config ) {
-    if ( !configObject.has(config)) {
-      customQueryConfig.setQueryRequiredProperties( new ArrayList<String>() );
-      customQueryConfig.setQueryOptionalProperties( new ArrayList<String>()  );
-      return;
+        if (configObject.has(config)) {
+            subqueryConfig = configObject.get(config);
+            if (subqueryConfig != null && !subqueryConfig.isJsonNull()) {
+                return subqueryConfig.getAsString();
+            }
+        }
+        return null;
     }
 
-    JsonElement queryConfig;
-    JsonObject subObject;
-    String multipleStartNodes;
-    List<String> propertyList;
+    private void getStoredQueryBlock(JsonObject configObject, String config) {
+        if (!configObject.has(config)) {
+            customQueryConfig.setQueryRequiredProperties(new ArrayList<String>());
+            customQueryConfig.setQueryOptionalProperties(new ArrayList<String>());
+            return;
+        }
+
+        JsonElement queryConfig;
+        JsonObject subObject;
+        String multipleStartNodes;
+        List<String> propertyList;
 
-    queryConfig = configObject.get(config);
-    subObject = queryConfig.getAsJsonObject();
-    propertyList = getPropertyList(subObject, REQUIRED_CONFIG);
-    if ( propertyList == null ) {
-      propertyList = new ArrayList<String>();
-    }
-    customQueryConfig.setQueryRequiredProperties( propertyList );
-    propertyList = getPropertyList(subObject, OPTIONAL_CONFIG);
-    if ( propertyList == null ) {
-      propertyList = new ArrayList<String>();
-    }
-    customQueryConfig.setQueryOptionalProperties( propertyList );
-
-  }
-
-
-  public CustomQueryConfig getStoredQuery(String queryName ) {
-
-    customQueryConfig = null;
-    JsonObject configObject;
-    JsonElement query;
-    JsonElement queryConfig;
-    String queryString;
-
-    for (JsonElement storedQuery : storedQueries) {
-      if (storedQuery.isJsonObject()) {
-        JsonObject queryObject = storedQuery.getAsJsonObject();
-        query = queryObject.get(queryName);
-        if ( query != null ) {
-          customQueryConfig = new CustomQueryConfig();
-          configObject = query.getAsJsonObject();
-          getStoredQueryBlock(configObject, QUERY_CONFIG);
-          if ( configObject.has(STORED_QUERY_CONFIG)) {
-            queryConfig = configObject.get(STORED_QUERY_CONFIG);
-            customQueryConfig.setQuery(queryConfig.getAsString());
-          }
-          break;
+        queryConfig = configObject.get(config);
+        subObject = queryConfig.getAsJsonObject();
+        propertyList = getPropertyList(subObject, REQUIRED_CONFIG);
+        if (propertyList == null) {
+            propertyList = new ArrayList<String>();
         }
-      }
-    }
+        customQueryConfig.setQueryRequiredProperties(propertyList);
+        propertyList = getPropertyList(subObject, OPTIONAL_CONFIG);
+        if (propertyList == null) {
+            propertyList = new ArrayList<String>();
+        }
+        customQueryConfig.setQueryOptionalProperties(propertyList);
 
-    return customQueryConfig;
+    }
 
-  }
+    public CustomQueryConfig getStoredQuery(String queryName) {
+
+        customQueryConfig = null;
+        JsonObject configObject;
+        JsonElement query;
+        JsonElement queryConfig;
+        String queryString;
+
+        for (JsonElement storedQuery : storedQueries) {
+            if (storedQuery.isJsonObject()) {
+                JsonObject queryObject = storedQuery.getAsJsonObject();
+                query = queryObject.get(queryName);
+                if (query != null) {
+                    customQueryConfig = new CustomQueryConfig();
+                    configObject = query.getAsJsonObject();
+                    getStoredQueryBlock(configObject, QUERY_CONFIG);
+                    if (configObject.has(STORED_QUERY_CONFIG)) {
+                        queryConfig = configObject.get(STORED_QUERY_CONFIG);
+                        customQueryConfig.setQuery(queryConfig.getAsString());
+                    }
+                    break;
+                }
+            }
+        }
 
+        return customQueryConfig;
 
+    }
 
 }
diff --git a/aai-queries/src/main/java/org/onap/aai/queries/GremlinServerSingleton.java b/aai-queries/src/main/java/org/onap/aai/queries/GremlinServerSingleton.java
index 509aa88..dd0db86 100644
--- a/aai-queries/src/main/java/org/onap/aai/queries/GremlinServerSingleton.java
+++ b/aai-queries/src/main/java/org/onap/aai/queries/GremlinServerSingleton.java
@@ -8,7 +8,7 @@
  * 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
+ * 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,
@@ -17,17 +17,8 @@
  * limitations under the License.
  * ============LICENSE_END=========================================================
  */
-package org.onap.aai.queries;
-
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import org.onap.aai.aaf.auth.FileWatcher;
-import org.onap.aai.logging.LogFormatTools;
-import org.onap.aai.util.AAIConstants;
 
-import org.springframework.beans.factory.annotation.Value;
-import javax.annotation.PostConstruct;
+package org.onap.aai.queries;
 
 import java.io.File;
 import java.io.IOException;
@@ -38,6 +29,15 @@ import java.util.Date;
 import java.util.Timer;
 import java.util.TimerTask;
 
+import javax.annotation.PostConstruct;
+
+import org.onap.aai.aaf.auth.FileWatcher;
+import org.onap.aai.logging.LogFormatTools;
+import org.onap.aai.util.AAIConstants;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Value;
+
 public class GremlinServerSingleton {
 
     private static Logger logger = LoggerFactory.getLogger(GremlinServerSingleton.class);
@@ -62,56 +62,57 @@ public class GremlinServerSingleton {
     @PostConstruct
     public void init() {
 
-    try {
-      String filepath = storedQueriesLocation + AAIConstants.AAI_FILESEP + "stored-queries.json";
-      Path path = Paths.get(filepath);
-      String customQueryConfigJson = new String(Files.readAllBytes(path));
-
-
-      queryConfig = new GetCustomQueryConfig(customQueryConfigJson);
-    } catch (IOException e) {
-      logger.error("Error occurred during the processing of query json file: " + LogFormatTools.getStackTop(e));
-    }
+        try {
+            String filepath =
+                storedQueriesLocation + AAIConstants.AAI_FILESEP + "stored-queries.json";
+            Path path = Paths.get(filepath);
+            String customQueryConfigJson = new String(Files.readAllBytes(path));
 
+            queryConfig = new GetCustomQueryConfig(customQueryConfigJson);
+        } catch (IOException e) {
+            logger.error("Error occurred during the processing of query json file: "
+                + LogFormatTools.getStackTop(e));
+        }
 
         TimerTask task = new FileWatcher(new File(storedQueriesLocation)) {
             @Override
             protected void onChange(File file) {
-            try {
-              String filepath = storedQueriesLocation;
-              Path path = Paths.get(filepath);
-              String customQueryConfigJson = new String(Files.readAllBytes(path));
-              queryConfig = new GetCustomQueryConfig(customQueryConfigJson);
-            } catch (IOException e) {
-              logger.error("Error occurred during the processing of query json file: " + LogFormatTools.getStackTop(e));
-            }
+                try {
+                    String filepath = storedQueriesLocation;
+                    Path path = Paths.get(filepath);
+                    String customQueryConfigJson = new String(Files.readAllBytes(path));
+                    queryConfig = new GetCustomQueryConfig(customQueryConfigJson);
+                } catch (IOException e) {
+                    logger.error("Error occurred during the processing of query json file: "
+                        + LogFormatTools.getStackTop(e));
+                }
             }
         };
 
         if (!timerSet) {
             timerSet = true;
             timer = new Timer();
-            timer.schedule( task , new Date(), 10000 );
+            timer.schedule(task, new Date(), 10000);
         }
 
     }
 
     /**
      * Gets the query using CustomQueryConfig
+     * 
      * @param key
      * @return
      */
-    public String getStoredQueryFromConfig(String key){
-      CustomQueryConfig customQueryConfig = queryConfig.getStoredQuery(key);
-      if ( customQueryConfig == null ) {
-        return null;
-      }
-      return customQueryConfig.getQuery();
+    public String getStoredQueryFromConfig(String key) {
+        CustomQueryConfig customQueryConfig = queryConfig.getStoredQuery(key);
+        if (customQueryConfig == null) {
+            return null;
+        }
+        return customQueryConfig.getQuery();
     }
 
     public CustomQueryConfig getCustomQueryConfig(String key) {
-      return queryConfig.getStoredQuery(key);
+        return queryConfig.getStoredQuery(key);
     }
 
-
 }