Package io.confluent.kafka.schemaregistry.storage.encoder

Class MetadataEncoderService

java.lang.Object

io.confluent.kafka.schemaregistry.storage.encoder.MetadataEncoderService

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

KafkaMetadataEncoderService

public abstract class MetadataEncoderService
extends Object
implements Closeable

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	encoderSecret
protected final AtomicBoolean	initialized
protected final CountDownLatch	initLatch
protected com.google.crypto.tink.KeyTemplate	keyTemplate

Constructor Summary

Constructors

Constructor	Description
MetadataEncoderService(SchemaRegistry schemaRegistry)

Method Summary

Modifier and Type	Method	Description
abstract void	close()
void	decodeMetadata(SchemaValue schema)
protected void	doInit()	Subclass hook to prepare any resources before secret rotation occurs.
void	encodeMetadata(SchemaValue schema)
protected static String	encoderOldSecret(SchemaRegistryConfig config)
protected static String	encoderSecret(SchemaRegistryConfig config)
protected abstract Set<String>	getAllTenants()	Get all tenant keys.
abstract com.google.crypto.tink.KeysetHandle	getEncoder(String tenant)
protected abstract KeysetWrapper	getEncoderWrapper(String tenant)	Get the encoder wrapper for a tenant.
protected abstract com.google.crypto.tink.KeysetHandle	getOrCreateEncoder(String tenant)
protected static com.google.crypto.tink.Aead	getPrimitive(String secret)
SchemaRegistry	getSchemaRegistry()
final void	init()	Initialize the metadata encoder service by rotating the secrets if needed.
protected void	maybeRotateSecrets()
protected abstract void	putEncoderWrapper(String tenant, KeysetWrapper wrapper)	Store an encoder wrapper for a tenant.
void	waitForInit()

Methods inherited from class java.lang.Object

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

Field Details

encoderSecret

protected final String encoderSecret

keyTemplate

protected com.google.crypto.tink.KeyTemplate keyTemplate

initialized

protected final AtomicBoolean initialized

initLatch

protected final CountDownLatch initLatch

Constructor Details

MetadataEncoderService

public MetadataEncoderService(SchemaRegistry schemaRegistry)

Method Details

getSchemaRegistry

public SchemaRegistry getSchemaRegistry()

getPrimitive

protected static com.google.crypto.tink.Aead getPrimitive(String secret)
                                                   throws GeneralSecurityException

Throws:

GeneralSecurityException

encoderSecret

protected static String encoderSecret(SchemaRegistryConfig config)

encoderOldSecret

protected static String encoderOldSecret(SchemaRegistryConfig config)

doInit

protected void doInit()

Subclass hook to prepare any resources before secret rotation occurs. Default is no-op.

init

public final void init()
                throws SchemaRegistryStoreException

Initialize the metadata encoder service by rotating the secrets if needed. Subclasses should override doInit() to prepare any resources before the secrets are rotated.

Throws:

SchemaRegistryStoreException

getAllTenants

protected abstract Set<String> getAllTenants()

Get all tenant keys. Used for secret rotation.

getEncoderWrapper

protected abstract KeysetWrapper getEncoderWrapper(String tenant)
                                            throws SchemaRegistryStoreException

Get the encoder wrapper for a tenant.

Throws:

SchemaRegistryStoreException

putEncoderWrapper

protected abstract void putEncoderWrapper(String tenant,
 KeysetWrapper wrapper)
                                   throws SchemaRegistryStoreException

Store an encoder wrapper for a tenant.

Throws:

SchemaRegistryStoreException

maybeRotateSecrets

protected void maybeRotateSecrets()
                           throws SchemaRegistryStoreException

Throws:

SchemaRegistryStoreException

waitForInit

public void waitForInit()
                 throws InterruptedException

Throws:

InterruptedException

getEncoder

public abstract com.google.crypto.tink.KeysetHandle getEncoder(String tenant)
                                                        throws SchemaRegistryStoreException

Throws:

SchemaRegistryStoreException

encodeMetadata

public void encodeMetadata(SchemaValue schema)
                    throws SchemaRegistryStoreException

Throws:

SchemaRegistryStoreException

decodeMetadata

public void decodeMetadata(SchemaValue schema)
                    throws SchemaRegistryStoreException

Throws:

SchemaRegistryStoreException

getOrCreateEncoder

protected abstract com.google.crypto.tink.KeysetHandle getOrCreateEncoder(String tenant)
                                                                   throws SchemaRegistryStoreException

Throws:

SchemaRegistryStoreException

close

public abstract void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable