Interface MtlsProvider (1.37.0)

public interface MtlsProvider

MtlsProvider is used by the Gax library for configuring mutual TLS in the HTTP and GRPC transport layer. The source of the client certificate is up to the implementation.

Note: This interface will replace the identically named "MtlsProvider" implementation in the Gax library. The Gax library version of MtlsProvider will be marked as deprecated. See https://github.com/googleapis/google-auth-library-java/issues/1758

Methods

getKeyStore()

public abstract KeyStore getKeyStore()

Returns a mutual TLS key store.

Returns
Type Description
KeyStore

KeyStore for configuring mTLS.

Exceptions
Type Description
CertificateSourceUnavailableException

if the certificate source is unavailable (ex. missing configuration file).

IOException

if the certificate source is unavailable (ex. missing configuration file).

isAvailable()

public abstract boolean isAvailable()

Returns true if the underlying mTLS provider is available.

Returns
Type Description
boolean
Exceptions
Type Description
IOException

if a general I/O error occurs while determining availability.