org.apache.nifi.syslog

Class SyslogReader

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.serialization.SchemaRegistryService

org.apache.nifi.syslog.SyslogReader

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordReaderFactory

@Tags(value={"syslog","logs","logfiles","parse","text","record","reader"})
 @CapabilityDescription(value="Attempts to parses the contents of a Syslog message in accordance to RFC5424 and RFC3164. In the case of RFC5424 formatted messages, structured data is not supported, and will be returned as part of the message.Note: Be mindfull that RFC3164 is informational and a wide range of different implementations are present in the wild.")
public class SyslogReader
extends SchemaRegistryService
implements RecordReaderFactory

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ADD_RAW
static PropertyDescriptor	CHARSET
(package private) static AllowableValue	GENERIC_SYSLOG_SCHEMA
static String	GENERIC_SYSLOG_SCHEMA_NAME
private static boolean	includeRaw
private SyslogParser	parser
(package private) static String	RAW_MESSAGE_NAME
private RecordSchema	recordSchema

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

schemaAccessStrategy

Constructor Summary

Constructors

Constructor and Description
SyslogReader()

Method Summary

Modifier and Type	Method and Description
private SchemaAccessStrategy	createAccessStrategy()
RecordReader	createRecordReader(Map<String,String> variables, InputStream in, long inputLength, ComponentLog logger)
(package private) static RecordSchema	createRecordSchema()
protected AllowableValue	getDefaultSchemaAccessStrategy()
protected SchemaAccessStrategy	getSchemaAccessStrategy(String strategy, SchemaRegistry schemaRegistry, PropertyContext context)
protected List<AllowableValue>	getSchemaAccessStrategyValues()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onEnabled(ConfigurationContext context)

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

buildStrategyProperty, customValidate, getConfigurationContext, getSchema, getSchema, getSchemaAccessStrategy, getSchemaAcessStrategyDescriptor, getSuppliedSchemaFields, 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.serialization.RecordReaderFactory

createRecordReader

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

initialize, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

GENERIC_SYSLOG_SCHEMA_NAME

public static final String GENERIC_SYSLOG_SCHEMA_NAME

See Also:

Constant Field Values

GENERIC_SYSLOG_SCHEMA

static final AllowableValue GENERIC_SYSLOG_SCHEMA

RAW_MESSAGE_NAME

static final String RAW_MESSAGE_NAME

See Also:

Constant Field Values

CHARSET

public static final PropertyDescriptor CHARSET

ADD_RAW

public static final PropertyDescriptor ADD_RAW

parser

private volatile SyslogParser parser

includeRaw

private static volatile boolean includeRaw

recordSchema

private volatile RecordSchema recordSchema

Constructor Detail

SyslogReader

public SyslogReader()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class SchemaRegistryService

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)

getSchemaAccessStrategyValues

protected List<AllowableValue> getSchemaAccessStrategyValues()

Overrides:

getSchemaAccessStrategyValues in class SchemaRegistryService

getDefaultSchemaAccessStrategy

protected AllowableValue getDefaultSchemaAccessStrategy()

Overrides:

getDefaultSchemaAccessStrategy in class SchemaRegistryService

getSchemaAccessStrategy

protected SchemaAccessStrategy getSchemaAccessStrategy(String strategy,
                                                       SchemaRegistry schemaRegistry,
                                                       PropertyContext context)

Overrides:

getSchemaAccessStrategy in class SchemaRegistryService

createRecordSchema

static RecordSchema createRecordSchema()

createAccessStrategy

private SchemaAccessStrategy createAccessStrategy()

createRecordReader

public RecordReader createRecordReader(Map<String,String> variables,
                                       InputStream in,
                                       long inputLength,
                                       ComponentLog logger)
                                throws IOException,
                                       SchemaNotFoundException

Specified by:

createRecordReader in interface RecordReaderFactory

Throws:

IOException

SchemaNotFoundException