blob: 255e7c12dff8d4d1390af25a65097690d21703b1 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/memory/singleton.h"
#include "base/observer_list.h"
#include "build/build_config.h"
#include "components/keyed_service/content/browser_context_keyed_service_factory.h"
class SigninManager;
class SigninManagerBase;
class PrefRegistrySimple;
class Profile;
// Singleton that owns all SigninManagers and associates them with
// Profiles. Listens for the Profile's destruction notification and cleans up
// the associated SigninManager.
class SigninManagerFactory : public BrowserContextKeyedServiceFactory {
class Observer {
// Called when a SigninManager(Base) instance is created.
virtual void SigninManagerCreated(SigninManagerBase* manager) {}
// Called when a SigninManager(Base) instance is being shut down. Observers
// of |manager| should remove themselves at this point.
virtual void SigninManagerShutdown(SigninManagerBase* manager) {}
virtual ~Observer() {}
#if defined(OS_CHROMEOS)
// Returns the instance of SigninManager associated with this profile
// (creating one if none exists). Returns NULL if this profile cannot have a
// SigninManager (for example, if |profile| is incognito).
static SigninManagerBase* GetForProfile(Profile* profile);
// Returns the instance of SigninManager associated with this profile. Returns
// null if no SigninManager instance currently exists (will not create a new
// instance).
static SigninManagerBase* GetForProfileIfExists(Profile* profile);
static const SigninManagerBase* GetForProfileIfExists(const Profile* profile);
// On non-ChromeOS platforms, the SigninManager the factory creates will be
// an instance of the extended SigninManager class.
static SigninManager* GetForProfile(Profile* profile);
static SigninManager* GetForProfileIfExists(Profile* profile);
static const SigninManager* GetForProfileIfExists(const Profile* profile);
// Returns an instance of the SigninManagerFactory singleton.
static SigninManagerFactory* GetInstance();
// Implementation of BrowserContextKeyedServiceFactory (public so tests
// can call it).
void RegisterProfilePrefs(
user_prefs::PrefRegistrySyncable* registry) override;
// Registers the browser-global prefs used by SigninManager.
static void RegisterPrefs(PrefRegistrySimple* registry);
// Methods to register or remove observers of SigninManager creation/shutdown.
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
// Notifies observers of |manager|'s creation. Should be called only by test
// SigninManager subclasses whose construction does not occur in
// |BuildServiceInstanceFor()|.
void NotifyObserversOfSigninManagerCreationForTesting(
SigninManagerBase* manager);
friend struct base::DefaultSingletonTraits<SigninManagerFactory>;
~SigninManagerFactory() override;
// List of observers. Checks that list is empty on destruction.
mutable base::ObserverList<Observer, true>::Unchecked observer_list_;
// BrowserContextKeyedServiceFactory:
KeyedService* BuildServiceInstanceFor(
content::BrowserContext* profile) const override;
void BrowserContextShutdown(content::BrowserContext* context) override;