chrome/browser/policy/profile_policy_connector_factory.h

   1 // Copyright (c) 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_POLICY_PROFILE_POLICY_CONNECTOR_FACTORY_H_
   6 #define CHROME_BROWSER_POLICY_PROFILE_POLICY_CONNECTOR_FACTORY_H_
   7
   8 #include <list>
   9 #include <map>
  10
  11 #include "base/basictypes.h"
  12 #include "base/memory/scoped_ptr.h"
  13 #include "components/keyed_service/content/browser_context_keyed_base_factory.h"
  14
  15 template <typename T>
  16 struct DefaultSingletonTraits;
  17
  18 namespace base {
  19 class SequencedTaskRunner;
  20 }
  21
  22 namespace content {
  23 class BrowserContext;
  24 }
  25
  26 namespace policy {
  27
  28 class ConfigurationPolicyProvider;
  29 class ProfilePolicyConnector;
  30
  31 // Creates ProfilePolicyConnectors for Profiles, which manage the common
  32 // policy providers and other policy components.
  33 // TODO(joaodasilva): convert this class to a proper BCKS once the PrefService,
  34 // which depends on this class, becomes a BCKS too.
  35 class ProfilePolicyConnectorFactory : public BrowserContextKeyedBaseFactory {
  36  public:
  37   // Returns the ProfilePolicyConnectorFactory singleton.
  38   static ProfilePolicyConnectorFactory* GetInstance();
  39
  40   // Returns the ProfilePolicyConnector associated with |context|. This is only
  41   // valid before |context| is shut down.
  42   static ProfilePolicyConnector* GetForBrowserContext(
  43       content::BrowserContext* context);
  44
  45   // Creates a new ProfilePolicyConnector for |context|, which must be managed
  46   // by the caller. Subsequent calls to GetForBrowserContext() will return the
  47   // instance created, as long as it lives.
  48   // If |force_immediate_load| is true then policy is loaded synchronously on
  49   // startup.
  50   static scoped_ptr<ProfilePolicyConnector> CreateForBrowserContext(
  51       content::BrowserContext* context,
  52       bool force_immediate_load);
  53
  54   // Overrides the |connector| for the given |context|; use only in tests.
  55   // Once this class becomes a proper BCKS then it can reuse the testing
  56   // methods of BrowserContextKeyedServiceFactory.
  57   void SetServiceForTesting(content::BrowserContext* context,
  58                             ProfilePolicyConnector* connector);
  59
  60   // The next Profile to call CreateForBrowserContext() will get a PolicyService
  61   // with |provider| as its sole policy provider. This can be called multiple
  62   // times to override the policy providers for more than 1 Profile.
  63   void PushProviderForTesting(ConfigurationPolicyProvider* provider);
  64
  65  private:
  66   friend struct DefaultSingletonTraits<ProfilePolicyConnectorFactory>;
  67
  68   ProfilePolicyConnectorFactory();
  69   ~ProfilePolicyConnectorFactory() override;
  70
  71   ProfilePolicyConnector* GetForBrowserContextInternal(
  72       content::BrowserContext* context);
  73
  74   scoped_ptr<ProfilePolicyConnector> CreateForBrowserContextInternal(
  75       content::BrowserContext* context,
  76       bool force_immediate_load);
  77
  78   // BrowserContextKeyedBaseFactory:
  79   void BrowserContextShutdown(content::BrowserContext* context) override;
  80   void BrowserContextDestroyed(content::BrowserContext* context) override;
  81   void SetEmptyTestingFactory(content::BrowserContext* context) override;
  82   bool HasTestingFactory(content::BrowserContext* context) override;
  83   void CreateServiceNow(content::BrowserContext* context) override;
  84
  85   typedef std::map<content::BrowserContext*, ProfilePolicyConnector*>
  86       ConnectorMap;
  87   ConnectorMap connectors_;
  88   std::list<ConfigurationPolicyProvider*> test_providers_;
  89
  90   DISALLOW_COPY_AND_ASSIGN(ProfilePolicyConnectorFactory);
  91 };
  92
  93 }  // namespace policy
  94
  95 #endif  // CHROME_BROWSER_POLICY_PROFILE_POLICY_CONNECTOR_FACTORY_H_