Package org.graylog2.plugin.inputs

Class Extractor

java.lang.Object

org.graylog2.plugin.inputs.Extractor

All Implemented Interfaces:

EmbeddedPersistable

Direct Known Subclasses:

CopyInputExtractor, GrokExtractor, JsonExtractor, LookupTableExtractor, RegexExtractor, RegexReplaceExtractor, SplitAndIndexExtractor, SubstringExtractor

public abstract class Extractor
extends Object
implements EmbeddedPersistable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Extractor.ConditionType
static enum	Extractor.CursorStrategy
static class	Extractor.ReservedFieldException
static class	Extractor.Result
static enum	Extractor.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected final Extractor.ConditionType	conditionType
protected final String	conditionValue
protected final AtomicLong	converterExceptions
protected final List<Converter>	converters
protected final String	creatorUserId
protected final Extractor.CursorStrategy	cursorStrategy
protected final AtomicLong	exceptions
protected final Map<String,Object>	extractorConfig
static final String	FIELD_CONDITION_TYPE
static final String	FIELD_CONDITION_VALUE
static final String	FIELD_CONVERTER_CONFIG
static final String	FIELD_CONVERTER_TYPE
static final String	FIELD_CONVERTERS
static final String	FIELD_CREATOR_USER_ID
static final String	FIELD_CURSOR_STRATEGY
static final String	FIELD_EXTRACTOR_CONFIG
static final String	FIELD_ID
static final String	FIELD_ORDER
static final String	FIELD_SOURCE_FIELD
static final String	FIELD_TARGET_FIELD
static final String	FIELD_TITLE
static final String	FIELD_TYPE
protected final String	id
protected long	order
protected Pattern	regexConditionPattern
protected final String	sourceField
protected final Extractor.Type	superType
protected final String	targetField
protected final String	title

Constructor Summary

Constructors

Constructor	Description
Extractor(com.codahale.metrics.MetricRegistry metricRegistry, String id, String title, long order, Extractor.Type type, Extractor.CursorStrategy cursorStrategy, String sourceField, String targetField, Map<String,Object> extractorConfig, String creatorUserId, List<Converter> converters, Extractor.ConditionType conditionType, String conditionValue)

Method Summary

Modifier and Type	Method	Description
List<Map<String,Object>>	converterConfigMap()
String	getCompleteTimerName()
String	getConditionHitsCounterName()
String	getConditionMissesCounterName()
String	getConditionTimerName()
Extractor.ConditionType	getConditionType()
String	getConditionValue()
long	getConverterExceptionCount()
List<Converter>	getConverters()
String	getConverterTimerName()
String	getCreatorUserId()
Extractor.CursorStrategy	getCursorStrategy()
long	getExceptionCount()
String	getExecutionTimerName()
Map<String,Object>	getExtractorConfig()
String	getId()
Long	getOrder()
Map<String,Object>	getPersistedFields()
String	getSourceField()
String	getTargetField()
String	getTitle()
Extractor.Type	getType()
void	incrementExceptions()
protected abstract Extractor.Result[]	run(String field)	Performs the extractor run.
void	runExtractor(Message msg)
void	setOrder(long order)

Methods inherited from class java.lang.Object

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

Field Details

FIELD_ID

public static final String FIELD_ID

See Also:

• Constant Field Values

FIELD_TITLE

public static final String FIELD_TITLE

See Also:

• Constant Field Values

FIELD_ORDER

public static final String FIELD_ORDER

See Also:

• Constant Field Values

FIELD_TYPE

public static final String FIELD_TYPE

See Also:

• Constant Field Values

FIELD_CURSOR_STRATEGY

public static final String FIELD_CURSOR_STRATEGY

See Also:

• Constant Field Values

FIELD_TARGET_FIELD

public static final String FIELD_TARGET_FIELD

See Also:

• Constant Field Values

FIELD_SOURCE_FIELD

public static final String FIELD_SOURCE_FIELD

See Also:

• Constant Field Values

FIELD_CREATOR_USER_ID

public static final String FIELD_CREATOR_USER_ID

See Also:

• Constant Field Values

FIELD_EXTRACTOR_CONFIG

public static final String FIELD_EXTRACTOR_CONFIG

See Also:

• Constant Field Values

FIELD_CONDITION_TYPE

public static final String FIELD_CONDITION_TYPE

See Also:

• Constant Field Values

FIELD_CONDITION_VALUE

public static final String FIELD_CONDITION_VALUE

See Also:

• Constant Field Values

FIELD_CONVERTERS

public static final String FIELD_CONVERTERS

See Also:

• Constant Field Values

FIELD_CONVERTER_TYPE

public static final String FIELD_CONVERTER_TYPE

See Also:

• Constant Field Values

FIELD_CONVERTER_CONFIG

public static final String FIELD_CONVERTER_CONFIG

See Also:

• Constant Field Values

exceptions

protected final AtomicLong exceptions

converterExceptions

protected final AtomicLong converterExceptions

id

protected final String id

title

protected final String title

superType

protected final Extractor.Type superType

cursorStrategy

protected final Extractor.CursorStrategy cursorStrategy

targetField

protected final String targetField

sourceField

protected final String sourceField

creatorUserId

protected final String creatorUserId

extractorConfig

protected final Map<String,Object> extractorConfig

converters

protected final List<Converter> converters

conditionType

protected final Extractor.ConditionType conditionType

conditionValue

protected final String conditionValue

order

protected long order

regexConditionPattern

protected Pattern regexConditionPattern

Constructor Details

Extractor

public Extractor(com.codahale.metrics.MetricRegistry metricRegistry,
 String id,
 String title,
 long order,
 Extractor.Type type,
 Extractor.CursorStrategy cursorStrategy,
 String sourceField,
 String targetField,
 Map<String,Object> extractorConfig,
 String creatorUserId,
 List<Converter> converters,
 Extractor.ConditionType conditionType,
 String conditionValue)
          throws Extractor.ReservedFieldException

Throws:

Extractor.ReservedFieldException

Method Details

run

protected abstract Extractor.Result[] run(String field)

Performs the extractor run.

Parameters:

field - the field to extract

Returns:

the extraction result

Throws:

ExtractorException - if the extraction hit an error

runExtractor

public void runExtractor(Message msg)

getId

public String getId()

getTitle

public String getTitle()

getOrder

public Long getOrder()

setOrder

public void setOrder(long order)

getType

public Extractor.Type getType()

getCursorStrategy

public Extractor.CursorStrategy getCursorStrategy()

getTargetField

public String getTargetField()

getSourceField

public String getSourceField()

getExtractorConfig

public Map<String,Object> getExtractorConfig()

getCreatorUserId

public String getCreatorUserId()

getConditionValue

public String getConditionValue()

getConditionType

public Extractor.ConditionType getConditionType()

getPersistedFields

public Map<String,Object> getPersistedFields()

Specified by:

getPersistedFields in interface EmbeddedPersistable

getConverters

public List<Converter> getConverters()

converterConfigMap

public List<Map<String,Object>> converterConfigMap()

getConditionHitsCounterName

public String getConditionHitsCounterName()

getConditionMissesCounterName

public String getConditionMissesCounterName()

getConditionTimerName

public String getConditionTimerName()

getExecutionTimerName

public String getExecutionTimerName()

getConverterTimerName

public String getConverterTimerName()

getCompleteTimerName

public String getCompleteTimerName()

getExceptionCount

public long getExceptionCount()

getConverterExceptionCount

public long getConverterExceptionCount()

incrementExceptions

public void incrementExceptions()