From ba2ba0d6ae6d6aca7f6503b21d6dc79c193b6ff4 Mon Sep 17 00:00:00 2001 From: bparmar-splunk Date: Fri, 10 Dec 2021 12:17:30 +0530 Subject: [PATCH 01/14] Javadoc description added. --- splunk/src/main/java/com/splunk/HttpService.java | 2 +- splunk/src/main/java/com/splunk/OutputServer.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/splunk/src/main/java/com/splunk/HttpService.java b/splunk/src/main/java/com/splunk/HttpService.java index b7ec204e..d07aae64 100644 --- a/splunk/src/main/java/com/splunk/HttpService.java +++ b/splunk/src/main/java/com/splunk/HttpService.java @@ -208,7 +208,7 @@ public int getPort() { /** * Sets Custom Headers of this service * - * @param headers + * @param headers The custom headers. */ public void setCustomHeaders(Map headers) { if (Objects.nonNull(headers)) { diff --git a/splunk/src/main/java/com/splunk/OutputServer.java b/splunk/src/main/java/com/splunk/OutputServer.java index 2bcd19b3..cafec3f6 100644 --- a/splunk/src/main/java/com/splunk/OutputServer.java +++ b/splunk/src/main/java/com/splunk/OutputServer.java @@ -92,7 +92,7 @@ public String getStatus() { /** * Returns client certificate path. * - * @return + * @return Path of client certificate. */ public String getClientCert() { return getString("clientCert", ""); From 1db81275a482edc425e4c113dd66321b468959fb Mon Sep 17 00:00:00 2001 From: bparmar-splunk Date: Wed, 9 Mar 2022 15:30:51 +0530 Subject: [PATCH 02/14] API docs upload automated Update: - While release, api docs will be generated and compressed using zip tool. - Using upload-artifact github-action module, it will allow us to download api docs zip till 90 days. --- .github/workflows/release.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6ff012f8..d4cdce89 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,6 +19,8 @@ jobs: server-id: splunk-artifactory - name: build run: mvn package --file pom.xml -DskipTests=true + - name: Create temp artifacts apidocs folder + run: mkdir apidocs - name: Create GitHub Release uses: softprops/action-gh-release@v1 with: @@ -32,3 +34,12 @@ jobs: env: MAVEN_USERNAME: ${{ secrets.ARTIFACTORY_USERNAME }} MAVEN_PASSWORD: ${{ secrets.ARTIFACTORY_PASSWORD }} + + - name: Zip docs + run: zip -r apidocs/docs.zip splunk/target/apidocs + + - name: Upload Artifact + uses: actions/upload-artifact@v3 + with: + name: apidocs + path: apidocs/docs.zip From 3c2b78292abee35efd204b0c624e4f9fc5c802cc Mon Sep 17 00:00:00 2001 From: Philippe Tang Date: Wed, 30 Mar 2022 16:58:51 -0700 Subject: [PATCH 03/14] [DVPL-10898] Convert to POST - search/jobs/export --- splunk/src/main/java/com/splunk/Service.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/splunk/src/main/java/com/splunk/Service.java b/splunk/src/main/java/com/splunk/Service.java index 4f4edcad..a8cc012f 100644 --- a/splunk/src/main/java/com/splunk/Service.java +++ b/splunk/src/main/java/com/splunk/Service.java @@ -223,7 +223,7 @@ public InputStream export(String search, Map args) { if (!args.containsKey("segmentation")) { args.put("segmentation", "none"); } - ResponseMessage response = get(JobCollection.REST_PATH + "/export", args); + ResponseMessage response = post(JobCollection.REST_PATH + "/export", args); return new ExportResultsStream(response.getContent()); } From b998ba8c0339d5e1af7c7caf77d24aef51af798c Mon Sep 17 00:00:00 2001 From: Philippe Tang Date: Wed, 30 Mar 2022 17:26:03 -0700 Subject: [PATCH 04/14] [DVPL-10898] Convert to POST - search/parser --- splunk/src/main/java/com/splunk/Service.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/splunk/src/main/java/com/splunk/Service.java b/splunk/src/main/java/com/splunk/Service.java index a8cc012f..7b16ac08 100644 --- a/splunk/src/main/java/com/splunk/Service.java +++ b/splunk/src/main/java/com/splunk/Service.java @@ -1251,7 +1251,7 @@ public ResponseMessage parse(String query) { */ public ResponseMessage parse(String query, Map args) { args = Args.create(args).add("q", query); - return get("search/parser", args); + return post("search/parser", args); } /** From 0da25a5c982ce647f02ba971a9524ff202bed77e Mon Sep 17 00:00:00 2001 From: Philippe Tang Date: Thu, 31 Mar 2022 14:48:16 -0700 Subject: [PATCH 05/14] [DVPL-10898] Remove 'search' request parameter - search/jobs/{search_id}/(events|results|results_preview) --- splunk/src/main/java/com/splunk/Job.java | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/splunk/src/main/java/com/splunk/Job.java b/splunk/src/main/java/com/splunk/Job.java index 3456b1e0..c42329e8 100644 --- a/splunk/src/main/java/com/splunk/Job.java +++ b/splunk/src/main/java/com/splunk/Job.java @@ -366,6 +366,10 @@ private InputStream getEventsMethod(String methodPath, Map args) { // search terms (i.e., elements in XML output). args.put("segmentation", "none"); } + if (args.containsKey("search")) { + // Remove the search request parameter if it exists + args.remove("search"); + } ResponseMessage response = service.get(path + methodPath, args); return response.getContent(); From ab9179fa5f34a78088d79ae16c95f8cfe343b32f Mon Sep 17 00:00:00 2001 From: Jeremy Cook Date: Fri, 1 Apr 2022 17:05:41 -0400 Subject: [PATCH 06/14] [DVPL-10898] Updated export and parser for v2 --- splunk/src/main/java/com/splunk/JobCollection.java | 8 +++++--- splunk/src/main/java/com/splunk/Service.java | 14 ++++++++++++-- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/splunk/src/main/java/com/splunk/JobCollection.java b/splunk/src/main/java/com/splunk/JobCollection.java index 529fb9da..b47feadc 100644 --- a/splunk/src/main/java/com/splunk/JobCollection.java +++ b/splunk/src/main/java/com/splunk/JobCollection.java @@ -27,13 +27,14 @@ public class JobCollection extends EntityCollection { static String oneShotNotAllowed = String.format( "Oneshot not allowed, use service oneshot search method"); static final String REST_PATH = "search/jobs"; + static final String REST_PATH_V2 = "search/v2/jobs"; /** * Class constructor. * * @param service The connected {@code Service} instance. */ JobCollection(Service service) { - super(service, REST_PATH, Job.class); + super(service, service.versionIsAtLeast("9.0") ? REST_PATH_V2 : REST_PATH, Job.class); this.refreshArgs.put("count", "0"); } @@ -45,7 +46,7 @@ public class JobCollection extends EntityCollection { * return and how to sort them (see {@link CollectionArgs}). */ JobCollection(Service service, Args args) { - super(service, REST_PATH, Job.class, args); + super(service, service.versionIsAtLeast("9.0") ? REST_PATH_V2 : REST_PATH, Job.class, args); this.refreshArgs.put("count", "0"); } @@ -86,7 +87,8 @@ public Job create(String query, Map args) { .item(0) .getTextContent(); - Job job = new Job(service, REST_PATH + "/" + sid); + String path = service.versionIsAtLeast("9.0") ? REST_PATH_V2 : REST_PATH; + Job job = new Job(service, path + "/" + sid); job.refresh(); return job; diff --git a/splunk/src/main/java/com/splunk/Service.java b/splunk/src/main/java/com/splunk/Service.java index 7b16ac08..cbe63b4a 100644 --- a/splunk/src/main/java/com/splunk/Service.java +++ b/splunk/src/main/java/com/splunk/Service.java @@ -223,7 +223,13 @@ public InputStream export(String search, Map args) { if (!args.containsKey("segmentation")) { args.put("segmentation", "none"); } - ResponseMessage response = post(JobCollection.REST_PATH + "/export", args); + ResponseMessage response; + + if (versionIsAtLeast("9.0")) + response = post(JobCollection.REST_PATH_V2 + "/export", args); + else { + response = post(JobCollection.REST_PATH + "/export", args); + } return new ExportResultsStream(response.getContent()); } @@ -1251,7 +1257,11 @@ public ResponseMessage parse(String query) { */ public ResponseMessage parse(String query, Map args) { args = Args.create(args).add("q", query); - return post("search/parser", args); + + if (versionIsAtLeast("9.0")) + return post("search/v2/parser", args); + else + return get("search/parser", args); } /** From eef6248365001c65cdd73a6773c944504c32d087 Mon Sep 17 00:00:00 2001 From: Jeremy Cook Date: Mon, 4 Apr 2022 11:20:56 -0400 Subject: [PATCH 07/14] [DVPL-10898] Added v2 support to events, results, results_preview --- splunk/src/main/java/com/splunk/Job.java | 18 +++++++++++++----- .../main/java/com/splunk/JobCollection.java | 2 +- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/splunk/src/main/java/com/splunk/Job.java b/splunk/src/main/java/com/splunk/Job.java index c42329e8..4648df24 100644 --- a/splunk/src/main/java/com/splunk/Job.java +++ b/splunk/src/main/java/com/splunk/Job.java @@ -29,15 +29,18 @@ public class Job extends Entity { private boolean isReady = false; + private String sid; /** * Class constructor. * * @param service The connected {@code Service} instance. * @param path The search jobs endpoint. + * @param sid The sid of the job. */ - Job(Service service, String path) { + Job(Service service, String path, String sid) { super(service, path); + this.sid = sid; } /** @@ -366,12 +369,17 @@ private InputStream getEventsMethod(String methodPath, Map args) { // search terms (i.e., elements in XML output). args.put("segmentation", "none"); } - if (args.containsKey("search")) { - // Remove the search request parameter if it exists - args.remove("search"); + + // Splunk version doesn't support v2 (pre-9.0) or the 'search' arg is included (which is v1 specific) + String fullPath; + if (service.versionIsEarlierThan("9.0") || args.containsKey("search")) { + fullPath = JobCollection.REST_PATH + sid + methodPath; + } + else { + fullPath = JobCollection.REST_PATH_V2 + sid + methodPath; } - ResponseMessage response = service.get(path + methodPath, args); + ResponseMessage response = service.get(fullPath, args); return response.getContent(); } diff --git a/splunk/src/main/java/com/splunk/JobCollection.java b/splunk/src/main/java/com/splunk/JobCollection.java index b47feadc..f0ffaba0 100644 --- a/splunk/src/main/java/com/splunk/JobCollection.java +++ b/splunk/src/main/java/com/splunk/JobCollection.java @@ -88,7 +88,7 @@ public Job create(String query, Map args) { .getTextContent(); String path = service.versionIsAtLeast("9.0") ? REST_PATH_V2 : REST_PATH; - Job job = new Job(service, path + "/" + sid); + Job job = new Job(service, path + "/" + sid, sid); job.refresh(); return job; From b8a88c58d9f64b1d5e1c961daefd7e27fae8597b Mon Sep 17 00:00:00 2001 From: Philippe Tang Date: Mon, 4 Apr 2022 10:44:44 -0700 Subject: [PATCH 08/14] [DVPL-10898] Updating reference of Job with 'sid' param --- splunk/src/main/java/com/splunk/SavedSearch.java | 4 ++-- splunk/src/main/java/com/splunk/Service.java | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/splunk/src/main/java/com/splunk/SavedSearch.java b/splunk/src/main/java/com/splunk/SavedSearch.java index 96979316..c8b1a37f 100644 --- a/splunk/src/main/java/com/splunk/SavedSearch.java +++ b/splunk/src/main/java/com/splunk/SavedSearch.java @@ -88,7 +88,7 @@ public Job dispatch(Map args) throws InterruptedException { // if job not yet scheduled, create an empty job object if (job == null) { - job = new Job(service, JobCollection.REST_PATH + "/" + sid); + job = new Job(service, JobCollection.REST_PATH + "/" + sid, sid); } return job; @@ -124,7 +124,7 @@ public Job[] history() { Job[] result = new Job[count]; for (int i = 0; i < count; ++i) { String sid = feed.entries.get(i).title; - result[i] = new Job(service, JobCollection.REST_PATH + "/" + sid); + result[i] = new Job(service, JobCollection.REST_PATH + "/" + sid, sid); } return result; } diff --git a/splunk/src/main/java/com/splunk/Service.java b/splunk/src/main/java/com/splunk/Service.java index cbe63b4a..be3a40ed 100644 --- a/splunk/src/main/java/com/splunk/Service.java +++ b/splunk/src/main/java/com/splunk/Service.java @@ -651,7 +651,7 @@ public JobCollection getJobs(Args args) { * @return A Job. */ public Job getJob(String sid) { - return new Job(this, JobCollection.REST_PATH + "/" + sid); + return new Job(this, JobCollection.REST_PATH + "/" + sid, sid); } /** From fcf4f78a7abb84e78b390d2bac036378a3e9b938 Mon Sep 17 00:00:00 2001 From: Philippe Tang Date: Wed, 20 Apr 2022 12:31:02 -0700 Subject: [PATCH 09/14] [DVPL-10898] Update get/post for v2-to-v1 fallback --- splunk/pom.xml | 2 +- splunk/src/main/java/com/splunk/Job.java | 8 ++-- .../main/java/com/splunk/JobCollection.java | 2 +- .../src/main/java/com/splunk/SavedSearch.java | 4 +- splunk/src/main/java/com/splunk/Service.java | 2 +- .../test/java/com/splunk/SearchJobTest.java | 44 +++++++++++++++++++ 6 files changed, 52 insertions(+), 10 deletions(-) diff --git a/splunk/pom.xml b/splunk/pom.xml index 4e0e361d..dd142867 100644 --- a/splunk/pom.xml +++ b/splunk/pom.xml @@ -71,7 +71,7 @@ org.jacoco jacoco-maven-plugin - 0.8.7 + 0.8.8 diff --git a/splunk/src/main/java/com/splunk/Job.java b/splunk/src/main/java/com/splunk/Job.java index 4648df24..3bdf904b 100644 --- a/splunk/src/main/java/com/splunk/Job.java +++ b/splunk/src/main/java/com/splunk/Job.java @@ -29,7 +29,6 @@ public class Job extends Entity { private boolean isReady = false; - private String sid; /** * Class constructor. @@ -38,9 +37,8 @@ public class Job extends Entity { * @param path The search jobs endpoint. * @param sid The sid of the job. */ - Job(Service service, String path, String sid) { + Job(Service service, String path) { super(service, path); - this.sid = sid; } /** @@ -373,10 +371,10 @@ private InputStream getEventsMethod(String methodPath, Map args) { // Splunk version doesn't support v2 (pre-9.0) or the 'search' arg is included (which is v1 specific) String fullPath; if (service.versionIsEarlierThan("9.0") || args.containsKey("search")) { - fullPath = JobCollection.REST_PATH + sid + methodPath; + fullPath = path.replace(JobCollection.REST_PATH_V2, JobCollection.REST_PATH) + methodPath; } else { - fullPath = JobCollection.REST_PATH_V2 + sid + methodPath; + fullPath = path.replace(JobCollection.REST_PATH, JobCollection.REST_PATH_V2) + methodPath; } ResponseMessage response = service.get(fullPath, args); diff --git a/splunk/src/main/java/com/splunk/JobCollection.java b/splunk/src/main/java/com/splunk/JobCollection.java index f0ffaba0..b47feadc 100644 --- a/splunk/src/main/java/com/splunk/JobCollection.java +++ b/splunk/src/main/java/com/splunk/JobCollection.java @@ -88,7 +88,7 @@ public Job create(String query, Map args) { .getTextContent(); String path = service.versionIsAtLeast("9.0") ? REST_PATH_V2 : REST_PATH; - Job job = new Job(service, path + "/" + sid, sid); + Job job = new Job(service, path + "/" + sid); job.refresh(); return job; diff --git a/splunk/src/main/java/com/splunk/SavedSearch.java b/splunk/src/main/java/com/splunk/SavedSearch.java index c8b1a37f..96979316 100644 --- a/splunk/src/main/java/com/splunk/SavedSearch.java +++ b/splunk/src/main/java/com/splunk/SavedSearch.java @@ -88,7 +88,7 @@ public Job dispatch(Map args) throws InterruptedException { // if job not yet scheduled, create an empty job object if (job == null) { - job = new Job(service, JobCollection.REST_PATH + "/" + sid, sid); + job = new Job(service, JobCollection.REST_PATH + "/" + sid); } return job; @@ -124,7 +124,7 @@ public Job[] history() { Job[] result = new Job[count]; for (int i = 0; i < count; ++i) { String sid = feed.entries.get(i).title; - result[i] = new Job(service, JobCollection.REST_PATH + "/" + sid, sid); + result[i] = new Job(service, JobCollection.REST_PATH + "/" + sid); } return result; } diff --git a/splunk/src/main/java/com/splunk/Service.java b/splunk/src/main/java/com/splunk/Service.java index be3a40ed..cbe63b4a 100644 --- a/splunk/src/main/java/com/splunk/Service.java +++ b/splunk/src/main/java/com/splunk/Service.java @@ -651,7 +651,7 @@ public JobCollection getJobs(Args args) { * @return A Job. */ public Job getJob(String sid) { - return new Job(this, JobCollection.REST_PATH + "/" + sid, sid); + return new Job(this, JobCollection.REST_PATH + "/" + sid); } /** diff --git a/splunk/src/test/java/com/splunk/SearchJobTest.java b/splunk/src/test/java/com/splunk/SearchJobTest.java index 5993417d..2f327af4 100644 --- a/splunk/src/test/java/com/splunk/SearchJobTest.java +++ b/splunk/src/test/java/com/splunk/SearchJobTest.java @@ -62,6 +62,18 @@ public void testEventsFromJob() { job.cancel(); } + @Test + public void testEventsFromJobV1Fallback() { + Job job = jobs.create(QUERY); + waitUntilDone(job); + + Map args = new HashMap(); + args.put("search","| head 1"); + Assert.assertEquals(1, countEvents(job.getEvents(args))); + + job.cancel(); + } + @Test public void testResultsFromJob() { Job job = jobs.create(QUERY); @@ -71,6 +83,18 @@ public void testResultsFromJob() { job.cancel(); } + + @Test + public void testResultsFromJobV1Fallback() { + Job job = jobs.create(QUERY); + waitUntilDone(job); + + Map args = new HashMap(); + args.put("search","| head 1"); + Assert.assertEquals(1, countEvents(job.getResults(args))); + + job.cancel(); + } @Test public void testGetJobBySid() { @@ -584,6 +608,26 @@ public void testPreview() throws InterruptedException { job.cancel(); } + @Test + public void testPreviewV1Fallback() throws InterruptedException { + JobArgs args = new JobArgs(); + args.put("field_list", "source,host,sourcetype"); + args.setStatusBuckets(100); + + Job job = jobs.create(QUERY, args); + + while (!job.isReady()) { + Thread.sleep(100); + } + + Map argsSearchQuery = new HashMap(); + argsSearchQuery.put("search","| head 1"); + // Assert.assertTrue(1 >= countEvents(job.getResultsPreview(args))); + Assert.assertEquals(1, countEvents(job.getResultsPreview(argsSearchQuery))); + + job.cancel(); + } + @Test public void testSearchLog() { Job job = jobs.create(QUERY); From 912e8459dd88da53acb750cfc06454c17a369ae0 Mon Sep 17 00:00:00 2001 From: Philippe Tang Date: Tue, 7 Jun 2022 18:15:53 -0700 Subject: [PATCH 10/14] Update test job - post processing with search params --- splunk/src/test/java/com/splunk/SearchJobTest.java | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/splunk/src/test/java/com/splunk/SearchJobTest.java b/splunk/src/test/java/com/splunk/SearchJobTest.java index 2f327af4..fbb7cbce 100644 --- a/splunk/src/test/java/com/splunk/SearchJobTest.java +++ b/splunk/src/test/java/com/splunk/SearchJobTest.java @@ -63,7 +63,7 @@ public void testEventsFromJob() { } @Test - public void testEventsFromJobV1Fallback() { + public void testEventsWithSearchParams() { Job job = jobs.create(QUERY); waitUntilDone(job); @@ -85,7 +85,7 @@ public void testResultsFromJob() { } @Test - public void testResultsFromJobV1Fallback() { + public void testResultsWithSearchParams() { Job job = jobs.create(QUERY); waitUntilDone(job); @@ -609,7 +609,7 @@ public void testPreview() throws InterruptedException { } @Test - public void testPreviewV1Fallback() throws InterruptedException { + public void testPreviewWithSearchParams() throws InterruptedException { JobArgs args = new JobArgs(); args.put("field_list", "source,host,sourcetype"); args.setStatusBuckets(100); From f0212199ca15589b0727b57a15d4671ad4f4f5fe Mon Sep 17 00:00:00 2001 From: Philippe Tang Date: Tue, 7 Jun 2022 18:16:06 -0700 Subject: [PATCH 11/14] Search API jobs v2 (/results_preview, /results, /events) allows search params with POST --- splunk/src/main/java/com/splunk/Job.java | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/splunk/src/main/java/com/splunk/Job.java b/splunk/src/main/java/com/splunk/Job.java index 3bdf904b..d101eeaf 100644 --- a/splunk/src/main/java/com/splunk/Job.java +++ b/splunk/src/main/java/com/splunk/Job.java @@ -368,16 +368,19 @@ private InputStream getEventsMethod(String methodPath, Map args) { args.put("segmentation", "none"); } - // Splunk version doesn't support v2 (pre-9.0) or the 'search' arg is included (which is v1 specific) + // Splunk version pre-9.0 doesn't support v2 + // v1(GET), v2(POST) String fullPath; - if (service.versionIsEarlierThan("9.0") || args.containsKey("search")) { + ResponseMessage response; + if (service.versionIsEarlierThan("9.0")) { 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); } - ResponseMessage response = service.get(fullPath, args); return response.getContent(); } From f1ea94b6456d22bbc56c0fdaee6be4c34b16aa92 Mon Sep 17 00:00:00 2001 From: Tim Pavlik Date: Mon, 13 Jun 2022 10:41:53 -0700 Subject: [PATCH 12/14] Take latest changes from develop --- .github/workflows/release.yml | 11 +++++++++++ splunk/src/main/java/com/splunk/HttpService.java | 2 +- splunk/src/main/java/com/splunk/OutputServer.java | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6ff012f8..d4cdce89 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,6 +19,8 @@ jobs: server-id: splunk-artifactory - name: build run: mvn package --file pom.xml -DskipTests=true + - name: Create temp artifacts apidocs folder + run: mkdir apidocs - name: Create GitHub Release uses: softprops/action-gh-release@v1 with: @@ -32,3 +34,12 @@ jobs: env: MAVEN_USERNAME: ${{ secrets.ARTIFACTORY_USERNAME }} MAVEN_PASSWORD: ${{ secrets.ARTIFACTORY_PASSWORD }} + + - name: Zip docs + run: zip -r apidocs/docs.zip splunk/target/apidocs + + - name: Upload Artifact + uses: actions/upload-artifact@v3 + with: + name: apidocs + path: apidocs/docs.zip diff --git a/splunk/src/main/java/com/splunk/HttpService.java b/splunk/src/main/java/com/splunk/HttpService.java index ef7d335d..5f2ad877 100644 --- a/splunk/src/main/java/com/splunk/HttpService.java +++ b/splunk/src/main/java/com/splunk/HttpService.java @@ -208,7 +208,7 @@ public int getPort() { /** * Sets Custom Headers of this service * - * @param headers + * @param headers The custom headers. */ public void setCustomHeaders(Map headers) { if (Objects.nonNull(headers)) { diff --git a/splunk/src/main/java/com/splunk/OutputServer.java b/splunk/src/main/java/com/splunk/OutputServer.java index 2bcd19b3..cafec3f6 100644 --- a/splunk/src/main/java/com/splunk/OutputServer.java +++ b/splunk/src/main/java/com/splunk/OutputServer.java @@ -92,7 +92,7 @@ public String getStatus() { /** * Returns client certificate path. * - * @return + * @return Path of client certificate. */ public String getClientCert() { return getString("clientCert", ""); From a7f3457a9bb2d8b557f7d5b16bf4bdd7b21dfb5d Mon Sep 17 00:00:00 2001 From: Tim Pavlik Date: Thu, 16 Jun 2022 11:36:01 -0700 Subject: [PATCH 13/14] Update test matrix to test 8.2 and latest (currently 9.0) and update 8.x references to 9.x --- .github/workflows/test.yml | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 1df987b9..84ca35c8 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -13,7 +13,7 @@ jobs: java-version: - 1.8 splunk-version: - - "8.0" + - "8.2" - "latest" runs-on: ${{ matrix.os }} diff --git a/README.md b/README.md index 77483b8a..fa72ab54 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ Here's what you need to get going with the Splunk SDK for Java. If you haven't already installed Splunk, download it [here](http://www.splunk.com/download). For more about installing and running Splunk and system requirements, see -[Installing & Running Splunk](http://dev.splunk.com/view/SP-CAAADRV). The Splunk SDK for Java has been tested with Splunk Enterprise 8.0 and 8.2.0. +[Installing & Running Splunk](http://dev.splunk.com/view/SP-CAAADRV). The Splunk SDK for Java has been tested with Splunk Enterprise 9.0 and 8.2. #### Splunk SDK for Java From de3d402edac844e47fc4c3a7b23f3f49436d6413 Mon Sep 17 00:00:00 2001 From: Abhi Shah Date: Fri, 17 Jun 2022 16:04:03 +0530 Subject: [PATCH 14/14] Update the release versions --- CHANGELOG.md | 8 +++++ README.md | 4 +-- deploy | 2 +- deploy.md | 30 +++++++++---------- examples/pom.xml | 2 +- pom.xml | 2 +- splunk/pom.xml | 2 +- .../src/main/java/com/splunk/HttpService.java | 2 +- 8 files changed, 30 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2438cf0c..aa425ff9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Splunk Enterprise SDK for Java Changelog +## Version 1.9.0 + +### New Features and APIs +* SDK Support for splunkd search API changes, for Splunk 9.0+. (Github PR [#189](https://github.com/splunk/splunk-sdk-java/pull/189)) + +### Minor Changes +* Automated docs generation using GitHub actions. (Github PR [#184](https://github.com/splunk/splunk-sdk-java/pull/184)) + ## Version 1.8.0 ### New Features and APIs diff --git a/README.md b/README.md index fa72ab54..3087c219 100644 --- a/README.md +++ b/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.8.0 +#### Version 1.9.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: com.splunk splunk - 1.8.0 + 1.9.0 ``` diff --git a/deploy b/deploy index 5a7a6c0d..cb13e579 100755 --- a/deploy +++ b/deploy @@ -2,7 +2,7 @@ declare -r scriptDirectory="$(dirname $(readlink -e $0))" declare -r scriptName="$(basename $0)" -declare -r version="1.8.0" +declare -r version="1.9.0" if [[ $# -ne 1 ]]; then echo 1>&2 "Usage: ${scriptName} {local|staging||production}" diff --git a/deploy.md b/deploy.md index af57427a..ec5046e5 100644 --- a/deploy.md +++ b/deploy.md @@ -9,8 +9,8 @@ deploy \ ##DESCRIPTION -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** +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** 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.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 + 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 Verify this structure prior to release. diff --git a/examples/pom.xml b/examples/pom.xml index 49d8981c..4b2b2462 100644 --- a/examples/pom.xml +++ b/examples/pom.xml @@ -37,7 +37,7 @@ com.splunk splunk - 1.8.0 + 1.9.0 provided diff --git a/pom.xml b/pom.xml index 9bfafba5..195c08c8 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ 4.0.0 - 1.8.0 + 1.9.0 true UTF-8 8 diff --git a/splunk/pom.xml b/splunk/pom.xml index dd142867..80680170 100644 --- a/splunk/pom.xml +++ b/splunk/pom.xml @@ -5,7 +5,7 @@ 4.0.0 splunk - 1.8.0 + 1.9.0 splunk-sdk-java com.splunk diff --git a/splunk/src/main/java/com/splunk/HttpService.java b/splunk/src/main/java/com/splunk/HttpService.java index 5f2ad877..693f3a36 100644 --- a/splunk/src/main/java/com/splunk/HttpService.java +++ b/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 defaultHeader = new HashMap() {{ - put("User-Agent", "splunk-sdk-java/1.8.0"); + put("User-Agent", "splunk-sdk-java/1.9.0"); put("Accept", "*/*"); }};