Package com.google.api.client.auth.oauth2

Class AuthorizationCodeFlow.Builder

  • Enclosing class:
    AuthorizationCodeFlow
    public static class AuthorizationCodeFlow.Builder
extends java.lang.Object
    Authorization code flow builder.

    Implementation is not thread-safe.

    • Field Detail

      • transport

        com.google.api.client.http.HttpTransport transport
        HTTP transport.

      • jsonFactory

        com.google.api.client.json.JsonFactory jsonFactory
        JSON factory.

      • tokenServerUrl

        com.google.api.client.http.GenericUrl tokenServerUrl
        Token server URL.

      • clientId

        java.lang.String clientId
        Client identifier.

      • authorizationServerEncodedUrl

        java.lang.String authorizationServerEncodedUrl
        Authorization server encoded URL.

      • credentialStore

        @Deprecated
@Beta
CredentialStore credentialStore
        Deprecated.
        Credential persistence store or null for none.

      • credentialDataStore

        @Beta
com.google.api.client.util.store.DataStore<StoredCredential> credentialDataStore
        Stored credential data store or null for none.

      • requestInitializer

        com.google.api.client.http.HttpRequestInitializer requestInitializer
        HTTP request initializer or null for none.

      • scopes

        java.util.Collection<java.lang.String> scopes
        Collection of scopes.

      • clock

        com.google.api.client.util.Clock clock
        Clock passed along to the Credential.

      • refreshListeners

        java.util.Collection<CredentialRefreshListener> refreshListeners
        Refresh listeners provided by the client.

    • 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,
               java.lang.String clientId,
               java.lang.String authorizationServerEncodedUrl)
        Parameters:
        method - method of presenting the access token to the resource server (for example BearerToken.authorizationHeaderAccessMethod())
        transport - HTTP transport
        jsonFactory - JSON factory
        tokenServerUrl - token server URL
        clientAuthentication - client authentication or null for none (see TokenRequest.setClientAuthentication(HttpExecuteInterceptor))
        clientId - client identifier
        authorizationServerEncodedUrl - authorization server encoded URL

    • Method Detail

      • build

        public AuthorizationCodeFlow build()
        Returns a new instance of an authorization code flow based on this builder.

      • 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

      • getClientId

        public final java.lang.String getClientId()
        Returns the client identifier.

      • setClientId

        public AuthorizationCodeFlow.Builder setClientId​(java.lang.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 java.lang.String getAuthorizationServerEncodedUrl()
        Returns the authorization server encoded URL.

      • setAuthorizationServerEncodedUrl

        public AuthorizationCodeFlow.Builder setAuthorizationServerEncodedUrl​(java.lang.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) Use getCredentialDataStore() instead.
        Beta
        Returns the credential persistence store or null for none.

      • getCredentialDataStore

        @Beta
public final com.google.api.client.util.store.DataStore<StoredCredential> getCredentialDataStore()
        Beta
        Returns the stored credential data store or null for none.
        Since:
        1.16

      • getClock

        public final com.google.api.client.util.Clock getClock()
        Returns the clock passed along to the Credential or Clock.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

      • setDataStoreFactory

        @Beta
public AuthorizationCodeFlow.Builder setDataStoreFactory​(com.google.api.client.util.store.DataStoreFactory dataStoreFactory)
                                                  throws java.io.IOException
        Beta
        Sets the data store factory or null 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 an IllegalArgumentException.

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

        Throws:
        java.io.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 or null 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 an IllegalArgumentException.

        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 or null for none.

      • setRequestInitializer

        public AuthorizationCodeFlow.Builder setRequestInitializer​(com.google.api.client.http.HttpRequestInitializer requestInitializer)
        Sets the HTTP request initializer or null 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​(java.util.Collection<java.lang.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 java.util.Collection<java.lang.String> getScopes()
        Returns a collection of scopes.

      • 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 java.util.Collection<CredentialRefreshListener> getRefreshListeners()
        Returns the listeners for refresh token results.
        Since:
        1.15

      • setRefreshListeners

        public AuthorizationCodeFlow.Builder setRefreshListeners​(java.util.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