LogstashIndexer (Logstash 2.5.0218.v0a_ff8fefc12b_ API)

java.lang.Object
- hudson.model.AbstractDescribableImpl<LogstashIndexer<?>>
- - jenkins.plugins.logstash.configuration.LogstashIndexer<T>

Type Parameters:

T - The class implementing the push to the indexer

All Implemented Interfaces:

ExtensionPoint, Describable<LogstashIndexer<?>>, ReconfigurableDescribable<LogstashIndexer<?>>

Direct Known Subclasses:

ElasticSearch, HostBasedLogstashIndexer
```
public abstract class LogstashIndexer<T extends AbstractLogstashIndexerDao>
extends AbstractDescribableImpl<LogstashIndexer<?>>
implements ExtensionPoint, ReconfigurableDescribable<LogstashIndexer<?>>
```
Extension point for logstash indexers. This extension point provides the configuration for the indexer. You also have to implement the actual indexer in a separate class extending AbstractLogstashIndexerDao.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class LogstashIndexer.LogstashIndexerDescriptor
- Nested classes/interfaces inherited from interface hudson.ExtensionPoint
  ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields
Modifier and Type Field Description

protected T instance

Constructor Summary

Constructors
Constructor Description

LogstashIndexer()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`static DescriptorExtensionList<LogstashIndexer<?>,Descriptor<LogstashIndexer<?>>>`	`all()`
`protected abstract T`	`createIndexerInstance()`	Creates a new `AbstractLogstashIndexerDao` instance corresponding to this configuration.
`T`	`getInstance()`	Gets the instance of the actual `AbstractLogstashIndexerDao` that is represented by this configuration.
`LogstashIndexer<T>`	`reconfigure(org.kohsuke.stapler.StaplerRequest req, net.sf.json.JSONObject form)`
`void`	`validate()`	Purpose of this method is to validate the inputs (if required) and if found erroneous throw an exception so that it will be bubbled up to the UI.

Methods inherited from class hudson.model.AbstractDescribableImpl
getDescriptor

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface hudson.model.Describable
getDescriptor

- Field Detail
  - instance
```
protected transient T extends AbstractLogstashIndexerDao instance
```
- Constructor Detail
  - LogstashIndexer
```
public LogstashIndexer()
```
- Method Detail
  - getInstance
```
@NonNull
public T getInstance()
```
    Gets the instance of the actual AbstractLogstashIndexerDao that is represented by this configuration.
    
    Returns:
    
    AbstractLogstashIndexerDao instance
  - validate
```
public void validate()
              throws Exception
```
    Purpose of this method is to validate the inputs (if required) and if found erroneous throw an exception so that it will be bubbled up to the UI.
    
    Throws:
    
    Exception - on erroneous input
  - createIndexerInstance
```
protected abstract T createIndexerInstance()
```
    Creates a new AbstractLogstashIndexerDao instance corresponding to this configuration.
    
    Returns:
    
    AbstractLogstashIndexerDao instance
  - all
```
public static DescriptorExtensionList<LogstashIndexer<?>,Descriptor<LogstashIndexer<?>>> all()
```
  - reconfigure
```
public LogstashIndexer<T> reconfigure(org.kohsuke.stapler.StaplerRequest req,
                                      net.sf.json.JSONObject form)
                               throws Descriptor.FormException
```
    Specified by:
    
    reconfigure in interface ReconfigurableDescribable<T extends AbstractLogstashIndexerDao>
    
    Throws:
    
    Descriptor.FormException