-
Notifications
You must be signed in to change notification settings - Fork 215
/
MetadataFromCommand.java
207 lines (184 loc) · 9.64 KB
/
MetadataFromCommand.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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
/*
* 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.things.service.persistence.actors.strategies.commands;
import static org.eclipse.ditto.base.model.common.ConditionChecker.checkNotNull;
import java.util.LinkedHashSet;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
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.entity.metadata.Metadata;
import org.eclipse.ditto.base.model.entity.metadata.MetadataBuilder;
import org.eclipse.ditto.base.model.headers.DittoHeaderDefinition;
import org.eclipse.ditto.base.model.headers.DittoHeaders;
import org.eclipse.ditto.base.model.headers.metadata.MetadataHeader;
import org.eclipse.ditto.base.model.headers.metadata.MetadataHeaderKey;
import org.eclipse.ditto.base.model.signals.WithOptionalEntity;
import org.eclipse.ditto.base.model.signals.commands.Command;
import org.eclipse.ditto.json.JsonFactory;
import org.eclipse.ditto.json.JsonObject;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.things.model.Thing;
import org.eclipse.ditto.things.model.ThingsModelFactory;
import org.eclipse.ditto.things.model.signals.commands.modify.CreateThing;
import org.eclipse.ditto.things.model.signals.commands.modify.MergeThing;
/**
* Creates or extends/modifies Metadata of an entity based on {@link MetadataHeader}s of a {@link Command}'s
* DittoHeaders.
*
* @since 1.3.0
*/
@Immutable
final class MetadataFromCommand implements Supplier<Metadata> {
private final Command<?> command;
private final Thing mergedThing;
@Nullable
private final Metadata existingMetadata;
private MetadataFromCommand(final Command<?> command,
final Thing mergedThing,
@Nullable final Metadata existingMetadata) {
this.command = checkNotNull(command, "command");
this.mergedThing = checkNotNull(mergedThing, "mergedThing");
this.existingMetadata = existingMetadata;
}
/**
* Returns a new {@code MetadataFromCommand}.
*
* @param command provides modified paths and headers.
* @param existingThing provides the existing thing.
* @param existingMetadata provides existing metadata to be extended.
* @throws NullPointerException if {@code command} or {@code withOptionalEntity} is {@code null}.
*/
static MetadataFromCommand of(final Command<?> command,
@Nullable final Thing existingThing,
@Nullable final Metadata existingMetadata) {
final Thing existingOrEmptyThing =
Objects.requireNonNullElseGet(existingThing, () -> Thing.newBuilder().build());
if (command instanceof WithOptionalEntity withOptionalEntity) {
final var mergedThing = withOptionalEntity.getEntity()
.map(entity -> {
final var resourcePath = command.getResourcePath();
if (resourcePath.isEmpty() && entity.isObject()) {
final JsonObject mergedThingJson =
JsonFactory.newObject(entity.asObject(), existingOrEmptyThing.toJson());
return ThingsModelFactory.newThing(mergedThingJson);
} else if (command instanceof MergeThing && entity.isObject()) {
final JsonObject mergedJson =
JsonFactory.newObject(entity.asObject(),
existingOrEmptyThing.toJson().get(resourcePath));
return ThingsModelFactory.newThing(existingOrEmptyThing.toJson().setValue(resourcePath, mergedJson));
} else {
return ThingsModelFactory.newThing(
existingOrEmptyThing.toJson().setValue(resourcePath, entity));
}
})
.orElse(existingOrEmptyThing);
return new MetadataFromCommand(command, mergedThing, existingMetadata);
} else {
return new MetadataFromCommand(command, existingOrEmptyThing, existingMetadata);
}
}
/**
* Builds Metadata based on the Command and the existing metadata of this instance. If the existing metadata is
* {@code null} and the command does not contain an entity for its implemented schema version, the result of this
* method is {@code null}. Otherwise, either a new Metadata is created or the existing metadata gets modified and/or
* extended. The values of the returned metadata are obtained from the metadata headers within the DittoHeaders of
* this instance's command.
*
* @return the created, modified or extended Metadata or {@code null}.
* @throws IllegalArgumentException if the key of a metadata header
* <ul>
* <li>is empty,</li>
* <li>starts with an asterisk ({@code *}) and has not exactly two levels,</li>
* <li>contains an asterisk at any level but the first.</li>
* </ul>
* @throws org.eclipse.ditto.json.JsonParseException if the value of a metadata header cannot be parsed.
*/
@Override
@Nullable
public Metadata get() {
return getInlineMetadata().orElseGet(() -> {
final SortedSet<MetadataHeader> metadataHeaders = getMetadataHeadersToPut();
final Optional<JsonValue> optionalJsonValue = mergedThing.toJson().getValue(command.getResourcePath());
if (!metadataHeaders.isEmpty() && optionalJsonValue.isPresent()) {
final var expandedMetadataHeaders = metadataHeaders.stream()
.flatMap(this::expandWildcards)
.collect(Collectors.toCollection(LinkedHashSet::new));
return buildMetadata(optionalJsonValue.get(), expandedMetadataHeaders);
}
return existingMetadata;
});
}
private Optional<Metadata> getInlineMetadata() {
return command instanceof CreateThing createThing ? createThing.getThing().getMetadata() : Optional.empty();
}
private SortedSet<MetadataHeader> getMetadataHeadersToPut() {
final DittoHeaders dittoHeaders = command.getDittoHeaders();
return dittoHeaders.getMetadataHeadersToPut();
}
private Stream<MetadataHeader> expandWildcards(final MetadataHeader metadataHeader) {
if (containsWildcard(metadataHeader)) {
MetadataWildcardValidator.validateMetadataWildcard(command.getResourcePath(),
metadataHeader.getKey().toString(), DittoHeaderDefinition.PUT_METADATA.getKey());
final var jsonPointers = MetadataFieldsWildcardResolver.resolve(command, mergedThing,
metadataHeader.getKey().getPath(), DittoHeaderDefinition.PUT_METADATA.getKey());
return jsonPointers.stream()
.map(MetadataHeaderKey::of)
.map(metadataHeaderKey -> MetadataHeader.of(metadataHeaderKey, metadataHeader.getValue()));
} else {
return Stream.of(metadataHeader);
}
}
private boolean containsWildcard(final MetadataHeader metadataHeader) {
return metadataHeader.getKey()
.toString()
.contains("/*/");
}
private Metadata buildMetadata(final JsonValue entity, final Set<MetadataHeader> metadataHeaders) {
final MetadataBuilder metadataBuilder = getMetadataBuilder();
final Consumer<MetadataHeader> addMetadataToBuilder = metadataHeader -> {
final MetadataHeaderKey metadataHeaderKey = metadataHeader.getKey();
final JsonValue metadataHeaderValue = metadataHeader.getValue();
if (entity.isObject()) {
final var field = entity.asObject().getField(metadataHeaderKey.getPath());
final var metadataHeaderKeyLeaf = metadataHeaderKey.getPath().cutLeaf();
if (field.isPresent()) {
if (field.get().getValue().isObject()) {
metadataBuilder.set(metadataHeaderKey.getPath(), metadataHeaderValue);
}
} else if (entity.asObject().contains(metadataHeaderKeyLeaf)) {
final var optionalLeafValue = entity.asObject().getValue(metadataHeaderKeyLeaf);
if (optionalLeafValue.isEmpty() || optionalLeafValue.get().isObject()
|| metadataHeaderKey.getPath().getLevelCount() > 1) {
metadataBuilder.set(metadataHeaderKey.getPath(), metadataHeaderValue);
}
} else if (metadataHeaderKey.getPath().getLevelCount() == 1) {
metadataBuilder.set(metadataHeaderKey.getPath(), metadataHeaderValue);
}
} else if (metadataHeaderKey.getPath().getLevelCount() > 1 || metadataHeaderValue.isObject()) {
metadataBuilder.set(metadataHeaderKey.getPath(), metadataHeaderValue);
}
};
metadataHeaders.forEach(addMetadataToBuilder);
return metadataBuilder.build();
}
private MetadataBuilder getMetadataBuilder() {
return null != existingMetadata ? Metadata.newBuilder().setAll(existingMetadata) : Metadata.newBuilder();
}
}