Release v1.0.10 (#87)

* Bump version numbers.
* Update README.

Author: kurtisvg

README.md

@@ -2,93 +2,120 @@
 Status](https://travis-ci.org/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/cloud-sql-jdbc-socket-factory)
 ## Cloud SQL Socket Factory for JDBC drivers
 
-The Cloud SQL Socket Factory is a library for the MySQL/Postgres JDBC drivers
-that allows a user with the appropriate permissions to connect to a Cloud SQL
-database without having to deal with IP whitelisting or SSL certificates
-manually.
+The Cloud SQL Socket Factory is a library for the MySQL/Postgres JDBC drivers that allows a user 
+with the appropriate permissions to connect to a Cloud SQL database without having to deal with IP 
+whitelisting or SSL certificates manually.
 
 ## Instructions
 
-The library is [available in Maven Central](http://search.maven.org/#artifactdetails%7Ccom.google.cloud.sql%7Cmysql-socket-factory%7C1.0.4%7Cjar).
+This library is available 
 
-Add a dependency using your favorite build tool. Maven and Gradle examples are shown below.
+[Maven Central](http://search.maven.org/#artifactdetails%7Ccom.google.cloud.sql%7Cmysql-socket-factory%7C1.0.4%7Cjar).
 
 
-### MySQL
+### Authentication
 
-**Note**: If you wish to use the 6.x (development) version of the MySQL driver, use the artifact id
-'mysql-socket-factory-connector-j-6'.
+This library uses the [Application Default Credentials](
+https://developers.google.com/identity/protocols/application-default-credentials) to authenticate
+the connection to the Cloud SQL server. For more details, see the previously mentioned link.
 
-#### Adding dependency (Maven)
+To activate credentials locally, use the following [gcloud](https://cloud.google.com/sdk/gcloud/) 
+command: 
+```bash
+gcloud auth application-default login
+```
+
+### Add library as a dependency
+
+#### MySQL
+
+**Note**: Use the correct version to match your JDBC driver:
+
+| JDBC Driver Version        | Cloud SQL Socket Factory Version         |
+| -------------------------- | ---------------------------------------- |
+| mysql-connector-java:8.x   | mysql-socket-factory-connector-j8:1.0.10 |
+| mysql-connector-java:6.x   | mysql-socket-factory-connector-j6:1.0.10 |
+| mysql-connector-java:5.1.x | mysql-socket-factory:1.0.10              |
 
+
+##### Maven
+Include the following in the project's `pom.xml`:
 ```maven-pom
 <dependency>
     <groupId>com.google.cloud.sql</groupId>
-    <artifactId>mysql-socket-factory</artifactId>
-    <version>1.0.9</version>
+    <artifactId>mysql-socket-factory-connector-j8</artifactId>
+    <version>1.0.10</version>
 </dependency>
 ```
 
-#### Adding dependency (Gradle)
-
+#### Gradle
+Include the following the project's `gradle.build`
 ```gradle
-compile 'com.google.cloud.sql:mysql-socket-factory:1.0.9'
+compile 'com.google.cloud.sql:mysql-socket-factory:1.0.10'
 ```
 
-#### Using
-
-When specifying the JDBC connection URL, add two additional parameters:
-
-| Property         | Value         |
-| ---------------- | ------------- |
-| socketFactory    | com.google.cloud.sql.mysql.SocketFactory |
-| cloudSqlInstance | The instance connection name (which is found on the instance details page in Google Developers Console)  |
-
-For example, if the instance connection name is `foo:bar:baz`, the JDBC URL
-would be
-`jdbc:mysql://google/mydb?socketFactory=com.google.cloud.sql.mysql.SocketFactory&cloudSqlInstance=foo:bar:baz`
-
-A tool is available in `examples/getting-started` that can help generate the JDBC URL and verify that connectivity can be established.
-
-### PostgreSQL
-
-#### Adding dependency (Maven)
+#### PostgreSQL
 
+##### Maven
+Include the following in the project's `pom.xml`:
 ```maven-pom
 <dependency>
     <groupId>com.google.cloud.sql</groupId>
-    <artifactId>postgres-socket-factory</artifactId>
-    <version>1.0.9</version>
+    <artifactId>mysql-socket-factory</artifactId>
+    <version>1.0.1o</version>
 </dependency>
 ```
 
-#### Adding dependency (Gradle)
-
+#### Gradle
+Include the following the project's `gradle.build`
 ```gradle
-compile 'com.google.cloud.sql:postgres-socket-factory:1.0.9'
+compile 'com.google.cloud.sql:mysql-socket-factory:1.0.10'
 ```
 
-#### Using
 
-When specifying the JDBC connection URL, add two additional parameters:
+#### Creating the JDBC URL
+
+##### MySQL
+
+Base JDBC url: `jdbc:mysql://google/<DATABASE_NAME>`
+
+When specifying the JDBC connection URL, add the additional parameters:
 
 | Property         | Value         |
 | ---------------- | ------------- |
 | socketFactory    | com.google.cloud.sql.postgres.SocketFactory |
-| socketFactoryArg | The instance connection name (which is found on the instance details page in Google Developers Console)  |
+| socketFactoryArg | The instance connection name (found on the instance details) |
+| useSSL           | False |
+| user             | MySQL username |
+| password         | MySQL user's password |
+
+The full JDBC url should look like this:
+```
+jdbc:mysql://google/<DATABASE_NAME>?cloudSqlInstance=<INSTANCE_CONNECTION_NAME>&socketFactory=com.google.cloud.sql.mysql.SocketFactory&useSSL=false&user=<MYSQL_USER_NAME>&password=<MYSQL_USER_PASSWORD>
+```
 
-For example, if the instance connection name is `foo:bar:baz`, the JDBC URL
-would be
-`jdbc:postgresql://google/mydb?socketFactory=com.google.cloud.sql.postgres.SocketFactory&socketFactoryArg=foo:bar:baz`
+##### Postgres
 
-A tool is available in `examples/getting-started` that can help generate the JDBC URL and verify that connectivity can be established.
+Base JDBC url: `jdbc:mysql://google/<DATABASE_NAME>`
 
-## Credentials
+When specifying the JDBC connection URL, add the additional parameters:
+
+| Property         | Value         |
+| ---------------- | ------------- |
+| socketFactory    | com.google.cloud.sql.postgres.SocketFactory |
+| socketFactoryArg | The instance connection name (which is found on the instance details page in Google Developers Console)  |
+| user             | Postgres username |
+| password         | Postgres user's password |
+
+The full JDBC url should look like this:
+```
+jdbc:postgresql://google/<DATABASE_NAME>?useSSL=false&socketFactoryArg=<INSTANCE_CONNECTION_NAME>&socketFactory=com.google.cloud.sql.postgres.SocketFactory&user=<POSTGRESQL_USER_NAME>&password=<POSTGRESQL_USER_PASSWORD>
+```
 
-The library needs to obtain credentials in order to retrieve SSL certificates that are used to connect to the instance.
-[Application Default Credentials](https://developers.google.com/identity/protocols/application-default-credentials) are used for this purpose.
+## Connecting via Unix Sockets
 
-On Google Compute Engine and Google App Engine, the VM/application service account is used.
+The library will automatically detect when it is running on GAE Standard, and will connect via the 
+ provided unix socket for reduced latency.
 
-For local development, application default credentials written by gcloud are used, if present.
-You must run `gcloud auth application-default login` once for the credentials to become available to the library.
+To force the library to connect to a unix socket (created by the Cloud SQL proxy) when running 
+outside of GAE-Standard, set the environment variable `CLOUD_SQL_FORCE_UNIX_SOCKET` to any value.

connector-j-5/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.google.cloud.sql</groupId>
         <artifactId>jdbc-socket-factory-parent</artifactId>
-        <version>1.0.10-SNAPSHOT</version>
+        <version>1.0.10</version>
     </parent>
     <artifactId>mysql-socket-factory</artifactId>
     <packaging>jar</packaging>
@@ -21,13 +21,13 @@
         <dependency>
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
-            <version>5.1.45</version>
+            <version>5.1.46</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>com.google.cloud.sql</groupId>
             <artifactId>jdbc-socket-factory-core</artifactId>
-            <version>1.0.9</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>com.github.jnr</groupId>

connector-j-6/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.google.cloud.sql</groupId>
         <artifactId>jdbc-socket-factory-parent</artifactId>
-        <version>1.0.10-SNAPSHOT</version>
+        <version>1.0.10</version>
     </parent>
     <artifactId>mysql-socket-factory-connector-j-6</artifactId>
     <packaging>jar</packaging>
@@ -22,11 +22,12 @@
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
             <version>6.0.6</version>
+            <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>com.google.cloud.sql</groupId>
             <artifactId>jdbc-socket-factory-core</artifactId>
-            <version>1.0.9</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>org.eclipse.jetty</groupId>

connector-j-8/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.google.cloud.sql</groupId>
         <artifactId>jdbc-socket-factory-parent</artifactId>
-        <version>1.0.10-SNAPSHOT</version>
+        <version>1.0.10</version>
     </parent>
     <artifactId>mysql-socket-factory-connector-j-8</artifactId>
     <packaging>jar</packaging>
@@ -22,11 +22,12 @@
             <groupId>mysql</groupId>
             <artifactId>mysql-connector-java</artifactId>
             <version>8.0.11</version>
+            <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>com.google.cloud.sql</groupId>
             <artifactId>jdbc-socket-factory-core</artifactId>
-            <version>1.0.8</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>org.eclipse.jetty</groupId>

core/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.google.cloud.sql</groupId>
         <artifactId>jdbc-socket-factory-parent</artifactId>
-        <version>1.0.10-SNAPSHOT</version>
+        <version>1.0.10</version>
     </parent>
     <artifactId>jdbc-socket-factory-core</artifactId>
     <packaging>jar</packaging>

pom.xml

@@ -5,7 +5,7 @@
     <groupId>com.google.cloud.sql</groupId>
     <artifactId>jdbc-socket-factory-parent</artifactId>
     <packaging>pom</packaging>
-    <version>1.0.10-SNAPSHOT</version>
+    <version>1.0.10</version>
 
     <name>Cloud SQL JDBC Socket Factory</name>
     <description>
@@ -65,8 +65,8 @@
                 <configuration>
                     <compilerId>javac-with-errorprone</compilerId>
                     <forceJavacCompilerUse>true</forceJavacCompilerUse>
-                    <source>1.7</source>
-                    <target>1.7</target>
+                    <source>1.8</source>
+                    <target>1.8</target>
                 </configuration>
                 <dependencies>
                     <dependency>

postgres/pom.xml

@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.google.cloud.sql</groupId>
         <artifactId>jdbc-socket-factory-parent</artifactId>
-        <version>1.0.10-SNAPSHOT</version>
+        <version>1.0.10</version>
         <relativePath>..</relativePath>
     </parent>
 
@@ -23,7 +23,7 @@
         <dependency>
             <groupId>com.google.cloud.sql</groupId>
             <artifactId>jdbc-socket-factory-core</artifactId>
-            <version>1.0.10-SNAPSHOT</version>
+            <version>1.0.10</version>
         </dependency>
         <dependency>
             <groupId>com.github.jnr</groupId>