com.splunk
Class OutputDefault

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

All Implemented Interfaces:

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

public class OutputDefault
extends Entity

The OutputDefault class represents the default TCP output configuration, providing access to global TCP output properties.

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	autoLb() Indicates whether this forwarder performs automatic load balancing.
boolean	blockOnQueueFull() Indicates whether this forwarder blocks when the output queue is full.
int	getAutoLbFrequency() Returns the frequency of automatic load balancing.
java.lang.String	getDefaultGroup() Returns the default indexer group that this forwarder sends all data to.
int	getDropEventsOnQueueFull() Returns the amount of time this forwarder waits before dropping events if the output queue is full.
java.lang.String	getForwardedIndex0Whitelist() Returns the inclusive set of indexes (whitelist 0) for this forwarder.
java.lang.String	getForwardedIndex1Blacklist() Returns the exclusive set of indexes (blacklist 1) for this forwarder.
java.lang.String	getForwardedIndex2Whitelist() Returns the inclusive set of indexes (whitelist 2) for this forwarder.
int	getHeartbeatFrequency() Returns the frequency that specifies how often to send a heartbeat packet to the receiving server. Note: This field is only used when sendCookedData is true.
long	getMaxQueueSize() Returns the maximum size of the output queue for this forwarder.
boolean	indexAndForward() Indicates whether to index data locally in addition to forwarding it. Note: This setting is not available for light forwarders.
boolean	isCompressed() Indicates whether this forwarder sends compressed data.
boolean	isForwardedIndexFilterDisable() Indicates whether the index filter for this forwarder is disabled.
boolean	sendCookedData() Indicates whether Splunk has processed ("cooked") the event data.

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

autoLb

public boolean autoLb()

Indicates whether this forwarder performs automatic load balancing. When true, this forwarder selects a new indexer using the frequency specified by autoLBFrequency, or immediately when an open connection to an indexer is lost.

Returns:

true if this forwarder performs automatic load balancing, false if not.

See Also:

getAutoLbFrequency()

blockOnQueueFull

public boolean blockOnQueueFull()

Indicates whether this forwarder blocks when the output queue is full. Blocking causes further blocking up the processing chain--if any target group's queue is blocked, no more data reaches any other target group. When false, events are dropped when indexers in the group can't be reached.

Returns:

true if this forwarder will block, false if not.

getAutoLbFrequency

public int getAutoLbFrequency()

Returns the frequency of automatic load balancing.

Returns:

The automatic load-balancing frequency in seconds, or -1 if not specified.

getDefaultGroup

public java.lang.String getDefaultGroup()

Returns the default indexer group that this forwarder sends all data to.
Note: This attribute is not required after Splunk version 4.2.

Returns:

A comma-separated list that contains one or more target group names, or null if not specified.

getDropEventsOnQueueFull

public int getDropEventsOnQueueFull()

Returns the amount of time this forwarder waits before dropping events if the output queue is full. A setting of 0 or -1 causes this forwarder to block.

Returns:

The wait time, in seconds.

getForwardedIndex0Whitelist

public java.lang.String getForwardedIndex0Whitelist()

Returns the inclusive set of indexes (whitelist 0) for this forwarder. This is an ordered list of whitelists and blacklists, which together decide if events should be forwarded to an index.

Returns:

The inclusive set of indexes.

getForwardedIndex1Blacklist

public java.lang.String getForwardedIndex1Blacklist()

Returns the exclusive set of indexes (blacklist 1) for this forwarder. This is an ordered list of whitelists and blacklists, which together decide if events should be forwarded to an index.

Returns:

The exclusive set of indexes.

getForwardedIndex2Whitelist

public java.lang.String getForwardedIndex2Whitelist()

Returns the inclusive set of indexes (whitelist 2) for this forwarder. This is an ordered list of whitelists and blacklists, which together decide if events should be forwarded to an index.

Returns:

The inclusive set of indexes.

getHeartbeatFrequency

public int getHeartbeatFrequency()

Returns the frequency that specifies how often to send a heartbeat packet to the receiving server.
Note: This field is only used when sendCookedData is true.

Returns:

The heartbeat frequency, in seconds.

See Also:

sendCookedData()

getMaxQueueSize

public long getMaxQueueSize()

Returns the maximum size of the output queue for this forwarder. The maximum size of the wait queue is set to three times this value.

Returns:

The maximum size of the output queue, in bytes.

indexAndForward

public boolean indexAndForward()

Indicates whether to index data locally in addition to forwarding it.
Note: This setting is not available for light forwarders.

Returns:

true if data is indexed locally and forwarded, false if not.

isCompressed

public boolean isCompressed()

Indicates whether this forwarder sends compressed data.

Returns:

true if this forwarder sends compressed data, false if not.

isForwardedIndexFilterDisable

public boolean isForwardedIndexFilterDisable()

Indicates whether the index filter for this forwarder is disabled.

Returns:

true if the index filter is disabled, false if events are raw and untouched before sending.

sendCookedData

public boolean sendCookedData()

Indicates whether Splunk has processed ("cooked") the event data.

Returns:

true if the event data has been processed, false if not.