com.google.api.client.auth.oauth2

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 and Description
AuthorizationCodeFlow.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

Methods

Modifier and Type	Method and Description
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 or null for none (see TokenRequest.setClientAuthentication(HttpExecuteInterceptor)).
String	getClientId() Returns the client identifier.
com.google.api.client.util.Clock	getClock() Returns the clock passed along to the Credential or Clock.SYSTEM when system default is used.
CredentialStore	getCredentialStore() Returns the credential persistence store or null for none.
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 example BearerToken.authorizationHeaderAccessMethod()).
com.google.api.client.http.HttpRequestInitializer	getRequestInitializer() Returns the HTTP request initializer or null for none.
String	getScopes() Returns the space-separated list of scopes or null for none.
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 or null for none (see TokenRequest.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	setCredentialStore(CredentialStore credentialStore) Sets the credential persistence store or null 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 example BearerToken.authorizationHeaderAccessMethod()).
AuthorizationCodeFlow.Builder	setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer) Sets the HTTP request initializer or null for none.
AuthorizationCodeFlow.Builder	setScopes(Iterable<String> scopes) Sets the list of scopes or null for none.
AuthorizationCodeFlow.Builder	setScopes(String... scopes) Sets the list of scopes or null for none.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationCodeFlow.Builder

public AuthorizationCodeFlow.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 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.

getMethod

public final Credential.AccessMethod getMethod()

Returns the method of presenting the access token to the resource server (for example BearerToken.authorizationHeaderAccessMethod()).

setMethod

public AuthorizationCodeFlow.Builder setMethod(Credential.AccessMethod method)

Sets the method of presenting the access token to the resource server (for example BearerToken.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 or null for none (see TokenRequest.setClientAuthentication(HttpExecuteInterceptor)).

setClientAuthentication

public AuthorizationCodeFlow.Builder setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication)

Sets the client authentication or null for none (see TokenRequest.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

public final CredentialStore getCredentialStore()

Returns the credential persistence store or null for none.

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

setCredentialStore

public AuthorizationCodeFlow.Builder setCredentialStore(CredentialStore credentialStore)

Sets the credential persistence store or null for none.

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

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(Iterable<String> scopes)

Sets the list of scopes 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:

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

setScopes

public AuthorizationCodeFlow.Builder setScopes(String... scopes)

Sets the list of scopes 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:

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

getScopes

public final String getScopes()

Returns the space-separated list of scopes or null for none.