-
Notifications
You must be signed in to change notification settings - Fork 215
/
SseConfig.java
105 lines (88 loc) · 3.36 KB
/
SseConfig.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
/*
* 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.gateway.service.util.config.streaming;
import org.eclipse.ditto.base.service.config.ThrottlingConfig;
import org.eclipse.ditto.internal.utils.config.KnownConfigValue;
/**
* Provides configuration settings of SSE.
*/
public interface SseConfig {
/**
* Config path relative to its parent.
*/
String CONFIG_PATH = "sse";
/**
* Returns the throttling config for SSE.
*
* @return the throttling config.
*/
ThrottlingConfig getThrottlingConfig();
/**
* Returns the full qualified classname of the {@code org.eclipse.ditto.gateway.service.endpoints.routes.sse.SseAuthorizationEnforcer}
* implementation to use for custom authorizations.
*
* @return the full qualified classname of the {@code SseAuthorizationEnforcer} implementation to use.
* @since 3.0.0
*/
String getAuthorizationEnforcer();
/**
* Returns the full qualified classname of the {@code org.eclipse.ditto.gateway.service.endpoints.routes.sse.SseConnectionSupervisor}
* implementation to use for supervising SSE connections.
*
* @return the full qualified classname of the {@code SseConnectionSupervisor} implementation to use.
* @since 3.0.0
*/
String getConnectionSupervisor();
/**
* Returns the full qualified classname of the {@code org.eclipse.ditto.gateway.service.endpoints.routes.sse.SseEventSniffer}
* implementation to use for custom SSE listeners.
*
* @return the full qualified classname of the {@code SseEventSniffer} implementation to use.
* @since 3.0.0
*/
String getEventSniffer();
enum SseConfigValue implements KnownConfigValue {
/**
* The full qualified classname of the {@code SseAuthorizationEnforcer} to instantiate.
* @since 3.0.0
*/
AUTHORIZATION_ENFORCER("authorization-enforcer",
"org.eclipse.ditto.gateway.service.endpoints.routes.sse.NoOpSseAuthorizationEnforcer"),
/**
* The full qualified classname of the {@code SseConnectionSupervisor} to instantiate.
* @since 3.0.0
*/
CONNECTION_SUPERVISOR("connection-supervisor",
"org.eclipse.ditto.gateway.service.endpoints.routes.sse.NoOpSseConnectionSupervisor"),
/**
* The full qualified classname of the {@code SseEventSniffer} to instantiate.
* @since 3.0.0
*/
EVENT_SNIFFER("event-sniffer",
"org.eclipse.ditto.gateway.service.endpoints.routes.sse.NoOpSseEventSniffer");
private final String path;
private final Object defaultValue;
SseConfigValue(final String thePath, final Object theDefaultValue) {
path = thePath;
defaultValue = theDefaultValue;
}
@Override
public Object getDefaultValue() {
return defaultValue;
}
@Override
public String getConfigPath() {
return path;
}
}
}