blob: 90db4a23b4241364d6cd464df621531073745be5 [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.
#ifndef COMPONENTS_SYNC_DRIVER_SYNC_CLIENT_H_
#define COMPONENTS_SYNC_DRIVER_SYNC_CLIENT_H_
#include "base/callback_forward.h"
#include "base/files/file_path.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/data_type_controller.h"
#include "components/sync/engine/model_safe_worker.h"
class PrefService;
namespace invalidation {
class InvalidationService;
} // namespace invalidation
namespace syncer {
class SyncApiComponentFactory;
class SyncableService;
class SyncService;
class SyncTypePreferenceProvider;
// 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 {
public:
SyncClient();
virtual ~SyncClient();
// Returns the current profile's preference service.
virtual PrefService* GetPrefService() = 0;
virtual base::FilePath GetSyncDataPath() = 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;
// Returns a vector with all supported datatypes and their controllers.
virtual DataTypeController::TypeVector CreateDataTypeControllers(
SyncService* sync_service) = 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;
// 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;
// Returns the preference provider, or null if none exists.
virtual SyncTypePreferenceProvider* GetPreferenceProvider() = 0;
private:
DISALLOW_COPY_AND_ASSIGN(SyncClient);
};
} // namespace syncer
#endif // COMPONENTS_SYNC_DRIVER_SYNC_CLIENT_H_