You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# The Splunk Enterprise Software Development Kit for Java
3
3
4
4
#### Version 1.6.5
5
5
6
-
The Splunk Software Development Kit (SDK) for Java contains library code and examples designed to enable developers to build applications using the Splunk platform.
6
+
The Splunk Enterprise Software Development Kit (SDK) for Java contains library code and examples designed to enable developers to build applications using the Splunk platform.
7
7
8
8
The Splunk platform is a search engine and analytic environment that uses a distributed map-reduce architecture to efficiently index, search, and process large time-varying data sets.
9
9
@@ -13,26 +13,26 @@ The Splunk developer platform enables developers to take advantage of the same t
13
13
14
14
For more information, see [Splunk Enterprise SDK for Java](https://dev.splunk.com/enterprise/docs/devtools/java/sdk-java/) on the Splunk Developer Portal.
15
15
16
-
## Getting started with the Splunk SDK for Java
16
+
## Getting started with the Splunk Enterprise SDK for Java
17
17
18
-
The Splunk SDK for Java contains library code and examples that show how to programmatically interact with the Splunk platform for a variety of scenarios including searching, saved searches, data inputs, and many more, along with building complete applications.
18
+
The Splunk Enterprise SDK for Java contains library code and examples that show how to programmatically interact with the Splunk platform for a variety of scenarios including searching, saved searches, data inputs, and many more, along with building complete applications.
19
19
20
20
### Requirements
21
21
22
-
Here's what you need to get going with the Splunk SDK for Java.
22
+
Here's what you need to get going with the Splunk Enterprise SDK for Java.
23
23
24
-
* Splunk
24
+
* Splunk Enterprise
25
25
26
-
If you haven't already installed Splunk, download it [here](http://www.splunk.com/download).
26
+
If you haven't already installed Splunk Enterprise, download it [here](http://www.splunk.com/download).
27
27
For more information, see the Splunk Enterprise [_Installation Manual_](https://docs.splunk.com/Documentation/Splunk/latest/Installation).
28
28
29
-
* Splunk SDK for Java
29
+
* Splunk Enterprise SDK for Java
30
30
31
31
Get the JAR from the [Splunk Developer Portal](https://dev.splunk.com/enterprise/downloads/) or clone the repository from [GitHub](https://github.com/splunk/splunk-sdk-java) if you want to contribute to the SDK. To use Maven, see "Use Maven to build projects" below.
32
32
33
33
* Java version 6 or higher, from [OpenJDK](https://openjdk.java.net) or [Oracle](https://www.oracle.com/technetwork/java). For instructions, see [Java Platform Installation](http://www.oracle.com/technetwork/java/javase/index-137561.html) on the Oracle website.
34
34
35
-
The Splunk SDK for Java is compatible with Java 8. Be aware that **Java 8 disables Secure Sockets Layer version 3 (SSLv3) by default**, so you will need to use Transport Layer Security (TLS) instead. To see an example of how to do this, see the [ssl_protocols](https://github.com/splunk/splunk-sdk-java/blob/master/examples/com/splunk/examples/ssl_protocols/Pro...) example. Alternatively, you can re-enable SSLv3 in Java settings, although this is not recommended.
35
+
The Splunk Enterprise SDK for Java is compatible with Java 8. Be aware that **Java 8 disables Secure Sockets Layer version 3 (SSLv3) by default**, so you will need to use Transport Layer Security (TLS) instead. To see an example of how to do this, see the [ssl_protocols](https://github.com/splunk/splunk-sdk-java/blob/master/examples/com/splunk/examples/ssl_protocols/Pro...) example. Alternatively, you can re-enable SSLv3 in Java settings, although this is not recommended.
36
36
37
37
* Ant, from the [Apache website](http://ant.apache.org/bindownload.cgi). For instructions, see [Installing Apache Ant](http://ant.apache.org/manual/install.html).
38
38
@@ -45,9 +45,9 @@ If you are using Windows, make sure the following system variables are created a
45
45
46
46
### Use Maven to build projects
47
47
48
-
You can use [Apache Maven](http://maven.apache.org/) to build your Splunk SDK for Java projects with a few updates to your project's **pom.xml** file. You can retrieve all necessary dependencies and build your project.
48
+
You can use [Apache Maven](http://maven.apache.org/) to build your Splunk Enterprise SDK for Java projects with a few updates to your project's **pom.xml** file. You can retrieve all necessary dependencies and build your project.
49
49
50
-
To add the Splunk SDK for Java JAR file as a dependency:
50
+
To add the Splunk Enterprise SDK for Java JAR file as a dependency:
51
51
52
52
1. Add the repository to your project's **pom.xml** file:
53
53
@@ -62,7 +62,7 @@ If you are using Windows, make sure the following system variables are created a
62
62
</repositories>
63
63
```
64
64
65
-
2. Add the dependency to the **pom.xml** file and update the version number to match the version of the Splunk SDK for Java that you are using:
65
+
2. Add the dependency to the **pom.xml** file and update the version number to match the version of the Splunk Enterprise SDK for Java that you are using:
66
66
67
67
```
68
68
<dependencies>
@@ -102,7 +102,7 @@ To build the documentation for the SDK, enter:
102
102
103
103
### Examples and unit tests
104
104
105
-
The Splunk SDK for Java includes several examples and unit tests to run at the command line.
105
+
The Splunk Enterprise SDK for Java includes several examples and unit tests to run at the command line.
106
106
107
107
#### Create a .splunkrc convenience file
108
108
@@ -180,11 +180,11 @@ The ant configuration can produce a single HTML report of all the tests run usin
180
180
181
181
The report is written in **build/reports/tests/index.html**.
182
182
183
-
You can also run the units within Java IDEs such as IntelliJ and Eclipse. For example, to open the Splunk SDK for Java project in Eclipse:
183
+
You can also run the units within Java IDEs such as IntelliJ and Eclipse. For example, to open the Splunk Enterprise SDK for Java project in Eclipse:
184
184
185
185
1. Click **File**, then click **Import**.
186
186
2. Click **General**, click **Existing Projects into Workspace**, then click **Next**.
187
-
3. In **Select root directory**, type the path to the Splunk SDK for Java root directory (or click **Browse** to locate it), then click **Finish**.
187
+
3. In **Select root directory**, type the path to the Splunk Enterprise SDK for Java root directory (or click **Browse** to locate it), then click **Finish**.
188
188
189
189
#### Measure code coverage
190
190
@@ -228,7 +228,7 @@ To learn about our branching model, see [Branching Model](https://github.com/spl
228
228
|:----------------------- |:----------- |
229
229
| [Splunk Developer Portal](http://dev.splunk.com) | General developer documentation, tools, and examples |
230
230
| [Integrate the Splunk platform using development tools for Java](https://dev.splunk.com/enterprise/docs/devtools/java)| Documentation for Java development |
231
-
| [Splunk SDK for Java Reference](http://docs.splunk.com/Documentation/JavaSDK) | SDK API reference documentation |
231
+
| [Splunk Enterprise SDK for Java Reference](http://docs.splunk.com/Documentation/JavaSDK) | SDK API reference documentation |
232
232
| [REST API Reference Manual](https://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTprolog) | Splunk REST API reference documentation |
233
233
| [Splunk>Docs](https://docs.splunk.com/Documentation) | General documentation for the Splunk platform |
234
234
| [GitHub Wiki](https://github.com/splunk/splunk-sdk-java/wiki/) | Documentation for this SDK's repository on GitHub |
@@ -251,7 +251,7 @@ If you would like to contribute to the SDK, see [Contributions to Splunk](https:
251
251
252
252
### Support
253
253
254
-
* You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html) and include "Splunk SDK for Java" in the subject line.
254
+
* You will be granted support if you or your company are already covered under an existing maintenance/support agreement. Submit a new case in the [Support Portal](https://www.splunk.com/en_us/support-and-services.html) and include "Splunk Enterprise SDK for Java" in the subject line.
255
255
256
256
If you are not covered under an existing maintenance/support agreement, you can find help through the broader community at [Splunk Answers](https://community.splunk.com/t5/Splunk-Development/ct-p/developer-tools).
257
257
@@ -267,4 +267,4 @@ You can reach the Splunk Developer Platform team at [email protected]_.
267
267
268
268
## License
269
269
270
-
The Splunk Software Development Kit for Java is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
270
+
The Splunk Enterprise Software Development Kit for Java is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
0 commit comments