Package com.google.auth.mtls

Interface MtlsProvider

All Known Implementing Classes:

SecureConnectProvider, X509Provider

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

Method Summary

Modifier and Type	Method	Description
KeyStore	getKeyStore()	Returns a mutual TLS key store.
boolean	isAvailable()	Returns true if the underlying mTLS provider is available.

Method Details

getKeyStore

KeyStore getKeyStore()
              throws CertificateSourceUnavailableException,
IOException

Returns a mutual TLS key store.

Returns:

KeyStore for configuring mTLS.

Throws:

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

IOException - if a general I/O error occurs while creating the KeyStore

isAvailable

boolean isAvailable()
             throws IOException

Returns true if the underlying mTLS provider is available.

Throws:

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