com.google.api.client.extensions.java6.auth.oauth2

Class AuthorizationCodeInstalledApp

java.lang.Object

com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp

public class AuthorizationCodeInstalledApp
extends Object

OAuth 2.0 authorization code flow for an installed Java application that persists end-user credentials.

Implementation is thread-safe.

Since:

1.11

Author:

Yaniv Inbar, Philipp Hanslovsky

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthorizationCodeInstalledApp.Browser Helper interface to allow caller to browse.
static class	AuthorizationCodeInstalledApp.DefaultBrowser Default browser that just delegates to browse(String).

Constructor Summary

Constructors

Constructor and Description
AuthorizationCodeInstalledApp(AuthorizationCodeFlow flow, VerificationCodeReceiver receiver)
AuthorizationCodeInstalledApp(AuthorizationCodeFlow flow, VerificationCodeReceiver receiver, AuthorizationCodeInstalledApp.Browser browser)

Method Summary

Modifier and Type	Method and Description
Credential	authorize(String userId) Authorizes the installed application to access user's protected data.
static void	browse(String url) Open a browser at the given URL using Desktop if available, or alternatively output the URL to System.out for command-line applications.
AuthorizationCodeFlow	getFlow() Returns the authorization code flow.
VerificationCodeReceiver	getReceiver() Returns the verification code receiver.
protected void	onAuthorization(AuthorizationCodeRequestUrl authorizationUrl) Handles user authorization by redirecting to the OAuth 2.0 authorization server.

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationCodeInstalledApp

public AuthorizationCodeInstalledApp(AuthorizationCodeFlow flow,
                                     VerificationCodeReceiver receiver)

Parameters:

flow - authorization code flow

receiver - verification code receiver

AuthorizationCodeInstalledApp

public AuthorizationCodeInstalledApp(AuthorizationCodeFlow flow,
                                     VerificationCodeReceiver receiver,
                                     AuthorizationCodeInstalledApp.Browser browser)

Parameters:

flow - authorization code flow

receiver - verification code receiver

Method Detail

authorize

public Credential authorize(String userId)
                     throws IOException

Authorizes the installed application to access user's protected data.

Parameters:

userId - user ID or null if not using a persisted credential store

Returns:

credential

Throws:

IOException

onAuthorization

protected void onAuthorization(AuthorizationCodeRequestUrl authorizationUrl)
                        throws IOException

Handles user authorization by redirecting to the OAuth 2.0 authorization server.

Default implementation is to call browse(authorizationUrl.build()). Subclasses may override to provide optional parameters such as the recommended state parameter. Sample implementation:

  @Override
  protected void onAuthorization(AuthorizationCodeRequestUrl authorizationUrl) throws IOException {
    authorizationUrl.setState("xyz");
    super.onAuthorization(authorizationUrl);
  }
 

Parameters:

authorizationUrl - authorization URL

Throws:

IOException - I/O exception

browse

public static void browse(String url)

Open a browser at the given URL using Desktop if available, or alternatively output the URL to System.out for command-line applications.

Parameters:

url - URL to browse

getFlow

public final AuthorizationCodeFlow getFlow()

Returns the authorization code flow.

getReceiver

public final VerificationCodeReceiver getReceiver()

Returns the verification code receiver.