chrome/browser/signin/android_profile_oauth2_token_service.h

   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 ProfileOAuth2TokenServiceRequest.
  26 class 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   virtual bool RefreshTokenIsAvailable(
  40       const std::string& account_id) const OVERRIDE;
  41
  42   // Lists account IDs of all accounts with a refresh token.
  43   virtual std::vector<std::string> GetAccounts() OVERRIDE;
  44
  45   // Lists account at the OS level.
  46   std::vector<std::string> GetSystemAccounts();
  47
  48   void ValidateAccounts(JNIEnv* env,
  49                         jobject obj,
  50                         jstring current_account);
  51
  52   // Takes a the signed in sync account as well as all the other
  53   // android account ids and check the token status of each.
  54   void ValidateAccounts(const std::string& signed_in_account);
  55
  56   // Triggers a notification to all observers of the OAuth2TokenService that a
  57   // refresh token is now available. This may cause observers to retry
  58   // operations that require authentication.
  59   virtual void FireRefreshTokenAvailableFromJava(JNIEnv* env,
  60                                                  jobject obj,
  61                                                  const jstring account_name);
  62   // Triggers a notification to all observers of the OAuth2TokenService that a
  63   // refresh token is now available.
  64   virtual void FireRefreshTokenRevokedFromJava(JNIEnv* env,
  65                                                jobject obj,
  66                                                const jstring account_name);
  67   // Triggers a notification to all observers of the OAuth2TokenService that all
  68   // refresh tokens have now been loaded.
  69   virtual void FireRefreshTokensLoadedFromJava(JNIEnv* env, jobject obj);
  70
  71   // Overridden from OAuth2TokenService to complete signout of all
  72   // OA2TService aware accounts.
  73   virtual void RevokeAllCredentials() OVERRIDE;
  74
  75  protected:
  76   friend class ProfileOAuth2TokenServiceFactory;
  77   AndroidProfileOAuth2TokenService();
  78   virtual ~AndroidProfileOAuth2TokenService();
  79
  80   // Overridden from OAuth2TokenService to intercept token fetch requests and
  81   // redirect them to the Account Manager.
  82   virtual void FetchOAuth2Token(RequestImpl* request,
  83                                 const std::string& account_id,
  84                                 net::URLRequestContextGetter* getter,
  85                                 const std::string& client_id,
  86                                 const std::string& client_secret,
  87                                 const ScopeSet& scopes) OVERRIDE;
  88
  89   // Overriden from OAuth2TokenService to avoid compile errors. Has NOTREACHED()
  90   // implementation as |AndroidProfileOAuth2TokenService| overrides
  91   // |FetchOAuth2Token| and thus bypasses this method entirely.
  92   virtual OAuth2AccessTokenFetcher* CreateAccessTokenFetcher(
  93       const std::string& account_id,
  94       net::URLRequestContextGetter* getter,
  95       OAuth2AccessTokenConsumer* consumer) OVERRIDE;
  96
  97   // Overridden from OAuth2TokenService to intercept token fetch requests and
  98   // redirect them to the Account Manager.
  99   virtual void InvalidateOAuth2Token(const std::string& account_id,
 100                                      const std::string& client_id,
 101                                      const ScopeSet& scopes,
 102                                      const std::string& access_token) OVERRIDE;
 103
 104   // Called to notify observers when a refresh token is available.
 105   virtual void FireRefreshTokenAvailable(
 106       const std::string& account_id) OVERRIDE;
 107   // Called to notify observers when a refresh token has been revoked.
 108   virtual void FireRefreshTokenRevoked(const std::string& account_id) OVERRIDE;
 109   // Called to notify observers when refresh tokans have been loaded.
 110   virtual void FireRefreshTokensLoaded() OVERRIDE;
 111
 112   // Return whether |signed_in_account| is valid and we have access
 113   // to all the tokens in |curr_account_ids|.
 114   bool ValidateAccounts(const std::string& signed_in_account,
 115                         const std::vector<std::string>& prev_account_ids,
 116                         const std::vector<std::string>& curr_account_ids,
 117                         std::vector<std::string>& refreshed_ids,
 118                         std::vector<std::string>& revoked_ids);
 119
 120  private:
 121   base::android::ScopedJavaGlobalRef<jobject> java_ref_;
 122
 123   DISALLOW_COPY_AND_ASSIGN(AndroidProfileOAuth2TokenService);
 124 };
 125
 126 #endif  // CHROME_BROWSER_SIGNIN_ANDROID_PROFILE_OAUTH2_TOKEN_SERVICE_H_