chrome/browser/engagement/site_engagement_service_factory.h

   1 // Copyright 2015 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_ENGAGEMENT_SITE_ENGAGEMENT_SERVICE_FACTORY_H_
   6 #define CHROME_BROWSER_ENGAGEMENT_SITE_ENGAGEMENT_SERVICE_FACTORY_H_
   7
   8 #include "base/memory/singleton.h"
   9 #include "components/keyed_service/content/browser_context_keyed_service_factory.h"
  10
  11 class Profile;
  12 class SiteEngagementService;
  13
  14 // Singleton that owns all SiteEngagementServices and associates them with
  15 // Profiles. Listens for the Profile's destruction notification and cleans up
  16 // the associated SiteEngagementService.
  17 //
  18 // The default factory behavior is suitable for this factory as:
  19 // * there should be no site engagement tracking in incognito
  20 // * the site engagement service should be created lazily
  21 // * the site engagement service is needed in tests.
  22 class SiteEngagementServiceFactory : public BrowserContextKeyedServiceFactory {
  23  public:
  24   static SiteEngagementService* GetForProfile(Profile* profile);
  25
  26   static SiteEngagementServiceFactory* GetInstance();
  27
  28  private:
  29   friend struct base::DefaultSingletonTraits<SiteEngagementServiceFactory>;
  30
  31   SiteEngagementServiceFactory();
  32   ~SiteEngagementServiceFactory() override;
  33
  34   // KeyedServiceBaseFactory:
  35   bool ServiceIsNULLWhileTesting() const override;
  36
  37   // BrowserContextKeyedServiceFactory:
  38   KeyedService* BuildServiceInstanceFor(
  39       content::BrowserContext* profile) const override;
  40
  41   DISALLOW_COPY_AND_ASSIGN(SiteEngagementServiceFactory);
  42 };
  43
  44 #endif  // CHROME_BROWSER_ENGAGEMENT_SITE_ENGAGEMENT_SERVICE_FACTORY_H_