blob: f077af006a33b7e026d78d59548f889061d0d58e [file] [log] [blame]
// Copyright 2012 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.
// InternalComponentsFactory exists so that tests can override creation of
// components used by the SyncManager that are not exposed across the sync
// API boundary.
#include <string>
#include <vector>
#include "base/files/file_path.h"
#include "sync/base/sync_export.h"
#include "sync/internal_api/public/engine/model_safe_worker.h"
namespace syncer {
class CancelationSignal;
class ExtensionsActivity;
class ModelTypeRegistry;
class ServerConnectionManager;
class SyncEngineEventListener;
class SyncScheduler;
namespace sessions {
class DebugInfoGetter;
class SyncSessionContext;
namespace syncable {
class Directory;
class DirectoryBackingStore;
class SYNC_EXPORT InternalComponentsFactory {
enum EncryptionMethod {
// Option to enable support for keystore key based encryption.
enum BackoffOverride {
// Use this value for integration testing to avoid long delays /
// timing out tests. Uses kInitialBackoffShortRetrySeconds (see
// polling_constants.h) for all initial retries.
enum PreCommitUpdatesPolicy {
// By default, the server will enable or disable this experiment through the
// sync protocol's experiments data type.
// This flag overrides the server's decision and enables the pre-commit
// update avoidance experiment.
// Configuration options for internal components. This struct is expected
// to grow and shrink over time with transient features / experiments,
// roughly following command line flags in chrome. Implementations of
// InternalComponentsFactory can use this information to build components
// with appropriate bells and whistles.
struct Switches {
EncryptionMethod encryption_method;
BackoffOverride backoff_override;
PreCommitUpdatesPolicy pre_commit_updates_policy;
// For selecting the types of storage to use to persist sync data when
// BuildDirectoryBackingStore() is called.
enum StorageOption {
// BuildDirectoryBackingStore should not use persistent on-disk storage.
// Use this if you want BuildDirectoryBackingStore to create/use a real
// on disk store.
// Use this to defer creating on-disk database until
// DirectoryBackingStore::SaveChanges() is called.
// Use this to test the case where a directory fails to load.
virtual ~InternalComponentsFactory() {}
virtual scoped_ptr<SyncScheduler> BuildScheduler(
const std::string& name,
sessions::SyncSessionContext* context,
CancelationSignal* cancelation_signal) = 0;
virtual scoped_ptr<sessions::SyncSessionContext> BuildContext(
ServerConnectionManager* connection_manager,
syncable::Directory* directory,
ExtensionsActivity* extensions_activity,
const std::vector<SyncEngineEventListener*>& listeners,
sessions::DebugInfoGetter* debug_info_getter,
ModelTypeRegistry* model_type_registry,
const std::string& invalidator_client_id) = 0;
virtual scoped_ptr<syncable::DirectoryBackingStore>
StorageOption storage,
const std::string& dir_name,
const base::FilePath& backing_filepath) = 0;
// Returns the Switches struct that this object is using as configuration, if
// the implementation is making use of one.
virtual Switches GetSwitches() const = 0;
} // namespace syncer