Package org.apache.nifi.cef

Class CEFReader

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.serialization.SchemaRegistryService

org.apache.nifi.cef.CEFReader

All Implemented Interfaces:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.controller.ControllerService, RecordReaderFactory

@Tags({"cef","record","reader","parser"})
@CapabilityDescription("Parses CEF (Common Event Format) events, returning each row as a record. This reader allows for inferring a schema based on the first event in the FlowFile or providing an explicit schema for interpreting the values.")
public final class CEFReader
extends SchemaRegistryService
implements RecordReaderFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	CEFReader.ValidateRawField

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final org.apache.nifi.components.PropertyDescriptor	ACCEPT_EMPTY_EXTENSIONS
private boolean	acceptEmptyExtensions
(package private) static final org.apache.nifi.components.AllowableValue	CUSTOM_EXTENSIONS_AS_STRINGS
(package private) static final org.apache.nifi.components.AllowableValue	CUSTOM_EXTENSIONS_INFERRED
(package private) static final org.apache.nifi.components.PropertyDescriptor	DATETIME_REPRESENTATION
(package private) static final org.apache.nifi.components.AllowableValue	HEADERS_AND_EXTENSIONS
(package private) static final org.apache.nifi.components.AllowableValue	HEADERS_ONLY
private boolean	includeCustomExtensions
(package private) static final org.apache.nifi.components.PropertyDescriptor	INFERENCE_STRATEGY
(package private) static final org.apache.nifi.components.PropertyDescriptor	INVALID_FIELD
private String	invalidField
private Locale	parcefoneLocale
private final com.fluenda.parcefone.parser.CEFParser	parser
(package private) static final org.apache.nifi.components.PropertyDescriptor	RAW_FIELD
private String	rawMessageField

Fields inherited from class org.apache.nifi.serialization.SchemaRegistryService

schemaAccessStrategy

Constructor Summary

Constructors

Constructor	Description
CEFReader()

Method Summary

Modifier and Type	Method	Description
RecordReader	createRecordReader(Map<String,String> variables, InputStream in, long inputLength, org.apache.nifi.logging.ComponentLog logger)
protected org.apache.nifi.components.AllowableValue	getDefaultSchemaAccessStrategy()
protected SchemaAccessStrategy	getSchemaAccessStrategy(String strategy, SchemaRegistry schemaRegistry, org.apache.nifi.context.PropertyContext context)
protected List<org.apache.nifi.components.AllowableValue>	getSchemaAccessStrategyValues()
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onEnabled(org.apache.nifi.controller.ConfigurationContext context)

Methods inherited from class org.apache.nifi.serialization.SchemaRegistryService

buildStrategyProperty, customValidate, getConfigurationContext, getSchema, getSchema, getSchemaAccessStrategy, getSchemaAccessStrategyDescriptor, getSuppliedSchemaFields, migrateProperties, storeSchemaAccessStrategy

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, getProperty, getStateManager, init, initialize, isEnabled

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize, isStateful, migrateProperties

Methods inherited from interface org.apache.nifi.serialization.RecordReaderFactory

createRecordReader

Field Details

HEADERS_ONLY

static final org.apache.nifi.components.AllowableValue HEADERS_ONLY

HEADERS_AND_EXTENSIONS

static final org.apache.nifi.components.AllowableValue HEADERS_AND_EXTENSIONS

CUSTOM_EXTENSIONS_AS_STRINGS

static final org.apache.nifi.components.AllowableValue CUSTOM_EXTENSIONS_AS_STRINGS

CUSTOM_EXTENSIONS_INFERRED

static final org.apache.nifi.components.AllowableValue CUSTOM_EXTENSIONS_INFERRED

INFERENCE_STRATEGY

static final org.apache.nifi.components.PropertyDescriptor INFERENCE_STRATEGY

RAW_FIELD

static final org.apache.nifi.components.PropertyDescriptor RAW_FIELD

INVALID_FIELD

static final org.apache.nifi.components.PropertyDescriptor INVALID_FIELD

DATETIME_REPRESENTATION

static final org.apache.nifi.components.PropertyDescriptor DATETIME_REPRESENTATION

ACCEPT_EMPTY_EXTENSIONS

static final org.apache.nifi.components.PropertyDescriptor ACCEPT_EMPTY_EXTENSIONS

parser

private final com.fluenda.parcefone.parser.CEFParser parser

rawMessageField

private volatile String rawMessageField

invalidField

private volatile String invalidField

parcefoneLocale

private volatile Locale parcefoneLocale

includeCustomExtensions

private volatile boolean includeCustomExtensions

acceptEmptyExtensions

private volatile boolean acceptEmptyExtensions

Constructor Details

CEFReader

public CEFReader()

Method Details

getSupportedPropertyDescriptors

protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class SchemaRegistryService

getSchemaAccessStrategyValues

protected List<org.apache.nifi.components.AllowableValue> getSchemaAccessStrategyValues()

Overrides:

getSchemaAccessStrategyValues in class SchemaRegistryService

getDefaultSchemaAccessStrategy

protected org.apache.nifi.components.AllowableValue getDefaultSchemaAccessStrategy()

Overrides:

getDefaultSchemaAccessStrategy in class SchemaRegistryService

getSchemaAccessStrategy

protected SchemaAccessStrategy getSchemaAccessStrategy(String strategy,
 SchemaRegistry schemaRegistry,
 org.apache.nifi.context.PropertyContext context)

Overrides:

getSchemaAccessStrategy in class SchemaRegistryService

onEnabled

@OnEnabled
public void onEnabled(org.apache.nifi.controller.ConfigurationContext context)

createRecordReader

public RecordReader createRecordReader(Map<String,String> variables,
 InputStream in,
 long inputLength,
 org.apache.nifi.logging.ComponentLog logger)
                                throws MalformedRecordException,
IOException,
SchemaNotFoundException

Specified by:

createRecordReader in interface RecordReaderFactory

Throws:

MalformedRecordException

IOException

SchemaNotFoundException