Package org.apache.nifi.syslog

Class Syslog5424Reader

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.serialization.SchemaRegistryService

org.apache.nifi.syslog.Syslog5424Reader

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordReaderFactory

@Tags({"syslog 5424","syslog","logs","logfiles","parse","text","record","reader"})
@CapabilityDescription("Provides a mechanism for reading RFC 5424 compliant Syslog data, such as log files, and structuring the data so that it can be processed.")
public class Syslog5424Reader
extends SchemaRegistryService
implements RecordReaderFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyDescriptor	ADD_RAW
private Charset	charset
static final PropertyDescriptor	CHARSET
private boolean	includeRaw
private StrictSyslog5424Parser	parser
(package private) static final String	RAW_MESSAGE_NAME
private RecordSchema	recordSchema
(package private) static final AllowableValue	RFC_5424_SCHEMA
static final String	RFC_5424_SCHEMA_NAME

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

schemaAccessStrategy

Constructor Summary

Constructors

Constructor	Description
Syslog5424Reader()

Method Summary

Modifier and Type	Method	Description
private SchemaAccessStrategy	createAccessStrategy()
RecordReader	createRecordReader(Map<String,String> variables, InputStream in, long inputLength, ComponentLog logger)
(package private) 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, 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

RFC_5424_SCHEMA_NAME

public static final String RFC_5424_SCHEMA_NAME

See Also:

• Constant Field Values

RFC_5424_SCHEMA

static final AllowableValue RFC_5424_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

charset

private volatile Charset charset

parser

private volatile StrictSyslog5424Parser parser

includeRaw

private volatile boolean includeRaw

recordSchema

private volatile RecordSchema recordSchema

Constructor Details

Syslog5424Reader

public Syslog5424Reader()

Method Details

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

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