Package io.grpc.xds.internal.security.certprovider

Class CertificateProviderStore

java.lang.Object

io.grpc.xds.internal.security.certprovider.CertificateProviderStore

@ThreadSafe
public final class CertificateProviderStore
extends java.lang.Object

Global map of all ref-counted CertificateProviders that have been instantiated in the application. Also propagates updates received from a CertificateProvider to all the CertificateProvider.Watchers registered for that CertificateProvider. The Store is meant to be used internally by gRPC and *not* a public API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	CertificateProviderStore.CertProviderFactory
private static class	CertificateProviderStore.CertProviderKey
(package private) class	CertificateProviderStore.Handle	Opaque Handle returned by createOrGetProvider(java.lang.String, java.lang.String, java.lang.Object, io.grpc.xds.internal.security.certprovider.CertificateProvider.Watcher, boolean).

Field Summary

Fields

Modifier and Type	Field	Description
private CertificateProviderRegistry	certificateProviderRegistry
private ReferenceCountingMap<CertificateProviderStore.CertProviderKey,CertificateProvider>	certProviderMap
private static CertificateProviderStore	instance
private static java.util.logging.Logger	logger

Constructor Summary

Constructors

Constructor	Description
CertificateProviderStore(CertificateProviderRegistry certificateProviderRegistry)

Method Summary

Modifier and Type	Method	Description
CertificateProviderStore.Handle	createOrGetProvider(java.lang.String certName, java.lang.String pluginName, java.lang.Object config, CertificateProvider.Watcher watcher, boolean notifyCertUpdates)	Creates or retrieves a CertificateProvider instance, increments its ref-count and registers the watcher passed.
private CertificateProviderStore.Handle	createProviderHelper(java.lang.String certName, java.lang.String pluginName, java.lang.Object config, CertificateProvider.Watcher watcher, boolean notifyCertUpdates)
static CertificateProviderStore	getInstance()	Gets the CertificateProviderStore singleton instance.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final java.util.logging.Logger logger

instance

private static CertificateProviderStore instance

certificateProviderRegistry

private final CertificateProviderRegistry certificateProviderRegistry

certProviderMap

private final ReferenceCountingMap<CertificateProviderStore.CertProviderKey,CertificateProvider> certProviderMap

Constructor Detail

CertificateProviderStore

public CertificateProviderStore(CertificateProviderRegistry certificateProviderRegistry)

Method Detail

createOrGetProvider

public CertificateProviderStore.Handle createOrGetProvider(java.lang.String certName,
                                                           java.lang.String pluginName,
                                                           java.lang.Object config,
                                                           CertificateProvider.Watcher watcher,
                                                           boolean notifyCertUpdates)

Creates or retrieves a CertificateProvider instance, increments its ref-count and registers the watcher passed. Returns a CertificateProviderStore.Handle that can be CertificateProviderStore.Handle.close()d when the instance is no longer needed by the caller.

Parameters:

notifyCertUpdates - when true, the caller is interested in identity cert updates. When false, the caller cannot depend on receiving the CertificateProvider.Watcher.updateCertificate(java.security.PrivateKey, java.util.List<java.security.cert.X509Certificate>) callbacks but may still receive these callbacks which should be ignored.

Throws:

java.lang.IllegalArgumentException - in case of errors in processing config or the plugin is incapable of sending cert updates when notifyCertUpdates is true.

java.lang.UnsupportedOperationException - if the plugin is incapable of sending cert updates when notifyCertUpdates is true.

createProviderHelper

private CertificateProviderStore.Handle createProviderHelper(java.lang.String certName,
                                                             java.lang.String pluginName,
                                                             java.lang.Object config,
                                                             CertificateProvider.Watcher watcher,
                                                             boolean notifyCertUpdates)

getInstance

public static CertificateProviderStore getInstance()

Gets the CertificateProviderStore singleton instance.