Returns if mutual TLS client certificate should be used. If the value is true, the key store
from #getKeyStore() will be used to configure mutual TLS transport.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the \u003ccode\u003eMtlsProvider\u003c/code\u003e class in the Google API Client Library for Java, which is currently in a pre-GA stage and may have limited support.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eMtlsProvider\u003c/code\u003e class is designed to configure mutual TLS (mTLS) in the transport layer using the default client certificate on a device, and it inherits from \u003ccode\u003ejava.lang.Object\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe latest version of the \u003ccode\u003eMtlsProvider\u003c/code\u003e class available is version 2.63.1, with a list of many previous versions included that are clickable links to the content of that version.\u003c/p\u003e\n"],["\u003cp\u003eKey functionalities of \u003ccode\u003eMtlsProvider\u003c/code\u003e include retrieving the mTLS key store with \u003ccode\u003egetKeyStore()\u003c/code\u003e, getting the current mTLS endpoint usage policy with \u003ccode\u003egetMtlsEndpointUsagePolicy()\u003c/code\u003e, and checking if a mTLS client certificate should be used with \u003ccode\u003euseMtlsClientCertificate()\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Class MtlsProvider (2.69.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.69.0 (latest)](/java/docs/reference/gax/latest/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.68.2](/java/docs/reference/gax/2.68.2/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.67.0](/java/docs/reference/gax/2.67.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.66.0](/java/docs/reference/gax/2.66.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.65.0](/java/docs/reference/gax/2.65.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.63.1](/java/docs/reference/gax/2.63.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.62.0](/java/docs/reference/gax/2.62.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.61.0](/java/docs/reference/gax/2.61.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.60.0](/java/docs/reference/gax/2.60.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.59.1](/java/docs/reference/gax/2.59.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.58.0](/java/docs/reference/gax/2.58.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.57.0](/java/docs/reference/gax/2.57.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.55.0](/java/docs/reference/gax/2.55.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.54.1](/java/docs/reference/gax/2.54.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.53.0](/java/docs/reference/gax/2.53.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.52.0](/java/docs/reference/gax/2.52.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.51.0](/java/docs/reference/gax/2.51.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.50.0](/java/docs/reference/gax/2.50.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.49.0](/java/docs/reference/gax/2.49.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.48.1](/java/docs/reference/gax/2.48.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.47.0](/java/docs/reference/gax/2.47.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.46.1](/java/docs/reference/gax/2.46.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.45.0](/java/docs/reference/gax/2.45.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.43.0](/java/docs/reference/gax/2.43.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.42.0](/java/docs/reference/gax/2.42.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.41.0](/java/docs/reference/gax/2.41.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.39.0](/java/docs/reference/gax/2.39.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.38.0](/java/docs/reference/gax/2.38.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.37.0](/java/docs/reference/gax/2.37.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.36.0](/java/docs/reference/gax/2.36.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.35.0](/java/docs/reference/gax/2.35.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.34.1](/java/docs/reference/gax/2.34.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.33.0](/java/docs/reference/gax/2.33.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.32.1](/java/docs/reference/gax/2.32.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.31.1](/java/docs/reference/gax/2.31.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.30.1](/java/docs/reference/gax/2.30.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.24.0](/java/docs/reference/gax/2.24.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.23.3](/java/docs/reference/gax/2.23.3/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.22.0](/java/docs/reference/gax/2.22.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.21.0](/java/docs/reference/gax/2.21.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.20.1](/java/docs/reference/gax/2.20.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.19.6](/java/docs/reference/gax/2.19.6/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.18.7](/java/docs/reference/gax/2.18.7/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.17.0](/java/docs/reference/gax/2.17.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.16.0](/java/docs/reference/gax/2.16.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.15.0](/java/docs/reference/gax/2.15.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.14.0](/java/docs/reference/gax/2.14.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.13.0](/java/docs/reference/gax/2.13.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.12.2](/java/docs/reference/gax/2.12.2/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.11.0](/java/docs/reference/gax/2.11.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.10.0](/java/docs/reference/gax/2.10.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.9.0](/java/docs/reference/gax/2.9.0/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.8.1](/java/docs/reference/gax/2.8.1/com.google.api.gax.rpc.mtls.MtlsProvider)\n- [2.7.1](/java/docs/reference/gax/2.7.1/com.google.api.gax.rpc.mtls.MtlsProvider) \n\n public class MtlsProvider\n\nProvider class for mutual TLS. It is used to configure the mutual TLS in the transport with the\ndefault client certificate on device.\n\nThis class is deprecated. It has been replaced by com.google.auth.mtls.SecureConnectProvider\nfrom the Java auth library.\n\nNote: This class is for Google cloud internal use only. \n\nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e MtlsProvider \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nConstructors\n------------\n\n### MtlsProvider() (deprecated)\n\n public MtlsProvider()\n\nMethods\n-------\n\n### getKeyStore() (deprecated)\n\n public KeyStore getKeyStore()\n\nThe mutual TLS key store created with the default client certificate on device.\n\n### getMtlsEndpointUsagePolicy() (deprecated)\n\n public MtlsProvider.MtlsEndpointUsagePolicy getMtlsEndpointUsagePolicy()\n\nReturns the current mutual TLS endpoint usage policy.\n\n### useMtlsClientCertificate() (deprecated)\n\n public boolean useMtlsClientCertificate()\n\nReturns if mutual TLS client certificate should be used. If the value is true, the key store\nfrom [#getKeyStore()](/java/docs/reference/gax/latest/com.google.api.gax.rpc.mtls.MtlsProvider#com_google_api_gax_rpc_mtls_MtlsProvider_getKeyStore__) will be used to configure mutual TLS transport."]]
