Requirements for the Splunk SDK for Java

Here's what you need to get going with the Splunk SDK for Java.

Splunk Enterprise

If you haven't already installed Splunk Enterprise, download it here. For more information about installing and running Splunk Enterprise and system requirements, see the Splunk Installation Manual.

Java

Running at least Java SE version 6 is required to run the Splunk SDK for Java. Java SE Development Kit (JDK) 8 is recommended. Download it from the Oracle web site.

Note: 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. For an example of how to do this, see the ssl_protocols example in the SDK. Alternatively, you can re-enable SSLv3 in Java settings, but this is not recommended.

If you are using Windows, make sure the JAVA_HOME system variable is set to the directory where the JDK is installed.

Ant

You'll also need Apache Ant, which you can download from the Apache website.

If you are using Windows, make sure these two system variables are correctly set:

  • ANT_HOME should be set to the location where Ant is installed.
  • PATH should include the path to the %ANT_HOME%\bin directory.

For more information, see Installing Apache Ant on the Apache website.

Splunk SDK for Java

Download the .JAR file and add it to your project.

If you want to verify your JAR download:

Or, get the Splunk SDK for Java: download the SDK as a ZIP, and then extract the files and build the SDK.

If you want to verify your SDK download: