org.apache.nifi.record.sink.kafka

Class KafkaRecordSink_1_0

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.record.sink.kafka.KafkaRecordSink_1_0

All Implemented Interfaces:

ConfigurableComponent, ControllerService, RecordSinkService

@Tags(value={"kafka","record","sink"})
 @CapabilityDescription(value="Provides a service to write records to a Kafka 1.x topic.")
public class KafkaRecordSink_1_0
extends AbstractControllerService
implements RecordSinkService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	KafkaRecordSink_1_0.KafkaSendException

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	ACK_WAIT_TIME
(package private) static PropertyDescriptor	COMPRESSION_CODEC
(package private) static AllowableValue	DELIVERY_BEST_EFFORT
(package private) static PropertyDescriptor	DELIVERY_GUARANTEE
(package private) static AllowableValue	DELIVERY_ONE_NODE
(package private) static AllowableValue	DELIVERY_REPLICATED
(package private) static AllowableValue	HEX_ENCODING
(package private) static PropertyDescriptor	MAX_REQUEST_SIZE
private long	maxAckWaitMillis
private int	maxMessageSize
(package private) static PropertyDescriptor	MESSAGE_HEADER_ENCODING
(package private) static PropertyDescriptor	METADATA_WAIT_TIME
private org.apache.kafka.clients.producer.Producer<byte[],byte[]>	producer
private List<PropertyDescriptor>	properties
private String	topic
(package private) static PropertyDescriptor	TOPIC
(package private) static AllowableValue	UTF8_ENCODING
private RecordSetWriterFactory	writerFactory

Fields inherited from interface org.apache.nifi.record.sink.RecordSinkService

RECORD_WRITER_FACTORY

Constructor Summary

Constructors

Constructor and Description
KafkaRecordSink_1_0()

Method Summary

Modifier and Type	Method and Description
(package private) static void	buildCommonKafkaProperties(ConfigurationContext context, Class<?> kafkaConfigClass, Map<String,Object> mapToPopulate)
protected org.apache.kafka.clients.producer.Producer<byte[],byte[]>	createProducer(Map<String,Object> kafkaProperties)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected RecordSetWriterFactory	getWriterFactory()
protected void	init(ControllerServiceInitializationContext context)
void	onEnabled(ConfigurationContext context)
WriteResult	sendData(RecordSet recordSet, Map<String,String> attributes, boolean sendZeroResults)
private static void	setJaasConfig(Map<String,Object> mapToPopulate, ConfigurationContext context) Method used to configure the 'sasl.jaas.config' property based on KAFKA-4259 https://cwiki.apache.org/confluence/display/KAFKA/KIP-85%3A+Dynamic+JAAS+configuration+for+Kafka+clients It expects something with the following format: <LoginModuleClass> <ControlFlag> *(<OptionName>=<OptionValue>); ControlFlag = required / requisite / sufficient / optional
void	stop()

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

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

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

equals, getPropertyDescriptor, getPropertyDescriptors, 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.record.sink.RecordSinkService

reset

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

DELIVERY_REPLICATED

static final AllowableValue DELIVERY_REPLICATED

DELIVERY_ONE_NODE

static final AllowableValue DELIVERY_ONE_NODE

DELIVERY_BEST_EFFORT

static final AllowableValue DELIVERY_BEST_EFFORT

UTF8_ENCODING

static final AllowableValue UTF8_ENCODING

HEX_ENCODING

static final AllowableValue HEX_ENCODING

TOPIC

static final PropertyDescriptor TOPIC

DELIVERY_GUARANTEE

static final PropertyDescriptor DELIVERY_GUARANTEE

METADATA_WAIT_TIME

static final PropertyDescriptor METADATA_WAIT_TIME

ACK_WAIT_TIME

static final PropertyDescriptor ACK_WAIT_TIME

MAX_REQUEST_SIZE

static final PropertyDescriptor MAX_REQUEST_SIZE

COMPRESSION_CODEC

static final PropertyDescriptor COMPRESSION_CODEC

MESSAGE_HEADER_ENCODING

static final PropertyDescriptor MESSAGE_HEADER_ENCODING

properties

private List<PropertyDescriptor> properties

writerFactory

private volatile RecordSetWriterFactory writerFactory

maxMessageSize

private volatile int maxMessageSize

maxAckWaitMillis

private volatile long maxAckWaitMillis

topic

private volatile String topic

producer

private volatile org.apache.kafka.clients.producer.Producer<byte[],byte[]> producer

Constructor Detail

KafkaRecordSink_1_0

public KafkaRecordSink_1_0()

Method Detail

init

protected void init(ControllerServiceInitializationContext context)
             throws InitializationException

Overrides:

init in class AbstractControllerService

Throws:

InitializationException

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onEnabled

@OnEnabled
public void onEnabled(ConfigurationContext context)
                          throws InitializationException

Throws:

InitializationException

sendData

public WriteResult sendData(RecordSet recordSet,
                            Map<String,String> attributes,
                            boolean sendZeroResults)
                     throws IOException

Specified by:

sendData in interface RecordSinkService

Throws:

IOException

stop

@OnDisabled
public void stop()
                      throws IOException

Throws:

IOException

buildCommonKafkaProperties

static void buildCommonKafkaProperties(ConfigurationContext context,
                                       Class<?> kafkaConfigClass,
                                       Map<String,Object> mapToPopulate)

setJaasConfig

private static void setJaasConfig(Map<String,Object> mapToPopulate,
                                  ConfigurationContext context)

Method used to configure the 'sasl.jaas.config' property based on KAFKA-4259
https://cwiki.apache.org/confluence/display/KAFKA/KIP-85%3A+Dynamic+JAAS+configuration+for+Kafka+clients

It expects something with the following format:

<LoginModuleClass> <ControlFlag> *(<OptionName>=<OptionValue>);
ControlFlag = required / requisite / sufficient / optional

Parameters:

mapToPopulate - Map of configuration properties

context - Context

getWriterFactory

protected RecordSetWriterFactory getWriterFactory()

createProducer

protected org.apache.kafka.clients.producer.Producer<byte[],byte[]> createProducer(Map<String,Object> kafkaProperties)