Fix for AsyncHttpClient#58 (Change default user-agent value to AsyncHttpClient).

Author: rlubke

api/src/main/java/com/ning/http/client/AsyncHttpClientConfig.java

@@ -24,10 +24,13 @@
 import javax.net.ssl.HostnameVerifier;
 import javax.net.ssl.SSLContext;
 import javax.net.ssl.SSLEngine;
+import java.io.IOException;
+import java.io.InputStream;
 import java.security.GeneralSecurityException;
 import java.util.Collections;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.Properties;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
@@ -52,6 +55,27 @@
 public class AsyncHttpClientConfig {
 
     protected final static String ASYNC_CLIENT = AsyncHttpClientConfig.class.getName() + ".";
+    public final static String AHC_VERSION;
+
+    static {
+        InputStream is = null;
+        Properties prop = new Properties();
+        try {
+            is = AsyncHttpClientConfig.class.getResourceAsStream("version.properties");
+            prop.load(is);
+        } catch (IOException e) {
+            e.printStackTrace();
+        } finally {
+            if (is != null) {
+                try {
+                    is.close();
+                } catch (IOException ignored) {
+
+                }
+            }
+        }
+        AHC_VERSION = prop.getProperty("ahc.version", "UNKNOWN");
+    }
 
     protected int maxTotalConnections;
     protected int maxConnectionPerHost;
@@ -490,7 +514,7 @@ public static class Builder {
         private boolean redirectEnabled = Boolean.getBoolean(ASYNC_CLIENT + "defaultRedirectsEnabled");
         private int maxDefaultRedirects = Integer.getInteger(ASYNC_CLIENT + "defaultMaxRedirects", 5);
         private boolean compressionEnabled = Boolean.getBoolean(ASYNC_CLIENT + "compressionEnabled");
-        private String userAgent = System.getProperty(ASYNC_CLIENT + "userAgent", "NING/1.0");
+        private String userAgent = System.getProperty(ASYNC_CLIENT + "userAgent", "AsyncHttpClient/" + AHC_VERSION);
         private boolean useProxyProperties = Boolean.getBoolean(ASYNC_CLIENT + "useProxyProperties");
         private boolean allowPoolingConnection = true;
         private ScheduledExecutorService reaper = Executors.newScheduledThreadPool(Runtime.getRuntime().availableProcessors(), new ThreadFactory() {

api/src/main/java/com/ning/http/client/AsyncHttpClientConfigBean.java

@@ -53,7 +53,7 @@ void configureDefaults() {
         redirectEnabled = Boolean.getBoolean(ASYNC_CLIENT + "defaultRedirectsEnabled");
         maxDefaultRedirects = Integer.getInteger(ASYNC_CLIENT + "defaultMaxRedirects", 5);
         compressionEnabled = Boolean.getBoolean(ASYNC_CLIENT + "compressionEnabled");
-        userAgent = System.getProperty(ASYNC_CLIENT + "userAgent", "NING/1.0");
+        userAgent = System.getProperty(ASYNC_CLIENT + "userAgent", "AsyncHttpClient/" + AHC_VERSION);
 
         boolean useProxyProperties = Boolean.getBoolean(ASYNC_CLIENT + "useProxyProperties");
         if (useProxyProperties) {

api/src/main/java/com/ning/http/client/providers/jdk/JDKAsyncHttpProvider.java

@@ -547,7 +547,9 @@ private void configure(URI uri, HttpURLConnection urlConnection, Request request
             } else if (config.getUserAgent() != null) {
                 urlConnection.setRequestProperty("User-Agent", config.getUserAgent());
             } else {
-                urlConnection.setRequestProperty("User-Agent", AsyncHttpProviderUtils.constructUserAgent(JDKAsyncHttpProvider.class));
+                urlConnection.setRequestProperty("User-Agent",
+                        AsyncHttpProviderUtils.constructUserAgent(JDKAsyncHttpProvider.class,
+                                                                  config));
             }
 
             if (request.getCookies() != null && !request.getCookies().isEmpty()) {

api/src/main/java/com/ning/http/client/version.properties

@@ -0,0 +1 @@
+ahc.version=${pom.version}

api/src/main/java/com/ning/http/util/AsyncHttpProviderUtils.java

@@ -12,6 +12,7 @@
  */
 package com.ning.http.util;
 
+import com.ning.http.client.AsyncHttpClientConfig;
 import com.ning.http.client.AsyncHttpProvider;
 import com.ning.http.client.ByteArrayPart;
 import com.ning.http.client.Cookie;
@@ -466,10 +467,11 @@ private static void add(StringBuilder sb, String name, int val) {
         sb.append((char) SEMICOLON);
     }
 
-    public static String constructUserAgent(Class<? extends AsyncHttpProvider> httpProvider) {
-        StringBuffer b = new StringBuffer("AsyncHttpClient/1.0")
-                .append(" ")
-                .append("(")
+    public static String constructUserAgent(Class<? extends AsyncHttpProvider> httpProvider,
+                                            AsyncHttpClientConfig config) {
+        return new StringBuffer(config.getUserAgent())
+                .append(' ')
+                .append('(')
                 .append(httpProvider.getSimpleName())
                 .append(" - ")
                 .append(System.getProperty("os.name"))
@@ -479,8 +481,7 @@ public static String constructUserAgent(Class<? extends AsyncHttpProvider> httpP
                 .append(System.getProperty("java.version"))
                 .append(" - ")
                 .append(Runtime.getRuntime().availableProcessors())
-                .append(" core(s))");
-        return b.toString();
+                .append(" core(s))").toString();
     }
 
     public static String parseCharset(String contentType) {

pom.xml

@@ -89,6 +89,15 @@
         </license>
     </licenses>
     <build>
+        <resources>
+            <resource>
+                <filtering>true</filtering>
+                <directory>src/main/java/</directory>
+                <excludes>
+                    <exclude>**/*.java</exclude>
+                </excludes>
+            </resource>
+        </resources>
         <extensions>
             <!-- Enabling the use of SSH -->
             <extension>
@@ -571,8 +580,8 @@
         </distMgmtSnapshotsUrl>
         <surefire.redirectTestOutputToFile>true
         </surefire.redirectTestOutputToFile>
-        <source.property>1.5</source.property>
-        <target.property>1.5</target.property>
+        <source.property>1.6</source.property>
+        <target.property>1.6</target.property>
         <surefire.version>2.12</surefire.version>
     </properties>
 </project>

providers/apache/src/main/java/com/ning/http/client/providers/apache/ApacheAsyncHttpProvider.java

@@ -377,7 +377,7 @@ private HttpMethodBase createMethod(HttpClient client, Request request) throws I
         } else if (config.getUserAgent() != null) {
             method.setRequestHeader("User-Agent", config.getUserAgent());
         } else {
-            method.setRequestHeader("User-Agent", AsyncHttpProviderUtils.constructUserAgent(ApacheAsyncHttpProvider.class));
+            method.setRequestHeader("User-Agent", AsyncHttpProviderUtils.constructUserAgent(ApacheAsyncHttpProvider.class, config));
         }
 
         if (config.isCompressionEnabled()) {

providers/netty/src/main/java/com/ning/http/client/providers/netty/NettyAsyncHttpProvider.java

@@ -715,7 +715,9 @@ private static HttpRequest construct(AsyncHttpClientConfig config,
         } else if (config.getUserAgent() != null) {
             nettyRequest.setHeader("User-Agent", config.getUserAgent());
         } else {
-            nettyRequest.setHeader("User-Agent", AsyncHttpProviderUtils.constructUserAgent(NettyAsyncHttpProvider.class));
+            nettyRequest.setHeader("User-Agent",
+                         AsyncHttpProviderUtils.constructUserAgent(NettyAsyncHttpProvider.class,
+                                                                   config));
         }
 
         if (!m.equals(HttpMethod.CONNECT)) {