com.google.api.client.googleapis.auth.oauth2

Class GoogleCredential.Builder

java.lang.Object

com.google.api.client.auth.oauth2.Credential.Builder

com.google.api.client.googleapis.auth.oauth2.GoogleCredential.Builder

Direct Known Subclasses:

MockGoogleCredential.Builder

Enclosing class:

GoogleCredential

public static class GoogleCredential.Builder
extends Credential.Builder

Google credential builder.

Implementation is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
GoogleCredential.Builder	addRefreshListener(CredentialRefreshListener refreshListener)
GoogleCredential	build()
String	getServiceAccountId() Returns the service account ID (typically an e-mail address) or null for none.
PrivateKey	getServiceAccountPrivateKey() Returns the private key to use with the service account flow or null for none.
String	getServiceAccountPrivateKeyId() Beta Returns the id of the private key to use with the service account flow or null for none.
String	getServiceAccountProjectId() Returns the service account Project ID or null for none.
Collection<String>	getServiceAccountScopes() Returns a collection of OAuth scopes to use with the service account flow or null for none.
String	getServiceAccountUser() Returns the email address of the user the application is trying to impersonate in the service account flow or null for none.
GoogleCredential.Builder	setClientAuthentication(HttpExecuteInterceptor clientAuthentication)
GoogleCredential.Builder	setClientSecrets(GoogleClientSecrets clientSecrets) Sets the client secrets.
GoogleCredential.Builder	setClientSecrets(String clientId, String clientSecret) Sets the client identifier and secret.
GoogleCredential.Builder	setClock(Clock clock)
GoogleCredential.Builder	setJsonFactory(JsonFactory jsonFactory)
GoogleCredential.Builder	setRefreshListeners(Collection<CredentialRefreshListener> refreshListeners)
GoogleCredential.Builder	setRequestInitializer(HttpRequestInitializer requestInitializer)
GoogleCredential.Builder	setServiceAccountId(String serviceAccountId) Sets the service account ID (typically an e-mail address) or null for none.
GoogleCredential.Builder	setServiceAccountPrivateKey(PrivateKey serviceAccountPrivateKey) Sets the private key to use with the service account flow or null for none.
GoogleCredential.Builder	setServiceAccountPrivateKeyFromP12File(File p12File) Sets the private key to use with the service account flow or null for none.
GoogleCredential.Builder	setServiceAccountPrivateKeyFromP12File(InputStream p12FileInputStream) Sets the private key to use with the service account flow or null for none.
GoogleCredential.Builder	setServiceAccountPrivateKeyFromPemFile(File pemFile) Beta Sets the private key to use with the service account flow or null for none.
GoogleCredential.Builder	setServiceAccountPrivateKeyId(String serviceAccountPrivateKeyId) Beta Sets the id of the private key to use with the service account flow or null for none.
GoogleCredential.Builder	setServiceAccountProjectId(String serviceAccountProjectId) Sets the service account Project ID or null for none.
GoogleCredential.Builder	setServiceAccountScopes(Collection<String> serviceAccountScopes) Sets the space-separated OAuth scopes to use with the service account flow or null for none.
GoogleCredential.Builder	setServiceAccountUser(String serviceAccountUser) Sets the email address of the user the application is trying to impersonate in the service account flow or null for none.
GoogleCredential.Builder	setTokenServerEncodedUrl(String tokenServerEncodedUrl)
GoogleCredential.Builder	setTokenServerUrl(GenericUrl tokenServerUrl)
GoogleCredential.Builder	setTransport(HttpTransport transport)

Methods inherited from class com.google.api.client.auth.oauth2.Credential.Builder

getClientAuthentication, getClock, getJsonFactory, getMethod, getRefreshListeners, getRequestInitializer, getTokenServerUrl, getTransport

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

build

public GoogleCredential build()

Overrides:

build in class Credential.Builder

setTransport

public GoogleCredential.Builder setTransport(HttpTransport transport)

Overrides:

setTransport in class Credential.Builder

setJsonFactory

public GoogleCredential.Builder setJsonFactory(JsonFactory jsonFactory)

Overrides:

setJsonFactory in class Credential.Builder

setClock

public GoogleCredential.Builder setClock(Clock clock)

Overrides:

setClock in class Credential.Builder

Since:

1.9

setClientSecrets

public GoogleCredential.Builder setClientSecrets(String clientId,
                                                 String clientSecret)

Sets the client identifier and secret.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

setClientSecrets

public GoogleCredential.Builder setClientSecrets(GoogleClientSecrets clientSecrets)

Sets the client secrets.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getServiceAccountId

public final String getServiceAccountId()

Returns the service account ID (typically an e-mail address) or null for none.

setServiceAccountId

public GoogleCredential.Builder setServiceAccountId(String serviceAccountId)

Sets the service account ID (typically an e-mail address) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getServiceAccountProjectId

public final String getServiceAccountProjectId()

Returns the service account Project ID or null for none.

setServiceAccountProjectId

public GoogleCredential.Builder setServiceAccountProjectId(String serviceAccountProjectId)

Sets the service account Project ID or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getServiceAccountScopes

public final Collection<String> getServiceAccountScopes()

Returns a collection of OAuth scopes to use with the service account flow or null for none.

setServiceAccountScopes

public GoogleCredential.Builder setServiceAccountScopes(Collection<String> serviceAccountScopes)

Sets the space-separated OAuth scopes to use with the service account flow or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameters:

serviceAccountScopes - collection of scopes to be joined by a space separator (or a single value containing multiple space-separated scopes)

Since:

1.15

getServiceAccountPrivateKey

public final PrivateKey getServiceAccountPrivateKey()

Returns the private key to use with the service account flow or null for none.

setServiceAccountPrivateKey

public GoogleCredential.Builder setServiceAccountPrivateKey(PrivateKey serviceAccountPrivateKey)

Sets the private key to use with the service account flow or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

getServiceAccountPrivateKeyId

@Beta
public final String getServiceAccountPrivateKeyId()

Beta
Returns the id of the private key to use with the service account flow or null for none.

setServiceAccountPrivateKeyId

@Beta
public GoogleCredential.Builder setServiceAccountPrivateKeyId(String serviceAccountPrivateKeyId)

Beta
Sets the id of the private key to use with the service account flow or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

setServiceAccountPrivateKeyFromP12File

public GoogleCredential.Builder setServiceAccountPrivateKeyFromP12File(File p12File)
                                                                throws GeneralSecurityException,
                                                                       IOException

Sets the private key to use with the service account flow or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameters:

p12File - p12 file object

Throws:

GeneralSecurityException

IOException

setServiceAccountPrivateKeyFromP12File

public GoogleCredential.Builder setServiceAccountPrivateKeyFromP12File(InputStream p12FileInputStream)
                                                                throws GeneralSecurityException,
                                                                       IOException

Sets the private key to use with the service account flow or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameters:

p12FileInputStream - input stream to the p12 file. This file is closed at the end of this method in a finally block.

Throws:

GeneralSecurityException

IOException

setServiceAccountPrivateKeyFromPemFile

@Beta
public GoogleCredential.Builder setServiceAccountPrivateKeyFromPemFile(File pemFile)
                                                                      throws GeneralSecurityException,
                                                                             IOException

Beta
Sets the private key to use with the service account flow or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameters:

pemFile - input stream to the PEM file (closed at the end of this method in a finally block)

Throws:

GeneralSecurityException

IOException

Since:

1.13

getServiceAccountUser

public final String getServiceAccountUser()

Returns the email address of the user the application is trying to impersonate in the service account flow or null for none.

setServiceAccountUser

public GoogleCredential.Builder setServiceAccountUser(String serviceAccountUser)

Sets the email address of the user the application is trying to impersonate in the service account flow or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

setRequestInitializer

public GoogleCredential.Builder setRequestInitializer(HttpRequestInitializer requestInitializer)

Overrides:

setRequestInitializer in class Credential.Builder

addRefreshListener

public GoogleCredential.Builder addRefreshListener(CredentialRefreshListener refreshListener)

Overrides:

addRefreshListener in class Credential.Builder

setRefreshListeners

public GoogleCredential.Builder setRefreshListeners(Collection<CredentialRefreshListener> refreshListeners)

Overrides:

setRefreshListeners in class Credential.Builder

setTokenServerUrl

public GoogleCredential.Builder setTokenServerUrl(GenericUrl tokenServerUrl)

Overrides:

setTokenServerUrl in class Credential.Builder

setTokenServerEncodedUrl

public GoogleCredential.Builder setTokenServerEncodedUrl(String tokenServerEncodedUrl)

Overrides:

setTokenServerEncodedUrl in class Credential.Builder

setClientAuthentication

public GoogleCredential.Builder setClientAuthentication(HttpExecuteInterceptor clientAuthentication)

Overrides:

setClientAuthentication in class Credential.Builder