org.apache.nifi.processors.standard

Class ParseCEF

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ParseCEF

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SideEffectFree
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"logs","cef","attributes","system","event","message"})
 @CapabilityDescription(value="Parses the contents of a CEF formatted message and adds attributes to the FlowFile for headers and extensions of the parts of the CEF message.\nNote: This Processor expects CEF messages WITHOUT the syslog headers (i.e. starting at \"CEF:0\"")
 @WritesAttribute(attribute="cef.header.version",description="The version of the CEF message.") @WritesAttribute(attribute="cef.header.deviceVendor",description="The Device Vendor of the CEF message.") @WritesAttribute(attribute="cef.header.deviceProduct",description="The Device Product of the CEF message.") @WritesAttribute(attribute="cef.header.deviceVersion",description="The Device Version of the CEF message.") @WritesAttribute(attribute="cef.header.deviceEventClassId",description="The Device Event Class ID of the CEF message.") @WritesAttribute(attribute="cef.header.name",description="The name of the CEF message.") @WritesAttribute(attribute="cef.header.severity",description="The severity of the CEF message.") @WritesAttribute(attribute="cef.extension.*",description="The key and value generated by the parsing of the message.")
 @SeeAlso(value=ParseSyslog.class)
public class ParseCEF
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ParseCEF.MacAddressToStringSerializer
protected static class	ParseCEF.ValidateLocale

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ACCEPT_EMPTY_EXTENSIONS
static PropertyDescriptor	APPEND_RAW_MESSAGE_TO_JSON
static PropertyDescriptor	DATETIME_REPRESENTATION
private static DateTimeFormatter	dateTimeFormatter
static String	DESTINATION_ATTRIBUTES
static String	DESTINATION_CONTENT
static PropertyDescriptor	FIELDS_DESTINATION
static PropertyDescriptor	INCLUDE_CUSTOM_EXTENSIONS
static String	LOCAL_TZ
private static com.fasterxml.jackson.databind.ObjectMapper	mapper
(package private) static Relationship	REL_FAILURE
(package private) static Relationship	REL_SUCCESS
private SimpleDateFormat	simpleDateFormat
static PropertyDescriptor	TIME_REPRESENTATION
private String	tzId
static String	UTC
static PropertyDescriptor	VALIDATE_DATA
(package private) javax.validation.Validator	validator

Constructor Summary

Constructors

Constructor and Description
ParseCEF()

Method Summary

Modifier and Type	Method and Description
Set<Relationship>	getRelationships()
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	OnScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private String	prettyResult(Object entryValue, String tzID)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

dateTimeFormatter

private static final DateTimeFormatter dateTimeFormatter

simpleDateFormat

private final SimpleDateFormat simpleDateFormat

tzId

private String tzId

mapper

private static final com.fasterxml.jackson.databind.ObjectMapper mapper

DESTINATION_CONTENT

public static final String DESTINATION_CONTENT

See Also:

Constant Field Values

DESTINATION_ATTRIBUTES

public static final String DESTINATION_ATTRIBUTES

See Also:

Constant Field Values

FIELDS_DESTINATION

public static final PropertyDescriptor FIELDS_DESTINATION

APPEND_RAW_MESSAGE_TO_JSON

public static final PropertyDescriptor APPEND_RAW_MESSAGE_TO_JSON

INCLUDE_CUSTOM_EXTENSIONS

public static final PropertyDescriptor INCLUDE_CUSTOM_EXTENSIONS

ACCEPT_EMPTY_EXTENSIONS

public static final PropertyDescriptor ACCEPT_EMPTY_EXTENSIONS

VALIDATE_DATA

public static final PropertyDescriptor VALIDATE_DATA

UTC

public static final String UTC

See Also:

Constant Field Values

LOCAL_TZ

public static final String LOCAL_TZ

See Also:

Constant Field Values

TIME_REPRESENTATION

public static final PropertyDescriptor TIME_REPRESENTATION

DATETIME_REPRESENTATION

public static final PropertyDescriptor DATETIME_REPRESENTATION

REL_FAILURE

static final Relationship REL_FAILURE

REL_SUCCESS

static final Relationship REL_SUCCESS

validator

final javax.validation.Validator validator

Constructor Detail

ParseCEF

public ParseCEF()

Method Detail

getSupportedPropertyDescriptors

public List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

OnScheduled

@OnScheduled
public void OnScheduled(ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

prettyResult

private String prettyResult(Object entryValue,
                            String tzID)