<commit_before># The Splunk Java Software Development Kit

#### Version 1.0

The Splunk Java Software Development Kit (SDK) contains library code and examples designed to enable developers to
build applications using Splunk.

Splunk 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.

The Splunk product is popular with system administrators for aggregation and
monitoring of IT machine data, security, compliance and a wide variety of 
other scenarios that share a requirement to efficiently index, search, analyze
and generate real-time notifications from large volumes of time series data.

The Splunk developer platform enables developers to take advantage of the 
same technology used by the Splunk product to build exciting new applications
that are enabled by Splunk's unique capabilities.


## Getting started with the Splunk Java SDK

The Splunk Java SDK contains library code and examples that show how to 
programmatically interact with Splunk for a variety of scenarios including 
searching, saved searches, data inputs, and many more, along with building 
complete applications. 

The information in this Readme provides steps to get going quickly, but for more
in-depth information be sure to visit the 
[Splunk Developer Portal](http://dev.splunk.com/view/java-sdk/SP-CAAAECN). 

### Requirements

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

#### Splunk

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). 

#### Splunk Java SDK

Get the Splunk Java SDK from [GitHub](https://github.com/) and clone the 
resources to your computer. For example, use the following command: 

    git clone https://github.com/splunk/splunk-sdk-java.git

#### Java and Ant

You'll need Java SE version 6 or higher, which you can download from the 
[Oracle web site](http://www.oracle.com/technetwork/java/javase/downloads/index.html). 

You'll also need Ant, which you can install from the [Apache website](http://ant.apache.org/bindownload.cgi). 

If you are using Windows, you'll need to make sure the following system 
variables are created and set: 

*   **ANT_HOME** should be set to the location where Ant is installed.

*   **JAVA_HOME** should be set to the directory where the JDK is installed.

*   **PATH** should include the path to the **%ANT_HOME%\bin** directory.

For full installation instructions, you can find more information here:
 
*   [Java Platform Installation](http://www.oracle.com/technetwork/java/javase/index-137561.html)

*   [Installing Apache Ant](http://ant.apache.org/manual/install.html)

### Building the SDK and documentation

To build the SDK, open a command prompt in the **/splunk-sdk-java** 
directory and enter: 

    ant

or

> ant dist

This builds all the .class files and the jars. If you just want to build
the .class files, you can run

> ant build

To remove all build artifacts from the repository, enter:<commit_msg>Tweak recent README additions to have consistent formatting.<commit_after># The Splunk Java Software Development Kit

#### Version 1.0

The Splunk Java Software Development Kit (SDK) contains library code and examples designed to enable developers to
build applications using Splunk.

Splunk 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.

The Splunk product is popular with system administrators for aggregation and
monitoring of IT machine data, security, compliance and a wide variety of 
other scenarios that share a requirement to efficiently index, search, analyze
and generate real-time notifications from large volumes of time series data.

The Splunk developer platform enables developers to take advantage of the 
same technology used by the Splunk product to build exciting new applications
that are enabled by Splunk's unique capabilities.


## Getting started with the Splunk Java SDK

The Splunk Java SDK contains library code and examples that show how to 
programmatically interact with Splunk for a variety of scenarios including 
searching, saved searches, data inputs, and many more, along with building 
complete applications. 

The information in this Readme provides steps to get going quickly, but for more
in-depth information be sure to visit the 
[Splunk Developer Portal](http://dev.splunk.com/view/java-sdk/SP-CAAAECN). 

### Requirements

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

#### Splunk

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). 

#### Splunk Java SDK

Get the Splunk Java SDK from [GitHub](https://github.com/) and clone the 
resources to your computer. For example, use the following command: 

    git clone https://github.com/splunk/splunk-sdk-java.git

#### Java and Ant

You'll need Java SE version 6 or higher, which you can download from the 
[Oracle web site](http://www.oracle.com/technetwork/java/javase/downloads/index.html). 

You'll also need Ant, which you can install from the [Apache website](http://ant.apache.org/bindownload.cgi). 

If you are using Windows, you'll need to make sure the following system 
variables are created and set: 

*   **ANT_HOME** should be set to the location where Ant is installed.

*   **JAVA_HOME** should be set to the directory where the JDK is installed.

*   **PATH** should include the path to the **%ANT_HOME%\bin** directory.

For full installation instructions, you can find more information here:
 
*   [Java Platform Installation](http://www.oracle.com/technetwork/java/javase/index-137561.html)

*   [Installing Apache Ant](http://ant.apache.org/manual/install.html)

### Building the SDK and documentation

To build the SDK, open a command prompt in the **/splunk-sdk-java** 
directory and enter: 

    ant

or

    ant dist

This builds all the .class files and the jars. If you just want to build
the .class files, you can run

    ant build

To remove all build artifacts from the repository, enter:
{'fraction_non_alphanumeric': 0.0700140339934508, 'fraction_numerical': 0.002806798690160611, 'mean_word_length': 4.340549542048293, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 4, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 16, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '389179', 'n_tokens_mistral': 1788, 'n_tokens_neox': 1641, 'n_words': 830}