io.confluent.kafka.multitenant

Class TopicBasedPhysicalClusterMetadata

java.lang.Object

io.confluent.kafka.multitenant.BasePhysicalClusterMetadata<LCMType>

io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata<KafkaLogicalClusterMetadata>

io.confluent.kafka.multitenant.TopicBasedPhysicalClusterMetadata

All Implemented Interfaces:

org.apache.kafka.common.Configurable, org.apache.kafka.common.Reconfigurable, org.apache.kafka.server.multitenant.MultiTenantMetadata

public class TopicBasedPhysicalClusterMetadata
extends io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata<KafkaLogicalClusterMetadata>

This holds metadata passed from CCloud related to this physical cluster

Nested Class Summary

Nested classes/interfaces inherited from class io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata

io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata.State

Field Summary

Fields

Modifier and Type	Field and Description
SslCertificateManager	sslCertificateManager
TenantLifecycleManager	tenantLifecycleManager

Fields inherited from class io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata

NUMBER_OF_NON_HC_TENANTS_METRIC_NAME, NUMBER_OF_TENANTS_METRIC_NAME

Constructor Summary

Constructors

Constructor and Description
TopicBasedPhysicalClusterMetadata(org.apache.kafka.common.metrics.Metrics metrics)
TopicBasedPhysicalClusterMetadata(org.apache.kafka.common.metrics.Metrics metrics, org.apache.kafka.common.utils.Time time)

Method Summary

Modifier and Type	Method and Description
void	configure(Map<String,?> configs) Creates a consumer for the LKC metadata topic (named in the ConfluentConfigs.CDC_LKC_METADATA_TOPIC_CONFIG config.) Adds the instance for the given broker session UUID, specified in KafkaConfig.BrokerSessionUuidProp to the static instance map.
String	dedicatedLogicalClusterId()
String	getSessionUuid(Map<String,?> configs)
Set<String>	kafkaLogicalClusterIds()
Set<String>	logicalClusterIds()
void	registerTenantCallback(Function<String,Boolean> callback) Registers tenant callback function to be invoked whenever a new tenant is added
void	registerTenantDeactivatedCallback(Function<String,Boolean> callback)
Map<org.apache.kafka.common.Endpoint,CompletableFuture<Void>>	start(Map<String,Object> interBrokerClientConfig, Collection<org.apache.kafka.common.Endpoint> endpoints)
void	startClients(Function<String,org.apache.kafka.clients.admin.Admin> adminClientSupplier)

Methods inherited from class io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata

close, consume, isUp, logicalClusterIdsIncludingStale, metadata, start

Methods inherited from class io.confluent.kafka.multitenant.BasePhysicalClusterMetadata

getInstance, reconfigurableConfigs, reconfigure, validateReconfiguration

Methods inherited from class java.lang.Object

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

Field Detail

tenantLifecycleManager

public TenantLifecycleManager tenantLifecycleManager

sslCertificateManager

public SslCertificateManager sslCertificateManager

Constructor Detail

TopicBasedPhysicalClusterMetadata

public TopicBasedPhysicalClusterMetadata(org.apache.kafka.common.metrics.Metrics metrics)

TopicBasedPhysicalClusterMetadata

public TopicBasedPhysicalClusterMetadata(org.apache.kafka.common.metrics.Metrics metrics,
                                         org.apache.kafka.common.utils.Time time)

Method Detail

configure

public void configure(Map<String,?> configs)

Creates a consumer for the LKC metadata topic (named in the ConfluentConfigs.CDC_LKC_METADATA_TOPIC_CONFIG config.) Adds the instance for the given broker session UUID, specified in KafkaConfig.BrokerSessionUuidProp to the static instance map. The caller of this method must call close() when done to remove the instance from the static map.

Specified by:

configure in interface org.apache.kafka.common.Configurable

Overrides:

configure in class io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata<KafkaLogicalClusterMetadata>

Parameters:

configs - broker configuration

Throws:

org.apache.kafka.common.config.ConfigException - if KafkaConfig.BrokerSessionUuidProp is not set, or ConfluentConfigs.CDC_LKC_METADATA_TOPIC_CONFIG is not set, or ConfluentConfigs.CDC_TOPIC_LOAD_TIMEOUT_MS_CONFIG is not set, or unable to monitor the SSL certificates on disk.

UnsupportedOperationException - if another instance of this class with the same broker session UUID was already configured.

getSessionUuid

public String getSessionUuid(Map<String,?> configs)

Specified by:

getSessionUuid in class io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata<KafkaLogicalClusterMetadata>

startClients

public void startClients(Function<String,org.apache.kafka.clients.admin.Admin> adminClientSupplier)

registerTenantCallback

public void registerTenantCallback(Function<String,Boolean> callback)

Registers tenant callback function to be invoked whenever a new tenant is added

Parameters:

callback - Callback function that has to be invoked for all tenants. The callback function should take a string(tenant ID) and return Boolean The function receives the lkc id for that tenant as the argument, and handle it own errors if need be, as exceptions thrown by this function would be rethrown, and could cause the broker to shut down if unhandled. Note that it could be invoked before the tenant cache is in a running state, and thus tenant metadata might not be yet accessible to this function.

registerTenantDeactivatedCallback

public void registerTenantDeactivatedCallback(Function<String,Boolean> callback)

start

public Map<org.apache.kafka.common.Endpoint,CompletableFuture<Void>> start(Map<String,Object> interBrokerClientConfig,
                                                                           Collection<org.apache.kafka.common.Endpoint> endpoints)

dedicatedLogicalClusterId

public String dedicatedLogicalClusterId()

kafkaLogicalClusterIds

public Set<String> kafkaLogicalClusterIds()

logicalClusterIds

public Set<String> logicalClusterIds()

Specified by:

logicalClusterIds in class io.confluent.kafka.multitenant.CommonTopicBasedPhysicalClusterMetadata<KafkaLogicalClusterMetadata>