com.google.api.client.auth.oauth2.UserAgentAuthorizationResponse 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.
 */

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

import com.google.api.client.util.Key;

/**
 * OAuth 2.0 User Agent Flow: parses the redirect URL fragment after end user
 * grants or denies authorization as specified in Authorization Server Response
 * 
 * Use {@link AccessProtectedResource} to authorize executed HTTP requests based
 * on the {@link #accessToken}.
 * 

 * Sample usage:
 * 
 * 
 * static void processRedirectUrl(HttpTransport transport, String redirectUrl)
 *     throws URISyntaxException {
 *   UserAgentAuthorizationResponse response
 *       = new UserAgentAuthorizationResponse(redirectUrl);
 *   if (response.error != null) {
 *     throw new RuntimeException("Authorization denied");
 *   }
 *   AccessProtectedResource.usingAuthorizationHeader(transport,
 *       response.accessToken);
 * }
 * 
 * 
 * 
 * @since 1.0
 * @author Yaniv Inbar
 */
public class UserAgentAuthorizationResponse extends
    AbstractAuthorizationResponse {


  /** (REQUIRED if the end user grants authorization) The access token. */
  @Key("access_token")
  public String accessToken;

  /**
   * (OPTIONAL) The duration in seconds of the access token lifetime.
   */
  @Key("expires_in")
  public Long expiresIn;

  /** (OPTIONAL) The refresh token. */
  @Key("refresh_token")
  public String refreshToken;

  /**
   * @param redirectUrl encoded redirect URL
   * @throws IllegalArgumentException URI syntax exception
   */
  public UserAgentAuthorizationResponse(String redirectUrl) {
    super(redirectUrl, false);
  }
}