com.splunk
Class Settings

java.lang.Object
  com.splunk.Resource
      com.splunk.Entity
          com.splunk.Settings

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>

public class Settings
extends Entity

The Settings class represents configuration information for an instance of Splunk.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.Resource

actions, path, service, title

Method Summary

boolean	getEnableSplunkWebSSL() Indicates whether SSL is enabled on the Splunk management port.
java.lang.String	getHost() Returns the default host name to use for data inputs.
int	getHttpPort() Returns the port on which Splunk Web is listening for this instance of Splunk.
int	getMgmtPort() Returns the IP address:port number for Splunkd.
int	getMinFreeSpace() Returns the amount of free disk space that is required for Splunk to continue searching and indexing.
java.lang.String	getPass4SymmKey() Returns the string that is prepended to the Splunk symmetric key to generate the final key that used to sign all traffic between master and slave licensers.
java.lang.String	getServerName() Returns the name that is used to identify this Splunk instance for features such as distributed search.
java.lang.String	getSessionTimeout() Returns the amount of time before a user session times out.
java.lang.String	getSplunkDB() Returns the fully-qualified path to the directory containing the default index for this instance of Splunk.
java.lang.String	getSplunkHome() Returns the fully-qualified path to the Splunk installation directory.
boolean	getStartWebServer() Indicates whether the instance is configured to start Splunk Web.
java.lang.String	getTrustedIP() Returns the IP address of the authenticating proxy.

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getMetadata, isDisabled, isEmpty, keySet, put, putAll, refresh, reload, remove, remove, size, update, validate, values

Methods inherited from class com.splunk.Resource

getActions, getName, getPath, getService, getTitle, invalidate

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Method Detail

getSplunkDB

public java.lang.String getSplunkDB()

Returns the fully-qualified path to the directory containing the default index for this instance of Splunk.

Returns:

The path to the Splunk index directory.

getSplunkHome

public java.lang.String getSplunkHome()

Returns the fully-qualified path to the Splunk installation directory.

Returns:

The path to the Splunk installation directory.

getEnableSplunkWebSSL

public boolean getEnableSplunkWebSSL()

Indicates whether SSL is enabled on the Splunk management port.

Returns:

true if SSL is enabled, false if not.

getHost

public java.lang.String getHost()

Returns the default host name to use for data inputs.

Returns:

The host name.

getHttpPort

public int getHttpPort()

Returns the port on which Splunk Web is listening for this instance of Splunk. The port number defaults to 8000.

Returns:

The Splunk Web port number.

getMgmtPort

public int getMgmtPort()

Returns the IP address:port number for Splunkd.

Returns:

The IP address:port number.

getMinFreeSpace

public int getMinFreeSpace()

Returns the amount of free disk space that is required for Splunk to continue searching and indexing.

Returns:

The required amount of free disk space, in megabytes.

getPass4SymmKey

public java.lang.String getPass4SymmKey()

Returns the string that is prepended to the Splunk symmetric key to generate the final key that used to sign all traffic between master and slave licensers.

Returns:

Licenser symmetric key.

getServerName

public java.lang.String getServerName()

Returns the name that is used to identify this Splunk instance for features such as distributed search.

Returns:

The name used to identify the Splunk instance.

getSessionTimeout

public java.lang.String getSessionTimeout()

Returns the amount of time before a user session times out.

Returns:

The session time-out.

getStartWebServer

public boolean getStartWebServer()

Indicates whether the instance is configured to start Splunk Web.

Returns:

true if the instance is configured to start Splunk Web, false if Splunk Web is disabled.

getTrustedIP

public java.lang.String getTrustedIP()

Returns the IP address of the authenticating proxy.

Returns:

The IP address of the authenticating proxy.