Package 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

Field Summary

Fields

Modifier and Type	Field	Description
private final AuthorizationCodeFlow	flow	Authorization code flow.
private static final Logger	LOGGER
private final VerificationCodeReceiver	receiver	Verification code receiver.

Constructor Summary

Constructors

Constructor	Description
AuthorizationCodeInstalledApp(AuthorizationCodeFlow flow, VerificationCodeReceiver receiver)

Method Summary

Modifier and Type	Method	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.
final AuthorizationCodeFlow	getFlow()	Returns the authorization code flow.
final 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

Field Details

flow

private final AuthorizationCodeFlow flow

Authorization code flow.

receiver

private final VerificationCodeReceiver receiver

Verification code receiver.

LOGGER

private static final Logger LOGGER

Constructor Details

AuthorizationCodeInstalledApp

public AuthorizationCodeInstalledApp(AuthorizationCodeFlow flow,
 VerificationCodeReceiver receiver)

Parameters:

flow - authorization code flow

receiver - verification code receiver

Method Details

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.