/
MongoDbConfig.java
467 lines (376 loc) · 13.5 KB
/
MongoDbConfig.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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
/*
* Copyright (c) 2019 Contributors to the Eclipse Foundation
*
* See the NOTICE file(s) distributed with this work for additional
* information regarding copyright ownership.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.internal.utils.persistence.mongo.config;
import java.time.Duration;
import java.util.Collections;
import java.util.Map;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.internal.utils.config.KnownConfigValue;
import com.mongodb.WriteConcern;
/**
* Provides configuration settings for the service's MongoDB connection.
*/
@Immutable
public interface MongoDbConfig {
/**
* Retrieves the MongoDB URI from configured source URI and MongoDB settings.
*
* @return the URI adapted from source URI with parameters set according to MongoDB settings.
*/
String getMongoDbUri();
/**
* Returns the maximum query duration.
*
* @return the duration.
*/
Duration getMaxQueryTime();
/**
* Returns the configuration settings of the MongoDB options.
*
* @return the options config.
*/
OptionsConfig getOptionsConfig();
/**
* Returns the configuration settings of the MongoDB connection pool.
*
* @return the connection pool config.
*/
ConnectionPoolConfig getConnectionPoolConfig();
/**
* Returns the configuration settings of the MongoDB circuit breaker.
*
* @return the circuit breaker config.
*/
CircuitBreakerConfig getCircuitBreakerConfig();
/**
* Returns the configuration settings of the MongoDB monitoring.
*
* @return the monitoring config.
*/
MonitoringConfig getMonitoringConfig();
/**
* An enumeration of known value paths and associated default values of the MongoDbConfig.
*/
enum MongoDbConfigValue implements KnownConfigValue {
/**
* The MongoDB URI - no default value in code provided.
*/
URI("uri", null),
/**
* The maximum query duration.
*/
MAX_QUERY_TIME("maxQueryTime", Duration.ofMinutes(1L));
private final String path;
private final Object defaultValue;
private MongoDbConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public String getConfigPath() {
return path;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
}
/**
* Provides configuration settings of the MongoDB options.
*/
@Immutable
interface OptionsConfig {
/**
* Indicates whether SSL should be enabled for the configured MongoDB source.
*
* @return {@code true} if SSL should be enabled, {@code false} else.
*/
boolean isSslEnabled();
/**
* Gets the desired read preference that should be used for accessing MongoDB.
*
* @return the desired read preference.
*/
ReadPreference readPreference();
/**
* Gets the desired read concern that should be used for accessing MongoDB.
*
* @return the desired read concern.
*/
ReadConcern readConcern();
/**
* Gets the desired write concern that should be used for writing to MongoDB.
*
* @return the desired write concern.
*/
WriteConcern writeConcern();
/**
* Gets the desired "retryWrites" setting that should be used for writing to MongoDB.
*
* @return the desired "retryWrites".
*/
boolean isRetryWrites();
/**
* Gets the extra options to add to the configured MongoDB {@code uri}.
*
* @return the extra options.
*/
Map<String, Object> extraUriOptions();
/**
* An enumeration of known value paths and associated default values of the OptionsConfig.
*/
enum OptionsConfigValue implements KnownConfigValue {
/**
* Determines whether SSL should be enabled for the configured MongoDB source.
*/
SSL_ENABLED("ssl", false),
/**
* Determines the read preference used for MongoDB connections. See {@link ReadPreference} for available options.
*/
READ_PREFERENCE("readPreference", "primaryPreferred"),
/**
* Determines the read concern used for MongoDB connections. See {@link ReadConcern} for available options.
*/
READ_CONCERN("readConcern", "default"),
/**
* Determines the write concern used for MongoDB connections. See {@link com.mongodb.WriteConcern} for
* available options.
*/
WRITE_CONCERN("writeConcern", "acknowledged"),
/**
* Determines the "retryWrites" setting used for MongoDB connections.
*/
RETRY_WRITES("retryWrites", true),
/**
* The extra options to add to the configured MongoDB {@code uri}.
*/
EXTRA_URI_OPTIONS("extra-uri-options", Collections.<String, Object>emptyMap());
private final String path;
private final Object defaultValue;
private OptionsConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public String getConfigPath() {
return path;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
}
}
/**
* Provides configuration settings of the MongoDB connection pool.
*/
@Immutable
interface ConnectionPoolConfig {
/**
* Returns the minimum number of connections in the connection pool always to be kept alive.
*
* @return the minimum number of connections.
*/
int getMinSize();
/**
* Returns the maximum number of connections in the connection pool.
*
* @return the maximum number of connections.
*/
int getMaxSize();
/**
* Returns the maximum time to wait for a connection to become available.
*
* @return the maximum wait time.
*/
Duration getMaxWaitTime();
/**
* Indicates whether a JMX {@code ConnectionPoolListener} should be added.
*
* @return {@code true} if a JMX ConnectionPoolListener should be added, {@code false} else.
*/
boolean isJmxListenerEnabled();
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code ConnectionPoolConfig}.
*/
enum ConnectionPoolConfigValue implements KnownConfigValue {
/**
* The minimum number of connections in the connection pool.
*/
MIN_SIZE("minSize", 0),
/**
* The maximum number of connections in the connection pool.
*/
MAX_SIZE("maxSize", 100),
/**
* The maximum time to wait for a connection to become available.
*/
MAX_WAIT_TIME("maxWaitTime", Duration.ofSeconds(30L)),
/**
* Determines whether a JMX {@code ConnectionPoolListener} should be added.
*/
JMX_LISTENER_ENABLED("jmxListenerEnabled", false);
private final String path;
private final Object defaultValue;
private ConnectionPoolConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public String getConfigPath() {
return path;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
}
}
/**
* Provides configuration settings of the MongoDB circuit breaker.
*/
@Immutable
interface CircuitBreakerConfig {
/**
* Returns the necessary amount of failures to be reached until the circuit breaker opens.
*
* @return the max failures amount.
*/
int getMaxFailures();
/**
* Returns the configuration settings of the circuit breaker timeout.
*
* @return the circuit breaker timeout config.
*/
TimeoutConfig getTimeoutConfig();
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code CircuitBreakerConfig}.
*/
enum CircuitBreakerConfigValue implements KnownConfigValue {
/**
* The necessary amount of failures to be reached until the circuit breaker opens.
*/
MAX_FAILURES("maxFailures", 5);
private final String path;
private final Object defaultValue;
private CircuitBreakerConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public String getConfigPath() {
return path;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
}
/**
* Provides configuration settings of the circuit breaker timeout.
*/
@Immutable
interface TimeoutConfig {
/**
* MongoDB timeouts cause the circuit breaker to open.
* This method returns the amount of time to be reached until the circuit breaker opens.
* If the duration is zero, timeouts won't open the circuit breaker.
*
* @return the duration to wait on MongoDB timeouts until the circuit breaker opens.
*/
Duration getCall();
/**
* Returns the amount of time after which the circuit breaker is "half-opened" again.
*
* @return the duration after timeout until the circuit breaker becomes "half-opened".
*/
Duration getReset();
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code TimeoutConfig}.
*/
enum TimeoutConfigValue implements KnownConfigValue {
/**
* The duration to wait on MongoDB timeouts until the circuit breaker opens.
*/
CALL("call", "5s"),
/**
* The duration after timeout until the circuit breaker becomes "half-opened".
*/
RESET("reset", "10s");
private final String path;
private final Object defaultValue;
private TimeoutConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public String getConfigPath() {
return path;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
}
}
}
/**
* Provides the configuration settings for the MongoDB monitoring.
*/
@Immutable
interface MonitoringConfig {
/**
* Indicates whether all commands should be monitored and reported with Kamon.
*
* @return {@code true} if all commands should be monitored, {@code false} else.
*/
boolean isCommandsEnabled();
/**
* Indicates whether connection pool statistics should be reported with Kamon.
*
* @return {@code true} if connection pool statistics should be reported, {@code false} else.
*/
boolean isConnectionPoolEnabled();
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code MonitoringConfig}.
*/
enum MonitoringConfigValue implements KnownConfigValue {
/**
* Determines whether all commands should be monitored and reported with Kamon.
*/
COMMANDS_ENABLED("commands", false),
/**
* Determines whether connection pool statistics should be reported with Kamon.
*/
CONNECTION_POOL_ENABLED("connection-pool", false);
private final String path;
private final Object defaultValue;
private MonitoringConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public String getConfigPath() {
return path;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
}
}
}