com.splunk

Class Receiver

java.lang.Object

com.splunk.Receiver

public class Receiver
extends Object

The Receiver class represents a named index and unnamed index receivers.

Method Summary

Modifier and Type	Method and Description
Socket	attach() Creates a writable socket to this index.
Socket	attach(Args args) Creates a writable socket to this index.
Socket	attach(String indexName) Creates a writable socket to this index.
Socket	attach(String indexName, Args args) Creates a writable socket to this index.
void	log(Args args, String data) Submits an event to this index through HTTP POST.
void	log(String data) Submits an event to this index through HTTP POST.
void	log(String indexName, Args args, String data) Logs an event to this index through HTTP POST.
void	log(String indexName, String data) Submits an event to this index through HTTP POST.
void	submit(Args args, String data) Submits an event to this index through HTTP POST.
void	submit(String data) Submits an event to this index through HTTP POST.
void	submit(String indexName, Args args, String data) Logs an event to this index through HTTP POST.
void	submit(String indexName, String data) Submits an event to this index through HTTP POST.

Methods inherited from class java.lang.Object

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

Method Detail

attach

public Socket attach()
              throws IOException

Creates a writable socket to this index.

Returns:

The socket.

Throws:

IOException - The IOException instance

attach

public Socket attach(String indexName)
              throws IOException

Creates a writable socket to this index.

Parameters:

indexName - The index to write to.

Returns:

The socket.

Throws:

IOException - The IOException instance

attach

public Socket attach(Args args)
              throws IOException

Creates a writable socket to this index.

Parameters:

args - Optional arguments for this stream. Valid parameters are: "host", "host_regex", "source", and "sourcetype".

Returns:

The socket.

Throws:

IOException - The IOException instance

attach

public Socket attach(String indexName,
                     Args args)
              throws IOException

Creates a writable socket to this index.

Parameters:

indexName - The index to write to.

args - Optional arguments for this stream. Valid parameters are: "host", "host_regex", "source", and "sourcetype".

Returns:

The socket.

Throws:

IOException - The IOException instance

submit

public void submit(String data)

Submits an event to this index through HTTP POST.

Parameters:

data - A string containing event data.

submit

public void submit(String indexName,
                   String data)

Submits an event to this index through HTTP POST.

Parameters:

indexName - The index to write to.

data - A string containing event data.

submit

public void submit(Args args,
                   String data)

Submits an event to this index through HTTP POST.

Parameters:

data - A string containing event data.

args - Optional arguments for this stream. Valid parameters are: "host", "host_regex", "source", and "sourcetype".

submit

public void submit(String indexName,
                   Args args,
                   String data)

Logs an event to this index through HTTP POST.

Parameters:

indexName - The index to write to.

data - A string containing event data.

args - Optional arguments for this stream. Valid parameters are: "host", "host_regex", "source", and "sourcetype".

log

public void log(String data)

Submits an event to this index through HTTP POST. This method is an alias for submit().

Parameters:

data - A string containing event data.

log

public void log(String indexName,
                String data)

Submits an event to this index through HTTP POST. This method is an alias for submit().

Parameters:

indexName - The index to write to.

data - A string containing event data.

log

public void log(Args args,
                String data)

Submits an event to this index through HTTP POST. This method is an alias for submit().

Parameters:

args - Optional arguments for this stream. Valid parameters are: "host", "host_regex", "source", and "sourcetype".

data - A string containing event data.

log

public void log(String indexName,
                Args args,
                String data)

Logs an event to this index through HTTP POST. This method is an alias for submit().

Parameters:

indexName - The index to write to.

args - Optional arguments for this stream. Valid parameters are: "host", "host_regex", "source", and "sourcetype".

data - A string containing event data.