/
PolicyIdReferencePlaceholderResolver.java
166 lines (141 loc) · 8.11 KB
/
PolicyIdReferencePlaceholderResolver.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
/*
* Copyright (c) 2017-2018 Bosch Software Innovations GmbH.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/org/documents/epl-2.0/index.php
*
* SPDX-License-Identifier: EPL-2.0
*/
package org.eclipse.ditto.services.concierge.enforcement.placeholders.references;
import java.time.Duration;
import java.util.EnumMap;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CompletionStage;
import java.util.stream.Collectors;
import javax.annotation.concurrent.Immutable;
import org.eclipse.ditto.json.JsonFieldDefinition;
import org.eclipse.ditto.json.JsonValue;
import org.eclipse.ditto.model.base.exceptions.DittoRuntimeException;
import org.eclipse.ditto.model.base.headers.DittoHeaders;
import org.eclipse.ditto.signals.commands.base.exceptions.GatewayInternalErrorException;
import org.eclipse.ditto.signals.commands.base.exceptions.GatewayPlaceholderReferenceNotSupportedException;
import org.eclipse.ditto.signals.commands.base.exceptions.GatewayPlaceholderReferenceUnknownFieldException;
import org.eclipse.ditto.signals.commands.things.ThingErrorResponse;
import org.eclipse.ditto.signals.commands.things.query.RetrieveThing;
import org.eclipse.ditto.signals.commands.things.query.RetrieveThingResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import akka.actor.ActorRef;
import akka.pattern.PatternsCS;
/**
* Responsible for resolving a policy id of a referenced entity.
*/
@Immutable
public final class PolicyIdReferencePlaceholderResolver implements ReferencePlaceholderResolver<String> {
private static final Logger LOGGER = LoggerFactory.getLogger(PolicyIdReferencePlaceholderResolver.class);
private final Duration retrieveEntityTimeoutDuration;
private final ActorRef conciergeForwarderActor;
private final Map<ReferencePlaceholder.ReferencedEntityType, ResolveEntityReferenceStrategy>
supportedEntityTypesToActionMap = new EnumMap<>(ReferencePlaceholder.ReferencedEntityType.class);
private final Set<CharSequence> supportedEntityTypeNames;
private PolicyIdReferencePlaceholderResolver(final ActorRef conciergeForwarderActor,
final Duration retrieveEntityTimeoutDuration) {
this.conciergeForwarderActor = conciergeForwarderActor;
this.retrieveEntityTimeoutDuration = retrieveEntityTimeoutDuration;
initializeSupportedEntityTypeReferences();
this.supportedEntityTypeNames =
this.supportedEntityTypesToActionMap.keySet().stream().map(Enum::name).collect(Collectors.toSet());
}
private void initializeSupportedEntityTypeReferences() {
this.supportedEntityTypesToActionMap.put(ReferencePlaceholder.ReferencedEntityType.THINGS,
this::handleThingPolicyIdReference);
}
/**
* Resolves the policy id of the entity of type {@link ReferencePlaceholder#referencedEntityType} with id
* {@link ReferencePlaceholder#referencedEntityId}.
*
* @param referencePlaceholder The placeholder holding the information about the referenced entity id.
* @param dittoHeaders The ditto headers.
* @return A completion stage of String that should eventually hold the policy id.
*/
@Override
public CompletionStage<String> resolve(final ReferencePlaceholder referencePlaceholder,
final DittoHeaders dittoHeaders) {
final ResolveEntityReferenceStrategy resolveEntityReferenceStrategy =
this.supportedEntityTypesToActionMap.get(referencePlaceholder.getReferencedEntityType());
if (resolveEntityReferenceStrategy == null) {
final String referencedEntityType = referencePlaceholder.getReferencedEntityType().name();
LOGGER.info(
"Could not find a placeholder replacement strategy for entity type <{}> in supported entity types: {}",
referencedEntityType, supportedEntityTypeNames);
throw notSupportedException(referencedEntityType, dittoHeaders);
}
LOGGER.debug("Will resolve entity reference for placeholder: <{}>", referencePlaceholder);
return resolveEntityReferenceStrategy.handleEntityPolicyIdReference(referencePlaceholder, dittoHeaders);
}
private CompletionStage<String> handleThingPolicyIdReference(final ReferencePlaceholder referencePlaceholder,
final DittoHeaders dittoHeaders) {
final RetrieveThing retrieveThingCommand =
RetrieveThing.getBuilder(referencePlaceholder.getReferencedEntityId(), dittoHeaders)
.withSelectedFields(referencePlaceholder.getReferencedField().toFieldSelector())
.build();
return PatternsCS.ask(conciergeForwarderActor, retrieveThingCommand, retrieveEntityTimeoutDuration)
.thenApply(response -> this.handleRetrieveThingResponse(response, referencePlaceholder, dittoHeaders));
}
private String handleRetrieveThingResponse(final Object response,
final ReferencePlaceholder referencePlaceholder,
final DittoHeaders dittoHeaders) {
if (response instanceof RetrieveThingResponse) {
return ((RetrieveThingResponse) response).getThing()
.getPolicyId()
.orElseThrow(() -> GatewayPlaceholderReferenceUnknownFieldException.fromUnknownFieldAndEntityId(
referencePlaceholder.getReferencedFieldSelector().toString(),
referencePlaceholder.getReferencedEntityId())
.build());
} else if (response instanceof ThingErrorResponse) {
LOGGER.info(
"Got ThingErrorResponse when waiting on RetrieveThingResponse when resolving policy id placeholder reference <{}>: {}",
referencePlaceholder,
response);
throw ((ThingErrorResponse) response).getDittoRuntimeException();
} else if (response instanceof DittoRuntimeException) {
// ignore warning that second argument isn't used. Runtime exceptions will have their stacktrace printed
// in the logs according to https://www.slf4j.org/faq.html#paramException
LOGGER.info(
"Got Exception when waiting on RetrieveThingResponse when resolving policy id placeholder reference <{}>",
referencePlaceholder,
response);
throw (DittoRuntimeException) response;
} else {
LOGGER.error(
"Did not retrieve expected RetrieveThingResponse when resolving policy id placeholder reference <{}>: {}",
referencePlaceholder, response);
throw GatewayInternalErrorException.newBuilder().dittoHeaders(dittoHeaders).build();
}
}
private GatewayPlaceholderReferenceUnknownFieldException unknownFieldException(
final ReferencePlaceholder placeholder, final DittoHeaders headers) {
return GatewayPlaceholderReferenceUnknownFieldException.fromUnknownFieldAndEntityId(
placeholder.getReferencedField().toString(),
placeholder.getReferencedEntityId())
.dittoHeaders(headers)
.build();
}
private GatewayPlaceholderReferenceNotSupportedException notSupportedException(final String referencedEntityType,
final DittoHeaders headers) {
return GatewayPlaceholderReferenceNotSupportedException.fromUnsupportedEntityType(
referencedEntityType, supportedEntityTypeNames)
.dittoHeaders(headers).build();
}
public static PolicyIdReferencePlaceholderResolver of(final ActorRef conciergeForwarderActor,
final Duration retrieveEntityTimeoutDuration) {
return new PolicyIdReferencePlaceholderResolver(conciergeForwarderActor, retrieveEntityTimeoutDuration);
}
interface ResolveEntityReferenceStrategy {
CompletionStage<String> handleEntityPolicyIdReference(final ReferencePlaceholder referencePlaceholder,
final DittoHeaders dittoHeaders);
}
}