LogstashIndexerDao (Logstash 2.5.0218.v0a_ff8fefc12b_ API)

All Known Implementing Classes:

AbstractLogstashIndexerDao, ElasticSearchDao, HostBasedLogstashIndexerDao, LogstashDao, RabbitMqDao, RedisDao, SyslogDao
```
public interface LogstashIndexerDao
```
Interface describing data access objects for Logstash indexers.

Since:

1.0.0

Author:

Rusty Gerard

Nested Class Summary

Nested Classes
Modifier and Type	Interface	Description
`static class`	`LogstashIndexerDao.IndexerType`	Deprecated.
`static class`	`LogstashIndexerDao.SyslogFormat`	Deprecated.
`static class`	`LogstashIndexerDao.SyslogProtocol`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`net.sf.json.JSONObject`	`buildPayload(BuildData buildData, String jenkinsUrl, List<String> logLines)`	Builds a JSON payload compatible with the Logstash schema.
`String`	`getDescription()`
`void`	`push(String data)`	Sends the log data to the Logstash indexer.

- Method Detail
  - getDescription
```
String getDescription()
```
  - push
```
void push(String data)
   throws IOException
```
    Sends the log data to the Logstash indexer.
    
    Parameters:
    
    data - The serialized data, not null
    
    Throws:
    
    IOException - The data is not written to the server
  - buildPayload
```
net.sf.json.JSONObject buildPayload(BuildData buildData,
                                    String jenkinsUrl,
                                    List<String> logLines)
```
    Builds a JSON payload compatible with the Logstash schema.
    
    Parameters:
    
    buildData - Metadata about the current build, not null
    
    jenkinsUrl - The host name of the Jenkins instance, not null
    
    logLines - The log data to transmit, not null
    
    Returns:
    
    The formatted JSON object, never null