refactor: integrating sample code as subprojects (aws#214)

Integrate sample code snippets into subprojects that is compilable and easy to run.

Author: karenc-bq

docs/using-the-jdbc-driver/DataSource.md

@@ -81,6 +81,8 @@ To use the AWS JDBC Driver with a connection pool, you must:
    ds.addDataSourceProperty("targetDataSourceProperties", targetDataSourceProps);
    ```
 
-See [here](./sample-code/HikariSample.java) for a complete sample.
+See [here](../../examples/AWSDriverExample/src/main/java/software/amazon/DatasourceExample.java) for a simple AWS Driver Datasource example.
+
+See [here](../../examples/HikariExample/src/main/java/software/amazon/HikariExample.java) for a complete Hikari example.
 
 > **:warning:Note:** HikariCP supports either DataSource-based configuration or DriverManager-based configuration by specifying the `dataSourceClassName` or the `jdbcUrl`. When using the `AwsWrapperDataSource` you must specify the `dataSourceClassName`, therefore `HikariDataSource.setJdbcUrl` is not supported. For more information see HikariCP's [documentation](https://github.com/brettwooldridge/HikariCP#gear-configuration-knobs-baby).

docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md

@@ -18,39 +18,5 @@ The following properties are required for the AWS Secrets Manager Connection Plu
 | `secretsManagerRegion`   | String |   Yes    | Set this value to be the region your secret is in.      | `us-east-2` | `us-east-1`   |
 
 ### Example
-The following example demonstrates using the AWS Advanced JDBC Driver to make a connection to a PostgreSQL database using credentials fetched from the AWS Secrets Manager:
-
-```java
-import java.sql.Connection;
-import java.sql.DriverManager;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.sql.Statement;
-import java.util.Properties;
-
-public class AwsSecretsManagerConnectionPluginPostgresqlSample {
-
-  private static final String CONNECTION_STRING = "jdbc:aws-wrapper:postgresql://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:5432/employees";
-
-  public static void main(String[] args) throws SQLException, ClassNotFoundException {
-    // Set the AWS Secrets Manager Connection Plugin parameters and the JDBC Wrapper parameters.
-    final Properties properties = new Properties();
-    properties.setProperty("secretsManagerRegion", "us-east-2");
-    properties.setProperty("secretsManagerSecretId", "secretId");
-
-    // Enable the AWS Secrets Manager Connection Plugin.
-    properties.setProperty(
-        "wrapperPlugins",
-        "awsSecretsManager");
-
-    // Try and make a connection:
-    try (final Connection conn = DriverManager.getConnection(CONNECTION_STRING, properties);
-         final Statement statement = conn.createStatement();
-         final ResultSet rs = statement.executeQuery("SELECT * FROM employees")) {
-      while (rs.next()) {
-        System.out.println(rs.getString("first_name"));
-      }
-    }
-  }
-}
-```
+[AwsSecretsManagerConnectionPluginPostgresqlExample.java](../../../examples/AWSDriverExample/src/main/java/software/amazon/AwsSecretsManagerConnectionPluginPostgresqlExample.java) 
+demonstrates using the AWS Advanced JDBC Driver to make a connection to a PostgreSQL database using credentials fetched from the AWS Secrets Manager:

docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md

@@ -34,49 +34,4 @@ IAM database authentication use is limited to certain database engines. For more
 
 
 ## Sample code
-```java
-import software.amazon.jdbc.PropertyDefinition;
-import java.sql.Connection;
-import java.sql.DriverManager;
-import java.sql.ResultSet;
-import java.sql.SQLException;
-import java.sql.Statement;
-import java.util.Properties;
-
-public class AwsIamAuthenticationPostgresqlSample {
-    public static final String POSTGRESQL_CONNECTION_STRING =
-        "jdbc:aws-wrapper:postgresql://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:5432/employees";
-    private static final String USERNAME = "john_smith";
-
-    public static void main(String[] args) throws SQLException {
-
-        final Properties properties = new Properties();
-        
-        // Enable AWS IAM database authentication and configure driver property values
-        properties.setProperty(PropertyDefinition.PLUGINS.name, "iam");
-        properties.setProperty(PropertyDefinition.USER.name, USERNAME);
-        properties.setProperty(PropertyDefinition.TARGET_DRIVER_USER_PROPERTY_NAME.name, "user");
-        properties.setProperty(PropertyDefinition.TARGET_DRIVER_PASSWORD_PROPERTY_NAME.name, "password");
-
-        // Attempt a connection
-        try (Connection conn = DriverManager.getConnection(POSTGRESQL_CONNECTION_STRING, properties);
-            Statement statement = conn.createStatement();
-            ResultSet result = statement.executeQuery("select aurora_db_instance_identifier()")) {
-
-            System.out.println(getResult(result));
-        } 
-    }
-
-    static String getResult(final ResultSet result) throws SQLException {
-        int cols = result.getMetaData().getColumnCount();
-        StringBuilder builder = new StringBuilder();
-        while (result.next()) {
-            for (int i = 1; i <= cols; i++) {
-                builder.append(result.getString(i)).append(" ");
-            }
-            builder.append("\n");
-        }
-        return builder.toString();
-    }
-}
-```
+[AwsIamAuthenticationPostgresqlExample.java](../../../examples/AWSDriverExample/src/main/java/software/amazon/AwsIamAuthenticationPostgresqlExample.java)

examples/AWSDriverExample/build.gradle.kts

@@ -0,0 +1,22 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ * 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,
+ * 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.
+ */
+
+dependencies {
+    implementation("org.postgresql:postgresql:42.5.0")
+    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:1.0.0")
+    implementation("software.amazon.awssdk:rds:2.17.289")
+    implementation("software.amazon.awssdk:secretsmanager:2.17.285")
+}

examples/AWSDriverExample/gradle.properties

@@ -0,0 +1,16 @@
+#    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.
+#    You may obtain a copy of the License at
+#
+#    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,
+#    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.
+
+# Do not publish the Jar file for this subproject
+nexus.publish=false

docs/using-the-jdbc-driver/sample-code/AwsIamAuthenticationPostgresqlSample.java renamed to examples/AWSDriverExample/src/main/java/software/amazon/AwsIamAuthenticationPostgresqlExample.java

@@ -16,6 +16,8 @@
  *
  */
 
+package software.amazon;
+
 import software.amazon.jdbc.PropertyDefinition;
 import java.sql.Connection;
 import java.sql.DriverManager;
@@ -24,7 +26,7 @@
 import java.sql.Statement;
 import java.util.Properties;
 
-public class AwsIamAuthenticationPostgresqlSample {
+public class AwsIamAuthenticationPostgresqlExample {
   public static final String POSTGRESQL_CONNECTION_STRING =
       "jdbc:aws-wrapper:postgresql://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:5432/employees";
   private static final String USERNAME = "john_smith";
@@ -36,27 +38,13 @@ public static void main(String[] args) throws SQLException {
     // Enable AWS IAM database authentication and configure driver property values
     properties.setProperty(PropertyDefinition.PLUGINS.name, "iam");
     properties.setProperty(PropertyDefinition.USER.name, USERNAME);
-    properties.setProperty(PropertyDefinition.TARGET_DRIVER_USER_PROPERTY_NAME.name, "user");
-    properties.setProperty(PropertyDefinition.TARGET_DRIVER_PASSWORD_PROPERTY_NAME.name, "password");
 
     // Attempt a connection
     try (Connection conn = DriverManager.getConnection(POSTGRESQL_CONNECTION_STRING, properties);
         Statement statement = conn.createStatement();
         ResultSet result = statement.executeQuery("select aurora_db_instance_identifier()")) {
 
-      System.out.println(getResult(result));
-    }
-  }
-
-  static String getResult(final ResultSet result) throws SQLException {
-    int cols = result.getMetaData().getColumnCount();
-    StringBuilder builder = new StringBuilder();
-    while (result.next()) {
-      for (int i = 1; i <= cols; i++) {
-        builder.append(result.getString(i)).append(" ");
-      }
-      builder.append("\n");
+      System.out.println(Util.getResult(result));
     }
-    return builder.toString();
   }
-}
+}

docs/using-the-jdbc-driver/sample-code/AwsSecretsManagerConnectionPluginPostgresqlSample.java renamed to examples/AWSDriverExample/src/main/java/software/amazon/AwsSecretsManagerConnectionPluginPostgresqlExample.java

@@ -14,35 +14,34 @@
  * limitations under the License.
  */
 
+package software.amazon;
+
 import java.sql.Connection;
 import java.sql.DriverManager;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.util.Properties;
+import software.amazon.jdbc.PropertyDefinition;
 
-public class AwsSecretsManagerConnectionPluginPostgresqlSample {
+public class AwsSecretsManagerConnectionPluginPostgresqlExample {
 
   private static final String CONNECTION_STRING = "jdbc:aws-wrapper:postgresql://db-identifier.cluster-XYZ.us-east-2.rds.amazonaws.com:5432/employees";
 
-  public static void main(String[] args) throws SQLException, ClassNotFoundException {
+  public static void main(String[] args) throws SQLException {
     // Set the AWS Secrets Manager Connection Plugin parameters and the JDBC Wrapper parameters.
     final Properties properties = new Properties();
     properties.setProperty("secretsManagerRegion", "us-east-2");
     properties.setProperty("secretsManagerSecretId", "secretId");
 
     // Enable the AWS Secrets Manager Connection Plugin.
-    properties.setProperty(
-        "wrapperPlugins",
-        "awsSecretsManager");
+    properties.setProperty(PropertyDefinition.PLUGINS.name, "awsSecretsManager");
 
     // Try and make a connection:
     try (final Connection conn = DriverManager.getConnection(CONNECTION_STRING, properties);
          final Statement statement = conn.createStatement();
          final ResultSet rs = statement.executeQuery("SELECT * FROM employees")) {
-      while (rs.next()) {
-        System.out.println(rs.getString("first_name"));
-      }
+      System.out.println(Util.getResult(rs));
     }
   }
 }

docs/using-the-jdbc-driver/sample-code/DataSourceSample.java renamed to examples/AWSDriverExample/src/main/java/software/amazon/DatasourceExample.java

@@ -1,29 +1,29 @@
 /*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
- *     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.
+ * You may obtain a copy of the License at
  *
- *     Licensed under the Apache License, Version 2.0 (the "License").
- *     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
- *
- *     Unless required by applicable law or agreed to in writing, software
- *     distributed under the License 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.
+ * 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,
+ * 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.
  */
 
-import software.amazon.jdbc.ds.AwsWrapperDataSource;
+package software.amazon;
+
 import java.sql.Connection;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.util.Properties;
+import software.amazon.jdbc.ds.AwsWrapperDataSource;
 
-public class DataSourceSample {
+public class DatasourceExample {
   private static final String USER = "username";
   private static final String PASSWORD = "password";
 
@@ -48,11 +48,9 @@ public static void main(String[] args) throws SQLException {
 
     // Try and make a connection:
     try (final Connection conn = ds.getConnection(USER, PASSWORD);
-         final Statement statement = conn.createStatement();
-         final ResultSet rs = statement.executeQuery("SELECT * FROM employees")) {
-      while (rs.next()) {
-        System.out.println(rs.getString("first_name"));
-      }
+        final Statement statement = conn.createStatement();
+        final ResultSet rs = statement.executeQuery("SELECT * FROM employees")) {
+      System.out.println(Util.getResult(rs));
     }
   }
 }

examples/AWSDriverExample/src/main/java/software/amazon/Util.java

@@ -0,0 +1,34 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ * 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,
+ * 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.
+ */
+
+package software.amazon;
+
+import java.sql.ResultSet;
+import java.sql.SQLException;
+
+public class Util {
+  static String getResult(final ResultSet result) throws SQLException {
+    int cols = result.getMetaData().getColumnCount();
+    StringBuilder builder = new StringBuilder();
+    while (result.next()) {
+      for (int i = 1; i <= cols; i++) {
+        builder.append(result.getString(i)).append(" ");
+      }
+      builder.append("\n");
+    }
+    return builder.toString();
+  }
+}

examples/HibernateExample/gradle.properties

@@ -12,5 +12,5 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-# Do not publish the Jar file for the benchmarks subproject
+# Do not publish the Jar file for this subproject
 nexus.publish=false

examples/HikariExample/build.gradle.kts

@@ -0,0 +1,21 @@
+/*
+ * 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.
+ * You may obtain a copy of the License at
+ *
+ * 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,
+ * 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.
+ */
+
+dependencies {
+    implementation("org.postgresql:postgresql:42.5.0")
+    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:1.0.0")
+    implementation("com.zaxxer:HikariCP:4.0.3")
+}

examples/HikariExample/gradle.properties

@@ -0,0 +1,16 @@
+#    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.
+#    You may obtain a copy of the License at
+#
+#    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,
+#    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.
+
+# Do not publish the Jar file for this subproject
+nexus.publish=false