com.splunk.modularinput

Class Script

java.lang.Object

com.splunk.modularinput.Script

public abstract class Script
extends Object

The Script class is an abstract base class for implementing modular inputs. Subclasses should override getScheme and streamEvents, and optional configureValidator if the modular input is using external validation.

Constructor Summary

Constructors

Constructor and Description
Script()

Method Summary

Modifier and Type	Method and Description
abstract Scheme	getScheme() Gets the scheme that defines the parameters understood by this modular input.
int	run(String[] args) Encodes all the common behavior of modular inputs.
int	run(String[] args, EventWriter eventWriter, InputStream in) Encodes all the common behavior of modular inputs.
protected String	stackTraceToLogEntry(Exception e)
abstract void	streamEvents(InputDefinition inputs, EventWriter ew) Streams events into Splunk.
void	validateInput(ValidationDefinition definition) Handles external validation for modular input kinds.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Script

public Script()

Method Detail

run

public int run(String[] args)

Encodes all the common behavior of modular inputs. You should have no reason to override this method in most cases.

Parameters:

args - An array of command line arguments passed to this script.

Returns:

An integer to be used as the exit value of this program.

run

public int run(String[] args,
               EventWriter eventWriter,
               InputStream in)

Encodes all the common behavior of modular inputs. You should have no reason to override this method in most cases.

Parameters:

args - An array of command line arguments passed to this script.

eventWriter - An EventWriter.

in - An InputStream.

Returns:

An integer to be used as the exit value of this program.

stackTraceToLogEntry

protected String stackTraceToLogEntry(Exception e)

getScheme

public abstract Scheme getScheme()

Gets the scheme that defines the parameters understood by this modular input.

Returns:

A Scheme object representing the parameters for this modular input.

validateInput

public void validateInput(ValidationDefinition definition)
                   throws Exception

Handles external validation for modular input kinds. When Splunk called a modular input script in validation mode, it will pass in an XML document giving information about the Splunk instance (so you can call back into it if needed) and the name and parameters of the proposed input. If this function does not throw an exception, the validation is assumed to succeed. Otherwise any error thrown will be turned into a string and logged back to Splunk. The default implementation always passes.

Parameters:

definition - The parameters for the proposed input passed by splunkd.

Throws:

Exception - The exception instance

streamEvents

public abstract void streamEvents(InputDefinition inputs,
                                  EventWriter ew)
                           throws MalformedDataException,
                                  XMLStreamException,
                                  IOException

Streams events into Splunk. It should do all of its output via EventWriter rather than assuming that there is a console attached.

Parameters:

inputs - InputDefinition instance

ew - An object with methods to write events and log messages to Splunk.

Throws:

MalformedDataException - The MalformedDataException instance

XMLStreamException - The XMLStreamException instance

IOException - The IOException instance