localSocketAddress implementation

src/main/java/com/microsoft/sqlserver/jdbc/IOBuffer.java

@@ -2890,6 +2890,17 @@ private Socket getConnectedSocket(InetSocketAddress addr, int timeoutInMilliSeco
         if (addr.isUnresolved())
             throw new java.net.UnknownHostException();
         selectedSocket = getSocketFactory().createSocket();
+
+        String localSocketAddress = this.conn.activeConnectionProperties.getProperty(SQLServerDriverStringProperty.LOCAL_SOCKET_ADDRESS.toString());
+
+        if (null != localSocketAddress && !localSocketAddress.isEmpty()) {
+            selectedSocket.bind(new InetSocketAddress(InetAddress.getByName(localSocketAddress), 0));
+
+            if (logger.isLoggable(Level.FINER)) {
+                logger.finer(this.toString() + " binding socket to: " + localSocketAddress);
+            }
+        }
+
         if (!selectedSocket.isConnected()) {
             selectedSocket.connect(addr, timeoutInMilliSeconds);
         }

src/main/java/com/microsoft/sqlserver/jdbc/ISQLServerDataSource.java

@@ -1283,4 +1283,18 @@ public interface ISQLServerDataSource extends javax.sql.CommonDataSource {
      * @param accessTokenCallbackClass
      */
     void setAccessTokenCallbackClass(String accessTokenCallbackClass);
+
+    /**
+     * Returns the specified address to explicitly to use on the client side for TCP/IP when connecting.
+     *
+     * @return localSocketAddress
+     */
+    String getLocalSocketAddress();
+
+    /**
+     * Sets the address to explicitly use on the client side for TCP/IP when connecting.
+     *
+     * @param localSocketAddress
+     */
+    void setLocalSocketAddress(String localSocketAddress);
 }

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerDataSource.java

@@ -249,6 +249,16 @@ public String getAccessToken() {
         return getStringProperty(connectionProps, SQLServerDriverStringProperty.ACCESS_TOKEN.toString(), null);
     }
 
+    @Override
+    public void setLocalSocketAddress(String localSocketAddress) {
+        setStringProperty(connectionProps, SQLServerDriverStringProperty.LOCAL_SOCKET_ADDRESS.toString(), localSocketAddress);
+    }
+
+    @Override
+    public String getLocalSocketAddress() {
+        return getStringProperty(connectionProps, SQLServerDriverStringProperty.LOCAL_SOCKET_ADDRESS.toString(), null);
+    }
+
     /**
      * Sets the Column Encryption setting. If lastUpdateCount is set to true, the driver will return only the last
      * update count from all the update counts returned by a batch. The default of false will return all update counts.

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerDriver.java

@@ -610,7 +610,8 @@ enum SQLServerDriverStringProperty {
     ENCRYPT("encrypt", EncryptOption.TRUE.toString()),
     SERVER_CERTIFICATE("serverCertificate", ""),
     DATETIME_DATATYPE("datetimeParameterType", DatetimeType.DATETIME2.toString()),
-    ACCESS_TOKEN_CALLBACK_CLASS("accessTokenCallbackClass", "");
+    ACCESS_TOKEN_CALLBACK_CLASS("accessTokenCallbackClass", ""),
+    LOCAL_SOCKET_ADDRESS("localSocketAddress", "");
 
     private final String name;
     private final String defaultValue;
@@ -931,6 +932,8 @@ public final class SQLServerDriver implements java.sql.Driver {
                     SQLServerDriverStringProperty.AAD_SECURE_PRINCIPAL_SECRET.getDefaultValue(), false, null),
             new SQLServerDriverPropertyInfo(SQLServerDriverStringProperty.MAX_RESULT_BUFFER.toString(),
                     SQLServerDriverStringProperty.MAX_RESULT_BUFFER.getDefaultValue(), false, null),
+            new SQLServerDriverPropertyInfo(SQLServerDriverStringProperty.LOCAL_SOCKET_ADDRESS.toString(),
+                    SQLServerDriverStringProperty.LOCAL_SOCKET_ADDRESS.getDefaultValue(), false, null),
             new SQLServerDriverPropertyInfo(SQLServerDriverIntProperty.CONNECT_RETRY_COUNT.toString(),
                     Integer.toString(SQLServerDriverIntProperty.CONNECT_RETRY_COUNT.getDefaultValue()), false, null),
             new SQLServerDriverPropertyInfo(SQLServerDriverIntProperty.CONNECT_RETRY_INTERVAL.toString(),

src/main/java/com/microsoft/sqlserver/jdbc/SQLServerResource.java

@@ -242,6 +242,7 @@ protected Object[][] getContents() {
         {"R_AADSecurePrincipalSecretPropertyDescription", "A Secret defined for a registered application which has been granted permission to the database connected."},
         {"R_accessTokenCallbackClassPropertyDescription", "The class to instantiate as the SQLServerAccessTokenCallback for acquiring tokens."},
         {"R_accessTokenCallbackPropertyDescription", "A SQLServerAccessTokenCallback object which is used to call a callback method to return an access token."},
+        {"R_localSocketAddressPropertyDescription", "A specified IPv4, IPv6 or DNS name to explicitly configure on the client side of TCP/IP when connecting."},
         {"R_noParserSupport", "An error occurred while instantiating the required parser. Error: \"{0}\""},
         {"R_writeOnlyXML", "Cannot read from this SQLXML instance. This instance is for writing data only."},
         {"R_dataHasBeenReadXML", "Cannot read from this SQLXML instance. The data has already been read."},

src/test/java/com/microsoft/sqlserver/jdbc/SQLServerConnectionTest.java

@@ -170,6 +170,9 @@ public void testDataSource() throws SQLServerException {
         ds.setTrustStorePassword(stringPropValue);
         assertEquals(stringPropValue, ds.getTrustStorePassword(), TestResource.getResource("R_valuesAreDifferent"));
 
+        ds.setLocalSocketAddress(stringPropValue);
+        assertEquals(stringPropValue, ds.getLocalSocketAddress(), TestResource.getResource("R_valuesAreDifferent"));
+
         // verify encrypt=true options
         ds.setEncrypt(EncryptOption.MANDATORY.toString());
         assertEquals("True", EncryptOption.valueOfString(ds.getEncrypt()).toString(),