org.apache.nifi.processors.kafka.pubsub

Class PublishKafkaRecord_1_0

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_1_0

All Implemented Interfaces:

ConfigurableComponent, Processor

@Tags(value={"Apache","Kafka","Record","csv","json","avro","logs","Put","Send","Message","PubSub","1.0"})
 @CapabilityDescription(value="Sends the contents of a FlowFile as individual records to Apache Kafka using the Kafka 1.0 Producer API. The contents of the FlowFile are expected to be record-oriented data that can be read by the configured Record Reader. The complementary NiFi processor for fetching messages is ConsumeKafkaRecord_1_0.")
 @InputRequirement(value=INPUT_REQUIRED)
 @DynamicProperty(name="The name of a Kafka configuration property.",
                 value="The value of a given Kafka configuration property.",
                 description="These properties will be added on the Kafka configuration after loading any provided configuration properties. In the event a dynamic property represents a property that was already set, its value will be ignored and WARN message logged. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration. ",
                 expressionLanguageScope=VARIABLE_REGISTRY)
 @WritesAttribute(attribute="msg.count",
                 description="The number of messages that were sent to Kafka for this FlowFile. This attribute is added only to FlowFiles that are routed to success.")
 @SeeAlso(value={PublishKafka_1_0.class,ConsumeKafka_1_0.class,ConsumeKafkaRecord_1_0.class})
public class PublishKafkaRecord_1_0
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static PropertyDescriptor	ACK_WAIT_TIME
(package private) static PropertyDescriptor	ATTRIBUTE_NAME_REGEX
(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	EXPRESSION_LANGUAGE_PARTITIONING
(package private) static AllowableValue	HEX_ENCODING
(package private) static PropertyDescriptor	MAX_REQUEST_SIZE
(package private) static PropertyDescriptor	MESSAGE_HEADER_ENCODING
(package private) static PropertyDescriptor	MESSAGE_KEY_FIELD
(package private) static PropertyDescriptor	METADATA_WAIT_TIME
protected static String	MSG_COUNT
(package private) static PropertyDescriptor	PARTITION
(package private) static PropertyDescriptor	PARTITION_CLASS
private static List<PropertyDescriptor>	PROPERTIES
private PublisherPool	publisherPool
(package private) static AllowableValue	RANDOM_PARTITIONING
(package private) static AllowableValue	RECORD_PATH_PARTITIONING
(package private) static PropertyDescriptor	RECORD_READER
(package private) static PropertyDescriptor	RECORD_WRITER
private RecordPathCache	recordPathCache
(package private) static Relationship	REL_FAILURE
(package private) static Relationship	REL_SUCCESS
private static Set<Relationship>	RELATIONSHIPS
(package private) static AllowableValue	ROUND_ROBIN_PARTITIONING
(package private) static PropertyDescriptor	TOPIC
(package private) static PropertyDescriptor	TRANSACTIONAL_ID_PREFIX
(package private) static PropertyDescriptor	USE_TRANSACTIONS
(package private) static AllowableValue	UTF8_ENCODING

Constructor Summary

Constructors

Constructor and Description
PublishKafkaRecord_1_0()

Method Summary

Modifier and Type	Method and Description
void	closePool()
protected PublisherPool	createPublisherPool(ProcessContext context)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private Integer	evaluateRecordPath(RecordPath recordPath, Record record)
private Function<Record,Integer>	getPartitioner(ProcessContext context, FlowFile flowFile)
private PublisherPool	getPublisherPool(ProcessContext context)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(ProcessContext context, ProcessSession session)

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

equals, getPropertyDescriptor, getPropertyDescriptors, 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

MSG_COUNT

protected static final String MSG_COUNT

See Also:

Constant Field Values

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

ROUND_ROBIN_PARTITIONING

static final AllowableValue ROUND_ROBIN_PARTITIONING

RANDOM_PARTITIONING

static final AllowableValue RANDOM_PARTITIONING

RECORD_PATH_PARTITIONING

static final AllowableValue RECORD_PATH_PARTITIONING

EXPRESSION_LANGUAGE_PARTITIONING

static final AllowableValue EXPRESSION_LANGUAGE_PARTITIONING

UTF8_ENCODING

static final AllowableValue UTF8_ENCODING

HEX_ENCODING

static final AllowableValue HEX_ENCODING

TOPIC

static final PropertyDescriptor TOPIC

RECORD_READER

static final PropertyDescriptor RECORD_READER

RECORD_WRITER

static final PropertyDescriptor RECORD_WRITER

MESSAGE_KEY_FIELD

static final PropertyDescriptor MESSAGE_KEY_FIELD

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

PARTITION_CLASS

static final PropertyDescriptor PARTITION_CLASS

PARTITION

static final PropertyDescriptor PARTITION

COMPRESSION_CODEC

static final PropertyDescriptor COMPRESSION_CODEC

ATTRIBUTE_NAME_REGEX

static final PropertyDescriptor ATTRIBUTE_NAME_REGEX

USE_TRANSACTIONS

static final PropertyDescriptor USE_TRANSACTIONS

TRANSACTIONAL_ID_PREFIX

static final PropertyDescriptor TRANSACTIONAL_ID_PREFIX

MESSAGE_HEADER_ENCODING

static final PropertyDescriptor MESSAGE_HEADER_ENCODING

REL_SUCCESS

static final Relationship REL_SUCCESS

REL_FAILURE

static final Relationship REL_FAILURE

PROPERTIES

private static final List<PropertyDescriptor> PROPERTIES

RELATIONSHIPS

private static final Set<Relationship> RELATIONSHIPS

publisherPool

private volatile PublisherPool publisherPool

recordPathCache

private final RecordPathCache recordPathCache

Constructor Detail

PublishKafkaRecord_1_0

public PublishKafkaRecord_1_0()

Method Detail

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

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

getPublisherPool

private PublisherPool getPublisherPool(ProcessContext context)

createPublisherPool

protected PublisherPool createPublisherPool(ProcessContext context)

closePool

@OnStopped
public void closePool()

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getPartitioner

private Function<Record,Integer> getPartitioner(ProcessContext context,
                                                FlowFile flowFile)

evaluateRecordPath

private Integer evaluateRecordPath(RecordPath recordPath,
                                   Record record)