-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
RedisConfiguration.java
439 lines (384 loc) · 13.2 KB
/
RedisConfiguration.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
/*
* Copyright 2018-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* 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.springframework.data.redis.connection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.function.IntSupplier;
import java.util.function.Supplier;
import org.springframework.lang.Nullable;
import org.springframework.util.Assert;
/**
* Marker interface for configuration classes related to Redis connection setup. As the setup scenarios are quite
* diverse instead of struggling with unifying those, {@link RedisConfiguration} provides means to identify
* configurations for the individual purposes.
*
* @author Christoph Strobl
* @author Luis De Bello
* @since 2.1
*/
public interface RedisConfiguration {
/**
* Get the configured database index if the current {@link RedisConfiguration} is
* {@link #isDatabaseIndexAware(RedisConfiguration) database aware} or evaluate and return the value of the given
* {@link Supplier}.
*
* @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
* {@link #isDatabaseIndexAware(RedisConfiguration) database aware}.
* @return never {@literal null}.
* @throws IllegalArgumentException if {@code other} is {@literal null}.
*/
default Integer getDatabaseOrElse(Supplier<Integer> other) {
return getDatabaseOrElse(this, other);
}
/**
* Get the configured {@link RedisPassword} if the current {@link RedisConfiguration} is
* {@link #isPasswordAware(RedisConfiguration) password aware} or evaluate and return the value of the given
* {@link Supplier}.
*
* @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
* {@link #isPasswordAware(RedisConfiguration) password aware}.
* @return never {@literal null}.
* @throws IllegalArgumentException if {@code other} is {@literal null}.
*/
default RedisPassword getPasswordOrElse(Supplier<RedisPassword> other) {
return getPasswordOrElse(this, other);
}
/**
* @param configuration can be {@literal null}.
* @return {@code true} if given {@link RedisConfiguration} is instance of {@link WithPassword}.
*/
static boolean isPasswordAware(@Nullable RedisConfiguration configuration) {
return configuration instanceof WithPassword;
}
/**
* @param configuration can be {@literal null}.
* @return {@code true} if given {@link RedisConfiguration} is instance of {@link WithDatabaseIndex}.
*/
static boolean isDatabaseIndexAware(@Nullable RedisConfiguration configuration) {
return configuration instanceof WithDatabaseIndex;
}
/**
* @param configuration can be {@literal null}.
* @return {@code true} if given {@link RedisConfiguration} is instance of {@link SentinelConfiguration}.
*/
static boolean isSentinelConfiguration(@Nullable RedisConfiguration configuration) {
return configuration instanceof SentinelConfiguration;
}
/**
* @param configuration can be {@literal null}.
* @return {@code true} if given {@link RedisConfiguration} is instance of {@link WithHostAndPort}.
* @since 2.1.6
*/
static boolean isHostAndPortAware(@Nullable RedisConfiguration configuration) {
return configuration instanceof WithHostAndPort;
}
/**
* @param configuration can be {@literal null}.
* @return {@code true} if given {@link RedisConfiguration} is instance of {@link ClusterConfiguration}.
*/
static boolean isClusterConfiguration(@Nullable RedisConfiguration configuration) {
return configuration instanceof ClusterConfiguration;
}
/**
* @param configuration can be {@literal null}.
* @return {@code true} if given {@link RedisConfiguration} is instance of {@link StaticMasterReplicaConfiguration}.
*/
static boolean isStaticMasterReplicaConfiguration(@Nullable RedisConfiguration configuration) {
return configuration instanceof StaticMasterReplicaConfiguration;
}
/**
* @param configuration can be {@literal null}.
* @return {@code true} if given {@link RedisConfiguration} is instance of {@link DomainSocketConfiguration}.
*/
static boolean isDomainSocketConfiguration(@Nullable RedisConfiguration configuration) {
return configuration instanceof DomainSocketConfiguration;
}
/**
* @param configuration can be {@literal null}.
* @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
* {@link #isDatabaseIndexAware(RedisConfiguration) database aware}.
* @return never {@literal null}.
* @throws IllegalArgumentException if {@code other} is {@literal null}.
*/
static Integer getDatabaseOrElse(@Nullable RedisConfiguration configuration, Supplier<Integer> other) {
Assert.notNull(other, "Other must not be null!");
return isDatabaseIndexAware(configuration) ? ((WithDatabaseIndex) configuration).getDatabase() : other.get();
}
/**
* @param configuration can be {@literal null}.
* @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
* {@link #isPasswordAware(RedisConfiguration) password aware}.
* @return never {@literal null}.
* @throws IllegalArgumentException if {@code other} is {@literal null}.
*/
static RedisPassword getPasswordOrElse(@Nullable RedisConfiguration configuration, Supplier<RedisPassword> other) {
Assert.notNull(other, "Other must not be null!");
return isPasswordAware(configuration) ? ((WithPassword) configuration).getPassword() : other.get();
}
/**
* @param configuration can be {@literal null}.
* @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
* {@link #isHostAndPortAware(RedisConfiguration) port aware}.
* @return never {@literal null}.
* @throws IllegalArgumentException if {@code other} is {@literal null}.
* @since 2.1.6
*/
static int getPortOrElse(@Nullable RedisConfiguration configuration, IntSupplier other) {
Assert.notNull(other, "Other must not be null!");
return isHostAndPortAware(configuration) ? ((WithHostAndPort) configuration).getPort() : other.getAsInt();
}
/**
* @param configuration can be {@literal null}.
* @param other a {@code Supplier} whose result is returned if given {@link RedisConfiguration} is not
* {@link #isHostAndPortAware(RedisConfiguration) host aware}.
* @return never {@literal null}.
* @throws IllegalArgumentException if {@code other} is {@literal null}.
* @since 2.1.6
*/
static String getHostOrElse(@Nullable RedisConfiguration configuration, Supplier<String> other) {
Assert.notNull(other, "Other must not be null!");
return isHostAndPortAware(configuration) ? ((WithHostAndPort) configuration).getHostName() : other.get();
}
/**
* {@link RedisConfiguration} part suitable for configurations that may use authentication when connecting.
*
* @author Christoph Strobl
* @since 2.1
*/
interface WithPassword {
/**
* Create and set a {@link RedisPassword} for given {@link String}.
*
* @param password can be {@literal null}.
*/
default void setPassword(@Nullable String password) {
setPassword(RedisPassword.of(password));
}
/**
* Create and set a {@link RedisPassword} for given {@link String}.
*
* @param password can be {@literal null}.
*/
default void setPassword(@Nullable char[] password) {
setPassword(RedisPassword.of(password));
}
/**
* Create and set a {@link RedisPassword} for given {@link String}.
*
* @param password must not be {@literal null} use {@link RedisPassword#none()} instead.
*/
void setPassword(RedisPassword password);
/**
* Get the RedisPassword to use when connecting.
*
* @return {@link RedisPassword#none()} if none set.
*/
RedisPassword getPassword();
}
/**
* {@link RedisConfiguration} part suitable for configurations that use a specific database.
*
* @author Christoph Strobl
* @since 2.1
*/
interface WithDatabaseIndex {
/**
* Set the database index to use.
*
* @param dbIndex
*/
void setDatabase(int dbIndex);
/**
* Get the database index to use.
*
* @return {@code zero} by default.
*/
int getDatabase();
}
/**
* {@link RedisConfiguration} part suitable for configurations that use host/port combinations for connecting.
*
* @author Christoph Strobl
* @since 2.1
*/
interface WithHostAndPort {
/**
* Set the Redis server hostname
*
* @param hostName must not be {@literal null}.
*/
void setHostName(String hostName);
/**
* @return never {@literal null}.
*/
String getHostName();
/**
* Set the Redis server port.
*
* @param port
*/
void setPort(int port);
/**
* Get the Redis server port.
*
* @return
*/
int getPort();
}
/**
* {@link RedisConfiguration} part suitable for configurations that use native domain sockets for connecting.
*
* @author Christoph Strobl
* @since 2.1
*/
interface WithDomainSocket {
/**
* Set the socket.
*
* @param socket path to the Redis socket. Must not be {@literal null}.
*/
void setSocket(String socket);
/**
* Get the domain socket.
*
* @return path to the Redis socket.
*/
String getSocket();
}
/**
* Configuration interface suitable for Redis Sentinel environments.
*
* @author Christoph Strobl
* @since 2.1
*/
interface SentinelConfiguration extends WithDatabaseIndex, WithPassword {
/**
* Set the name of the master node.
*
* @param name must not be {@literal null}.
*/
default void setMaster(final String name) {
Assert.notNull(name, "Name of sentinel master must not be null.");
setMaster(() -> name);
}
/**
* Set the master node.
*
* @param master must not be {@literal null}.
*/
void setMaster(NamedNode master);
/**
* Get the {@literal Sentinel} master node.
*
* @return get the master node or {@literal null} if not set.
*/
@Nullable
NamedNode getMaster();
/**
* Returns an {@link Collections#unmodifiableSet(Set)} of {@literal Sentinels}.
*
* @return {@link Set} of sentinels. Never {@literal null}.
*/
Set<RedisNode> getSentinels();
/**
* Get the {@link RedisPassword} used when authenticating with a Redis Server..
*
* @return never {@literal null}.
* @since 2.2.2
*/
default RedisPassword getDataNodePassword() {
return getPassword();
}
/**
* Create and set a {@link RedisPassword} to be used when authenticating with Redis Sentinel from the given
* {@link String}.
*
* @param password can be {@literal null}.
* @since 2.2.2
*/
default void setSentinelPassword(@Nullable String password) {
setSentinelPassword(RedisPassword.of(password));
}
/**
* Create and set a {@link RedisPassword} to be used when authenticating with Redis Sentinel from the given
* {@link Character} sequence.
*
* @param password can be {@literal null}.
* @since 2.2.2
*/
default void setSentinelPassword(@Nullable char[] password) {
setSentinelPassword(RedisPassword.of(password));
}
/**
* Set a {@link RedisPassword} to be used when authenticating with Redis Sentinel.
*
* @param password must not be {@literal null} use {@link RedisPassword#none()} instead.
* @since 2.2.2
*/
void setSentinelPassword(RedisPassword password);
/**
* Returns the {@link RedisPassword} to use when connecting to a Redis Sentinel. <br />
* Can be set via {@link #setSentinelPassword(RedisPassword)} or {@link RedisPassword#none()} if no password has
* been set.
*
* @return the {@link RedisPassword} for authenticating with Redis Sentinel.
* @since 2.2.2
*/
RedisPassword getSentinelPassword();
}
/**
* Configuration interface suitable for Redis cluster environments.
*
* @author Christoph Strobl
* @since 2.1
*/
interface ClusterConfiguration extends WithPassword {
/**
* Returns an {@link Collections#unmodifiableSet(Set)} of {@literal cluster nodes}.
*
* @return {@link Set} of nodes. Never {@literal null}.
*/
Set<RedisNode> getClusterNodes();
/**
* @return max number of redirects to follow or {@literal null} if not set.
*/
@Nullable
Integer getMaxRedirects();
}
/**
* Configuration interface suitable for Redis master/slave environments with fixed hosts. <br/>
* Redis is undergoing a nomenclature change where the term replica is used synonymously to slave.
*
* @author Christoph Strobl
* @author Mark Paluch
* @since 2.1
*/
interface StaticMasterReplicaConfiguration extends WithDatabaseIndex, WithPassword {
/**
* @return unmodifiable {@link List} of {@link RedisStandaloneConfiguration nodes}.
*/
List<RedisStandaloneConfiguration> getNodes();
}
/**
* Configuration interface suitable for single node redis connections using local unix domain socket.
*
* @author Christoph Strobl
* @since 2.1
*/
interface DomainSocketConfiguration extends WithDomainSocket, WithDatabaseIndex, WithPassword {
}
}