-
Notifications
You must be signed in to change notification settings - Fork 215
/
EnforcementConfig.java
113 lines (94 loc) · 3.45 KB
/
EnforcementConfig.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
/*
* Copyright (c) 2022 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.policies.enforcement.config;
import java.util.List;
import java.util.Set;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.model.signals.Signal;
import org.eclipse.ditto.base.model.signals.commands.Command;
import org.eclipse.ditto.internal.utils.cacheloaders.config.AskWithRetryConfig;
import org.eclipse.ditto.internal.utils.config.KnownConfigValue;
/**
* Provides configuration settings for Concierge enforcement behaviour.
*/
@Immutable
public interface EnforcementConfig {
/**
* Returns the configuration for the used "ask with retry" pattern in the concierge enforcement to load
* things+policies.
*
* @return the "ask with retry" pattern config for retrieval of things and policies.
*/
AskWithRetryConfig getAskWithRetryConfig();
/**
* Returns the buffer size used for the queue in the enforcer actor.
*
* @return the buffer size.
*/
int getBufferSize();
/**
* Returns whether live responses from channels other than their subscribers should be dispatched.
*
* @return whether global live response dispatching is enabled.
*/
boolean isDispatchLiveResponsesGlobally();
/**
* Returns a list of namespaces for which a special usage logging should be enabled in enforcement.
*
* @return list of namespaces which should be inspected.
*/
Set<String> getSpecialLoggingInspectedNamespaces();
/**
* Check if global dispatch of a signal should be supported.
*
* @param signal the signal.
* @return whether global dispatch support is needed.
*/
default boolean shouldDispatchGlobally(final Signal<?> signal) {
return isDispatchLiveResponsesGlobally() &&
signal instanceof Command<?> &&
signal.getDittoHeaders().isResponseRequired();
}
/**
* An enumeration of the known config path expressions and their associated default values for
* {@code EnforcementConfig}.
*/
enum EnforcementConfigValue implements KnownConfigValue {
/**
* The buffer size used for the queue in the enforcer actor.
*/
BUFFER_SIZE("buffer-size", 1_000),
/**
* Whether to enable dispatching live responses from channels other than the subscribers.
*/
GLOBAL_LIVE_RESPONSE_DISPATCHING("global-live-response-dispatching", true),
/**
* List of namespaces for which a special usage logging should be enabled in enforcement.
*/
SPECIAL_LOGGING_INSPECTED_NAMESPACES("special-logging-inspected-namespaces", List.of());
private final String path;
private final Object defaultValue;
EnforcementConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public String getConfigPath() {
return path;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
}
}