Class AuthorizationCodeInstalledApp
java.lang.Object
com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp
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
FieldsModifier and TypeFieldDescriptionprivate final AuthorizationCodeFlow
Authorization code flow.private static final Logger
private final VerificationCodeReceiver
Verification code receiver. -
Constructor Summary
ConstructorsConstructorDescription -
Method Summary
Modifier and TypeMethodDescriptionAuthorizes the installed application to access user's protected data.static void
Open a browser at the given URL usingDesktop
if available, or alternatively output the URL toSystem.out
for command-line applications.final AuthorizationCodeFlow
getFlow()
Returns the authorization code flow.final VerificationCodeReceiver
Returns the verification code receiver.protected void
onAuthorization
(AuthorizationCodeRequestUrl authorizationUrl) Handles user authorization by redirecting to the OAuth 2.0 authorization server.
-
Field Details
-
flow
Authorization code flow. -
receiver
Verification code receiver. -
LOGGER
-
-
Constructor Details
-
AuthorizationCodeInstalledApp
- Parameters:
flow
- authorization code flowreceiver
- verification code receiver
-
-
Method Details
-
authorize
Authorizes the installed application to access user's protected data.- Parameters:
userId
- user ID ornull
if not using a persisted credential store- Returns:
- credential
- Throws:
IOException
-
onAuthorization
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
Open a browser at the given URL usingDesktop
if available, or alternatively output the URL toSystem.out
for command-line applications.- Parameters:
url
- URL to browse
-
getFlow
Returns the authorization code flow. -
getReceiver
Returns the verification code receiver.
-