components/signin/core/browser/signin_error_controller.h

   1 // Copyright 2014 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 COMPONENTS_SIGNIN_CORE_BROWSER_SIGNIN_ERROR_CONTROLLER_H_
   6 #define COMPONENTS_SIGNIN_CORE_BROWSER_SIGNIN_ERROR_CONTROLLER_H_
   7
   8 #include <set>
   9 #include "base/basictypes.h"
  10 #include "base/compiler_specific.h"
  11 #include "base/observer_list.h"
  12 #include "google_apis/gaia/google_service_auth_error.h"
  13
  14 // Keep track of auth errors and expose them to observers in the UI. Services
  15 // that wish to expose auth errors to the user should register an
  16 // AuthStatusProvider to report their current authentication state, and should
  17 // invoke AuthStatusChanged() when their authentication state may have changed.
  18 class SigninErrorController {
  19  public:
  20   class AuthStatusProvider {
  21    public:
  22     AuthStatusProvider();
  23     virtual ~AuthStatusProvider();
  24
  25     // Returns the account id with the status specified by GetAuthStatus().
  26     virtual std::string GetAccountId() const = 0;
  27
  28     // API invoked by SigninErrorController to get the current auth status of
  29     // the various signed in services.
  30     virtual GoogleServiceAuthError GetAuthStatus() const = 0;
  31   };
  32
  33   // The observer class for SigninErrorController lets the controller notify
  34   // observers when an error arises or changes.
  35   class Observer {
  36    public:
  37     virtual ~Observer() {}
  38     virtual void OnErrorChanged() = 0;
  39   };
  40
  41   SigninErrorController();
  42   ~SigninErrorController();
  43
  44   // Adds a provider which the SigninErrorController object will start querying
  45   // for auth status.
  46   void AddProvider(const AuthStatusProvider* provider);
  47
  48   // Removes a provider previously added by SigninErrorController (generally
  49   // only called in preparation for shutdown).
  50   void RemoveProvider(const AuthStatusProvider* provider);
  51
  52   // Invoked when the auth status of an AuthStatusProvider has changed.
  53   void AuthStatusChanged();
  54
  55   // True if there exists an error worth elevating to the user.
  56   bool HasError() const;
  57
  58   void AddObserver(Observer* observer);
  59   void RemoveObserver(Observer* observer);
  60
  61   const std::string& error_account_id() const { return error_account_id_; }
  62   const GoogleServiceAuthError& auth_error() const { return auth_error_; }
  63
  64  private:
  65   std::set<const AuthStatusProvider*> provider_set_;
  66
  67   // The account that generated the last auth error.
  68   std::string error_account_id_;
  69
  70   // The auth error detected the last time AuthStatusChanged() was invoked (or
  71   // NONE if AuthStatusChanged() has never been invoked).
  72   GoogleServiceAuthError auth_error_;
  73
  74   ObserverList<Observer, false> observer_list_;
  75
  76   DISALLOW_COPY_AND_ASSIGN(SigninErrorController);
  77 };
  78
  79 #endif  // COMPONENTS_SIGNIN_CORE_BROWSER_SIGNIN_ERROR_CONTROLLER_H_