jenkins.plugins.logstash.persistence

Class AbstractLogstashIndexerDao

java.lang.Object

jenkins.plugins.logstash.persistence.AbstractLogstashIndexerDao

All Implemented Interfaces:

LogstashIndexerDao

Direct Known Subclasses:

ElasticSearchDao, RabbitMqDao, RedisDao, SyslogDao

public abstract class AbstractLogstashIndexerDao
extends Object
implements LogstashIndexerDao

Abstract data access object for Logstash indexers.

Since:

1.0.0

Author:

Rusty Gerard

Nested Class Summary

Nested classes/interfaces inherited from interface jenkins.plugins.logstash.persistence.LogstashIndexerDao

LogstashIndexerDao.IndexerType, LogstashIndexerDao.SyslogFormat, LogstashIndexerDao.SyslogProtocol

Field Summary

Fields

Modifier and Type	Field and Description
protected String	host
protected String	key
protected String	password
protected int	port
protected String	username

Constructor Summary

Constructors

Constructor and Description
AbstractLogstashIndexerDao(String host, int port, String key, String username, String password)

Method Summary

Modifier and Type	Method and Description
net.sf.json.JSONObject	buildPayload(BuildData buildData, String jenkinsUrl, List<String> logLines) Builds a JSON payload compatible with the Logstash schema.
Charset	getCharset() Gets the configured charset used to push data to the indexer
String	getDescription()
void	setCharset(Charset charset) Sets the charset used to push data to the indexer

Methods inherited from class java.lang.Object

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

Methods inherited from interface jenkins.plugins.logstash.persistence.LogstashIndexerDao

getIndexerType, push

Field Detail

host

protected final String host

port

protected final int port

key

protected final String key

username

protected final String username

password

protected final String password

Constructor Detail

AbstractLogstashIndexerDao

public AbstractLogstashIndexerDao(String host,
                                  int port,
                                  String key,
                                  String username,
                                  String password)

Method Detail

setCharset

public void setCharset(Charset charset)

Sets the charset used to push data to the indexer

Specified by:

setCharset in interface LogstashIndexerDao

Parameters:

charset - The charset to push data

getCharset

public Charset getCharset()

Gets the configured charset used to push data to the indexer

Returns:

charste to push data

buildPayload

public net.sf.json.JSONObject buildPayload(BuildData buildData,
                                           String jenkinsUrl,
                                           List<String> logLines)

Description copied from interface: LogstashIndexerDao

Builds a JSON payload compatible with the Logstash schema.

Specified by:

buildPayload in interface LogstashIndexerDao

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

getDescription

public String getDescription()

Specified by:

getDescription in interface LogstashIndexerDao