-
Notifications
You must be signed in to change notification settings - Fork 215
/
ConnectivityConfig.java
145 lines (123 loc) · 4.53 KB
/
ConnectivityConfig.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
/*
* Copyright (c) 2020 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.connectivity.service.config;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.service.config.ServiceSpecificConfig;
import org.eclipse.ditto.connectivity.service.config.mapping.MappingConfig;
import org.eclipse.ditto.internal.models.acks.config.AcknowledgementConfig;
import org.eclipse.ditto.internal.utils.config.DefaultScopedConfig;
import org.eclipse.ditto.internal.utils.config.KnownConfigValue;
import org.eclipse.ditto.internal.utils.health.config.WithHealthCheckConfig;
import org.eclipse.ditto.internal.utils.persistence.mongo.config.WithMongoDbConfig;
import org.eclipse.ditto.internal.utils.persistence.operations.WithPersistenceOperationsConfig;
import org.eclipse.ditto.internal.utils.persistentactors.config.PingConfig;
import org.eclipse.ditto.internal.utils.protocol.config.WithProtocolConfig;
import com.typesafe.config.Config;
/**
* Provides the configuration settings of the Connectivity service.
*/
@Immutable
public interface ConnectivityConfig extends ServiceSpecificConfig, WithHealthCheckConfig,
WithPersistenceOperationsConfig, WithMongoDbConfig, WithProtocolConfig {
/**
* Returns the config of connections.
*
* @return the config.
*/
ConnectionConfig getConnectionConfig();
/**
* Returns the config for Connectivity service's reconnect (wakeup for connection persistence actors) behaviour.
*
* @return the config.
*/
PingConfig getPingConfig();
/**
* Returns the config for Connectivity service's behaviour for retrieval of connection ids.
*
* @return the config.
*/
ConnectionIdsRetrievalConfig getConnectionIdsRetrievalConfig();
/**
* Returns the config for the Connectivity service's client.
*
* @return the config.
*/
ClientConfig getClientConfig();
/**
* Returns the config for the Connectivity service's monitoring features (connection logs and metrics).
*
* @return the config.
*/
MonitoringConfig getMonitoringConfig();
/**
* Returns the config for Connectivity service's message mapping.
*
* @return the config.
*/
MappingConfig getMappingConfig();
/**
* Returns the configuration for acknowledgement handling.
*
* @return the config.
*/
AcknowledgementConfig getAcknowledgementConfig();
/**
* Returns the configuration for ssh tunneling.
*
* @return the config.
*/
TunnelConfig getTunnelConfig();
/**
* Returns the full qualified classname of the {@code org.eclipse.ditto.connectivity.service.CustomConnectivityRootExecutor}
* implementation to use for custom executions in {@code ConnectivityRootActor}.
*
* @return the full qualified classname of the {@code CustomConnectivityRootExecutor} implementation to use.
* @since 3.0.0
*/
String getCustomRootExecutor();
/**
* Read the static connectivity config from an actor system.
*
* @param config the config to parse.
* @return the connectivity config.
*/
static ConnectivityConfig of(final Config config) {
return DittoConnectivityConfig.of(DefaultScopedConfig.dittoScoped(config));
}
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code ConnectivityConfig}.
*/
enum ConnectivityConfigValue implements KnownConfigValue {
/**
* The full qualified classname of the {@code CustomConnectivityRootExecutor} to instantiate.
* @since 3.0.0
*/
CUSTOM_ROOT_EXECUTOR("connectivity.custom-root-executor",
"org.eclipse.ditto.gateway.service.starter.NoOpGatewayRootExecutor");
private final String path;
private final Object defaultValue;
ConnectivityConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
@Override
public String getConfigPath() {
return path;
}
}
}