Merge pull request #20 from LisaLeib/java-quickstart-sample

Java quickstart sample - remove blank folders and add query key

Author: HeidiSteen

quickstart/pom.xml

@@ -1,13 +1,12 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
-    <groupId>AzureSearchSample</groupId>
-    <artifactId>AzureSearchSample</artifactId>
-    <version>0.0.1-SNAPSHOT</version>
-    <packaging>jar</packaging>
-    <properties>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    </properties>
+
+    <groupId>AzureSearchQuickstart</groupId>
+    <artifactId>AzureSearchQuickstart</artifactId>
+    <version>1.0-SNAPSHOT</version>
     <build>
         <sourceDirectory>src</sourceDirectory>
         <plugins>
@@ -31,7 +30,7 @@
                     </execution>
                 </executions>
                 <configuration>
-                    <mainClass>com.microsoft.azure.search.samples.app.App</mainClass>
+                    <mainClass>app.App</mainClass>
                     <cleanupDaemonThreads>false</cleanupDaemonThreads>
                 </configuration>
             </plugin>
@@ -44,4 +43,5 @@
             <version>1.0.2</version>
         </dependency>
     </dependencies>
+
 </project>

…rosoft/azure/search/samples/app/App.java quickstart/src/main/java/app/App.javaquickstart/src/main/java/com/microsoft/azure/search/samples/app/App.java renamed to quickstart/src/main/java/app/App.java quickstart/src/main/java/com/microsoft/azure/search/samples/app/App.java renamed to quickstart/src/main/java/app/App.java

@@ -1,7 +1,6 @@
-package com.microsoft.azure.search.samples.app;
-
-import com.microsoft.azure.search.samples.service.SearchServiceClient;
+package app;
 
+import service.SearchServiceClient;
 import java.io.IOException;
 import java.util.Properties;
 
@@ -19,36 +18,42 @@ public static void main(String[] args) {
             var config = loadPropertiesFromResource("config.properties");
             var client = new SearchServiceClient(
                     config.getProperty("SearchServiceName"),
-                    config.getProperty("SearchServiceApiKey"),
+                    config.getProperty("SearchServiceAdminKey"),
+                    config.getProperty("SearchServiceQueryKey"),
                     config.getProperty("ApiVersion"),
                     config.getProperty("IndexName")
             );
 
-            if(client.indexExists()){ client.deleteIndex();}
+
+//Uncomment the next 3 lines in the 1 - Create Index section of the quickstart
+            if (client.indexExists()) { client.deleteIndex();}
             client.createIndex("index.json");
             Thread.sleep(1000L); // wait a second to create the index
+
+//Uncomment the next 2 lines in the 2 - Load Documents section of the quickstart
             client.uploadDocuments("hotels.json");
             Thread.sleep(2000L); // wait 2 seconds for data to upload
 
+//Uncomment the following 5 search queries in the 3 - Search an index section of the quickstart
             // Query 1
             client.logMessage("\n*QUERY 1****************************************************************");
-            client.logMessage("Search for: Atlanta'");
+            client.logMessage("Search for: Atlanta");
             client.logMessage("Return: All fields'");
             client.searchPlus("Atlanta");
 
             // Query 2
             client.logMessage("\n*QUERY 2****************************************************************");
             client.logMessage("Search for: Atlanta");
             client.logMessage("Return: HotelName, Tags, Address");
-            SearchServiceClient.SearchOptions options2 = client.new SearchOptions();
+            SearchServiceClient.SearchOptions options2 = client.createSearchOptions();
             options2.select = "HotelName,Tags,Address";
             client.searchPlus("Atlanta", options2);
 
             //Query 3
             client.logMessage("\n*QUERY 3****************************************************************");
             client.logMessage("Search for: wifi & restaurant");
             client.logMessage("Return: HotelName, Description, Tags");
-            SearchServiceClient.SearchOptions options3 = client.new SearchOptions();
+            SearchServiceClient.SearchOptions options3 = client.createSearchOptions();
             options3.select = "HotelName,Description,Tags";
             client.searchPlus("wifi,restaurant", options3);
 
@@ -57,7 +62,7 @@ public static void main(String[] args) {
             client.logMessage("Search for: all");
             client.logMessage("Filter: Ratings greater than 4");
             client.logMessage("Return: HotelName, Rating");
-            SearchServiceClient.SearchOptions options4 = client.new SearchOptions();
+            SearchServiceClient.SearchOptions options4 = client.createSearchOptions();
             options4.filter="Rating%20gt%204";
             options4.select = "HotelName,Rating";
             client.searchPlus("*",options4);
@@ -68,7 +73,7 @@ public static void main(String[] args) {
             client.logMessage("Get: Top 2 results");
             client.logMessage("Order by: Rating in descending order");
             client.logMessage("Return: HotelId, HotelName, Category, Rating");
-            SearchServiceClient.SearchOptions options5 = client.new SearchOptions();
+            SearchServiceClient.SearchOptions options5 = client.createSearchOptions();
             options5.top=2;
             options5.orderby = "Rating%20desc";
             options5.select = "HotelId,HotelName,Category,Rating";

…samples/service/SearchServiceClient.java …in/java/service/SearchServiceClient.javaquickstart/src/main/java/com/microsoft/azure/search/samples/service/SearchServiceClient.java renamed to quickstart/src/main/java/service/SearchServiceClient.java quickstart/src/main/java/com/microsoft/azure/search/samples/service/SearchServiceClient.java renamed to quickstart/src/main/java/service/SearchServiceClient.java

@@ -1,4 +1,4 @@
-package com.microsoft.azure.search.samples.service;
+package service;
 
 import javax.json.Json;
 import javax.net.ssl.HttpsURLConnection;
@@ -16,36 +16,98 @@
 /**
  * This class is responsible for implementing HTTP operations for creating the index, uploading documents and searching the data*/
 public class SearchServiceClient {
-    private final String _apiKey;
+    private final String _adminKey;
+    private final String _queryKey;
     private final String _apiVersion;
     private final String _serviceName;
     private final String _indexName;
     private final static HttpClient client = HttpClient.newHttpClient();
 
-
-    public SearchServiceClient(String serviceName, String apiKey, String apiVersion, String indexName) {
+    public SearchServiceClient(String serviceName, String adminKey, String queryKey, String apiVersion, String indexName) {
         this._serviceName = serviceName;
-        this._apiKey = apiKey;
+        this._adminKey = adminKey;
+        this._queryKey = queryKey;
         this._apiVersion = apiVersion;
         this._indexName = indexName;
     }
 
-    private HttpRequest httpRequest(URI uri, String method, String contents)
-    {
-        return httpRequest(uri, _apiKey, method, contents);
-    }
-
     private static HttpResponse<String> sendRequest(HttpRequest request) throws IOException, InterruptedException {
         logMessage(String.format("%s: %s", request.method(), request.uri()));
         return client.send(request, HttpResponse.BodyHandlers.ofString());
     }
 
+    private static URI buildURI(Consumer<Formatter> fmtFn)
+    {
+        Formatter strFormatter = new Formatter();
+        fmtFn.accept(strFormatter);
+        String url = strFormatter.out().toString();
+        strFormatter.close();
+        return URI.create(url);
+    }
+
+    public static void logMessage(String message) {
+        System.out.println(message);
+    }
+
+    public static boolean isSuccessResponse(HttpResponse<String> response) {
+        try {
+            int responseCode = response.statusCode();
+
+            logMessage("\n Response code = " + responseCode);
+
+            if (responseCode == HttpURLConnection.HTTP_OK || responseCode == HttpURLConnection.HTTP_ACCEPTED
+                    || responseCode == HttpURLConnection.HTTP_NO_CONTENT || responseCode == HttpsURLConnection.HTTP_CREATED) {
+                return true;
+            }
+
+            // We got an error
+            var msg = response.body();
+            if (msg != null) {
+                logMessage(String.format("\n MESSAGE: %s", msg));
+            }
+
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+
+        return false;
+    }
+
+    public static HttpRequest httpRequest(URI uri, String key, String method, String contents) {
+        contents = contents == null ? "" : contents;
+        var builder = HttpRequest.newBuilder();
+        builder.uri(uri);
+        builder.setHeader("content-type", "application/json");
+        builder.setHeader("api-key", key);
+
+        switch (method) {
+            case "GET":
+                builder = builder.GET();
+                break;
+            case "HEAD":
+                builder = builder.GET();
+                break;
+            case "DELETE":
+                builder = builder.DELETE();
+                break;
+            case "PUT":
+                builder = builder.PUT(HttpRequest.BodyPublishers.ofString(contents));
+                break;
+            case "POST":
+                builder = builder.POST(HttpRequest.BodyPublishers.ofString(contents));
+                break;
+            default:
+                throw new IllegalArgumentException(String.format("Can't create request for method '%s'", method));
+        }
+        return builder.build();
+    }
+
     public boolean indexExists() throws IOException, InterruptedException {
         logMessage("\n Checking if index exists...");
         var uri = buildURI(strFormatter -> strFormatter.format(
                 "https://%s.search.windows.net/indexes/%s/docs?api-version=%s&search=*",
                 _serviceName,_indexName,_apiVersion));
-        var request = httpRequest(uri, "HEAD", "");
+        var request = httpRequest(uri, _adminKey, "HEAD", "");
         var response = sendRequest(request);
         return isSuccessResponse(response);
     }
@@ -55,7 +117,7 @@ public boolean deleteIndex() throws IOException, InterruptedException {
         var uri = buildURI(strFormatter -> strFormatter.format(
                 "https://%s.search.windows.net/indexes/%s?api-version=%s",
                 _serviceName,_indexName,_apiVersion));
-        var request = httpRequest(uri, "DELETE", "*");
+        var request = httpRequest(uri, _adminKey, "DELETE", "*");
         var response = sendRequest(request);
         return isSuccessResponse(response);
     }
@@ -71,7 +133,7 @@ public boolean createIndex(String indexDefinitionFile) throws IOException, Inter
         var inputStream = SearchServiceClient.class.getResourceAsStream("index.json");
         var indexDef = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
         //Send HTTP PUT request to create the index in the search service
-        var request = httpRequest(uri, "PUT", indexDef);
+        var request = httpRequest(uri, _adminKey, "PUT", indexDef);
         var response = sendRequest(request);
         return isSuccessResponse(response);
     }
@@ -86,13 +148,15 @@ public boolean uploadDocuments(String documentsFile) throws IOException, Interru
         var inputStream = SearchServiceClient.class.getResourceAsStream(documentsFile);
         var documents = new String(inputStream.readAllBytes(), StandardCharsets.UTF_8);
         //Send HTTP POST request to upload and index the data
-        var request = httpRequest(endpoint, "POST", documents);
+        var request = httpRequest(endpoint, _adminKey, "POST", documents);
         var response = sendRequest(request);
         return isSuccessResponse(response);
     }
 
+    public SearchOptions createSearchOptions() { return new SearchOptions();}
+
     //Defines available search parameters that can be set
-    public class SearchOptions {
+    public static class SearchOptions {
 
         public String select = "";
         public String filter = "";
@@ -125,94 +189,26 @@ public void searchPlus(String queryString)
     public void searchPlus(String queryString, SearchOptions options) {
 
         try {
-             String optionsString = createOptionsString(options);
+            String optionsString = createOptionsString(options);
             var uri = buildURI(strFormatter -> strFormatter.format(
                     "https://%s.search.windows.net/indexes/%s/docs?api-version=%s&search=%s%s",
                     _serviceName, _indexName, _apiVersion, queryString, optionsString));
-            var request = httpRequest(uri, "GET", null);
+            var request = httpRequest(uri, _queryKey, "GET", null);
             var response = sendRequest(request);
-           // logMessage("Full response:\n");
-           // logMessage(response.body());
             var jsonReader = Json.createReader(new StringReader(response.body()));
             var jsonArray = jsonReader.readObject().getJsonArray("value");
-             var resultsCount = jsonArray.size();
+            var resultsCount = jsonArray.size();
             logMessage("Results:\nCount: " + resultsCount);
             for (int i = 0; i <= resultsCount - 1; i++) {
                 logMessage(jsonArray.get(i).toString());
             }
 
             jsonReader.close();
 
-          }
-         catch (Exception e) {
-                e.printStackTrace();
-            }
-
-    }
-
-    private static URI buildURI(Consumer<Formatter> fmtFn)
-    {
-        Formatter strFormatter = new Formatter();
-        fmtFn.accept(strFormatter);
-        String url = strFormatter.out().toString();
-        strFormatter.close();
-        return URI.create(url);
-    }
-
-    public static void logMessage(String message) {
-        System.out.println(message);
-    }
-
-    public static boolean isSuccessResponse(HttpResponse<String> response) {
-        try {
-            int responseCode = response.statusCode();
-
-            logMessage("\n Response code = " + responseCode);
-
-            if (responseCode == HttpURLConnection.HTTP_OK || responseCode == HttpURLConnection.HTTP_ACCEPTED
-                    || responseCode == HttpURLConnection.HTTP_NO_CONTENT || responseCode == HttpsURLConnection.HTTP_CREATED) {
-                return true;
-            }
-
-            // We got an error
-            var msg = response.body();
-            if (msg != null) {
-                logMessage(String.format("\n MESSAGE: %s", msg));
-            }
-
-        } catch (Exception e) {
+        }
+        catch (Exception e) {
             e.printStackTrace();
         }
 
-        return false;
-    }
-
-    private static HttpRequest httpRequest(URI uri, String apiKey, String method, String contents) {
-        contents = contents == null ? "" : contents;
-        var builder = HttpRequest.newBuilder();
-        builder.uri(uri);
-        builder.setHeader("content-type", "application/json");
-        builder.setHeader("api-key", apiKey);
-
-        switch (method) {
-            case "GET":
-                builder = builder.GET();
-                break;
-            case "HEAD":
-                builder = builder.GET();
-                break;
-            case "DELETE":
-                builder = builder.DELETE();
-                break;
-            case "PUT":
-                builder = builder.PUT(HttpRequest.BodyPublishers.ofString(contents));
-                break;
-            case "POST":
-                builder = builder.POST(HttpRequest.BodyPublishers.ofString(contents));
-                break;
-            default:
-                throw new IllegalArgumentException(String.format("Can't create request for method '%s'", method));
-        }
-        return builder.build();
     }
-}
+}

quickstart/src/main/resources/app/config.properties

@@ -0,0 +1,5 @@
+SearchServiceName=<YOUR-SEARCH-SERVICE-NAME>
+SearchServiceAdminKey=<YOUR-ADMIN-KEY>
+SearchServiceQueryKey=<YOUR-QUERY-KEY>
+IndexName=hotels-quickstart
+ApiVersion=2019-05-06