/
ISymmetricEngine.java
245 lines (192 loc) · 7.43 KB
/
ISymmetricEngine.java
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
/*
* Licensed to JumpMind Inc under one or more contributor
* license agreements. See the NOTICE file distributed
* with this work for additional information regarding
* copyright ownership. JumpMind Inc licenses this file
* to you under the GNU Lesser General Public License (the
* "License"); you may not use this file except in compliance
* with the License.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, see
* <http://www.gnu.org/licenses/>.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License. */
package org.jumpmind.symmetric;
import java.util.Properties;
import javax.sql.DataSource;
import org.jumpmind.symmetric.db.IDbDialect;
import org.jumpmind.symmetric.job.IJobManager;
import org.jumpmind.symmetric.job.PullJob;
import org.jumpmind.symmetric.job.PurgeJob;
import org.jumpmind.symmetric.job.PushJob;
import org.jumpmind.symmetric.job.RouterJob;
import org.jumpmind.symmetric.model.NodeStatus;
import org.jumpmind.symmetric.model.RemoteNodeStatuses;
import org.jumpmind.symmetric.service.IAcknowledgeService;
import org.jumpmind.symmetric.service.IBandwidthService;
import org.jumpmind.symmetric.service.IClusterService;
import org.jumpmind.symmetric.service.IConfigurationService;
import org.jumpmind.symmetric.service.IDataExtractorService;
import org.jumpmind.symmetric.service.IDataLoaderService;
import org.jumpmind.symmetric.service.IDataService;
import org.jumpmind.symmetric.service.IIncomingBatchService;
import org.jumpmind.symmetric.service.INodeService;
import org.jumpmind.symmetric.service.IOutgoingBatchService;
import org.jumpmind.symmetric.service.IParameterService;
import org.jumpmind.symmetric.service.IPullService;
import org.jumpmind.symmetric.service.IPurgeService;
import org.jumpmind.symmetric.service.IPushService;
import org.jumpmind.symmetric.service.IRegistrationService;
import org.jumpmind.symmetric.service.IRouterService;
import org.jumpmind.symmetric.service.ISecurityService;
import org.jumpmind.symmetric.service.IStatisticService;
import org.jumpmind.symmetric.service.ITriggerRouterService;
import org.jumpmind.symmetric.service.IUpgradeService;
import org.jumpmind.symmetric.statistic.IStatisticManager;
import org.springframework.context.ApplicationContext;
public interface ISymmetricEngine {
public void stop();
public void destroy();
/**
* @return the URL that represents this engine
*/
public String getSyncUrl();
/**
* Get a list of configured properties for Symmetric. Read-only.
*/
public Properties getProperties();
/**
* @return The lower case representation of the engine name as setup in the
* symmetric.properties file. We always use a lower case
* representation because there are times the engine name is used in
* triggers at which point you can lose the original case
* representation.
*/
public String getEngineName();
/**
* Will setup the SymmetricDS tables, if not already setup and if the engine
* is configured to do so.
*/
public void setup();
/**
* Must be called to start SymmetricDS.
* @return true if successfully started
*/
public boolean start();
/**
* Queue up an initial load or a reload to a node.
*/
public String reloadNode(String nodeId);
public String sendSQL(String nodeId, String catalogName, String schemaName, String tableName, String sql);
/**
* Will perform a push the same way the {@link PushJob} would have.
*
* @see IPushService#pushData()
* @return {@link RemoteNodeStatuses}
*/
public RemoteNodeStatuses push();
/**
* Call this to resync triggers
*
* @see ITriggerRouterService#syncTriggers()
*/
public void syncTriggers();
/**
* Get the current status of this node.
*
* @return {@link NodeStatus}
*/
public NodeStatus getNodeStatus();
/**
* Will perform a pull the same way the {@link PullJob} would have.
*
* @see IPullService#pullData()
* @return {@link RemoteNodeStatuses}
*/
public RemoteNodeStatuses pull();
/**
* Route captured data the same way the {@link RouterJob} would have.
*/
public void route();
/**
* This can be called to do a purge. It may be called only if the
* {@link PurgeJob} has not been enabled.
*
* @see IPurgeService#purge()
*/
public void purge();
/**
* Will check to see if this instance of SymmetricDS is configured with the
* required properties for a node to operate.
*/
public boolean isConfigured();
/**
* Push a copy of the node onto the push queue so the SymmetricDS node
* 'checks' in with it's root node.
* @param force When force is true the heart beat will always be inserted. If it is false,
* the heart beat will only be inserted if the period between heart beats has expired.
*/
public void heartbeat(boolean force);
/**
* Open up registration for node to attach.
*
* @see IRegistrationService#openRegistration(String, String)
*/
public void openRegistration(String groupId, String externalId);
public void reOpenRegistration(String nodeId);
/**
* Check to see if this node has been registered.
*
* @return true if the node is registered
*/
public boolean isRegistered();
/**
* Check to see if this node has been started.
*
* @return true if the node is started
*/
public boolean isStarted();
/**
* Check to see if this node is starting.
*
* @return true if the node is starting
*/
public boolean isStarting();
/**
* Expose access to the Spring context. This is for advanced use only.
*
* @return the Spring application context that SymmetricDS runs in
*/
public ApplicationContext getApplicationContext();
public IConfigurationService getConfigurationService();
public IParameterService getParameterService();
public INodeService getNodeService();
public IRegistrationService getRegistrationService();
public IUpgradeService getUpgradeService();
public IClusterService getClusterService();
public IPurgeService getPurgeService();
public IDataService getDataService();
public IDbDialect getDbDialect();
public IJobManager getJobManager();
public IOutgoingBatchService getOutgoingBatchService();
public IAcknowledgeService getAcknowledgeService();
public IBandwidthService getBandwidthService();
public IDataExtractorService getDataExtractorService();
public IDataLoaderService getDataLoaderService();
public IIncomingBatchService getIncomingBatchService();
public IPullService getPullService();
public IPushService getPushService();
public IRouterService getRouterService();
public ISecurityService getSecurityService();
public IStatisticService getStatisticService();
public ITriggerRouterService getTriggerRouterService();
public IStatisticManager getStatisticManager();
public DataSource getDataSource();
}