Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class CertificateBasedAccess (2.70.2)

public class CertificateBasedAccess

Utility class for handling certificate-based access configurations.

This class handles the processing of GOOGLE_API_USE_CLIENT_CERTIFICATE and GOOGLE_API_USE_MTLS_ENDPOINT environment variables according to https://google.aip.dev/auth/4114

Inheritance

java.lang.Object > CertificateBasedAccess

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

createWithSystemEnv()

public static CertificateBasedAccess createWithSystemEnv()

Returns
Type	Description
`CertificateBasedAccess`

Constructors

CertificateBasedAccess(EnvironmentProvider envProvider)

public CertificateBasedAccess(EnvironmentProvider envProvider)

The EnvironmentProvider mechanism supports env var injection for unit tests.

Parameter
Name	Description
`envProvider`	`EnvironmentProvider`

Methods

getMtlsEndpointUsagePolicy()

public CertificateBasedAccess.MtlsEndpointUsagePolicy getMtlsEndpointUsagePolicy()

Returns the current mutual TLS endpoint usage policy.

Returns
Type	Description
`CertificateBasedAccess.MtlsEndpointUsagePolicy`

useMtlsClientCertificate()

public boolean useMtlsClientCertificate()

Returns if mutual TLS client certificate should be used.

Returns
Type	Description
`boolean`