1 /*
2  * Copyright (c) 2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef DISTRIBUTED_RDB_RDB_SERVICE_H
17 #define DISTRIBUTED_RDB_RDB_SERVICE_H
18 
19 #include <memory>
20 #include <string>
21 
22 #include "result_set.h"
23 #include "rdb_types.h"
24 #include "rdb_notifier.h"
25 #include "distributeddata_relational_store_ipc_interface_code.h"
26 
27 namespace OHOS {
28 namespace DistributedRdb {
29 class RdbService {
30 public:
31     struct Option {
32         int32_t mode;
33         uint32_t seqNum = 0;
34         bool isAsync = false;
35         bool isAutoSync = false;
36         bool isCompensation = false;
37     };
38     using ResultSet = NativeRdb::ResultSet;
39     inline static constexpr const char *SERVICE_NAME = "relational_store";
40 
41     virtual std::string ObtainDistributedTableName(const std::string &device, const std::string &table) = 0;
42 
43     virtual int32_t SetDistributedTables(
44         const RdbSyncerParam &param, const std::vector<std::string> &tables,
45         const std::vector<Reference> &references, bool isRebuild, int32_t type = DISTRIBUTED_DEVICE) = 0;
46 
47     virtual int32_t Sync(const RdbSyncerParam &param, const Option &option, const PredicatesMemo &predicates,
48         const AsyncDetail &async) = 0;
49 
50     virtual int32_t Subscribe(const RdbSyncerParam &param, const SubscribeOption &option,
51         RdbStoreObserver *observer) = 0;
52 
53     virtual int32_t UnSubscribe(const RdbSyncerParam &param, const SubscribeOption &option,
54         RdbStoreObserver *observer) = 0;
55 
56     virtual int32_t RegisterAutoSyncCallback(
57         const RdbSyncerParam &param, std::shared_ptr<DetailProgressObserver> observer) = 0;
58 
59     virtual int32_t UnregisterAutoSyncCallback(
60         const RdbSyncerParam &param, std::shared_ptr<DetailProgressObserver> observer) = 0;
61 
62     virtual std::pair<int32_t, std::shared_ptr<ResultSet>> RemoteQuery(const RdbSyncerParam &param,
63         const std::string &device, const std::string &sql, const std::vector<std::string> &selectionArgs) = 0;
64 
65     virtual int32_t InitNotifier(const RdbSyncerParam &param, sptr<IRemoteObject> notifier) = 0;
66 
67     virtual int32_t BeforeOpen(RdbSyncerParam &param) = 0;
68 
69     virtual int32_t AfterOpen(const RdbSyncerParam &param) = 0;
70 
71     // only use param.storeName_
72     virtual int32_t Delete(const RdbSyncerParam &param) = 0;
73 
74     virtual std::pair<int32_t, std::shared_ptr<ResultSet>> QuerySharingResource(
75         const RdbSyncerParam &param, const PredicatesMemo &predicates, const std::vector<std::string> &columns) = 0;
76 
77     virtual int32_t NotifyDataChange(
78         const RdbSyncerParam &param, const RdbChangedData &rdbChangedData, const RdbNotifyConfig &rdbNotifyConfig) = 0;
79 
80     virtual int32_t SetSearchable(const RdbSyncerParam& param, bool isSearchable) = 0;
81 
82     virtual int32_t Disable(const RdbSyncerParam &param) = 0;
83 
84     virtual int32_t Enable(const RdbSyncerParam &param) = 0;
85 
86     virtual int32_t GetPassword(const RdbSyncerParam &param, std::vector<uint8_t> &password) = 0;
87 
88     virtual std::pair<int32_t, uint32_t> LockCloudContainer(const RdbSyncerParam &param) = 0;
89 
90     virtual int32_t UnlockCloudContainer(const RdbSyncerParam &param) = 0;
91 
92     virtual int32_t GetDebugInfo(const RdbSyncerParam &param, std::map<std::string, RdbDebugInfo> &debugInfo) = 0;
93 };
94 }
95 } // namespace OHOS::DistributedRdb
96 #endif