rolled in review comments

Author: scmacdon

.doc_gen/metadata/location_metadata.yaml

@@ -133,6 +133,32 @@ location_CalculateRoute:
                 - location.java2.calc.distance.main
   services:
     location: {CalculateRoute}
+location_DeleteGeofenceCollection:
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/location
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - location.java2.delete.collection.main
+  services:
+    location: {DeleteGeofenceCollection}    
+location_DeleteKey:
+  languages:
+    Java:
+      versions:
+        - sdk_version: 2
+          github: javav2/example_code/location
+          sdkguide:
+          excerpts:
+            - description:
+              snippet_tags:
+                - location.java2.delete.key.main
+  services:
+    location: {DeleteKey}  
 location_DeleteMap:
   languages:
     Java:

javav2/example_code/location/src/main/java/com/example/location/HelloLocation.java

@@ -16,13 +16,27 @@
 import java.util.concurrent.CompletableFuture;
 
 // snippet-start:[location.java2.hello.main]
+/**
+ * Before running this Java V2 code example, set up your development
+ * environment, including your credentials.
+ *
+ * For more information, see the following documentation topic:
+ *
+ * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
+ *
+ * In addition, you need to create a collection using the AWS Management
+ * console. For information, see the following documentation.
+ *
+ * https://docs.aws.amazon.com/location/latest/developerguide/geofence-gs.html
+
+ */
 public class HelloLocation {
 
     private static LocationAsyncClient locationAsyncClient;
     private static final Logger logger = LoggerFactory.getLogger(HelloLocation.class);
 
     // This Singleton pattern ensures that only one `LocationClient`
-    // instance is used throughout the application.
+    // instance.
     private static LocationAsyncClient getClient() {
         if (locationAsyncClient == null) {
             SdkAsyncHttpClient httpClient = NettyNioAsyncHttpClient.builder()
@@ -50,31 +64,42 @@ public static void main(String[] args) {
         final String usage = """
 
             Usage:
-                <colletionName>
+                <collectionName>
 
             Where:
-                colletionName - The Amazon location collection name. 
+                collectionName - The Amazon location collection name.
             """;
 
         if (args.length != 1) {
             System.out.println(usage);
             System.exit(1);
         }
 
-        String colletionName = args[0];
-        listGeofences(colletionName);
+        String collectionName = args[0];
+        listGeofences(collectionName);
     }
 
+    /**
+     * Lists geofences from a specified geofence collection asynchronously.
+     *
+     * @param collectionName The name of the geofence collection to list geofences from.
+     * @return A {@link CompletableFuture} representing the result of the asynchronous operation.
+     *         The future completes when all geofences have been processed and logged.
+     */
     public static CompletableFuture<Void> listGeofences(String collectionName) {
         ListGeofencesRequest geofencesRequest = ListGeofencesRequest.builder()
-            .collectionName(collectionName)
-            .build();
+                .collectionName(collectionName)
+                .build();
 
         ListGeofencesPublisher paginator = getClient().listGeofencesPaginator(geofencesRequest);
         CompletableFuture<Void> future = paginator.subscribe(response -> {
-            response.entries().forEach(geofence ->
-                logger.info("Geofence ID: " + geofence.geofenceId())
-            );
+            if (response.entries().isEmpty()) {
+                logger.info("No Geofences were found in the collection.");
+            } else {
+                response.entries().forEach(geofence ->
+                        logger.info("Geofence ID: " + geofence.geofenceId())
+                );
+            }
         });
         return future;
     }

javav2/example_code/location/src/main/java/com/example/location/scenario/LocationActions.java

@@ -16,7 +16,6 @@
 import software.amazon.awssdk.services.geoplaces.model.SearchNearbyRequest;
 import software.amazon.awssdk.services.geoplaces.model.SearchNearbyResponse;
 import software.amazon.awssdk.services.geoplaces.model.SearchTextRequest;
-import software.amazon.awssdk.services.geoplaces.model.SearchTextResponse;
 import software.amazon.awssdk.services.location.LocationAsyncClient;
 import software.amazon.awssdk.services.location.model.AccessDeniedException;
 import software.amazon.awssdk.services.location.model.ApiKeyRestrictions;
@@ -157,66 +156,58 @@ public CompletableFuture<SearchNearbyResponse> searchNearBy() {
      *
      * @param searchQuery the search query to be used for the place search (ex, coffee shop)
      */
-    public CompletableFuture<SearchTextResponse> searchText(String searchQuery) {
+    public CompletableFuture<Void> searchText(String searchQuery) {
         double latitude = 37.7749;  // San Francisco
         double longitude = -122.4194;
         List<Double> queryPosition = List.of(longitude, latitude);
 
         SearchTextRequest request = SearchTextRequest.builder()
-            .queryText(searchQuery)
-            .biasPosition(queryPosition)
-            .build();
+                .queryText(searchQuery)
+                .biasPosition(queryPosition)
+                .build();
 
         return getGeoPlacesClient().searchText(request)
-            .whenComplete((response, exception) -> {
-                if (exception != null) {
-                    Throwable cause = exception.getCause();
-                    if (cause instanceof software.amazon.awssdk.services.geoplaces.model.ValidationException) {
-                        throw new CompletionException("A validation error occurred: " + cause.getMessage(), cause);
+                .thenCompose(response -> {
+                    if (response.resultItems().isEmpty()) {
+                        logger.info("No places found.");
+                        return CompletableFuture.completedFuture(null);
                     }
-                    throw new CompletionException("Error performing place search", exception);
-                }
 
-                // Process the response and fetch detailed information about the place.
-                response.resultItems().stream().findFirst().ifPresent(result -> {
-                    String placeId = result.placeId(); // Get Place ID
+                    // Get the first place ID
+                    String placeId = response.resultItems().get(0).placeId();
                     logger.info("Found Place with id: " + placeId);
 
-                    // Fetch detailed info using getPlace.
+                    // Fetch detailed info using getPlace
                     GetPlaceRequest getPlaceRequest = GetPlaceRequest.builder()
-                        .placeId(placeId)
-                        .build();
-
-                    getGeoPlacesClient().getPlace(getPlaceRequest)
-                        .whenComplete((placeResponse, placeException) -> {
-                            if (placeException != null) {
-                                Throwable cause = placeException.getCause();
-                                if (cause instanceof software.amazon.awssdk.services.geoplaces.model.ValidationException) {
-                                    throw new CompletionException("A validation error occurred: " + cause.getMessage(), cause);
+                            .placeId(placeId)
+                            .build();
+
+                    return getGeoPlacesClient().getPlace(getPlaceRequest)
+                            .thenAccept(placeResponse -> {
+                                logger.info("Detailed Place Information:");
+                                logger.info("Name: " + placeResponse.placeType().name());
+                                logger.info("Address: " + placeResponse.address().label());
+
+                                if (placeResponse.foodTypes() != null && !placeResponse.foodTypes().isEmpty()) {
+                                    logger.info("Food Types:");
+                                    placeResponse.foodTypes().forEach(foodType -> {
+                                        logger.info("  - " + foodType);
+                                    });
+                                } else {
+                                    logger.info("No food types available.");
                                 }
-                                throw new CompletionException("Error fetching place details", placeException);
-                            }
-
-                            // Print detailed place information.
-                            logger.info("Detailed Place Information:");
-                            logger.info("Name: " + placeResponse.placeType().name());
-                            logger.info("Address: " + placeResponse.address().label());
-
-                            // Print each food type (if any).
-                            if (placeResponse.foodTypes() != null && !placeResponse.foodTypes().isEmpty()) {
-                                logger.info("Food Types:");
-                                placeResponse.foodTypes().forEach(foodType -> {
-                                    logger.info("  - " + foodType);
-                                });
-                            } else {
-                                logger.info("No food types available.");
-                            }
-
-                            logger.info("-------------------------");
-                        });
+                                logger.info("-------------------------");
+                            });
+                })
+                .exceptionally(exception -> {
+                    Throwable cause = exception.getCause();
+                    if (cause instanceof software.amazon.awssdk.services.geoplaces.model.ValidationException) {
+                        throw new CompletionException("A validation error occurred: " + cause.getMessage(), cause);
+                    }
+                    throw new CompletionException("Error performing place search", exception);
                 });
-            });
     }
+
     // snippet-end:[geoplaces.java2.search.text.main]
 
     // snippet-start:[geoplaces.java2.geocode.main]

javav2/example_code/location/src/main/java/com/example/location/scenario/LocationScenario.java

@@ -19,6 +19,15 @@
 import java.util.concurrent.CompletionException;
 
 // snippet-start:[location.java2.scenario.main]
+/*
+ * Before running this Java V2 code example, set up your development
+ * environment, including your credentials.
+ *
+ * For more information, see the following documentation topic:
+ *
+ * https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/get-started.html
+ *
+ */
 public class LocationScenario {
 
     public static final String DASHES = new String(new char[80]).replace("\0", "-");
@@ -43,18 +52,18 @@ public static void main(String[] args) {
               deviceId - The ID of the device (e.g., "iPhone-112356").
             """;
 
-        if (args.length != 7) {
-            logger.info(usage);
-            return;
-        }
+        //if (args.length != 7) {
+        //    logger.info(usage);
+        //    return;
+       // }
 
-        String mapName = args[0];
-        String keyName = args[1];
-        String collectionName = args[2];
-        String geoId = args[3];
-        String trackerName = args[4];
-        String calculatorName = args[5];
-        String deviceId = args[6];
+        String mapName = "AWSMap200" ; //args[0];
+        String keyName = "AWSApiKey200" ; //args[1];
+        String collectionName = "AWSLocationCollection200" ; //args[2];
+        String geoId = "geoId200" ; //args[3];
+        String trackerName = "geoTracker200" ; //args[4];
+        String calculatorName = "AWSRouteCalc200" ; //args[5];
+        String deviceId = "iPhone-112356" ; //args[6];
 
         logger.info("""
             AWS Location Service is a fully managed service offered by Amazon Web Services (AWS) that
@@ -82,6 +91,8 @@ location names into geographic coordinates (latitude and longitude),\s
         try {
             runScenario(mapName, keyName, collectionName, geoId, trackerName, calculatorName, deviceId);
         } catch (RuntimeException e) {
+            // Clean up AWS Resources.
+            cleanUp(mapName, keyName, collectionName, trackerName, calculatorName);
             logger.info(e.getMessage());
         }
     }
@@ -145,9 +156,10 @@ restrict API keys to specific AWS Location operations (e.g., only
             In order to get the MAP URL, you need to get the API Key value.
             You can get the key value using the AWS Management Console under
             Location Services. This operation cannot be completed using the
-            AWS SDK.
+            AWS SDK. For more information about getting the key value, see 
+            https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html.
             """);
-        String mapUrl = "https://maps.geo.aws.amazon.com/maps/v0/maps/{MapName}/tiles/{z}/{x}/{y}?key={KeyValue}";
+        String mapUrl = "https://maps.geo.aws.amazon.com/maps/v0/maps/"+mapName+"/tiles/{z}/{x}/{y}?key={KeyValue}";
         logger.info("Embed this URL in your Web app: " + mapUrl);
         logger.info("");
         waitForInputToContinue(scanner);
@@ -291,7 +303,7 @@ restrict API keys to specific AWS Location operations (e.g., only
         waitForInputToContinue(scanner);
         try {
             CalculateRouteResponse response = locationActions.calcDistanceAsync(calculatorName).join();
-            logger.info("Successfully calculated route. The distance is {}", response.summary().distance());
+            logger.info("Successfully calculated route. The distance in kilometers is {}", response.summary().distance());
         } catch (CompletionException ce) {
             Throwable cause = ce.getCause();
             if (cause instanceof ResourceNotFoundException) {
@@ -325,7 +337,7 @@ restrict API keys to specific AWS Location operations (e.g., only
             waitForInputToContinue(scanner);
 
             logger.info("Now we are going to perform a nearby Search.");
-            waitForInputToContinue(scanner);
+            //waitForInputToContinue(scanner);
             locationActions.searchNearBy().join();
             waitForInputToContinue(scanner);
         } catch (CompletionException ce) {
@@ -343,21 +355,7 @@ restrict API keys to specific AWS Location operations (e.g., only
         logger.info("Would you like to delete the AWS Location Services resources? (y/n)");
         String delAns = scanner.nextLine().trim();
         if (delAns.equalsIgnoreCase("y")) {
-            try {
-                locationActions.deleteMap(mapName).join();
-                locationActions.deleteKey(keyName).join();
-                locationActions.deleteGeofenceCollectionAsync(collectionName).join();
-                locationActions.deleteTracker(trackerName).join();
-                locationActions.deleteRouteCalculator(calculatorName).join();
-            } catch (CompletionException ce) {
-                Throwable cause = ce.getCause();
-                if (cause instanceof ResourceNotFoundException) {
-                    logger.info("The resource was not found: {}", cause.getMessage(), cause);
-                } else {
-                    logger.info("An unexpected error occurred: {}", cause.getMessage(), cause);
-                }
-                return;
-            }
+            cleanUp(mapName, keyName, collectionName, trackerName, calculatorName);
         } else {
             logger.info("The AWS resources will not be deleted.");
         }
@@ -369,6 +367,33 @@ restrict API keys to specific AWS Location operations (e.g., only
         logger.info(DASHES);
     }
 
+    /**
+     * Cleans up resources by deleting the specified map, key, geofence collection, tracker, and route calculator.
+     *
+     * @param mapName The name of the map to delete.
+     * @param keyName The name of the key to delete.
+     * @param collectionName The name of the geofence collection to delete.
+     * @param trackerName The name of the tracker to delete.
+     * @param calculatorName The name of the route calculator to delete.
+     */
+    private static void cleanUp(String mapName, String keyName, String collectionName, String trackerName, String calculatorName) {
+        try {
+            locationActions.deleteMap(mapName).join();
+            locationActions.deleteKey(keyName).join();
+            locationActions.deleteGeofenceCollectionAsync(collectionName).join();
+            locationActions.deleteTracker(trackerName).join();
+            locationActions.deleteRouteCalculator(calculatorName).join();
+        } catch (CompletionException ce) {
+            Throwable cause = ce.getCause();
+            if (cause instanceof ResourceNotFoundException) {
+                logger.info("The resource was not found: {}", cause.getMessage(), cause);
+            } else {
+                logger.info("An unexpected error occurred: {}", cause.getMessage(), cause);
+            }
+            return;
+        }
+    }
+
     private static void waitForInputToContinue(Scanner scanner) {
         while (true) {
             logger.info("");