Merge pull request #1473 from scmacdon/master

Update the Java V2 Cognito Java Examples

Author: scmacdon

javav2/example_code/cognito/Readme.md

@@ -23,7 +23,7 @@ For systems with Bash support, once you set the **CLASSPATH**, you can run a par
 
  ## Testing the Amazon Cognito files
 
-You can test the Java code examples for Amazon Cognito by running a test file named **CognitoServiceIntegrationTest**. This file uses JUnit 5 to run the JUnit tests and is located in the **src/test/java** folder. For more information, see [https://junit.org/junit5/](https://junit.org/junit5/).
+You can test the Java code examples for Amazon Cognito by running a test file named **AmazonCognitoTest**. This file uses JUnit 5 to run the JUnit tests and is located in the **src/test/java** folder. For more information, see [https://junit.org/junit5/](https://junit.org/junit5/).
 
 You can execute the JUnit tests from a Java IDE, such as IntelliJ, or from the command line by using Maven. As each test is run, you can view messages that inform you if the various tests succeed or fail. For example, the following message informs you that Test 3 passed.
 
@@ -52,7 +52,7 @@ You will see output from the JUnit tests, as shown here.
 	[INFO] -------------------------------------------------------
 	[INFO]  T E S T S
 	[INFO] -------------------------------------------------------
-	[INFO] Running CognitoServiceIntegrationTest
+	[INFO] Running AmazonCognitoTest
 	Test 1 passed
 	Test 2 passed
 	...

javav2/example_code/cognito/metadata.yaml

@@ -42,6 +42,6 @@ files:
   - path: src/main/java/com/example/cognito/ListUsers.java
     services:
       - cognito      
-  - path: src/test/java/CognitoServiceIntegrationTest.java
+  - path: src/test/java/AmazonCognitoTest.java
     services:
       - cognito    

javav2/example_code/cognito/src/main/java/com/example/cognito/AddLoginProvider.java

@@ -1,26 +1,14 @@
 //snippet-sourcedescription:[AddLoginProvider.java demonstrates how to associate an Amazon Cognito identity pool with an identity provider.]
-//snippet-keyword:[Java]
-//snippet-sourcesyntax:[java]
+//snippet-keyword:[AWS SDK for Java v2]
 //snippet-keyword:[Code Sample]
 //snippet-keyword:[Amazon Cognito]
-//snippet-service:[cognito]
 //snippet-sourcetype:[full-example]
-//snippet-sourcedate:[8/14/2020]
+//snippet-sourcedate:[11/04/2020]
 //snippet-sourceauthor:[scmacdon AWS]
 /*
- * Copyright Amazon.com, Inc. or its affiliates. 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.
- * A copy of the License is located at
- *
- *  http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file 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.
- */
+   Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   SPDX-License-Identifier: Apache-2.0
+*/
 
 package com.example.cognito;
 
@@ -38,21 +26,21 @@
 public class AddLoginProvider {
 
     public static void main(String[] args) {
+
         final String USAGE = "\n" +
                 "Usage:\n" +
-                "    AddLoginProvider <app_id> <identity_pool_name> <identity_pool_id><providerName>\n\n" +
+                "    AddLoginProvider <appId> <identityPoolName> <identityPoolId> <providerName>\n\n" +
                 "Where:\n" +
-                "    appId - The application ID from the login provider.\n\n" +
-                "    identityPoolName - The name of your identity pool.\n\n" +
-                "    identityPoolId  - The AWS Region and GUID of your identity pool.\n\n" +
-                "    providerName  - The provider name (i.e., cognito-idp.us-east-1.amazonaws.com/us-east-1_Taz4Yxxxx).\n\n";
+                "    appId - the application ID value from the login provider.\n\n" +
+                "    identityPoolName - the name of your identity pool.\n\n" +
+                "    identityPoolId - the Id value of your identity pool.\n\n" +
+                "    providerName - the provider name (i.e., cognito-idp.us-east-1.amazonaws.com/us-east-1_Taz4Yxxxx).\n\n";
 
-        if (args.length < 4) {
+        if (args.length != 4) {
             System.out.println(USAGE);
             System.exit(1);
         }
 
-        /* Read the name from command args */
         String appId = args[0];
         String identityPoolName = args[1];
         String identityPoolId = args[2];
@@ -63,14 +51,15 @@ public static void main(String[] args) {
                 .build();
 
         setLoginProvider(cognitoclient,appId, identityPoolName, identityPoolId, providerName) ;
+        cognitoclient.close();
     }
 
     //snippet-start:[cognito.java2.add_login_provider.main]
     public static void setLoginProvider(CognitoIdentityClient cognitoclient,
-                                    String appId,
-                                    String identityPoolName,
-                                    String identityPoolId,
-                                    String providerName) {
+                                        String appId,
+                                        String identityPoolName,
+                                        String identityPoolId,
+                                        String providerName) {
 
         CognitoIdentityProvider identityProvider = CognitoIdentityProvider.builder()
                 .providerName(providerName)
@@ -103,4 +92,4 @@ public static void setLoginProvider(CognitoIdentityClient cognitoclient,
         }
         //snippet-end:[cognito.java2.add_login_provider.main]
     }
-}
+}

javav2/example_code/cognito/src/main/java/com/example/cognito/CreateAdminUser.java

@@ -1,26 +1,14 @@
 //snippet-sourcedescription:[CreateAdminUser.java demonstrates how to add a new admin to your user pool.]
-//snippet-keyword:[Java]
-//snippet-sourcesyntax:[java]
+//snippet-keyword:[AWS SDK for Java v2]
 //snippet-keyword:[Code Sample]
 //snippet-keyword:[Amazon Cognito]
-//snippet-service:[cognito]
 //snippet-sourcetype:[full-example]
-//snippet-sourcedate:[8/14/2020]
+//snippet-sourcedate:[11/04/2020]
 //snippet-sourceauthor:[scmacdon AWS]
 /*
- * Copyright Amazon.com, Inc. or its affiliates. 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.
- * A copy of the License is located at
- *
- *  http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file 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.
- */
+   Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   SPDX-License-Identifier: Apache-2.0
+*/
 
 package com.example.cognito;
 
@@ -38,29 +26,27 @@ public class CreateAdminUser {
     public static void main(String[] args) {
         final String USAGE = "\n" +
                 "Usage:\n" +
-                "    CreateAdminUser <user_pool_id> <username> <email>\n\n" +
+                "    CreateAdminUser <userPoolId> <userName> <email>\n\n" +
                 "Where:\n" +
-                "    user_pool_id - The ID for the user pool where the user will be created.\n\n" +
-                "    username - The user name for the user.\n\n" +
-                "    email  - The email to use for verifying the admin account.\n\n" +
-                "Example:\n" +
-                "    CreateTable HelloTable\n";
+                "    userPoolId - the Id value for the user pool where the user will be created.\n\n" +
+                "    userName - the user name for the admin user.\n\n" +
+                "    email - the email to use for verifying the admin account.\n\n" ;
 
-         if (args.length < 3) {
-              System.out.println(USAGE);
-              System.exit(1);
+        if (args.length != 3) {
+            System.out.println(USAGE);
+            System.exit(1);
         }
 
-        /* Read the name from command args */
         String userPoolId = args[0];
-        String name = args[1];
+        String userName = args[1];
         String email = args[2];
 
         CognitoIdentityProviderClient cognitoclient = CognitoIdentityProviderClient.builder()
                 .region(Region.US_EAST_1)
                 .build();
 
-        createAdmin(cognitoclient, userPoolId, name, email);
+        createAdmin(cognitoclient, userPoolId, userName, email);
+        cognitoclient.close();
     }
 
     //snippet-start:[cognito.java2.add_login_provider.main]
@@ -71,16 +57,16 @@ public static void createAdmin(CognitoIdentityProviderClient cognitoclient,
 
         try{
             AdminCreateUserResponse response = cognitoclient.adminCreateUser(
-                AdminCreateUserRequest.builder()
-                        .userPoolId(userPoolId)
-                        .username(name)
-                        .userAttributes(AttributeType.builder()
-                                .name("email")
-                                .value(email)
-                                .build())
-                        .messageAction("SUPPRESS")
-                        .build()
-        );
+                    AdminCreateUserRequest.builder()
+                            .userPoolId(userPoolId)
+                            .username(name)
+                            .userAttributes(AttributeType.builder()
+                                    .name("email")
+                                    .value(email)
+                                    .build())
+                            .messageAction("SUPPRESS")
+                            .build()
+            );
 
             System.out.println("User " + response.user().username() + "is created. Status: " + response.user().userStatus());
 
@@ -90,4 +76,4 @@ public static void createAdmin(CognitoIdentityProviderClient cognitoclient,
         }
         //snippet-end:[cognito.java2.add_login_provider.main]
     }
-}
+}

javav2/example_code/cognito/src/main/java/com/example/cognito/CreateIdentityPool.java

@@ -1,26 +1,14 @@
 //snippet-sourcedescription:[CreateIdentityPool.java demonstrates how to create a new Amazon Cognito identity pool. The identity pool is a store of user identity information that is specific to your AWS account.]
-//snippet-keyword:[Java]
-//snippet-sourcesyntax:[java]
+//snippet-keyword:[AWS SDK for Java v2]
 //snippet-keyword:[Code Sample]
 //snippet-keyword:[Amazon Cognito]
-//snippet-service:[cognito]
 //snippet-sourcetype:[full-example]
-//snippet-sourcedate:[8/14/2020]
+//snippet-sourcedate:[11/04/2020]
 //snippet-sourceauthor:[scmacdon AWS]
 /*
- * Copyright Amazon.com, Inc. or its affiliates. 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.
- * A copy of the License is located at
- *
- *  http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file 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.
- */
+   Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   SPDX-License-Identifier: Apache-2.0
+*/
 
 package com.example.cognito;
 
@@ -37,45 +25,43 @@ public class CreateIdentityPool {
     public static void main(String[] args) {
         final String USAGE = "\n" +
                 "Usage:\n" +
-                "    CreateIdentityPool <identity_pool_name> \n\n" +
+                "    CreateIdentityPool <identityPoolName> \n\n" +
                 "Where:\n" +
-                "    identity_pool_name - The name to give your identity pool.\n\n" +
-                "Example:\n" +
-                "    CreateTable HelloTable\n";
+                "    identityPoolName - the name to give your identity pool.\n\n" ;
 
-        if (args.length < 1) {
+        if (args.length != 1) {
             System.out.println(USAGE);
-           System.exit(1);
+            System.exit(1);
         }
 
         String identityPoolName = args[0];
-
         CognitoIdentityClient cognitoclient = CognitoIdentityClient.builder()
                 .region(Region.US_EAST_1)
                 .build();
 
         String identityPoolId = createIdPool(cognitoclient, identityPoolName) ;
         System.out.println("Unity pool ID " + identityPoolId);
+        cognitoclient.close();
     }
 
     //snippet-start:[cognito.java2.create_identity_pool.main]
     public static String createIdPool(CognitoIdentityClient cognitoclient, String identityPoolName ) {
 
         try {
             CreateIdentityPoolResponse response = cognitoclient.createIdentityPool(
-                CreateIdentityPoolRequest.builder()
-                        .allowUnauthenticatedIdentities(false)
-                        .identityPoolName(identityPoolName)
-                        .build()
-        );
+                    CreateIdentityPoolRequest.builder()
+                            .allowUnauthenticatedIdentities(false)
+                            .identityPoolName(identityPoolName)
+                            .build()
+            );
 
-           return response.identityPoolId();
+            return response.identityPoolId();
 
         } catch (CognitoIdentityProviderException e){
             System.err.println(e.awsErrorDetails().errorMessage());
             System.exit(1);
-    }
-       return "";
+        }
+        return "";
         //snippet-end:[cognito.java2.create_identity_pool.main]
     }
-}
+}

javav2/example_code/cognito/src/main/java/com/example/cognito/CreateUserPool.java

@@ -1,26 +1,14 @@
 //snippet-sourcedescription:[CreateUserPool.java demonstrates how to create a user pool for Amazon Cognito.]
-//snippet-keyword:[Java]
-//snippet-sourcesyntax:[java]
+//snippet-keyword:[AWS SDK for Java v2]
 //snippet-keyword:[Code Sample]
 //snippet-keyword:[Amazon Cognito]
-//snippet-service:[cognito]
 //snippet-sourcetype:[full-example]
-//snippet-sourcedate:[8/14/2020]
+//snippet-sourcedate:[11/04/2020]
 //snippet-sourceauthor:[scmacdon AWS]
 /*
- * Copyright Amazon.com, Inc. or its affiliates. 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.
- * A copy of the License is located at
- *
- *  http://aws.amazon.com/apache2.0
- *
- * or in the "license" file accompanying this file. This file 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.
- */
+   Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+   SPDX-License-Identifier: Apache-2.0
+*/
 
 package com.example.cognito;
 
@@ -39,14 +27,14 @@ public static void main(String[] args) {
                 "Usage:\n" +
                 "    CreateUserPool <userPoolName> \n\n" +
                 "Where:\n" +
-                "    userPoolName - The name to give your user pool when it's created.\n\n" +
+                "    userPoolName - the name to give your user pool when it's created.\n\n" +
                 "Example:\n" +
                 "    CreateTable HelloTable\n";
 
-        if (args.length < 1) {
-               System.out.println(USAGE);
-               System.exit(1);
-         }
+        if (args.length != 1) {
+            System.out.println(USAGE);
+            System.exit(1);
+        }
         /* Read the name from command args */
         String userPoolName = args[0];
 
@@ -56,6 +44,7 @@ public static void main(String[] args) {
 
         String id = createPool(cognitoclient,userPoolName);
         System.out.println("User pool ID: " + id);
+        cognitoclient.close();
     }
 
     //snippet-start:[cognito.java2.create_user_pool.main]
@@ -67,7 +56,7 @@ public static String createPool(CognitoIdentityProviderClient cognitoclient,Stri
                             .poolName(userPoolName)
                             .build()
             );
-           return repsonse.userPool().id();
+            return repsonse.userPool().id();
 
         } catch (CognitoIdentityProviderException e){
             System.err.println(e.awsErrorDetails().errorMessage());
@@ -76,4 +65,4 @@ public static String createPool(CognitoIdentityProviderClient cognitoclient,Stri
         return "";
         //snippet-end:[cognito.java2.create_user_pool.main]
     }
-}
+}