Package io.grpc.xds.internal.security

Class TlsContextManagerImpl

java.lang.Object

io.grpc.xds.internal.security.TlsContextManagerImpl

All Implemented Interfaces:

TlsContextManager

public final class TlsContextManagerImpl
extends Object
implements TlsContextManager

Class to manage SslContextProvider objects created from inputs we get from xDS. Used by gRPC-xds to access the SslContext's and is not public API. This manager manages the life-cycle of SslContextProvider objects as shared resources via ref-counting as described in ReferenceCountingMap.

Field Summary

Fields

Modifier and Type	Field	Description
private final ReferenceCountingMap<EnvoyServerProtoData.UpstreamTlsContext,SslContextProvider>	mapForClients
private final ReferenceCountingMap<EnvoyServerProtoData.DownstreamTlsContext,SslContextProvider>	mapForServers

Constructor Summary

Constructors

Constructor	Description
TlsContextManagerImpl(Bootstrapper.BootstrapInfo bootstrapInfo)	Create a TlsContextManagerImpl instance using the passed in Bootstrapper.BootstrapInfo.
TlsContextManagerImpl(ReferenceCountingMap.ValueFactory<EnvoyServerProtoData.UpstreamTlsContext,SslContextProvider> clientFactory, ReferenceCountingMap.ValueFactory<EnvoyServerProtoData.DownstreamTlsContext,SslContextProvider> serverFactory)

Method Summary

Modifier and Type	Method	Description
SslContextProvider	findOrCreateClientSslContextProvider(EnvoyServerProtoData.UpstreamTlsContext upstreamTlsContext)	Creates a SslContextProvider.
SslContextProvider	findOrCreateServerSslContextProvider(EnvoyServerProtoData.DownstreamTlsContext downstreamTlsContext)	Creates a SslContextProvider.
SslContextProvider	releaseClientSslContextProvider(SslContextProvider clientSslContextProvider)	Releases an instance of the given client-side SslContextProvider.
SslContextProvider	releaseServerSslContextProvider(SslContextProvider serverSslContextProvider)	Releases an instance of the given server-side SslContextProvider.

Methods inherited from class java.lang.Object

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

Field Details

mapForClients

private final ReferenceCountingMap<EnvoyServerProtoData.UpstreamTlsContext,SslContextProvider> mapForClients

mapForServers

private final ReferenceCountingMap<EnvoyServerProtoData.DownstreamTlsContext,SslContextProvider> mapForServers

Constructor Details

TlsContextManagerImpl

public TlsContextManagerImpl(Bootstrapper.BootstrapInfo bootstrapInfo)

Create a TlsContextManagerImpl instance using the passed in Bootstrapper.BootstrapInfo.

TlsContextManagerImpl

TlsContextManagerImpl(ReferenceCountingMap.ValueFactory<EnvoyServerProtoData.UpstreamTlsContext,SslContextProvider> clientFactory,
 ReferenceCountingMap.ValueFactory<EnvoyServerProtoData.DownstreamTlsContext,SslContextProvider> serverFactory)

Method Details

findOrCreateServerSslContextProvider

public SslContextProvider findOrCreateServerSslContextProvider(EnvoyServerProtoData.DownstreamTlsContext downstreamTlsContext)

Description copied from interface: TlsContextManager

Creates a SslContextProvider. Used for retrieving a server-side SslContext.

Specified by:

findOrCreateServerSslContextProvider in interface TlsContextManager

findOrCreateClientSslContextProvider

public SslContextProvider findOrCreateClientSslContextProvider(EnvoyServerProtoData.UpstreamTlsContext upstreamTlsContext)

Description copied from interface: TlsContextManager

Creates a SslContextProvider. Used for retrieving a client-side SslContext.

Specified by:

findOrCreateClientSslContextProvider in interface TlsContextManager

releaseClientSslContextProvider

public SslContextProvider releaseClientSslContextProvider(SslContextProvider clientSslContextProvider)

Description copied from interface: TlsContextManager

Releases an instance of the given client-side SslContextProvider.

The instance must have been obtained from TlsContextManager.findOrCreateClientSslContextProvider(io.grpc.xds.EnvoyServerProtoData.UpstreamTlsContext). Otherwise will throw IllegalArgumentException.

Caller must not release a reference more than once. It's advised that you clear the reference to the instance with the null returned by this method.

Specified by:

releaseClientSslContextProvider in interface TlsContextManager

releaseServerSslContextProvider

public SslContextProvider releaseServerSslContextProvider(SslContextProvider serverSslContextProvider)

Description copied from interface: TlsContextManager

Releases an instance of the given server-side SslContextProvider.

The instance must have been obtained from TlsContextManager.findOrCreateServerSslContextProvider(io.grpc.xds.EnvoyServerProtoData.DownstreamTlsContext). Otherwise will throw IllegalArgumentException.

Caller must not release a reference more than once. It's advised that you clear the reference to the instance with the null returned by this method.

Specified by:

releaseServerSslContextProvider in interface TlsContextManager