1// Copyright 2013 The Chromium Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5#ifndef CHROME_BROWSER_SIGNIN_ANDROID_PROFILE_OAUTH2_TOKEN_SERVICE_H_
6#define CHROME_BROWSER_SIGNIN_ANDROID_PROFILE_OAUTH2_TOKEN_SERVICE_H_
7
8#include <jni.h>
9#include <string>
10
11#include "base/android/jni_weak_ref.h"
12#include "base/callback.h"
13#include "base/memory/scoped_ptr.h"
14#include "base/time/time.h"
15#include "components/signin/core/browser/profile_oauth2_token_service.h"
16#include "google_apis/gaia/google_service_auth_error.h"
17
18// A specialization of ProfileOAuth2TokenService that will be returned by
19// ProfileOAuth2TokenServiceFactory for OS_ANDROID.  This instance uses
20// native Android features to lookup OAuth2 tokens.
21//
22// See |ProfileOAuth2TokenService| for usage details.
23//
24// Note: requests should be started from the UI thread. To start a
25// request from other thread, please use OAuth2TokenServiceRequest.
26class AndroidProfileOAuth2TokenService : public ProfileOAuth2TokenService {
27 public:
28  // Registers the AndroidProfileOAuth2TokenService's native methods through
29  // JNI.
30  static bool Register(JNIEnv* env);
31
32  // Creates a new instance of the AndroidProfileOAuth2TokenService.
33  static AndroidProfileOAuth2TokenService* Create();
34
35  // Returns a reference to the Java instance of this service.
36  static jobject GetForProfile(
37      JNIEnv* env, jclass clazz, jobject j_profile_android);
38
39  // Called by the TestingProfile class to disable account validation in
40  // tests.  This prevents the token service from trying to look up system
41  // accounts which requires special permission.
42  static void set_is_testing_profile() {
43    is_testing_profile_ = true;
44  }
45
46  // ProfileOAuth2TokenService overrides:
47  virtual void Initialize(SigninClient* client) OVERRIDE;
48  virtual bool RefreshTokenIsAvailable(
49      const std::string& account_id) const OVERRIDE;
50  virtual void UpdateAuthError(
51      const std::string& account_id,
52      const GoogleServiceAuthError& error) OVERRIDE;
53  virtual std::vector<std::string> GetAccounts() OVERRIDE;
54
55  // Lists account at the OS level.
56  std::vector<std::string> GetSystemAccounts();
57
58  void ValidateAccounts(JNIEnv* env,
59                        jobject obj,
60                        jstring current_account,
61                        jboolean force_notifications);
62
63  // Takes a the signed in sync account as well as all the other
64  // android account ids and check the token status of each.  If
65  // |force_notifications| is true, TokenAvailable notifications will
66  // be sent anyway, even if the account was already known.
67  void ValidateAccounts(const std::string& signed_in_account,
68                        bool force_notifications);
69
70  // Triggers a notification to all observers of the OAuth2TokenService that a
71  // refresh token is now available. This may cause observers to retry
72  // operations that require authentication.
73  virtual void FireRefreshTokenAvailableFromJava(JNIEnv* env,
74                                                 jobject obj,
75                                                 const jstring account_name);
76  // Triggers a notification to all observers of the OAuth2TokenService that a
77  // refresh token is now available.
78  virtual void FireRefreshTokenRevokedFromJava(JNIEnv* env,
79                                               jobject obj,
80                                               const jstring account_name);
81  // Triggers a notification to all observers of the OAuth2TokenService that all
82  // refresh tokens have now been loaded.
83  virtual void FireRefreshTokensLoadedFromJava(JNIEnv* env, jobject obj);
84
85  // Overridden from OAuth2TokenService to complete signout of all
86  // OA2TService aware accounts.
87  virtual void RevokeAllCredentials() OVERRIDE;
88
89 protected:
90  friend class ProfileOAuth2TokenServiceFactory;
91  AndroidProfileOAuth2TokenService();
92  virtual ~AndroidProfileOAuth2TokenService();
93
94  virtual OAuth2AccessTokenFetcher* CreateAccessTokenFetcher(
95      const std::string& account_id,
96      net::URLRequestContextGetter* getter,
97      OAuth2AccessTokenConsumer* consumer) OVERRIDE;
98
99  // Overridden from OAuth2TokenService to intercept token fetch requests and
100  // redirect them to the Account Manager.
101  virtual void InvalidateOAuth2Token(const std::string& account_id,
102                                     const std::string& client_id,
103                                     const ScopeSet& scopes,
104                                     const std::string& access_token) OVERRIDE;
105
106  // Called to notify observers when a refresh token is available.
107  virtual void FireRefreshTokenAvailable(
108      const std::string& account_id) OVERRIDE;
109  // Called to notify observers when a refresh token has been revoked.
110  virtual void FireRefreshTokenRevoked(const std::string& account_id) OVERRIDE;
111  // Called to notify observers when refresh tokans have been loaded.
112  virtual void FireRefreshTokensLoaded() OVERRIDE;
113
114  // Return whether |signed_in_account| is valid and we have access
115  // to all the tokens in |curr_account_ids|. If |force_notifications| is true,
116  // TokenAvailable notifications will be sent anyway, even if the account was
117  // already known.
118  bool ValidateAccounts(const std::string& signed_in_account,
119                        const std::vector<std::string>& prev_account_ids,
120                        const std::vector<std::string>& curr_account_ids,
121                        std::vector<std::string>& refreshed_ids,
122                        std::vector<std::string>& revoked_ids,
123                        bool force_notifications);
124
125 private:
126  base::android::ScopedJavaGlobalRef<jobject> java_ref_;
127
128  static bool is_testing_profile_;
129
130  DISALLOW_COPY_AND_ASSIGN(AndroidProfileOAuth2TokenService);
131};
132
133#endif  // CHROME_BROWSER_SIGNIN_ANDROID_PROFILE_OAUTH2_TOKEN_SERVICE_H_
134