/
ThrottlingConfig.java
114 lines (95 loc) · 3.4 KB
/
ThrottlingConfig.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
/*
* 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.services.base.config;
import java.time.Duration;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.services.utils.config.KnownConfigValue;
import com.typesafe.config.Config;
import com.typesafe.config.ConfigFactory;
/**
* Provides configuration settings for throttling based on an {@code interval} and a {@code limit}.
*/
@Immutable
public interface ThrottlingConfig {
/**
* Expected path of this config relative to its parent.
*/
String CONFIG_PATH = "throttling";
/**
* Returns the consumer throttling interval meaning in which duration may the configured
* {@link #getLimit() limit} be processed before throttling further messages.
*
* @return the consumer throttling interval.
*/
Duration getInterval();
/**
* Returns the consumer throttling limit defining processed messages per configured
* {@link #getInterval()} interval}.
*
* @return the consumer throttling limit.
*/
int getLimit();
/**
* Render this object into a Config object from which a copy of this object can be constructed.
*
* @return the config representation.
*/
default Config render() {
final Map<String, Object> map = new HashMap<>();
map.put(ConfigValue.INTERVAL.getConfigPath(), getInterval().toMillis() + "ms");
map.put(ConfigValue.LIMIT.getConfigPath(), getLimit());
return ConfigFactory.parseMap(map).atKey(CONFIG_PATH);
}
/**
* Returns an instance of {@code ThrottlingConfig} based on the settings of the specified Config.
*
* @param config is supposed to provide the settings at {@value #CONFIG_PATH}.
* @return the instance.
* @throws org.eclipse.ditto.services.utils.config.DittoConfigError if {@code config} is invalid.
*/
static ThrottlingConfig of(final Config config) {
return DefaultThrottlingConfig.of(config);
}
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code Amqp10Config}.
*/
enum ConfigValue implements KnownConfigValue {
/**
* The consumer throttling interval meaning in which duration may the configured
* {@link #LIMIT limit} be processed before throttling further messages.
*/
INTERVAL("interval", Duration.ofSeconds(1)),
/**
* The consumer throttling limit defining processed messages per configured
* {@link #INTERVAL interval}.
*/
LIMIT("limit", 100);
private final String path;
private final Object defaultValue;
ConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
@Override
public String getConfigPath() {
return path;
}
}
}