1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
// Copyright 2014 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_API_COMPONENT_FACTORY_H_
#define COMPONENTS_SYNC_DRIVER_SYNC_API_COMPONENT_FACTORY_H_
#include <memory>
#include <string>
#include "base/memory/weak_ptr.h"
#include "components/sync/base/model_type.h"
#include "components/sync/driver/data_type_controller.h"
#include "components/sync/model/attachments/attachment_service.h"
#include "components/sync/model/data_type_error_handler.h"
#include "components/sync/model/syncable_service.h"
namespace base {
class FilePath;
} // namespace base
namespace invalidation {
class InvalidationService;
} // namespace invalidation
namespace syncer {
class AssociatorInterface;
class ChangeProcessor;
class DataTypeDebugInfoListener;
class DataTypeEncryptionHandler;
class DataTypeManager;
class DataTypeManagerObserver;
class LocalDeviceInfoProvider;
class SyncEngine;
class SyncClient;
class SyncPrefs;
class SyncService;
class SyncableService;
struct UserShare;
// This factory provides sync driver code with the model type specific sync/api
// service (like SyncableService) implementations.
class SyncApiComponentFactory {
public:
virtual ~SyncApiComponentFactory() {}
// Callback to allow platform-specific datatypes to register themselves as
// data type controllers.
// |disabled_types| and |enabled_types| control the disable/enable state of
// types that are on or off by default (respectively).
typedef base::Callback<void(SyncService* sync_service,
ModelTypeSet disabled_types,
ModelTypeSet enabled_types)>
RegisterDataTypesMethod;
// The various factory methods for the data type model associators
// and change processors all return this struct. This is needed
// because the change processors typically require a type-specific
// model associator at construction time.
//
// Note: This interface is deprecated in favor of the SyncableService API.
// New datatypes that do not live on the UI thread should directly return a
// weak pointer to a SyncableService. All others continue to return
// SyncComponents. It is safe to assume that the factory methods below are
// called on the same thread in which the datatype resides.
//
// TODO(zea): Have all datatypes using the new API switch to returning
// SyncableService weak pointers instead of SyncComponents (crbug.com/100114).
struct SyncComponents {
AssociatorInterface* model_associator;
ChangeProcessor* change_processor;
SyncComponents(AssociatorInterface* ma, ChangeProcessor* cp)
: model_associator(ma), change_processor(cp) {}
};
// Creates and registers enabled datatypes with the provided SyncClient.
virtual void RegisterDataTypes(
SyncService* sync_service,
const RegisterDataTypesMethod& register_platform_types_method) = 0;
// Creates a DataTypeManager; the return pointer is owned by the caller.
virtual DataTypeManager* CreateDataTypeManager(
ModelTypeSet initial_types,
const WeakHandle<DataTypeDebugInfoListener>& debug_info_listener,
const DataTypeController::TypeMap* controllers,
const DataTypeEncryptionHandler* encryption_handler,
ModelTypeConfigurer* configurer,
DataTypeManagerObserver* observer) = 0;
// Creating this in the factory helps us mock it out in testing.
virtual SyncEngine* CreateSyncEngine(
const std::string& name,
invalidation::InvalidationService* invalidator,
const base::WeakPtr<SyncPrefs>& sync_prefs,
const base::FilePath& sync_folder) = 0;
// Creating this in the factory helps us mock it out in testing.
virtual std::unique_ptr<LocalDeviceInfoProvider>
CreateLocalDeviceInfoProvider() = 0;
// Legacy datatypes that need to be converted to the SyncableService API.
virtual SyncComponents CreateBookmarkSyncComponents(
SyncService* sync_service,
std::unique_ptr<DataTypeErrorHandler> error_handler) = 0;
// Creates attachment service.
// Note: Should only be called from the model type thread.
//
// |store_birthday| is the store birthday. Must not be empty.
//
// |model_type| is the model type this AttachmentService will be used with.
//
// |delegate| is optional delegate for AttachmentService to notify about
// asynchronous events (AttachmentUploaded). Pass null if delegate is not
// provided. AttachmentService doesn't take ownership of delegate, the pointer
// must be valid throughout AttachmentService lifetime.
virtual std::unique_ptr<AttachmentService> CreateAttachmentService(
std::unique_ptr<AttachmentStoreForSync> attachment_store,
const UserShare& user_share,
const std::string& store_birthday,
ModelType model_type,
AttachmentService::Delegate* delegate) = 0;
};
} // namespace syncer
#endif // COMPONENTS_SYNC_DRIVER_SYNC_API_COMPONENT_FACTORY_H_
|
