Class AuthorizationCodeFlow.Builder
- java.lang.Object
-
- com.google.api.client.auth.oauth2.AuthorizationCodeFlow.Builder
-
- Enclosing class:
- AuthorizationCodeFlow
public static class AuthorizationCodeFlow.Builder extends Object
Authorization code flow builder.Implementation is not thread-safe.
-
-
Constructor Summary
Constructors Constructor Description Builder(Credential.AccessMethod method, com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.GenericUrl tokenServerUrl, com.google.api.client.http.HttpExecuteInterceptor clientAuthentication, String clientId, String authorizationServerEncodedUrl)
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description AuthorizationCodeFlow.Builder
addRefreshListener(CredentialRefreshListener refreshListener)
Adds a listener for refresh token results.AuthorizationCodeFlow
build()
Returns a new instance of an authorization code flow based on this builder.String
getAuthorizationServerEncodedUrl()
Returns the authorization server encoded URL.com.google.api.client.http.HttpExecuteInterceptor
getClientAuthentication()
Returns the client authentication ornull
for none (seeTokenRequest.setClientAuthentication(HttpExecuteInterceptor)
).String
getClientId()
Returns the client identifier.com.google.api.client.util.Clock
getClock()
Returns the clock passed along to the Credential orClock.SYSTEM
when system default is used.AuthorizationCodeFlow.CredentialCreatedListener
getCredentialCreatedListener()
Returns the credential created listener ornull
for none.com.google.api.client.util.store.DataStore<StoredCredential>
getCredentialDataStore()
Beta
Returns the stored credential data store ornull
for none.CredentialStore
getCredentialStore()
Deprecated.(to be removed in the future) UsegetCredentialDataStore()
instead.com.google.api.client.json.JsonFactory
getJsonFactory()
Returns the JSON factory.Credential.AccessMethod
getMethod()
Returns the method of presenting the access token to the resource server (for exampleBearerToken.authorizationHeaderAccessMethod()
).Collection<CredentialRefreshListener>
getRefreshListeners()
Returns the listeners for refresh token results.com.google.api.client.http.HttpRequestInitializer
getRequestInitializer()
Returns the HTTP request initializer ornull
for none.Collection<String>
getScopes()
Returns a collection of scopes.com.google.api.client.http.GenericUrl
getTokenServerUrl()
Returns the token server URL.com.google.api.client.http.HttpTransport
getTransport()
Returns the HTTP transport.AuthorizationCodeFlow.Builder
setAuthorizationServerEncodedUrl(String authorizationServerEncodedUrl)
Sets the authorization server encoded URL.AuthorizationCodeFlow.Builder
setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication)
Sets the client authentication ornull
for none (seeTokenRequest.setClientAuthentication(HttpExecuteInterceptor)
).AuthorizationCodeFlow.Builder
setClientId(String clientId)
Sets the client identifier.AuthorizationCodeFlow.Builder
setClock(com.google.api.client.util.Clock clock)
Sets the clock to pass to the Credential.AuthorizationCodeFlow.Builder
setCredentialCreatedListener(AuthorizationCodeFlow.CredentialCreatedListener credentialCreatedListener)
Sets the credential created listener ornull
for none.AuthorizationCodeFlow.Builder
setCredentialDataStore(com.google.api.client.util.store.DataStore<StoredCredential> credentialDataStore)
Beta
Sets the stored credential data store ornull
for none.AuthorizationCodeFlow.Builder
setCredentialStore(CredentialStore credentialStore)
Deprecated.(to be removed in the future) UsesetDataStoreFactory(DataStoreFactory)
orsetCredentialDataStore(DataStore)
instead.AuthorizationCodeFlow.Builder
setDataStoreFactory(com.google.api.client.util.store.DataStoreFactory dataStoreFactory)
Beta
Sets the data store factory ornull
for none.AuthorizationCodeFlow.Builder
setJsonFactory(com.google.api.client.json.JsonFactory jsonFactory)
Sets the JSON factory.AuthorizationCodeFlow.Builder
setMethod(Credential.AccessMethod method)
Sets the method of presenting the access token to the resource server (for exampleBearerToken.authorizationHeaderAccessMethod()
).AuthorizationCodeFlow.Builder
setRefreshListeners(Collection<CredentialRefreshListener> refreshListeners)
Sets the listeners for refresh token results.AuthorizationCodeFlow.Builder
setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer)
Sets the HTTP request initializer ornull
for none.AuthorizationCodeFlow.Builder
setScopes(Collection<String> scopes)
Sets the collection of scopes.AuthorizationCodeFlow.Builder
setTokenServerUrl(com.google.api.client.http.GenericUrl tokenServerUrl)
Sets the token server URL.AuthorizationCodeFlow.Builder
setTransport(com.google.api.client.http.HttpTransport transport)
Sets the HTTP transport.
-
-
-
Constructor Detail
-
Builder
public Builder(Credential.AccessMethod method, com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.GenericUrl tokenServerUrl, com.google.api.client.http.HttpExecuteInterceptor clientAuthentication, String clientId, String authorizationServerEncodedUrl)
- Parameters:
method
- method of presenting the access token to the resource server (for exampleBearerToken.authorizationHeaderAccessMethod()
)transport
- HTTP transportjsonFactory
- JSON factorytokenServerUrl
- token server URLclientAuthentication
- client authentication ornull
for none (seeTokenRequest.setClientAuthentication(HttpExecuteInterceptor)
)clientId
- client identifierauthorizationServerEncodedUrl
- authorization server encoded URL
-
-
Method Detail
-
build
public AuthorizationCodeFlow build()
Returns a new instance of an authorization code flow based on this builder.
-
getMethod
public final Credential.AccessMethod getMethod()
Returns the method of presenting the access token to the resource server (for exampleBearerToken.authorizationHeaderAccessMethod()
).
-
setMethod
public AuthorizationCodeFlow.Builder setMethod(Credential.AccessMethod method)
Sets the method of presenting the access token to the resource server (for exampleBearerToken.authorizationHeaderAccessMethod()
).Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.11
-
getTransport
public final com.google.api.client.http.HttpTransport getTransport()
Returns the HTTP transport.
-
setTransport
public AuthorizationCodeFlow.Builder setTransport(com.google.api.client.http.HttpTransport transport)
Sets the HTTP transport.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.11
-
getJsonFactory
public final com.google.api.client.json.JsonFactory getJsonFactory()
Returns the JSON factory.
-
setJsonFactory
public AuthorizationCodeFlow.Builder setJsonFactory(com.google.api.client.json.JsonFactory jsonFactory)
Sets the JSON factory.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.11
-
getTokenServerUrl
public final com.google.api.client.http.GenericUrl getTokenServerUrl()
Returns the token server URL.
-
setTokenServerUrl
public AuthorizationCodeFlow.Builder setTokenServerUrl(com.google.api.client.http.GenericUrl tokenServerUrl)
Sets the token server URL.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.11
-
getClientAuthentication
public final com.google.api.client.http.HttpExecuteInterceptor getClientAuthentication()
Returns the client authentication ornull
for none (seeTokenRequest.setClientAuthentication(HttpExecuteInterceptor)
).
-
setClientAuthentication
public AuthorizationCodeFlow.Builder setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication)
Sets the client authentication ornull
for none (seeTokenRequest.setClientAuthentication(HttpExecuteInterceptor)
).Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.11
-
getClientId
public final String getClientId()
Returns the client identifier.
-
setClientId
public AuthorizationCodeFlow.Builder setClientId(String clientId)
Sets the client identifier.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.11
-
getAuthorizationServerEncodedUrl
public final String getAuthorizationServerEncodedUrl()
Returns the authorization server encoded URL.
-
setAuthorizationServerEncodedUrl
public AuthorizationCodeFlow.Builder setAuthorizationServerEncodedUrl(String authorizationServerEncodedUrl)
Sets the authorization server encoded URL.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.11
-
getCredentialStore
@Beta @Deprecated public final CredentialStore getCredentialStore()
Deprecated.(to be removed in the future) UsegetCredentialDataStore()
instead.Beta
Returns the credential persistence store ornull
for none.
-
getCredentialDataStore
@Beta public final com.google.api.client.util.store.DataStore<StoredCredential> getCredentialDataStore()
Beta
Returns the stored credential data store ornull
for none.- Since:
- 1.16
-
getClock
public final com.google.api.client.util.Clock getClock()
Returns the clock passed along to the Credential orClock.SYSTEM
when system default is used.- Since:
- 1.9
-
setClock
public AuthorizationCodeFlow.Builder setClock(com.google.api.client.util.Clock clock)
Sets the clock to pass to the Credential.The default value for this parameter is
Clock.SYSTEM
Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.9
-
setCredentialStore
@Beta @Deprecated public AuthorizationCodeFlow.Builder setCredentialStore(CredentialStore credentialStore)
Deprecated.(to be removed in the future) UsesetDataStoreFactory(DataStoreFactory)
orsetCredentialDataStore(DataStore)
instead.Beta
Sets the credential persistence store ornull
for none.Warning: not compatible with
setDataStoreFactory(com.google.api.client.util.store.DataStoreFactory)
orsetCredentialDataStore(com.google.api.client.util.store.DataStore<com.google.api.client.auth.oauth2.StoredCredential>)
, and if either of those is called before this method is called, this method will throw anIllegalArgumentException
.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
setDataStoreFactory
@Beta public AuthorizationCodeFlow.Builder setDataStoreFactory(com.google.api.client.util.store.DataStoreFactory dataStoreFactory) throws IOException
Beta
Sets the data store factory ornull
for none.Warning: not compatible with
setCredentialStore(com.google.api.client.auth.oauth2.CredentialStore)
, and if it is called before this method is called, this method will throw anIllegalArgumentException
.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Throws:
IOException
- Since:
- 1.16
-
setCredentialDataStore
@Beta public AuthorizationCodeFlow.Builder setCredentialDataStore(com.google.api.client.util.store.DataStore<StoredCredential> credentialDataStore)
Beta
Sets the stored credential data store ornull
for none.Warning: not compatible with
setCredentialStore(com.google.api.client.auth.oauth2.CredentialStore)
, and if it is called before this method is called, this method will throw anIllegalArgumentException
.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.16
-
getRequestInitializer
public final com.google.api.client.http.HttpRequestInitializer getRequestInitializer()
Returns the HTTP request initializer ornull
for none.
-
setRequestInitializer
public AuthorizationCodeFlow.Builder setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer)
Sets the HTTP request initializer ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
setScopes
public AuthorizationCodeFlow.Builder setScopes(Collection<String> scopes)
Sets the collection of scopes.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Parameters:
scopes
- collection of scopes- Since:
- 1.15
-
getScopes
public final Collection<String> getScopes()
Returns a collection of scopes.
-
setCredentialCreatedListener
public AuthorizationCodeFlow.Builder setCredentialCreatedListener(AuthorizationCodeFlow.CredentialCreatedListener credentialCreatedListener)
Sets the credential created listener ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.14
-
addRefreshListener
public AuthorizationCodeFlow.Builder addRefreshListener(CredentialRefreshListener refreshListener)
Adds a listener for refresh token results.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Parameters:
refreshListener
- refresh listener- Since:
- 1.15
-
getRefreshListeners
public final Collection<CredentialRefreshListener> getRefreshListeners()
Returns the listeners for refresh token results.- Since:
- 1.15
-
setRefreshListeners
public AuthorizationCodeFlow.Builder setRefreshListeners(Collection<CredentialRefreshListener> refreshListeners)
Sets the listeners for refresh token results.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Since:
- 1.15
-
getCredentialCreatedListener
public final AuthorizationCodeFlow.CredentialCreatedListener getCredentialCreatedListener()
Returns the credential created listener ornull
for none.- Since:
- 1.14
-
-