io.confluent.license.validator

Class ConfluentLicenseValidator

java.lang.Object

io.confluent.license.validator.ConfluentLicenseValidator

All Implemented Interfaces:

Closeable, AutoCloseable, Consumer<LicenseChanged>, Supplier<org.apache.kafka.server.license.LicenseTrackingInfoHolder>, org.apache.kafka.common.Configurable, org.apache.kafka.server.license.LicenseValidator

public class ConfluentLicenseValidator
extends Object
implements org.apache.kafka.server.license.LicenseValidator, Consumer<LicenseChanged>

License validator used by Kafka brokers for proprietary features. This includes license metrics and periodic error logging for expired and invalid licenses. The component using the license (e.g. broker) will start regardless of whether the license is invalid or has expired. An error is logged periodically. If the license is missing, it will create a TRIAL license. License is stored in a Kafka topic in the MDS cluster if MDS is enabled. Otherwise it is stored in the Kafka cluster associated with the component. Since LicenseManager is used by several components, broker-specific startup sequence is managed by ConfluentLicenseValidator. If a valid license is configured, license store is started asynchronously. License is registered if/when license store start up completes. Broker starts up successfully if a valid license is configured in server.properties even if the license topic cannot be created or is unavailable. If a valid license is not configured, license validator blocks on the license store during start up and broker start up fails if the license topic is unavailable within the create timeout.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConfluentLicenseValidator.LicenseStatus

Field Summary

Fields

Modifier and Type	Field and Description
static String	METRIC_GROUP
static String	METRIC_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConfluentLicenseValidator()
protected	ConfluentLicenseValidator(LicenseManager licenseManager, ScheduledExecutorService executorService, Duration checkLicenseInterval)

Method Summary

Modifier and Type	Method and Description
void	accept(LicenseChanged licenseChanged)
protected void	checkLicense()
void	close()
void	configure(Map<String,?> configs)
protected LicenseManager	createLicenseManager(LicenseConfig licenseConfig)
protected io.confluent.license.validator.ConfluentLicenseValidator.KafkaLicenseStore	createLicenseStore(LicenseConfig licenseConfig)
boolean	enabled()
org.apache.kafka.server.license.LicenseTrackingInfoHolder	get() Provides LicenseTrackingInfoHolder, which is used to retrieve tracking identifiers from License to Segment without exposing internal LicenseManager or License.
protected long	getNextCheckIntervalMsAndMaybeLog(long timeRemainingMs)
boolean	isLicenseValid()
protected void	registerMetric(String metricGroup)
protected void	schedulePeriodicValidation()
void	start(String componentId)
protected void	updateExpiredStatus(ConfluentLicenseValidator.LicenseStatus status, Date expirationDate)
protected void	updateInvalidStatus(String reason)
protected void	updateLicenseStatus(ConfluentLicenseValidator.LicenseStatus status)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

andThen

Field Detail

METRIC_GROUP

public static final String METRIC_GROUP

See Also:

Constant Field Values

METRIC_NAME

public static final String METRIC_NAME

See Also:

Constant Field Values

Constructor Detail

ConfluentLicenseValidator

public ConfluentLicenseValidator()

ConfluentLicenseValidator

protected ConfluentLicenseValidator(LicenseManager licenseManager,
                                    ScheduledExecutorService executorService,
                                    Duration checkLicenseInterval)

Method Detail

configure

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

Specified by:

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

enabled

public final boolean enabled()

Specified by:

enabled in interface org.apache.kafka.server.license.LicenseValidator

start

public void start(String componentId)

Specified by:

start in interface org.apache.kafka.server.license.LicenseValidator

isLicenseValid

public boolean isLicenseValid()

Specified by:

isLicenseValid in interface org.apache.kafka.server.license.LicenseValidator

accept

public void accept(LicenseChanged licenseChanged)

Specified by:

accept in interface Consumer<LicenseChanged>

get

public org.apache.kafka.server.license.LicenseTrackingInfoHolder get()

Provides LicenseTrackingInfoHolder, which is used to retrieve tracking identifiers from License to Segment without exposing internal LicenseManager or License.

Specified by:

get in interface Supplier<org.apache.kafka.server.license.LicenseTrackingInfoHolder>

Returns:

LicenseTrackingInfoHolder

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

createLicenseStore

protected io.confluent.license.validator.ConfluentLicenseValidator.KafkaLicenseStore createLicenseStore(LicenseConfig licenseConfig)

createLicenseManager

protected LicenseManager createLicenseManager(LicenseConfig licenseConfig)

updateExpiredStatus

protected void updateExpiredStatus(ConfluentLicenseValidator.LicenseStatus status,
                                   Date expirationDate)

updateInvalidStatus

protected void updateInvalidStatus(String reason)

updateLicenseStatus

protected void updateLicenseStatus(ConfluentLicenseValidator.LicenseStatus status)

registerMetric

protected void registerMetric(String metricGroup)

schedulePeriodicValidation

protected void schedulePeriodicValidation()

checkLicense

protected void checkLicense()

getNextCheckIntervalMsAndMaybeLog

protected long getNextCheckIntervalMsAndMaybeLog(long timeRemainingMs)