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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
|
/*-
* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
* Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ============LICENSE_END=========================================================
*/
package org.onap.policy.controlloop.actorserviceprovider.impl;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executor;
import java.util.function.BiConsumer;
import lombok.Getter;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoderObject;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Operation that uses a bidirectional topic.
*
* @param <S> response type
*/
@Getter
public abstract class BidirectionalTopicOperation<Q, S> extends OperationPartial {
private static final Logger logger = LoggerFactory.getLogger(BidirectionalTopicOperation.class);
/**
* Response status.
*/
public enum Status {
SUCCESS, FAILURE, STILL_WAITING
}
/**
* Configuration for this operation.
*/
private final BidirectionalTopicConfig config;
/**
* Response class.
*/
private final Class<S> responseClass;
// fields extracted from "config"
private final BidirectionalTopicHandler topicHandler;
private final Forwarder forwarder;
/**
* Constructs the object.
*
* @param params operation parameters
* @param config configuration for this operation
* @param clazz response class
* @param propertyNames names of properties required by this operation
*/
public BidirectionalTopicOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config,
Class<S> clazz, List<String> propertyNames) {
super(params, config, propertyNames);
this.config = config;
this.responseClass = clazz;
this.forwarder = config.getForwarder();
this.topicHandler = config.getTopicHandler();
}
public long getTimeoutMs() {
return config.getTimeoutMs();
}
/**
* If no timeout is specified, then it returns the default timeout.
*/
@Override
protected long getTimeoutMs(Integer timeoutSec) {
// TODO move this method to the superclass
return (timeoutSec == null || timeoutSec == 0 ? getTimeoutMs() : super.getTimeoutMs(timeoutSec));
}
/**
* Publishes the request and arranges to receive the response.
*/
@Override
protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
final Q request = makeRequest(attempt);
final List<String> expectedKeyValues = getExpectedKeyValues(attempt, request);
final PipelineControllerFuture<OperationOutcome> controller = new PipelineControllerFuture<>();
final Executor executor = params.getExecutor();
// register a listener BEFORE publishing
BiConsumer<String, StandardCoderObject> listener = (rawResponse, scoResponse) -> {
try {
OperationOutcome latestOutcome = processResponse(outcome, rawResponse, scoResponse);
if (latestOutcome != null) {
// final response - complete the controller
controller.completeAsync(() -> latestOutcome, executor);
}
} catch (RuntimeException e) {
logger.warn("{}: failed to process response for {}", getFullName(), params.getRequestId());
controller.completeExceptionally(e);
}
};
forwarder.register(expectedKeyValues, listener);
// ensure listener is unregistered if the controller is canceled
controller.add(() -> forwarder.unregister(expectedKeyValues, listener));
// publish the request
try {
publishRequest(request);
} catch (RuntimeException e) {
logger.warn("{}: failed to publish request for {}", getFullName(), params.getRequestId());
forwarder.unregister(expectedKeyValues, listener);
throw e;
}
return controller;
}
/**
* Makes the request.
*
* @param attempt operation attempt
* @return a new request
*/
protected abstract Q makeRequest(int attempt);
/**
* Gets values, expected in the response, that should match the selector keys.
*
* @param attempt operation attempt
* @param request request to be published
* @return a list of the values to be matched by the selector keys
*/
protected abstract List<String> getExpectedKeyValues(int attempt, Q request);
/**
* Publishes the request. Encodes the request, if it is not already a String.
*
* @param request request to be published
*/
protected void publishRequest(Q request) {
String json = prettyPrint(request);
logMessage(EventType.OUT, topicHandler.getSinkTopicCommInfrastructure(), topicHandler.getSinkTopic(), json);
if (!topicHandler.send(json)) {
throw new IllegalStateException("nothing published");
}
}
/**
* Processes a response.
*
* @param infra communication infrastructure on which the response was received
* @param outcome outcome to be populated
* @param response raw response to process
* @param scoResponse response, as a {@link StandardCoderObject}
* @return the outcome, or {@code null} if still waiting for completion
*/
protected OperationOutcome processResponse(OperationOutcome outcome, String rawResponse,
StandardCoderObject scoResponse) {
logger.info("{}.{}: response received for {}", params.getActor(), params.getOperation(), params.getRequestId());
logMessage(EventType.IN, topicHandler.getSourceTopicCommInfrastructure(), topicHandler.getSourceTopic(),
rawResponse);
// decode the response
S response;
if (responseClass == String.class) {
response = responseClass.cast(rawResponse);
} else if (responseClass == StandardCoderObject.class) {
response = responseClass.cast(scoResponse);
} else {
try {
response = getCoder().decode(rawResponse, responseClass);
} catch (CoderException e) {
logger.warn("{}.{} cannot decode response for {}", params.getActor(), params.getOperation(),
params.getRequestId());
throw new IllegalArgumentException("cannot decode response", e);
}
}
// check its status
switch (detmStatus(rawResponse, response)) {
case SUCCESS:
logger.info("{}.{} request succeeded for {}", params.getActor(), params.getOperation(),
params.getRequestId());
setOutcome(outcome, OperationResult.SUCCESS, response);
postProcessResponse(outcome, rawResponse, response);
return outcome;
case FAILURE:
logger.info("{}.{} request failed for {}", params.getActor(), params.getOperation(),
params.getRequestId());
return setOutcome(outcome, OperationResult.FAILURE, response);
case STILL_WAITING:
default:
logger.info("{}.{} request incomplete for {}", params.getActor(), params.getOperation(),
params.getRequestId());
return null;
}
}
/**
* Sets an operation's outcome and default message based on the result.
*
* @param outcome operation to be updated
* @param result result of the operation
* @param response response used to populate the outcome
* @return the updated operation
*/
public OperationOutcome setOutcome(OperationOutcome outcome, OperationResult result, S response) {
outcome.setResponse(response);
return setOutcome(outcome, result);
}
/**
* Processes a successful response.
*
* @param outcome outcome to be populated
* @param rawResponse raw response
* @param response decoded response
*/
protected void postProcessResponse(OperationOutcome outcome, String rawResponse, S response) {
// do nothing
}
/**
* Determines the status of the response.
*
* @param rawResponse raw response
* @param response decoded response
* @return the status of the response
*/
protected abstract Status detmStatus(String rawResponse, S response);
}
|