Add User-Agent header to HTTP requests (#24)

nightfallai · Nov 18, 2021 · 07051ed · 07051ed
1 parent 892ccbe
commit 07051ed
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>ai.nightfall</groupId>
     <artifactId>scan-api</artifactId>
-    <version>1.0.1</version>
+    <version>1.0.2</version>
 
     <name>${project.groupId}:${project.artifactId}</name>
     <description>The Nightfall Scanner provides Java bindings for our developer platform, which allows clients
@@ -93,6 +93,18 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <version>3.2.0</version>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
+                        </manifest>
+                    </archive>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>

diff --git a/src/main/java/ai/nightfall/scan/NightfallClient.java b/src/main/java/ai/nightfall/scan/NightfallClient.java
@@ -46,6 +46,7 @@ public class NightfallClient implements Closeable {
     private static final long wakeupDurationMillis = Duration.ofSeconds(15).toMillis();
     private static final int DEFAULT_RETRY_COUNT = 5;
     private static final String API_HOST = "https://api.nightfall.ai";
+    private final String implVersion = loadImplVersion();
 
     private final String apiHost;
     private final String apiKey;
@@ -64,6 +65,14 @@ public class NightfallClient implements Closeable {
         this.httpClient = httpClient;
     }
 
+    private String loadImplVersion() {
+        Package pkg = this.getClass().getPackage();
+        if (pkg == null) {
+            return "";
+        }
+        return pkg.getImplementationVersion();
+    }
+
     /**
      * Closes this client and releases underlying system resources.
      */
@@ -357,6 +366,10 @@ private <E> E issueRequest(
         if (headers != null) {
             builder.headers(headers);
         }
+        if (this.implVersion != null && !this.implVersion.equals("")) {
+            builder.addHeader("User-Agent", "nightfall-java-sdk/" + this.implVersion);
+        }
+
         builder.addHeader("Authorization", "Bearer " + this.apiKey);
 
         RequestBody reqBody = null;