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

Class GoogleAuthorizationCodeFlow.Builder

java.lang.Object

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

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

Enclosing class:

GoogleAuthorizationCodeFlow

public static class GoogleAuthorizationCodeFlow.Builder
extends AuthorizationCodeFlow.Builder

Google authorization code flow builder.

Implementation is not thread-safe.

Constructor Summary

Constructors

Constructor and Description
Builder(HttpTransport transport, JsonFactory jsonFactory, GoogleClientSecrets clientSecrets, Collection<String> scopes)
Builder(HttpTransport transport, JsonFactory jsonFactory, String clientId, String clientSecret, Collection<String> scopes)

Method Summary

Modifier and Type	Method and Description
GoogleAuthorizationCodeFlow.Builder	addRefreshListener(CredentialRefreshListener refreshListener)
GoogleAuthorizationCodeFlow	build()
String	getAccessType() Returns the access type ("online" to request online access or "offline" to request offline access) or null for the default behavior of "online".
String	getApprovalPrompt() Returns the approval prompt behavior ("auto" to request auto-approval or "force" to force the approval UI to show) or null for the default behavior of "auto".
GoogleAuthorizationCodeFlow.Builder	setAccessType(String accessType) Sets the access type ("online" to request online access or "offline" to request offline access) or null for the default behavior ("online" for web applications and "offline" for installed applications).
GoogleAuthorizationCodeFlow.Builder	setApprovalPrompt(String approvalPrompt) Sets the approval prompt behavior ("auto" to request auto-approval or "force" to force the approval UI to show) or null for the default behavior ("auto" for web applications and "force" for installed applications).
GoogleAuthorizationCodeFlow.Builder	setAuthorizationServerEncodedUrl(String authorizationServerEncodedUrl)
GoogleAuthorizationCodeFlow.Builder	setClientAuthentication(HttpExecuteInterceptor clientAuthentication)
GoogleAuthorizationCodeFlow.Builder	setClientId(String clientId)
GoogleAuthorizationCodeFlow.Builder	setClock(Clock clock)
GoogleAuthorizationCodeFlow.Builder	setCredentialCreatedListener(AuthorizationCodeFlow.CredentialCreatedListener credentialCreatedListener)
GoogleAuthorizationCodeFlow.Builder	setCredentialDataStore(DataStore<StoredCredential> typedDataStore)
GoogleAuthorizationCodeFlow.Builder	setCredentialStore(CredentialStore credentialStore) Deprecated.
GoogleAuthorizationCodeFlow.Builder	setDataStoreFactory(DataStoreFactory dataStore)
GoogleAuthorizationCodeFlow.Builder	setJsonFactory(JsonFactory jsonFactory)
GoogleAuthorizationCodeFlow.Builder	setMethod(Credential.AccessMethod method)
GoogleAuthorizationCodeFlow.Builder	setRefreshListeners(Collection<CredentialRefreshListener> refreshListeners)
GoogleAuthorizationCodeFlow.Builder	setRequestInitializer(HttpRequestInitializer requestInitializer)
GoogleAuthorizationCodeFlow.Builder	setScopes(Collection<String> scopes)
GoogleAuthorizationCodeFlow.Builder	setTokenServerUrl(GenericUrl tokenServerUrl)
GoogleAuthorizationCodeFlow.Builder	setTransport(HttpTransport transport)

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

enablePKCE, getAuthorizationServerEncodedUrl, getClientAuthentication, getClientId, getClock, getCredentialCreatedListener, getCredentialDataStore, getCredentialStore, getJsonFactory, getMethod, getRefreshListeners, getRequestInitializer, getScopes, 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(HttpTransport transport,
               JsonFactory jsonFactory,
               String clientId,
               String clientSecret,
               Collection<String> scopes)

Parameters:

transport - HTTP transport

jsonFactory - JSON factory

clientId - client identifier

clientSecret - client secret

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

Since:

1.15

Builder

public Builder(HttpTransport transport,
               JsonFactory jsonFactory,
               GoogleClientSecrets clientSecrets,
               Collection<String> scopes)

Parameters:

transport - HTTP transport

jsonFactory - JSON factory

clientSecrets - Google client secrets

scopes - collection of scopes to be joined by a space separator

Since:

1.15

Method Detail

build

public GoogleAuthorizationCodeFlow build()

Overrides:

build in class AuthorizationCodeFlow.Builder

setDataStoreFactory

public GoogleAuthorizationCodeFlow.Builder setDataStoreFactory(DataStoreFactory dataStore)
                                                        throws IOException

Overrides:

setDataStoreFactory in class AuthorizationCodeFlow.Builder

Throws:

IOException

setCredentialDataStore

public GoogleAuthorizationCodeFlow.Builder setCredentialDataStore(DataStore<StoredCredential> typedDataStore)

Overrides:

setCredentialDataStore in class AuthorizationCodeFlow.Builder

setCredentialCreatedListener

public GoogleAuthorizationCodeFlow.Builder setCredentialCreatedListener(AuthorizationCodeFlow.CredentialCreatedListener credentialCreatedListener)

Overrides:

setCredentialCreatedListener in class AuthorizationCodeFlow.Builder

setCredentialStore

@Beta
 @Deprecated
public GoogleAuthorizationCodeFlow.Builder setCredentialStore(CredentialStore credentialStore)

Deprecated.

Overrides:

setCredentialStore in class AuthorizationCodeFlow.Builder

setRequestInitializer

public GoogleAuthorizationCodeFlow.Builder setRequestInitializer(HttpRequestInitializer requestInitializer)

Overrides:

setRequestInitializer in class AuthorizationCodeFlow.Builder

setScopes

public GoogleAuthorizationCodeFlow.Builder setScopes(Collection<String> scopes)

Overrides:

setScopes in class AuthorizationCodeFlow.Builder

setMethod

public GoogleAuthorizationCodeFlow.Builder setMethod(Credential.AccessMethod method)

Overrides:

setMethod in class AuthorizationCodeFlow.Builder

Since:

1.11

setTransport

public GoogleAuthorizationCodeFlow.Builder setTransport(HttpTransport transport)

Overrides:

setTransport in class AuthorizationCodeFlow.Builder

Since:

1.11

setJsonFactory

public GoogleAuthorizationCodeFlow.Builder setJsonFactory(JsonFactory jsonFactory)

Overrides:

setJsonFactory in class AuthorizationCodeFlow.Builder

Since:

1.11

setTokenServerUrl

public GoogleAuthorizationCodeFlow.Builder setTokenServerUrl(GenericUrl tokenServerUrl)

Overrides:

setTokenServerUrl in class AuthorizationCodeFlow.Builder

Since:

1.11

setClientAuthentication

public GoogleAuthorizationCodeFlow.Builder setClientAuthentication(HttpExecuteInterceptor clientAuthentication)

Overrides:

setClientAuthentication in class AuthorizationCodeFlow.Builder

Since:

1.11

setClientId

public GoogleAuthorizationCodeFlow.Builder setClientId(String clientId)

Overrides:

setClientId in class AuthorizationCodeFlow.Builder

Since:

1.11

setAuthorizationServerEncodedUrl

public GoogleAuthorizationCodeFlow.Builder setAuthorizationServerEncodedUrl(String authorizationServerEncodedUrl)

Overrides:

setAuthorizationServerEncodedUrl in class AuthorizationCodeFlow.Builder

Since:

1.11

setClock

public GoogleAuthorizationCodeFlow.Builder setClock(Clock clock)

Overrides:

setClock in class AuthorizationCodeFlow.Builder

Since:

1.11

addRefreshListener

public GoogleAuthorizationCodeFlow.Builder addRefreshListener(CredentialRefreshListener refreshListener)

Overrides:

addRefreshListener in class AuthorizationCodeFlow.Builder

setRefreshListeners

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

Overrides:

setRefreshListeners in class AuthorizationCodeFlow.Builder

setApprovalPrompt

public GoogleAuthorizationCodeFlow.Builder setApprovalPrompt(String approvalPrompt)

Sets the approval prompt behavior ("auto" to request auto-approval or "force" to force the approval UI to show) or null for the default behavior ("auto" for web applications and "force" for installed applications).

By default this has the value null.

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

getApprovalPrompt

public final String getApprovalPrompt()

Returns the approval prompt behavior ("auto" to request auto-approval or "force" to force the approval UI to show) or null for the default behavior of "auto".

setAccessType

public GoogleAuthorizationCodeFlow.Builder setAccessType(String accessType)

Sets the access type ("online" to request online access or "offline" to request offline access) or null for the default behavior ("online" for web applications and "offline" for installed applications).

By default this has the value null.

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

getAccessType

public final String getAccessType()

Returns the access type ("online" to request online access or "offline" to request offline access) or null for the default behavior of "online".