org.apache.camel.model.dataformat

Class GrokDataFormat

java.lang.Object

org.apache.camel.model.IdentifiedType

org.apache.camel.model.DataFormatDefinition

org.apache.camel.model.dataformat.GrokDataFormat

All Implemented Interfaces:

DefinitionPropertyPlaceholderConfigurer, OtherAttributesAware, org.apache.camel.spi.PropertyConfigurer, org.apache.camel.spi.PropertyPlaceholderConfigurer

@Metadata(label="dataformat,transformation",
          title="Grok",
          firstVersion="3.0.0")
public class GrokDataFormat
extends DataFormatDefinition

The Grok data format is used for unmarshalling unstructured data to objects using Logstash based Grok patterns.

Constructor Summary

Constructors

Constructor and Description
GrokDataFormat()

Method Summary

Modifier and Type	Method and Description
String	getPattern()
boolean	isAllowMultipleMatchesPerLine()
boolean	isFlattened()
boolean	isNamedOnly()
void	setAllowMultipleMatchesPerLine(boolean allowMultipleMatchesPerLine) If false, every line of input is matched for pattern only once.
void	setFlattened(boolean flattened) Turns on flattened mode.
void	setNamedOnly(boolean namedOnly) Whether to capture named expressions only or not (i.e.
void	setPattern(String pattern) The grok pattern to match lines of input
String	toString()

Methods inherited from class org.apache.camel.model.DataFormatDefinition

getContentTypeHeader, getDataFormat, getDataFormatName, getOtherAttributes, getShortName, setContentTypeHeader, setDataFormat, setDataFormatName, setOtherAttributes

Methods inherited from class org.apache.camel.model.IdentifiedType

getId, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.camel.model.DefinitionPropertyPlaceholderConfigurer

getReadPropertyPlaceholderOptions, getWritePropertyPlaceholderOptions

Constructor Detail

GrokDataFormat

public GrokDataFormat()

Method Detail

getPattern

public String getPattern()

setPattern

public void setPattern(String pattern)

The grok pattern to match lines of input

isFlattened

public boolean isFlattened()

setFlattened

public void setFlattened(boolean flattened)

Turns on flattened mode. In flattened mode the exception is thrown when there are multiple pattern matches with same key.

isAllowMultipleMatchesPerLine

public boolean isAllowMultipleMatchesPerLine()

setAllowMultipleMatchesPerLine

public void setAllowMultipleMatchesPerLine(boolean allowMultipleMatchesPerLine)

If false, every line of input is matched for pattern only once. Otherwise the line can be scanned multiple times when non-terminal pattern is used.

isNamedOnly

public boolean isNamedOnly()

setNamedOnly

public void setNamedOnly(boolean namedOnly)

Whether to capture named expressions only or not (i.e. %{IP:ip} but not ${IP})

toString

public String toString()

Overrides:

toString in class Object