org.apache.nifi.processors.kafka.pubsub

Class ConsumeKafka_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.ConsumeKafka_1_0

All Implemented Interfaces:

ConfigurableComponent, Processor

@CapabilityDescription(value="Consumes messages from Apache Kafka specifically built against the Kafka 1.0 Consumer API. The complementary NiFi processor for sending messages is PublishKafka_1_0.")
 @Tags(value={"Kafka","Get","Ingest","Ingress","Topic","PubSub","Consume","1.0"})
 @WritesAttribute(attribute="kafka.count",description="The number of messages written if more than one") @WritesAttribute(attribute="kafka.key",description="The key of message if present and if single message. How the key is encoded depends on the value of the \'Key Attribute Encoding\' property.") @WritesAttribute(attribute="kafka.offset",description="The offset of the message in the partition of the topic.") @WritesAttribute(attribute="kafka.timestamp",description="The timestamp of the message in the partition of the topic.") @WritesAttribute(attribute="kafka.partition",description="The partition of the topic the message or message bundle is from") @WritesAttribute(attribute="kafka.topic",description="The topic the message or message bundle is from")
 @InputRequirement(value=INPUT_FORBIDDEN)
 @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)
public class ConsumeKafka_1_0
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
private Set<ConsumerLease>	activeLeases
(package private) static PropertyDescriptor	AUTO_OFFSET_RESET
private ConsumerPool	consumerPool
(package private) static List<PropertyDescriptor>	DESCRIPTORS
(package private) static PropertyDescriptor	GROUP_ID
(package private) static PropertyDescriptor	HEADER_NAME_REGEX
(package private) static PropertyDescriptor	HONOR_TRANSACTIONS
(package private) static PropertyDescriptor	KEY_ATTRIBUTE_ENCODING
(package private) static PropertyDescriptor	MAX_POLL_RECORDS
(package private) static PropertyDescriptor	MAX_UNCOMMITTED_TIME
(package private) static PropertyDescriptor	MESSAGE_DEMARCATOR
(package private) static PropertyDescriptor	MESSAGE_HEADER_ENCODING
(package private) static AllowableValue	OFFSET_EARLIEST
(package private) static AllowableValue	OFFSET_LATEST
(package private) static AllowableValue	OFFSET_NONE
(package private) static Relationship	REL_SUCCESS
(package private) static Set<Relationship>	RELATIONSHIPS
(package private) static AllowableValue	TOPIC_NAME
(package private) static AllowableValue	TOPIC_PATTERN
(package private) static PropertyDescriptor	TOPIC_TYPE
(package private) static PropertyDescriptor	TOPICS

Constructor Summary

Constructors

Constructor and Description
ConsumeKafka_1_0()

Method Summary

Modifier and Type	Method and Description
void	close()
protected ConsumerPool	createConsumerPool(ProcessContext context, ComponentLog log)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private ConsumerPool	getConsumerPool(ProcessContext context)
Set<Relationship>	getRelationships()
protected PropertyDescriptor	getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	interruptActiveThreads()
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

OFFSET_EARLIEST

static final AllowableValue OFFSET_EARLIEST

OFFSET_LATEST

static final AllowableValue OFFSET_LATEST

OFFSET_NONE

static final AllowableValue OFFSET_NONE

TOPIC_NAME

static final AllowableValue TOPIC_NAME

TOPIC_PATTERN

static final AllowableValue TOPIC_PATTERN

TOPICS

static final PropertyDescriptor TOPICS

TOPIC_TYPE

static final PropertyDescriptor TOPIC_TYPE

GROUP_ID

static final PropertyDescriptor GROUP_ID

AUTO_OFFSET_RESET

static final PropertyDescriptor AUTO_OFFSET_RESET

KEY_ATTRIBUTE_ENCODING

static final PropertyDescriptor KEY_ATTRIBUTE_ENCODING

MESSAGE_DEMARCATOR

static final PropertyDescriptor MESSAGE_DEMARCATOR

HEADER_NAME_REGEX

static final PropertyDescriptor HEADER_NAME_REGEX

MAX_POLL_RECORDS

static final PropertyDescriptor MAX_POLL_RECORDS

MAX_UNCOMMITTED_TIME

static final PropertyDescriptor MAX_UNCOMMITTED_TIME

HONOR_TRANSACTIONS

static final PropertyDescriptor HONOR_TRANSACTIONS

MESSAGE_HEADER_ENCODING

static final PropertyDescriptor MESSAGE_HEADER_ENCODING

REL_SUCCESS

static final Relationship REL_SUCCESS

DESCRIPTORS

static final List<PropertyDescriptor> DESCRIPTORS

RELATIONSHIPS

static final Set<Relationship> RELATIONSHIPS

consumerPool

private volatile ConsumerPool consumerPool

activeLeases

private final Set<ConsumerLease> activeLeases

Constructor Detail

ConsumeKafka_1_0

public ConsumeKafka_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

close

@OnStopped
public void close()

getSupportedDynamicPropertyDescriptor

protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(String propertyDescriptorName)

Overrides:

getSupportedDynamicPropertyDescriptor in class AbstractConfigurableComponent

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

getConsumerPool

private ConsumerPool getConsumerPool(ProcessContext context)

createConsumerPool

protected ConsumerPool createConsumerPool(ProcessContext context,
                                          ComponentLog log)

interruptActiveThreads

@OnUnscheduled
public void interruptActiveThreads()

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException