blob: d38f986e2c55ab20453e868f934cb7f5e7982de1 [file] [log] [blame]
// Copyright 2015 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/callback_forward.h"
#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "base/memory/weak_ptr.h"
#include "components/sync/base/extensions_activity.h"
#include "components/sync/base/model_type.h"
#include "components/sync/driver/sync_api_component_factory.h"
#include "components/sync/engine/model_safe_worker.h"
#include "components/sync/model/model_type_controller_delegate.h"
class BookmarkUndoService;
class PrefService;
namespace autofill {
class PersonalDataManager;
} // namespace autofill
namespace bookmarks {
class BookmarkModel;
} // namespace bookmarks
namespace favicon {
class FaviconService;
} // namespace favicon
namespace history {
class HistoryService;
} // namespace history
namespace invalidation {
class InvalidationService;
} // namespace invalidation
namespace sync_sessions {
class SessionSyncService;
} // namespace sync_sessions
namespace syncer {
class DeviceInfoSyncService;
class ModelTypeStoreService;
class SyncableService;
// Interface for clients of the Sync API to plumb through necessary dependent
// components. This interface is purely for abstracting dependencies, and
// should not contain any non-trivial functional logic.
// Note: on some platforms, getters might return nullptr. Callers are expected
// to handle these scenarios gracefully.
class SyncClient {
virtual ~SyncClient();
// Returns the current profile's preference service.
virtual PrefService* GetPrefService() = 0;
virtual ModelTypeStoreService* GetModelTypeStoreService() = 0;
// Returns the path to the folder used for storing the local sync database.
// It is only used when sync is running against a local backend.
virtual base::FilePath GetLocalSyncBackendFolder() = 0;
// DataType specific service getters.
virtual DeviceInfoSyncService* GetDeviceInfoSyncService() = 0;
virtual bookmarks::BookmarkModel* GetBookmarkModel() = 0;
virtual favicon::FaviconService* GetFaviconService() = 0;
virtual history::HistoryService* GetHistoryService() = 0;
virtual sync_sessions::SessionSyncService* GetSessionSyncService() = 0;
virtual bool HasPasswordStore() = 0;
// Returns a vector with all supported datatypes and their controllers.
virtual DataTypeController::TypeVector CreateDataTypeControllers(
SyncService* sync_service) = 0;
// Returns a callback that will be invoked when password sync state has
// potentially been changed.
virtual base::Closure GetPasswordStateChangedCallback() = 0;
virtual autofill::PersonalDataManager* GetPersonalDataManager() = 0;
virtual BookmarkUndoService* GetBookmarkUndoServiceIfExists() = 0;
virtual invalidation::InvalidationService* GetInvalidationService() = 0;
virtual scoped_refptr<ExtensionsActivity> GetExtensionsActivity() = 0;
// Returns a weak pointer to the syncable service specified by |type|.
// Weak pointer may be unset if service is already destroyed.
// Note: Should only be dereferenced from the model type thread.
virtual base::WeakPtr<SyncableService> GetSyncableServiceForType(
ModelType type) = 0;
// Returns a weak pointer to the ModelTypeControllerDelegate specified by
// |type|. Weak pointer may be unset if service is already destroyed. Note:
// Should only be dereferenced from the model type thread.
virtual base::WeakPtr<ModelTypeControllerDelegate>
GetControllerDelegateForModelType(ModelType type) = 0;
// Creates and returns a new ModelSafeWorker for the group, or null if one
// cannot be created.
// TODO(maxbogue): Move this inside SyncApiComponentFactory.
virtual scoped_refptr<ModelSafeWorker> CreateModelWorkerForGroup(
ModelSafeGroup group) = 0;
// Returns the current SyncApiComponentFactory instance.
virtual SyncApiComponentFactory* GetSyncApiComponentFactory() = 0;
} // namespace syncer