Class AuthorizationCodeFlow (1.37.0)

Thread-safe OAuth 2.0 authorization code flow that manages and persists end-user credentials.

This is designed to simplify the flow in which an end-user authorizes the application to access their protected data, and then the application has access to their data based on an access token and a refresh token to refresh that access token when it expires.

The first step is to call #loadCredential(String) based on the known user ID to check if the end-user's credentials are already known. If not, call #newAuthorizationUrl() and direct the end-user's browser to an authorization page. The web browser will then redirect to the redirect URL with a "code" query parameter which can then be used to request an access token using #newTokenRequest(String). Finally, use #createAndStoreCredential(TokenResponse, String) to store and obtain a credential for accessing protected resources.

Creates a new credential for the given user ID based on the given token response and stores it in the credential store.

Returns the authorization server encoded URL.

Returns the client authentication or null for none (see TokenRequest#setClientAuthentication(HttpExecuteInterceptor)).

Returns the client identifier.

Returns the clock which will be passed along to the Credential.

Beta
Returns the stored credential data store or null for none.

Deprecated. (to be removed in the future) Use #getCredentialDataStore() instead.

Beta
Returns the credential persistence store or null for none.

Returns the JSON factory.

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

Returns the unmodifiable list of listeners for refresh token results.

Returns the HTTP request initializer or null for none.

Returns the a collection of scopes.

Returns the space-separated list of scopes.

Returns the token server encoded URL.

Returns the HTTP transport.

Loads the credential of the given user ID from the credential store.

Returns a new instance of an authorization code request URL.

This is a builder for an authorization web page to allow the end user to authorize the application to access their protected resources and that returns an authorization code. It uses the #getAuthorizationServerEncodedUrl(), #getClientId(), and #getScopes(). Sample usage:

 private AuthorizationCodeFlow flow;

 public void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
 String url = flow.newAuthorizationUrl().setState("xyz")
 .setRedirectUri("https://client.example.com/rd").build();
 response.sendRedirect(url);
 }
 

Returns a new instance of an authorization code token request based on the given authorization code.

This is used to make a request for an access token using the authorization code. It uses #getTransport(), #getJsonFactory(), #getTokenServerEncodedUrl(), #getClientAuthentication(), #getRequestInitializer(), and #getScopes().

static TokenResponse requestAccessToken(AuthorizationCodeFlow flow, String code) throws IOException, TokenResponseException { return flow.newTokenRequest(code).setRedirectUri("https://client.example.com/rd").execute(); }