Merge pull request #183 from splunk/master

PR from Master to Develop for v1.8.0

Author: fantavlik

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Splunk Enterprise SDK for Java Changelog
 
+## Version 1.8.0
+
+### New Features and APIs
+* Added a support to add custom headers in Service class. (Github PR [#176](https://github.com/splunk/splunk-sdk-java/pull/176)).
+* SSL Certificate validation (default implementation) added. (Github PR [#175](https://github.com/splunk/splunk-sdk-java/pull/175)).
+  * Boolean flag is introduced to skip/validate certificate. Use _HttpService.setValidateCertificates()_ to enable/disable certificate validation.
+  * Breaking change: Certificate validation is now enforced by default, for local or non-production use cases use _HttpService.setValidateCertificates(false)_.
+* Apps/app-install replaced with **apps/local**. (Github PR [#168](https://github.com/splunk/splunk-sdk-java/pull/168))
+* Breaking change: HttpService.useTLS flag removed, please use _HttpService.setSslSecurityProtocol()_ to set a specific SSL/TLS implementation or else TLS v1.2 is used by default for Java 1.8.
+
+### Minor Changes
+
+* External Entities restricted in XML factory. (Github PR [#180](https://github.com/splunk/splunk-sdk-java/pull/180)).
+  * Prevent expansion of external entities in Document Builder factory.
+* Headers modified in Socket creation. (Github PR [#179](https://github.com/splunk/splunk-sdk-java/pull/179)).
+  * Http Request uses raw request headers by including escape characters which seems vulnerable. It was replaced with PrintWriter methods to avoid escape characters.
+  * Host parameter used in Socket is omitted to prevent exposing it to external users.
+* README.md file modified with all login methods along with Splunk Search creation example. (Github PR [#177](https://github.com/splunk/splunk-sdk-java/pull/177)).
+* Deploy plugin is removed from Splunk module pom to avoid redundancy. (Github PR [#172](https://github.com/splunk/splunk-sdk-java/pull/172)).
+* Setter methods for Session and Bearer token added along with test case. (Github PR [#171](https://github.com/splunk/splunk-sdk-java/pull/171))
+  * **Use:** service.setSplunkToken() for session tokens and service.setBearerToken() for long-lived tokens.
+* Modular input folder name renamed based on newer splunk folder name validation. (Github PR [#168](https://github.com/splunk/splunk-sdk-java/pull/168))
+* SDK app collection URL has been updated to v1.1.0 in docker compose file. (Github PR [#168](https://github.com/splunk/splunk-sdk-java/pull/168))
+  * Test files in sdk app collections are modified based on python v3 syntax.
+* Added Saved Search test case based on title. (Github PR [#166](https://github.com/splunk/splunk-sdk-java/pull/166))
+
 ## Version 1.7.1
 
 ### Minor Changes

README.md

@@ -1,7 +1,7 @@
-![Build Status](https://github.com/splunk/splunk-sdk-java/actions/workflows/release.yml/badge.svg?branch=master)
+[![Java SDK Test](https://github.com/splunk/splunk-sdk-java/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/splunk/splunk-sdk-java/actions/workflows/test.yml)
 # The Splunk Software Development Kit for Java
 
-#### Version 1.7.1
+#### Version 1.8.0
 
 The Splunk Software Development Kit (SDK) for Java contains library code and
 examples designed to enable developers to build applications using Splunk.
@@ -75,7 +75,7 @@ To add the Splunk SDK for Java `.JAR` file as a dependency:
   <dependency>
     <groupId>com.splunk</groupId>
     <artifactId>splunk</artifactId>
-    <version>1.7.1</version>
+    <version>1.8.0</version>
   </dependency>
 </dependencies>
 ```

deploy

@@ -2,7 +2,7 @@
 
 declare -r scriptDirectory="$(dirname $(readlink -e $0))"
 declare -r scriptName="$(basename $0)"
-declare -r version="1.7.1"
+declare -r version="1.8.0"
 
 if [[ $# -ne 1 ]]; then
     echo 1>&2 "Usage: ${scriptName} {local|staging||production}"

deploy.md

@@ -9,8 +9,8 @@ deploy \<repository-name>
 
 ##DESCRIPTION
 
-Deploy transmits **target/splunk-1.7.1.jar**, **target/splunk-1.7.1-javadoc.jar**, and
-**target/splunk-1.7.1-sources.jar** to the **local**, **staging**, or **production**
+Deploy transmits **target/splunk-1.8.0.jar**, **target/splunk-1.8.0-javadoc.jar**, and
+**target/splunk-1.8.0-sources.jar** to the **local**, **staging**, or **production**
 maven repository. Repository names are mapped to locations as follows.
 
 | repository-name | location                                                       |
@@ -21,18 +21,18 @@ maven repository. Repository names are mapped to locations as follows.
 
 After deployment you should find this tree structure at the location of your repository
 
-    com/splunk/splunk/1.7.1/
-    ├── splunk-1.7.1-javadoc.jar
-    ├── splunk-1.7.1-javadoc.jar.md5
-    ├── splunk-1.7.1-javadoc.jar.sha1
-    ├── splunk-1.7.1-sources.jar
-    ├── splunk-1.7.1-sources.jar.md5
-    ├── splunk-1.7.1-sources.jar.sha1
-    ├── splunk-1.7.1.jar
-    ├── splunk-1.7.1.jar.md5
-    ├── splunk-1.7.1.jar.sha1
-    ├── splunk-1.7.1.pom
-    ├── splunk-1.7.1.pom.md5
-    └── splunk-1.7.1.pom.sha1
+    com/splunk/splunk/1.8.0/
+    ├── splunk-1.8.0-javadoc.jar
+    ├── splunk-1.8.0-javadoc.jar.md5
+    ├── splunk-1.8.0-javadoc.jar.sha1
+    ├── splunk-1.8.0-sources.jar
+    ├── splunk-1.8.0-sources.jar.md5
+    ├── splunk-1.8.0-sources.jar.sha1
+    ├── splunk-1.8.0.jar
+    ├── splunk-1.8.0.jar.md5
+    ├── splunk-1.8.0.jar.sha1
+    ├── splunk-1.8.0.pom
+    ├── splunk-1.8.0.pom.md5
+    └── splunk-1.8.0.pom.sha1
 
 Verify this structure prior to release.

examples/pom.xml

@@ -8,7 +8,7 @@
     <parent>
         <artifactId>splunk-sdk-java</artifactId>
         <groupId>com.splunk</groupId>
-        <version>1.0.0</version>
+        <version>1.0.1</version>
     </parent>
 
     <build>
@@ -37,7 +37,7 @@
         <dependency>
             <groupId>com.splunk</groupId>
             <artifactId>splunk</artifactId>
-            <version>1.7.1</version>
+            <version>1.8.0</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

pom.xml

@@ -6,7 +6,7 @@
     <modelVersion>4.0.0</modelVersion>
 
     <properties>
-        <version.number>1.7.1</version.number>
+        <version.number>1.8.0</version.number>
         <maven.resources.overwrite>true</maven.resources.overwrite>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.source>8</maven.compiler.source>
@@ -15,7 +15,7 @@
 
     <groupId>com.splunk</groupId>
     <artifactId>splunk-sdk-java</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.1</version>
     <packaging>pom</packaging>
     <name>Splunk SDK for Java</name>
     <url>https://dev.splunk.com/enterprise/docs/devtools/java/sdk-java</url>

splunk/pom.xml

@@ -5,11 +5,11 @@
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>splunk</artifactId>
-    <version>1.7.1</version>
+    <version>1.8.0</version>
     <parent>
         <artifactId>splunk-sdk-java</artifactId>
         <groupId>com.splunk</groupId>
-        <version>1.0.0</version>
+        <version>1.0.1</version>
     </parent>
     <properties>
         <https.protocols>TLSv1.2</https.protocols>

splunk/src/main/java/com/splunk/HttpService.java

@@ -89,7 +89,7 @@ public boolean verify(String s, SSLSession sslSession) {
     private String prefix = null;
 
     static Map<String, String> defaultHeader = new HashMap<String, String>() {{
-        put("User-Agent", "splunk-sdk-java/1.7.1");
+        put("User-Agent", "splunk-sdk-java/1.8.0");
         put("Accept", "*/*");
     }};