io.confluent.kafka.multitenant

Class PhysicalClusterMetadata

java.lang.Object

io.confluent.kafka.multitenant.PhysicalClusterMetadata

All Implemented Interfaces:

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

public class PhysicalClusterMetadata
extends Object
implements org.apache.kafka.server.multitenant.MultiTenantMetadata

This holds metadata passed from CCloud related to this physical cluster

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PhysicalClusterMetadata.State

Field Summary

Fields

Modifier and Type	Field and Description
SslCertificateManager	sslCertificateManager
TenantLifecycleManager	tenantLifecycleManager

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	close(String brokerSessionUuid)
void	configure(Map<String,?> configs) Loads the cache and starts listening for directory events in directory specified in ConfluentConfigs.MULTITENANT_METADATA_DIR_CONFIG config.
static PhysicalClusterMetadata	getInstance(String brokerSessionUuid)
void	handleSocketServerInitialized(String endpoint)
boolean	isUp() Returns true if cache is loaded and listening for metadata, otherwise returns false.
Set<String>	logicalClusterIds() Returns all active logical clusters with up-to-date/valid metadata hosted by this physical cluster
Set<String>	logicalClusterIdsIncludingStale() Returns all active logical clusters hosted by this physical cluster, including logical clusters with stale/invalid metadata
LogicalClusterMetadata	metadata(String logicalClusterId) Returns metadata of a given logical cluster ID

Methods inherited from class java.lang.Object

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

Field Detail

tenantLifecycleManager

public TenantLifecycleManager tenantLifecycleManager

sslCertificateManager

public SslCertificateManager sslCertificateManager

Constructor Detail

PhysicalClusterMetadata

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

PhysicalClusterMetadata

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

Method Detail

configure

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

Loads the cache and starts listening for directory events in directory specified in ConfluentConfigs.MULTITENANT_METADATA_DIR_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. In addition to events in the directory, we are scheduling a full reload of the directory every MULTITENANT_METADATA_RELOAD_DELAY_MS to make sure nothing is missed

Specified by:

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

Parameters:

configs - broker configuration

Throws:

org.apache.kafka.common.config.ConfigException - if KafkaConfig.BrokerSessionUuidProp is not set, or ConfluentConfigs.MULTITENANT_METADATA_DIR_CONFIG is not set.

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

close

public void close(String brokerSessionUuid)

Specified by:

close in interface org.apache.kafka.server.multitenant.MultiTenantMetadata

handleSocketServerInitialized

public void handleSocketServerInitialized(String endpoint)

Specified by:

handleSocketServerInitialized in interface org.apache.kafka.server.multitenant.MultiTenantMetadata

getInstance

public static PhysicalClusterMetadata getInstance(String brokerSessionUuid)

isUp

public boolean isUp()

Returns true if cache is loaded and listening for metadata, otherwise returns false.

logicalClusterIds

public Set<String> logicalClusterIds()

Returns all active logical clusters with up-to-date/valid metadata hosted by this physical cluster

Returns:

set of logical cluster IDs

Throws:

IllegalStateException - if cache is not started or already shut down

logicalClusterIdsIncludingStale

public Set<String> logicalClusterIdsIncludingStale()

Returns all active logical clusters hosted by this physical cluster, including logical clusters with stale/invalid metadata

Returns:

set of logical cluster IDs

Throws:

IllegalStateException - if cache is not started or already shut down

metadata

public LogicalClusterMetadata metadata(String logicalClusterId)

Returns metadata of a given logical cluster ID

Parameters:

logicalClusterId - logical cluster ID

Returns:

logical cluster metadata or null if logical cluster does not exist or its metadata is stale

Throws:

IllegalStateException - if cache is not started yet or already shut down