org.apache.nifi.processors.kafka.pubsub

Class KafkaProcessorUtils

java.lang.Object

org.apache.nifi.processors.kafka.pubsub.KafkaProcessorUtils

public final class KafkaProcessorUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KafkaProcessorUtils.KafkaConfigValidator

Field Summary

Fields

Modifier and Type	Field and Description
private static String	ALLOW_EXPLICIT_KEYTAB
static PropertyDescriptor	BOOTSTRAP_SERVERS
(package private) static AllowableValue	HEX_ENCODING
(package private) static Pattern	HEX_KEY_PATTERN
static PropertyDescriptor	JAAS_SERVICE_NAME
(package private) static String	KAFKA_COUNT
(package private) static String	KAFKA_KEY
(package private) static String	KAFKA_OFFSET
(package private) static String	KAFKA_PARTITION
(package private) static String	KAFKA_TIMESTAMP
(package private) static String	KAFKA_TOPIC
static PropertyDescriptor	KERBEROS_CREDENTIALS_SERVICE
(package private) org.slf4j.Logger	logger
static AllowableValue	SEC_PLAINTEXT
static AllowableValue	SEC_SASL_PLAINTEXT
static AllowableValue	SEC_SASL_SSL
static AllowableValue	SEC_SSL
static PropertyDescriptor	SECURITY_PROTOCOL
static PropertyDescriptor	SSL_CONTEXT_SERVICE
(package private) static PropertyDescriptor	USER_KEYTAB
(package private) static PropertyDescriptor	USER_PRINCIPAL
(package private) static AllowableValue	UTF8_ENCODING

Constructor Summary

Constructors

Constructor and Description
KafkaProcessorUtils()

Method Summary

Modifier and Type	Method and Description
(package private) static void	buildCommonKafkaProperties(ProcessContext context, Class<?> kafkaConfigClass, Map<String,Object> mapToPopulate)
(package private) static String	buildTransitURI(String securityProtocol, String brokers, String topic) Builds transit URI for provenance event.
(package private) static List<PropertyDescriptor>	getCommonPropertyDescriptors()
private static Set<String>	getPublicStaticStringFieldValues(Class<?>... classes)
static Supplier<String>	getTransactionalIdSupplier(String prefix) Method used to create a transactional id Supplier for KafkaProducer
static boolean	isStaticStringFieldNamePresent(String name, Class<?>... classes)
private static void	setJaasConfig(Map<String,Object> mapToPopulate, ProcessContext 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
static Collection<ValidationResult>	validateCommonProperties(ValidationContext validationContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALLOW_EXPLICIT_KEYTAB

private static final String ALLOW_EXPLICIT_KEYTAB

See Also:

Constant Field Values

logger

final org.slf4j.Logger logger

UTF8_ENCODING

static final AllowableValue UTF8_ENCODING

HEX_ENCODING

static final AllowableValue HEX_ENCODING

HEX_KEY_PATTERN

static final Pattern HEX_KEY_PATTERN

KAFKA_KEY

static final String KAFKA_KEY

See Also:

Constant Field Values

KAFKA_TOPIC

static final String KAFKA_TOPIC

See Also:

Constant Field Values

KAFKA_PARTITION

static final String KAFKA_PARTITION

See Also:

Constant Field Values

KAFKA_OFFSET

static final String KAFKA_OFFSET

See Also:

Constant Field Values

KAFKA_TIMESTAMP

static final String KAFKA_TIMESTAMP

See Also:

Constant Field Values

KAFKA_COUNT

static final String KAFKA_COUNT

See Also:

Constant Field Values

SEC_PLAINTEXT

public static final AllowableValue SEC_PLAINTEXT

SEC_SSL

public static final AllowableValue SEC_SSL

SEC_SASL_PLAINTEXT

public static final AllowableValue SEC_SASL_PLAINTEXT

SEC_SASL_SSL

public static final AllowableValue SEC_SASL_SSL

BOOTSTRAP_SERVERS

public static final PropertyDescriptor BOOTSTRAP_SERVERS

SECURITY_PROTOCOL

public static final PropertyDescriptor SECURITY_PROTOCOL

JAAS_SERVICE_NAME

public static final PropertyDescriptor JAAS_SERVICE_NAME

USER_PRINCIPAL

static final PropertyDescriptor USER_PRINCIPAL

USER_KEYTAB

static final PropertyDescriptor USER_KEYTAB

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

KERBEROS_CREDENTIALS_SERVICE

public static final PropertyDescriptor KERBEROS_CREDENTIALS_SERVICE

Constructor Detail

KafkaProcessorUtils

public KafkaProcessorUtils()

Method Detail

getCommonPropertyDescriptors

static List<PropertyDescriptor> getCommonPropertyDescriptors()

validateCommonProperties

public static Collection<ValidationResult> validateCommonProperties(ValidationContext validationContext)

buildTransitURI

static String buildTransitURI(String securityProtocol,
                              String brokers,
                              String topic)

Builds transit URI for provenance event. The transit URI will be in the form of <security.protocol>://<bootstrap.servers>/topic

buildCommonKafkaProperties

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

getTransactionalIdSupplier

public static Supplier<String> getTransactionalIdSupplier(String prefix)

Method used to create a transactional id Supplier for KafkaProducer

Parameters:

prefix - String transactional id prefix, can be null

Returns:

A Supplier that generates transactional id

setJaasConfig

private static void setJaasConfig(Map<String,Object> mapToPopulate,
                                  ProcessContext 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

isStaticStringFieldNamePresent

public static boolean isStaticStringFieldNamePresent(String name,
                                                     Class<?>... classes)

getPublicStaticStringFieldValues

private static Set<String> getPublicStaticStringFieldValues(Class<?>... classes)