1 // Copyright (c) 2012 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.
5 #ifndef CHROME_BROWSER_SESSIONS_SESSION_SERVICE_FACTORY_H_
6 #define CHROME_BROWSER_SESSIONS_SESSION_SERVICE_FACTORY_H_
8 #include "base/memory/singleton.h"
9 #include "chrome/browser/profiles/profile.h"
10 #include "chrome/browser/sessions/session_service.h"
11 #include "components/keyed_service/content/browser_context_keyed_service_factory.h"
13 // Singleton that owns all SessionServices and associates them with
14 // Profiles. Listens for the Profile's destruction notification and cleans up
15 // the associated SessionService.
16 class SessionServiceFactory
: public BrowserContextKeyedServiceFactory
{
18 // Returns the session service for |profile|. This may return NULL. If this
19 // profile supports a session service (it isn't incognito), and the session
20 // service hasn't yet been created, this forces creation of the session
21 // service. This returns NULL if ShutdownForProfile has been called for
24 // This returns NULL if the profile is incognito. Callers should always check
25 // the return value for NULL.
26 static SessionService
* GetForProfile(Profile
* profile
);
28 // Returns the session service for |profile|, but do not create it if it
29 // doesn't exist. This returns NULL if the profile is incognito or if session
30 // service has been explicitly shutdown (browser is exiting). Callers should
31 // always check the return value for NULL.
32 static SessionService
* GetForProfileIfExisting(Profile
* profile
);
34 // Returns the session service for |profile|. This is the same as
35 // GetForProfile, but will force creation of the session service even if
36 // ShutdownForProfile has been called for |profile|.
37 static SessionService
* GetForProfileForSessionRestore(Profile
* profile
);
39 // If |profile| has a session service, it is shut down. To properly record the
40 // current state this forces creation of the session service, then shuts it
42 static void ShutdownForProfile(Profile
* profile
);
44 #if defined(UNIT_TEST)
45 // For test use: force setting of the session service for a given profile.
46 // This will delete a previous session service for this profile if it exists.
47 static void SetForTestProfile(Profile
* profile
,
48 scoped_ptr
<SessionService
> service
) {
49 GetInstance()->BrowserContextShutdown(profile
);
50 GetInstance()->BrowserContextDestroyed(profile
);
51 GetInstance()->Associate(profile
, service
.Pass());
55 static SessionServiceFactory
* GetInstance();
58 friend struct base::DefaultSingletonTraits
<SessionServiceFactory
>;
59 FRIEND_TEST_ALL_PREFIXES(SessionCrashedInfoBarDelegateUnitTest
,
60 DetachingTabWithCrashedInfoBar
);
62 SessionServiceFactory();
63 ~SessionServiceFactory() override
;
65 // BrowserContextKeyedServiceFactory:
66 KeyedService
* BuildServiceInstanceFor(
67 content::BrowserContext
* profile
) const override
;
68 bool ServiceIsCreatedWithBrowserContext() const override
;
69 bool ServiceIsNULLWhileTesting() const override
;
72 #endif // CHROME_BROWSER_SESSIONS_SESSION_SERVICE_FACTORY_H_