-
Notifications
You must be signed in to change notification settings - Fork 214
/
HonoValidator.java
186 lines (159 loc) · 7.31 KB
/
HonoValidator.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
/*
* 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.connectivity.service.messaging.hono;
import java.text.MessageFormat;
import java.util.LinkedHashSet;
import java.util.Objects;
import java.util.Set;
import java.util.function.Consumer;
import java.util.function.Supplier;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.annotation.Nullable;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.connectivity.model.Connection;
import org.eclipse.ditto.connectivity.model.ConnectionConfigurationInvalidException;
import org.eclipse.ditto.connectivity.model.ConnectionType;
import org.eclipse.ditto.connectivity.model.HonoAddressAlias;
import org.eclipse.ditto.connectivity.model.Source;
import org.eclipse.ditto.connectivity.model.Target;
import org.eclipse.ditto.connectivity.service.config.ConnectivityConfig;
import org.eclipse.ditto.connectivity.service.messaging.validation.AbstractProtocolValidator;
import org.eclipse.ditto.connectivity.service.placeholders.ConnectivityPlaceholders;
import org.eclipse.ditto.placeholders.PlaceholderFactory;
import org.apache.pekko.actor.ActorSystem;
@Immutable
public final class HonoValidator extends AbstractProtocolValidator {
@Nullable private static HonoValidator instance;
private final Set<String> allowedSourceAddressHonoAliasValues;
private HonoValidator() {
allowedSourceAddressHonoAliasValues = Stream.of(HonoAddressAlias.values())
.filter(honoAddressAlias -> HonoAddressAlias.COMMAND != honoAddressAlias)
.map(HonoAddressAlias::getAliasValue)
.collect(Collectors.toCollection(LinkedHashSet::new));
}
/**
* Returns an instance of the Hono validator.
*
* @return the instance.
*/
public static HonoValidator getInstance() {
var result = instance;
if (null == result) {
result = new HonoValidator();
instance = result;
}
return result;
}
@Override
public ConnectionType type() {
return ConnectionType.HONO;
}
@Override
public void validate(final Connection connection,
final DittoHeaders dittoHeaders,
final ActorSystem actorSystem,
final ConnectivityConfig connectivityConfig) {
validateSourceConfigs(connection, dittoHeaders);
validateTargetConfigs(connection, dittoHeaders);
validatePayloadMappings(connection, actorSystem, connectivityConfig, dittoHeaders);
}
@Override
protected void validateSource(final Source source,
final DittoHeaders dittoHeaders,
final Supplier<String> sourceDescription) {
validateSourceEnforcement(source, dittoHeaders);
validateSourceAddresses(source, dittoHeaders);
validateSourceQos(source, dittoHeaders);
}
private void validateSourceEnforcement(final Source source, final DittoHeaders dittoHeaders) {
final Consumer<String> validateInputTemplate =
inputTemplate -> validateTemplate(inputTemplate,
dittoHeaders,
PlaceholderFactory.newHeadersPlaceholder());
final Consumer<Set<String>> validateFilterTemplates =
filters -> filters.forEach(
filterTemplate -> validateTemplate(filterTemplate,
dittoHeaders,
ConnectivityPlaceholders.newThingPlaceholder(),
ConnectivityPlaceholders.newPolicyPlaceholder(),
ConnectivityPlaceholders.newEntityPlaceholder(),
ConnectivityPlaceholders.newFeaturePlaceholder())
);
source.getEnforcement()
.ifPresent(enforcement -> {
validateInputTemplate.accept(enforcement.getInput());
validateFilterTemplates.accept(enforcement.getFilters());
});
}
private void validateSourceAddresses(final Source source, final DittoHeaders dittoHeaders) {
final var sourceAddresses = source.getAddresses();
sourceAddresses.forEach(address -> validateSourceAddress(address, dittoHeaders));
}
private void validateSourceAddress(final String sourceAddress, final DittoHeaders dittoHeaders) {
if (sourceAddress.isEmpty()) {
throw newConnectionConfigurationInvalidException("The provided source address must not be empty.",
dittoHeaders);
}
if (!allowedSourceAddressHonoAliasValues.contains(sourceAddress)) {
throw newConnectionConfigurationInvalidException(
MessageFormat.format("The provided source address <{0}> is invalid." +
" It should be one of the defined aliases: {1}",
sourceAddress,
allowedSourceAddressHonoAliasValues),
dittoHeaders
);
}
}
private static ConnectionConfigurationInvalidException newConnectionConfigurationInvalidException(
final String errorMessage,
final DittoHeaders dittoHeaders
) {
return ConnectionConfigurationInvalidException.newBuilder(errorMessage).dittoHeaders(dittoHeaders).build();
}
private static void validateSourceQos(final Source source, final DittoHeaders dittoHeaders) {
source.getQos()
.filter(qos -> qos < 0 || qos > 1)
.ifPresent(qos -> {
throw newConnectionConfigurationInvalidException(
MessageFormat.format(
"Invalid source ''qos'' value <{0}>. Supported values are <0> and <1>.",
qos),
dittoHeaders
);
});
}
@Override
protected void validateTarget(final Target target,
final DittoHeaders dittoHeaders,
final Supplier<String> targetDescription) {
validateTargetAddress(target.getAddress(), dittoHeaders);
validateExtraFields(target);
}
private static void validateTargetAddress(final String targetAddress, final DittoHeaders dittoHeaders) {
if (targetAddress.isEmpty()) {
throw newConnectionConfigurationInvalidException("The provided target address must not be empty.",
dittoHeaders);
}
final var allowedTargetAddressAliasValue = HonoAddressAlias.COMMAND.getAliasValue();
if (!Objects.equals(allowedTargetAddressAliasValue, targetAddress)) {
throw newConnectionConfigurationInvalidException(
MessageFormat.format("The provided target address <{0}> is invalid. It should be <{1}>.",
targetAddress,
allowedTargetAddressAliasValue),
dittoHeaders
);
}
}
}