Merge pull request #194 from splunk/Release/1.9.1

Release/1.9.1

Author: ashah-splunk

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Splunk Enterprise SDK for Java Changelog
 
+## Version 1.9.1
+
+### New Features and APIs
+* SDK Support for third-party (Load Balancer) "sticky sessions"(cookie persistence) (Github PR [#192](https://github.com/splunk/splunk-sdk-java/pull/192))
+* Added Args option for Saved Search history method (GitHub Issue [#126](https://github.com/splunk/splunk-sdk-java/issues/126) & PR [#188](https://github.com/splunk/splunk-sdk-java/pull/188) )
+
+### Minor Changes
+* Special handling related to the semantic versioning of specific Search APIs functional in Splunk Enterprise 9.0.2 and (Splunk Cloud 9.0.2209). These SDK changes will enable seamless transition between the APIs based on the version of the Splunk Enterprise/Cloud (Github PR [#193](https://github.com/splunk/splunk-sdk-java/pull/193))
+* Updated checks to fetch Storage Passwords with wildcards in namespace. (GitHub PR [#187](https://github.com/splunk/splunk-sdk-java/pull/187))
+
 ## Version 1.9.0
 
 ### New Features and APIs

README.md

@@ -1,7 +1,7 @@
 [![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.9.0
+#### Version 1.9.1
 
 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.9.0</version>
+    <version>1.9.1</version>
   </dependency>
 </dependencies>
 ```

deploy

@@ -2,7 +2,7 @@
 
 declare -r scriptDirectory="$(dirname $(readlink -e $0))"
 declare -r scriptName="$(basename $0)"
-declare -r version="1.9.0"
+declare -r version="1.9.1"
 
 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.9.0.jar**, **target/splunk-1.9.0-javadoc.jar**, and
-**target/splunk-1.9.0-sources.jar** to the **local**, **staging**, or **production**
+Deploy transmits **target/splunk-1.9.1.jar**, **target/splunk-1.9.1-javadoc.jar**, and
+**target/splunk-1.9.1-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.9.0/
-    ├── splunk-1.9.0-javadoc.jar
-    ├── splunk-1.9.0-javadoc.jar.md5
-    ├── splunk-1.9.0-javadoc.jar.sha1
-    ├── splunk-1.9.0-sources.jar
-    ├── splunk-1.9.0-sources.jar.md5
-    ├── splunk-1.9.0-sources.jar.sha1
-    ├── splunk-1.9.0.jar
-    ├── splunk-1.9.0.jar.md5
-    ├── splunk-1.9.0.jar.sha1
-    ├── splunk-1.9.0.pom
-    ├── splunk-1.9.0.pom.md5
-    └── splunk-1.9.0.pom.sha1
+    com/splunk/splunk/1.9.1/
+    ├── splunk-1.9.1-javadoc.jar
+    ├── splunk-1.9.1-javadoc.jar.md5
+    ├── splunk-1.9.1-javadoc.jar.sha1
+    ├── splunk-1.9.1-sources.jar
+    ├── splunk-1.9.1-sources.jar.md5
+    ├── splunk-1.9.1-sources.jar.sha1
+    ├── splunk-1.9.1.jar
+    ├── splunk-1.9.1.jar.md5
+    ├── splunk-1.9.1.jar.sha1
+    ├── splunk-1.9.1.pom
+    ├── splunk-1.9.1.pom.md5
+    └── splunk-1.9.1.pom.sha1
 
 Verify this structure prior to release.

examples/pom.xml

@@ -37,7 +37,7 @@
         <dependency>
             <groupId>com.splunk</groupId>
             <artifactId>splunk</artifactId>
-            <version>1.9.0</version>
+            <version>1.9.1</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

pom.xml

@@ -6,7 +6,7 @@
     <modelVersion>4.0.0</modelVersion>
 
     <properties>
-        <version.number>1.9.0</version.number>
+        <version.number>1.9.1</version.number>
         <maven.resources.overwrite>true</maven.resources.overwrite>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <maven.compiler.source>8</maven.compiler.source>
@@ -24,7 +24,7 @@
         <dependency>
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
-            <version>2.8.6</version>
+            <version>2.8.9</version>
         </dependency>
         <dependency>
             <groupId>net.sf.opencsv</groupId>

splunk/pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>splunk</artifactId>
-    <version>1.9.0</version>
+    <version>1.9.1</version>
     <parent>
         <artifactId>splunk-sdk-java</artifactId>
         <groupId>com.splunk</groupId>

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.9.0");
+        put("User-Agent", "splunk-sdk-java/1.9.1");
         put("Accept", "*/*");
     }};
 
@@ -316,12 +316,12 @@ public void removeAllCookies() {
     }
 
     /**
-     * Returns true if the cookeStore has any cookies, false otherwise
+     * Returns true if the cookieStore has any Splunk Authorization cookies, false otherwise
      *
      * @return True if there are cookies, false otherwise
      */
-    public Boolean hasCookies() {
-        return !cookieStore.isEmpty();
+    public Boolean hasSplunkAuthCookies() {
+        return cookieStore.hasSplunkAuthCookie();
     }
 
     /**

splunk/src/main/java/com/splunk/Job.java

@@ -372,15 +372,15 @@ private InputStream getEventsMethod(String methodPath, Map args) {
         // v1(GET), v2(POST)
         String fullPath;
         ResponseMessage response;
-        if (service.versionIsEarlierThan("9.0")) {
+        if (!service.enableV2SearchApi()) {
             fullPath = path.replace(JobCollection.REST_PATH_V2, JobCollection.REST_PATH) + methodPath;
             response = service.get(fullPath, args);
         }
         else {
             fullPath = path.replace(JobCollection.REST_PATH, JobCollection.REST_PATH_V2) + methodPath;
             response = service.post(fullPath, args);
         }
-
+        
         return response.getContent();
     }
 

splunk/src/main/java/com/splunk/JobCollection.java

@@ -34,7 +34,7 @@ public class JobCollection extends EntityCollection<Job> {
      * @param service The connected {@code Service} instance.
      */
     JobCollection(Service service) {
-        super(service, service.versionIsAtLeast("9.0") ? REST_PATH_V2 : REST_PATH, Job.class);
+        super(service, service.enableV2SearchApi() ? REST_PATH_V2 : REST_PATH, Job.class);
         this.refreshArgs.put("count", "0");
     }
 
@@ -46,7 +46,7 @@ public class JobCollection extends EntityCollection<Job> {
      * return and how to sort them (see {@link CollectionArgs}).
      */
     JobCollection(Service service, Args args) {
-        super(service, service.versionIsAtLeast("9.0") ? REST_PATH_V2 : REST_PATH, Job.class, args);
+        super(service, service.enableV2SearchApi() ? REST_PATH_V2 : REST_PATH, Job.class);
         this.refreshArgs.put("count", "0");
     }
 
@@ -87,7 +87,7 @@ public Job create(String query, Map args) {
             .item(0)
             .getTextContent();
 
-        String path = service.versionIsAtLeast("9.0") ? REST_PATH_V2 : REST_PATH;
+        String path = service.enableV2SearchApi() ? REST_PATH_V2 : REST_PATH;
         Job job = new Job(service, path + "/" + sid);
         job.refresh();
 

splunk/src/main/java/com/splunk/PasswordCollection.java

@@ -50,6 +50,9 @@ public class PasswordCollection extends EntityCollection<Password> {
      * @return The new credential.
      */
     public Password create(String name, String password) {
+        if(checkForWildcards()){
+            throw new IllegalArgumentException("While creating StoragePasswords, namespace cannot have wildcards.");
+        }
         Args args = new Args("password", password);
         return create(name, args);
     }
@@ -63,6 +66,9 @@ public Password create(String name, String password) {
      * @return The new credential.
      */
     public Password create(String name, String password, String realm) {
+        if(checkForWildcards()){
+            throw new IllegalArgumentException("While creating StoragePasswords, namespace cannot have wildcards.");
+        }
         Args args = new Args();
         args.put("password", password);
         args.put("realm", realm);
@@ -97,11 +103,17 @@ public Password get(Object key) {
      * @return The removed credential, or null if not found.
      */
     public Password remove(String realm, String name) {
+        if(checkForWildcards()){
+            throw new IllegalArgumentException("app context must be specified when removing a password.");
+        }
         return super.remove(String.format("%s:%s:", realm, name));
     }
 
     @Override
     public Password remove(String key) {
+        if(checkForWildcards()){
+            throw new IllegalArgumentException("app context must be specified when removing a password.");
+        }
         // Make it compatible with the old way (low-efficient)
         if (!key.contains(":")) {
             Password password = getByUsername((String) key);
@@ -129,4 +141,12 @@ private Password getByUsername(String name) {
         }
         return null;
     }
+
+    private boolean checkForWildcards(){
+        boolean isWildCard = false;
+        if(("-").equals(service.getOwner()) || ("-").equals(service.getApp())){
+            isWildCard = true;
+        }
+        return isWildCard;
+    }
 }

splunk/src/main/java/com/splunk/Receiver.java

@@ -98,9 +98,13 @@ public Socket attach(String indexName, Args args) throws IOException {
         headers.add("Accept-Encoding: identity");
         headers.add("X-Splunk-Input-Mode: Streaming");
 
-        if (service.hasCookies()) {
+        if (service.hasSplunkAuthCookies()) {
             headers.add(String.format("Cookie: %s", service.stringifyCookies()));
         } else {
+            // to persist the cookies other than Splunk such as from Load Balancer
+            if(!service.cookieStore.isEmpty()){
+                headers.add(String.format("Cookie: %s", service.stringifyCookies()));
+            }
             headers.add(String.format("Authorization: %s", service.getToken()));
         }
         headers.add("");