Merge pull request #489 from Azure/release/8.5.0

merging proxy support to legacy dev

Author: rickle-msft

ChangeLog.txt

@@ -1,3 +1,7 @@
+2019.08.15 Version 8.5.0
+ * Support for HTTP proxy with Basic auth.
+ * Support for HTTP proxy with Digest auth.
+
 2019.08.05 Version 8.4.0
  * Support for 2019-02-02 REST version. Please see our REST API documentation and blogs for information about the related added features.
  * Added support for setting rehydrate priority for SetBlobTier and CopyBlob APIs.

README.md

@@ -39,7 +39,7 @@ To get the binaries of this library as distributed by Microsoft, ready for use w
 <dependency>
 	<groupId>com.microsoft.azure</groupId>
 	<artifactId>azure-storage</artifactId>
-	<version>8.4.0</version>
+	<version>8.5.0</version>
 </dependency>
 ```
 

microsoft-azure-storage-samples/pom.xml

@@ -26,7 +26,7 @@
 		<dependency>
 			<groupId>com.microsoft.azure</groupId>
 			<artifactId>azure-storage</artifactId>
-			<version>8.4.0</version>
+			<version>8.5.0-preview</version>
 		</dependency>
 		<dependency>
 			<groupId>com.microsoft.azure</groupId>

microsoft-azure-storage-samples/src/com/microsoft/azure/storage/logging/pom.xml

@@ -26,7 +26,7 @@
         <dependency>
             <groupId>com.microsoft.azure</groupId>
             <artifactId>azure-storage</artifactId>
-            <version>8.4.0</version>
+            <version>8.5.0-preview</version>
         </dependency>
         <dependency>
             <groupId>com.microsoft.azure</groupId>

microsoft-azure-storage/src/com/microsoft/azure/storage/Constants.java

@@ -765,7 +765,7 @@ public static class HeaderConstants {
         /**
          * Specifies the value to use for UserAgent header.
          */
-        public static final String USER_AGENT_VERSION = "8.4.0";
+        public static final String USER_AGENT_VERSION = "8.5.0-preview";
 
         /**
          * The default type for content-type and accept

microsoft-azure-storage/src/com/microsoft/azure/storage/OperationContext.java

@@ -45,11 +45,31 @@ public final class OperationContext {
      */
     private static Proxy proxyDefault;
 
+    /**
+     * Represents a username to be used by default for a proxy when making a request.
+     */
+    private static String proxyDefaultUsername = null;
+
+    /**
+     * Represents a password to be used by default for a proxy when making a request.
+     */
+    private static String proxyDefaultPassword = null;
+
     /**
      * Represents a proxy to be used when making a request.
      */
     private Proxy proxy;
 
+    /**
+     * Represents a username for a proxy when making a request.
+     */
+    private String proxyUsername = null;
+
+    /**
+     * Represents a password for a proxy when making a request.
+     */
+    private String proxyPassword = null;
+
     /**
      * Represents the operation latency, in milliseconds, from the client's perspective. This may include any potential
      * retries.
@@ -241,6 +261,26 @@ public Proxy getProxy() {
         return this.proxy;
     }
 
+    /**
+     * Gets a username for the authenticated proxy which will be used when making a request.
+     * Default is <code>null</code>. To set a username use {@link #setProxyUsername(String)}
+     *
+     * @return A {@link String} to use when making a request.
+     */
+    public String getProxyUsername() {
+        return proxyUsername != null ? proxyUsername : getDefaultProxyUsername();
+    }
+
+    /**
+     * Gets the password for the authenticated proxy which will be used when making a request.
+     * Default is <code>null</code>. To set a password to use {@link #setProxyPassword(String)}
+     *
+     * @return A {@link String} to use when making a request.
+     */
+    public String getProxyPassword() {
+        return proxyPassword != null ? proxyPassword : getDefaultProxyPassword();
+    }
+
     /**
      * Gets any additional headers for the request, for example, for proxy or logging information.
      * 
@@ -446,6 +486,28 @@ public void setProxy(Proxy proxy) {
         this.proxy = proxy;
     }
 
+    /**
+     * Sets a username for an authenticated proxy which will be used when making a request.
+     * Default is <code>null</code>.
+     *
+     * @param username
+     *            A {@link java.lang.String} to use when making a request.
+     */
+    public void setProxyUsername(final String username) {
+        this.proxyUsername = username;
+    }
+
+    /**
+     * Sets a password for an authenticated proxy which will be used when making a request.
+     * Default is <code>null</code>.
+     *
+     * @param password
+     *            A {@link java.lang.String} to use when making a request.
+     */
+    public void setProxyPassword(final String password) {
+        this.proxyPassword = password;
+    }
+
     /**
      * Sets any additional headers for the request, for example, for proxy or logging information.
      * 
@@ -619,4 +681,46 @@ public static Proxy getDefaultProxy() {
     public static void setDefaultProxy(Proxy defaultProxy) {
         OperationContext.proxyDefault = defaultProxy;
     }
+
+    /**
+     * Gets a default username for the authenticated proxy which will be used when making a request.
+     * Default is <code>null</code>. To set a username use {@link #setDefaultProxyUsername(String)}
+     *
+     * @return A {@link String} to use when making a request.
+     */
+    public static String getDefaultProxyUsername() {
+        return OperationContext.proxyDefaultUsername;
+    }
+
+    /**
+     * Gets the default password for the authenticated proxy which will be used when making a request.
+     * Default is <code>null</code>. To set a password to use {@link #setProxyPassword(String)}
+     *
+     * @return A {@link String} to use when making a request.
+     */
+    public static String getDefaultProxyPassword() {
+        return OperationContext.proxyDefaultPassword;
+    }
+
+    /**
+     * Sets a default username for an authenticated proxy which will be used when making a request.
+     * Default is <code>null</code>.
+     *
+     * @param username
+     *            A {@link java.lang.String} to use when making a request.
+     */
+    public static void setDefaultProxyUsername(final String username) {
+        OperationContext.proxyDefaultUsername = username;
+    }
+
+    /**
+     * Sets a default password for an authenticated proxy which will be used when making a request.
+     * Default is <code>null</code>.
+     *
+     * @param password
+     *            A {@link java.lang.String} to use when making a request.
+     */
+    public static void setDefaultProxyPassword(final String password) {
+        OperationContext.proxyDefaultPassword = password;
+    }
 }

microsoft-azure-storage/src/com/microsoft/azure/storage/core/BaseRequest.java

@@ -16,11 +16,13 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
+import java.net.Authenticator;
 import java.net.HttpURLConnection;
 import java.net.Proxy;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.net.PasswordAuthentication;
 import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.Map;
@@ -186,14 +188,36 @@ public static HttpURLConnection createURLConnection(final URI uri, final Request
 
         // Get the proxy settings
         Proxy proxy = OperationContext.getDefaultProxy();
+        String username = OperationContext.getDefaultProxyUsername();
+        String password = OperationContext.getDefaultProxyPassword();
         if (opContext != null && opContext.getProxy() != null) {
             proxy = opContext.getProxy();
+            if (opContext.getProxyUsername() != null) {
+                username = opContext.getProxyUsername();
+            }
+            if (opContext.getProxyPassword() != null) {
+                password = opContext.getProxyPassword();
+            }
         }
 
         // Set up connection, optionally with proxy settings
         final HttpURLConnection retConnection;
         if (proxy != null) {
             retConnection = (HttpURLConnection) resourceUrl.openConnection(proxy);
+            if (username != null && password != null) {
+                String authString = "Basic " + Utility.safeEncode(username + ":" + password);
+                final String authUsername = username;
+                final String authPassword = password;
+                retConnection.setRequestProperty("Proxy-Authorization", authString);
+                Authenticator.setDefault(new Authenticator() {
+                    @Override
+                    protected PasswordAuthentication getPasswordAuthentication() {
+                        PasswordAuthentication passwordAuthentication =
+                                new PasswordAuthentication (authUsername, authPassword.toCharArray());
+                        return passwordAuthentication;
+                    }
+                });
+            }
         }
         else {
             retConnection = (HttpURLConnection) resourceUrl.openConnection();

pom.xml

@@ -10,7 +10,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>com.microsoft.azure</groupId>
 	<artifactId>azure-storage</artifactId>
-	<version>8.4.0</version>
+	<version>8.5.0-preview</version>
 	<packaging>jar</packaging>
 
 	<name>Microsoft Azure Storage Client SDK</name>