com.splunk.modularinput

Class ValidationDefinition

java.lang.Object

com.splunk.modularinput.ValidationDefinition

public class ValidationDefinition
extends Object

The ValidationDefinition class represents the XML sent by Splunk for external validation of a new modular input.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
String	getCheckpointDir() Gets the path to write checkpoint files for restarting inputs in.
String	getName() Gets the name of the proposed modular input instance.
Map<String,Parameter>	getParameters()
String	getServerHost() Gets the name of the server on which this modular input is being run.
String	getServerUri() Gets the URI to the server on which this modular input is being run.
String	getSessionKey() Gets a session key providing access to splunkd's REST API on this host.
int	hashCode()
static ValidationDefinition	parseDefinition(InputStream stream) Create a ValidationDefinition from a provided stream containing XML.
void	setParameters(Collection<Parameter> parameters) Sets a list of Parameter objects giving the proposed configuration.

Methods inherited from class java.lang.Object

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

Method Detail

getServerHost

public String getServerHost()

Gets the name of the server on which this modular input is being run.

Returns:

The name of the server on which this modular input is being run.

getServerUri

public String getServerUri()

Gets the URI to the server on which this modular input is being run.

Returns:

The URI to the server on which this modular input is being run.

getCheckpointDir

public String getCheckpointDir()

Gets the path to write checkpoint files for restarting inputs in.

Returns:

The path to write checkpoint files for restarting inputs in.

getSessionKey

public String getSessionKey()

Gets a session key providing access to splunkd's REST API on this host.

Returns:

A session key providing access to splunkd's REST API on this host.

getName

public String getName()

Gets the name of the proposed modular input instance.

Returns:

The name of the proposed modular input instance.

setParameters

public void setParameters(Collection<Parameter> parameters)

Sets a list of Parameter objects giving the proposed configuration.

Parameters:

parameters - A list of Parameter objects giving the proposed configuration.

getParameters

public Map<String,Parameter> getParameters()

Returns:

The parameters on the proposed input.

parseDefinition

public static ValidationDefinition parseDefinition(InputStream stream)
                                            throws ParserConfigurationException,
                                                   IOException,
                                                   SAXException,
                                                   MalformedDataException

Create a ValidationDefinition from a provided stream containing XML. The XML typically will look like

 
 <items>
     <server_host>myHost</server_host>
     <server_uri>https://127.0.0.1:8089</server_uri>
     <session_key>123102983109283019283</session_key>
     <checkpoint_dir>/opt/splunk/var/lib/splunk/modinputs</checkpoint_dir>
     <item name="myScheme">
         <param name="param1">value1</param>
         <param_list name="param2">
             <value>value2</value>
             <value>value3</value>
             <value>value4</value>
         </param_list>
     </item>
 </items>
 
 

Parameters:

stream - containing XML to parse.

Returns:

a ValidationDefinition.

Throws:

ParserConfigurationException - if there are errors in setting up the parser (which indicates system configuration issues).

IOException - if there is an error in reading from the stream.

SAXException - when the XML is invalid.

MalformedDataException - when the XML does not meet the required schema.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object