Home | History | Annotate | Download | only in browser 
      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     // Returns the username with the status specified by GetAuthStatus().
     29     virtual std::string GetUsername() const = 0;
     30 
     31     // API invoked by SigninErrorController to get the current auth status of
     32     // the various signed in services.
     33     virtual GoogleServiceAuthError GetAuthStatus() const = 0;
     34   };
     35 
     36   // The observer class for SigninErrorController lets the controller notify
     37   // observers when an error arises or changes.
     38   class Observer {
     39    public:
     40     virtual ~Observer() {}
     41     virtual void OnErrorChanged() = 0;
     42   };
     43 
     44   SigninErrorController();
     45   ~SigninErrorController();
     46 
     47   // Adds a provider which the SigninErrorController object will start querying
     48   // for auth status.
     49   void AddProvider(const AuthStatusProvider* provider);
     50 
     51   // Removes a provider previously added by SigninErrorController (generally
     52   // only called in preparation for shutdown).
     53   void RemoveProvider(const AuthStatusProvider* provider);
     54 
     55   // Invoked when the auth status of an AuthStatusProvider has changed.
     56   void AuthStatusChanged();
     57 
     58   // True if there exists an error worth elevating to the user.
     59   bool HasError() const;
     60 
     61   void AddObserver(Observer* observer);
     62   void RemoveObserver(Observer* observer);
     63 
     64   const std::string& error_account_id() const { return error_account_id_; }
     65   const std::string& error_username() const { return error_username_; }
     66   const GoogleServiceAuthError& auth_error() const { return auth_error_; }
     67 
     68  private:
     69   std::set<const AuthStatusProvider*> provider_set_;
     70 
     71   // The account that generated the last auth error.
     72   std::string error_account_id_;
     73   std::string error_username_;
     74 
     75   // The auth error detected the last time AuthStatusChanged() was invoked (or
     76   // NONE if AuthStatusChanged() has never been invoked).
     77   GoogleServiceAuthError auth_error_;
     78 
     79   ObserverList<Observer, false> observer_list_;
     80 
     81   DISALLOW_COPY_AND_ASSIGN(SigninErrorController);
     82 };
     83 
     84 #endif  // COMPONENTS_SIGNIN_CORE_BROWSER_SIGNIN_ERROR_CONTROLLER_H_
     85