Package io.confluent.security.authorizer.provider

Interface Provider

All Superinterfaces:

AutoCloseable, Closeable, org.apache.kafka.common.Configurable

All Known Subinterfaces:

AccessRuleProvider, GroupProvider, MetadataProvider

public interface Provider
extends org.apache.kafka.common.Configurable, Closeable

Interface used by providers used for authorization.

Method Summary

Modifier and Type	Method	Description
String	providerName()	Returns the name of this provider.
default CompletionStage<Void>	start(org.apache.kafka.server.authorizer.internals.ConfluentAuthorizerServerInfo serverInfo)	Starts a provider and returns a future that is completed when the provider is ready.
boolean	usesMetadataFromThisKafkaCluster()	Returns true if this provider uses metadata from a Kafka topic on this cluster.

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.apache.kafka.common.Configurable

configure

Method Details

start

default CompletionStage<Void> start(org.apache.kafka.server.authorizer.internals.ConfluentAuthorizerServerInfo serverInfo)

Starts a provider and returns a future that is completed when the provider is ready. By default, a provider is auto-started on configure and this method returns a completed future. Providers that need to delay startup due to bootstrapping limitations must override this method and return a future that is completed when the provider has started up. This allows brokers to use providers that load metadata from broker topics using the inter-broker listener. External listeners that rely on this metadata will be started when the returned future completes.

Parameters:

serverInfo - Runtime broker configuration metadata

providerName

String providerName()

Returns the name of this provider.

Returns:

provider name

usesMetadataFromThisKafkaCluster

boolean usesMetadataFromThisKafkaCluster()

Returns true if this provider uses metadata from a Kafka topic on this cluster.