Class MutableCredentials (6.116.0)

6.116.0 (latest) 6.111.1 6.108.0 6.107.0 6.103.0 6.102.1 6.101.1 6.100.0 6.99.0 6.98.1 6.97.1 6.96.1 6.95.1 6.94.0 6.93.0 6.89.0 6.88.0 6.87.0 6.86.0 6.85.0 6.83.0 6.82.0 6.80.1 6.79.0 6.77.0 6.74.1 6.72.0 6.71.0 6.69.0 6.68.0 6.66.0 6.65.1 6.62.0 6.60.0 6.58.0 6.57.0 6.56.0 6.55.0 6.54.0 6.53.0 6.52.1 6.51.0 6.50.1 6.49.0 6.25.1 6.24.0 6.23.4 6.22.0 6.21.2 6.20.0 6.19.1 6.18.0 6.17.4 6.14.1

public class MutableCredentials extends Credentials

A mutable Credentials implementation that delegates authentication behavior to a scoped ServiceAccountCredentials instance.

This class is intended for scenarios where an application needs to replace the underlying service account credentials for a long-running Spanner Client.

All operations inherited from Credentials are forwarded to the current delegate, including request metadata retrieval and token refresh. Calling #updateCredentials(ServiceAccountCredentials) replaces the delegate with a newly scoped credentials instance created from the same scopes that were provided when this object was constructed.

Inheritance

java.lang.Object > com.google.auth.Credentials > MutableCredentials

Inherited Members

com.google.auth.Credentials.blockingGetToCallback(java.net.URI,com.google.auth.RequestMetadataCallback)

com.google.auth.Credentials.getAuthenticationType()

com.google.auth.Credentials.getMetricsCredentialType()

com.google.auth.Credentials.getRequestMetadata()

com.google.auth.Credentials.getRequestMetadata(java.net.URI)

com.google.auth.Credentials.getRequestMetadata(java.net.URI,java.util.concurrent.Executor,com.google.auth.RequestMetadataCallback)

com.google.auth.Credentials.getUniverseDomain()

com.google.auth.Credentials.hasRequestMetadata()

com.google.auth.Credentials.hasRequestMetadataOnly()

com.google.auth.Credentials.refresh()

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)

Constructors

MutableCredentials(ServiceAccountCredentials credentials)

public MutableCredentials(ServiceAccountCredentials credentials)

Creates a MutableCredentials instance with default spanner scopes.

Parameter
Name	Description
credentials	com.google.auth.oauth2.ServiceAccountCredentials

MutableCredentials(ServiceAccountCredentials credentials, Set<String> scopes)

public MutableCredentials(ServiceAccountCredentials credentials, Set<String> scopes)

Parameters
Name	Description
credentials	com.google.auth.oauth2.ServiceAccountCredentials
scopes	Set<String>

Methods

getAuthenticationType()

public String getAuthenticationType()

Returns
Type	Description
String

Overrides

com.google.auth.Credentials.getAuthenticationType()

getMetricsCredentialType()

public CredentialTypeForMetrics getMetricsCredentialType()

Returns
Type	Description
com.google.auth.CredentialTypeForMetrics

Overrides

com.google.auth.Credentials.getMetricsCredentialType()

getRequestMetadata(URI uri)

public Map<String,List<String>> getRequestMetadata(URI uri)

Parameter
Name	Description
uri	URI

Returns
Type	Description
Map<String,List<String>>

Overrides

com.google.auth.Credentials.getRequestMetadata(java.net.URI)

Exceptions
Type	Description
IOException

getRequestMetadata(URI uri, Executor executor, RequestMetadataCallback callback)

public void getRequestMetadata(URI uri, Executor executor, RequestMetadataCallback callback)

Parameters
Name	Description
uri	URI
executor	Executor
callback	com.google.auth.RequestMetadataCallback

Overrides

com.google.auth.Credentials.getRequestMetadata(java.net.URI,java.util.concurrent.Executor,com.google.auth.RequestMetadataCallback)

getUniverseDomain()

public String getUniverseDomain()

Returns
Type	Description
String

Overrides

com.google.auth.Credentials.getUniverseDomain()

Exceptions
Type	Description
IOException

hasRequestMetadata()

public boolean hasRequestMetadata()

Returns
Type	Description
boolean

Overrides

com.google.auth.Credentials.hasRequestMetadata()

hasRequestMetadataOnly()

public boolean hasRequestMetadataOnly()

Returns
Type	Description
boolean

Overrides

com.google.auth.Credentials.hasRequestMetadataOnly()

refresh()

public void refresh()

Overrides

com.google.auth.Credentials.refresh()

Exceptions
Type	Description
IOException

updateCredentials(ServiceAccountCredentials credentials)

public void updateCredentials(ServiceAccountCredentials credentials)

Replaces the current delegate with a newly scoped credentials instance.

Note any in-flight RPC may continue to use the old credentials.

The provided ServiceAccountCredentials is scoped using the same scopes that were supplied when this MutableCredentials instance was created.

Parameter
Name	Description
credentials	com.google.auth.oauth2.ServiceAccountCredentials the new base service account credentials to scope and use for client authorization.