com.google.api.client.auth.oauth2.package-info Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-client Show documentation

Google API Client Library for Java. Supports Java 5 (or higher) desktop (SE) and web (EE), Android, and Google App Engine.

There is a newer version: 1.4.1-beta

Show newest version

/*
 * Copyright (c) 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

/**
 * OAuth 2.0 authorization as specified in The OAuth 2.0 Protocol
 * (draft-ietf-oauth-v2-10) (see detailed package specification).
 *
 * 
 * Before using this library, you may need to register your application with the authorization
 * server to receive a client ID and client secret.
 * 
 *
 * 
 * Typical steps for the OAuth 2 authorization flow:
 * 

 * Redirect end user in the browser to the authorization page using
 * {@link com.google.api.client.auth.oauth2.AuthorizationRequestUrl} to grant your application
 * access to their protected data.
 * Process the authorization response using
 * {@link com.google.api.client.auth.oauth2.AuthorizationResponse} to parse the authorization code
 * and/or access token.
 * Request an access token, depending on the access grant type:
 * 
 * Authorization code:
 * {@link com.google.api.client.auth.oauth2.AccessTokenRequest.AuthorizationCodeGrant}
 * Resource Owner Password Credentials: {@link
 * com.google.api.client.auth.oauth2.AccessTokenRequest.ResourceOwnerPasswordCredentialsGrant}
 * Assertion: {@link com.google.api.client.auth.oauth2.AccessTokenRequest.AssertionGrant}
 * Refresh Token: {@link com.google.api.client.auth.oauth2.AccessTokenRequest.RefreshTokenGrant}
 * 
 * None (e.g. client owns protected resource):
 * {@link com.google.api.client.auth.oauth2.AccessTokenRequest}
 * 
 * 
 * 
 * 
 *
 * 
 * Warning: this package is experimental, and its content may be changed in incompatible ways or
 * possibly entirely removed in a future version of the library
 * 
 *
 * @since 1.2
 * @author Yaniv Inbar
 */

package com.google.api.client.auth.oauth2;