com.splunk
Class TcpInput

java.lang.Object
  com.splunk.Resource
      com.splunk.Entity
          com.splunk.Input
              com.splunk.TcpInput

All Implemented Interfaces:

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

public class TcpInput
extends Input

The TcpInput class represents a TCP raw input. This differs from a TCP cooked input in that this TCP input is in raw form, and is not processed (or "cooked").

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

toUpdate

Fields inherited from class com.splunk.Resource

actions, partialPath, path, refreshArgs, service, title

Method Summary

TcpConnections	connections() Returns an object that contains the inbound raw TCP connections.
java.lang.String	getConnectionHost() Returns the style of host connection.
java.lang.String	getGroup() Returns the group of this TCP input.
java.lang.String	getHost() Returns the source host of this TCP input where this indexer gets its data.
java.lang.String	getIndex() Returns the index name of this TCP input.
InputKind	getKind() Returns the input kind of this TCP input.
java.lang.String	getQueue() Returns the queue for this TCP input.
int	getRcvBuf() Deprecated. Returns the value of the _rcvbuf attribute for this TCP input.
java.lang.String	getRestrictToHost() Returns the incoming host restriction for this TCP input.
java.lang.String	getSource() Returns the initial source key for this TCP input.
java.lang.String	getSourceType() Returns the source type for events from this TCP input.
boolean	getSSL() Indicates whether this TCP input is using secure socket layer (SSL).
void	setConnectionHost(java.lang.String connection_host) Sets the from-host for the remote server that is sending data.
void	setDisabled(boolean disabled) Sets whether this input is enabled or disabled.
void	setHost(java.lang.String host) Sets the host from which the indexer gets data.
void	setIndex(java.lang.String index) Sets the index in which to store all generated events.
void	setQueue(java.lang.String queue) Sets how the input processor should deposit the events it reads.
void	setRawTcpDoneTimeout(int rawTcpDoneTimeout) Sets the timeout value for adding a Done key.
void	setRestrictToHost(java.lang.String restrictToHost) Sets a restriction to accept inputs from the specified host only.
void	setSource(java.lang.String source) Sets the initial value for the source key for events from this input.
void	setSourceType(java.lang.String sourcetype) Sets the source type for events from this input.
void	setSSL(boolean SSL) Sets whether to use secure socket layer (SSL).

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, 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

connections

public TcpConnections connections()

Returns an object that contains the inbound raw TCP connections.

Returns:

The TCP connections object.

getConnectionHost

public java.lang.String getConnectionHost()

Returns the style of host connection. Valid values are: "ip", "dns", and "none".

Returns:

The style of host connection, or null if not specified.

getGroup

public java.lang.String getGroup()

Returns the group of this TCP input.

Returns:

The group.

getHost

public java.lang.String getHost()

Returns the source host of this TCP input where this indexer gets its data.

Returns:

The source host, or null if not specified.

getIndex

public java.lang.String getIndex()

Returns the index name of this TCP input.

Returns:

The index name, or null if not specified.

getKind

public InputKind getKind()

Returns the input kind of this TCP input.

Overrides:

getKind in class Input

Returns:

The input kind.

See Also:

InputKind

getQueue

public java.lang.String getQueue()

Returns the queue for this TCP input. Valid values are: "parsingQueue" and "indexQueue".

Returns:

The queue, or null if not specified.

getRcvBuf

public int getRcvBuf()

Deprecated. Returns the value of the _rcvbuf attribute for this TCP input.

Returns:

The _rcvbuf value.

getRestrictToHost

public java.lang.String getRestrictToHost()

Returns the incoming host restriction for this TCP input. When specified, this input only accepts data from the specified host.

Returns:

The incoming host restriction, or null if not specified.

getSource

public java.lang.String getSource()

Returns the initial source key for this TCP input. Typically this value is the input file path.

Returns:

The source key, or null if not specified.

getSourceType

public java.lang.String getSourceType()

Returns the source type for events from this TCP input.

Returns:

The source type, or null if not specified.

getSSL

public boolean getSSL()

Indicates whether this TCP input is using secure socket layer (SSL).

Returns:

true if this TCP input is using SSL, false if not.

setSSL

public void setSSL(boolean SSL)

Sets whether to use secure socket layer (SSL).

Parameters:

SSL - true to use SSL, false if not.

setConnectionHost

public void setConnectionHost(java.lang.String connection_host)

Sets the from-host for the remote server that is sending data. Valid values are:

• "ip": Sets the host to the IP address of the remote server sending data.
• "dns": Sets the host to the reverse DNS entry for the IP address of the remote server sending data.
• "none": Leaves the host as specified in inputs.conf, which is typically the Splunk system host name.

Parameters:

connection_host - The connection host information.

setDisabled

public void setDisabled(boolean disabled)

Sets whether this input is enabled or disabled. You can also do this using the Entity.disable and Entity.enable methods.

Parameters:

disabled - true to disabled to script input, false to enable.

See Also:

Entity.disable(), Entity.enable()

setHost

public void setHost(java.lang.String host)

Sets the host from which the indexer gets data.

Parameters:

host - The host name.

setIndex

public void setIndex(java.lang.String index)

Sets the index in which to store all generated events.

Parameters:

index - The index name.

setQueue

public void setQueue(java.lang.String queue)

Sets how the input processor should deposit the events it reads. Valid values are:

• parsingQueue: Applies props.conf and other parsing rules to your data.
• indexQueue: Sends your data directly into the index.

Parameters:

queue - The queue-processing type.

setRawTcpDoneTimeout

public void setRawTcpDoneTimeout(int rawTcpDoneTimeout)

Sets the timeout value for adding a Done key. If a connection over the input port specified by name remains idle after receiving data for this specified number of seconds, it adds a Done key, implying that the last event has been completely received.

Parameters:

rawTcpDoneTimeout - The timeout value, in seconds.

setRestrictToHost

public void setRestrictToHost(java.lang.String restrictToHost)

Sets a restriction to accept inputs from the specified host only.

Parameters:

restrictToHost - The host.

setSource

public void setSource(java.lang.String source)

Sets the initial value for the source key for events from this input. The source key is used during parsing and indexing. The source field is used for searches. As a convenience, the source string is prepended with "source::".

Note: Overriding the source key is generally not recommended. Typically, the input layer provides a more accurate string to aid in problem analysis and investigation, accurately recording the file from which the data was retrieved. Consider the use of source types, tagging, and search wildcards before overriding this value.

Parameters:

source - The source.

setSourceType

public void setSourceType(java.lang.String sourcetype)

Sets the source type for events from this input.

Parameters:

sourcetype - The source type.