2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ============LICENSE_END=========================================================
21 package org.onap.policy.controlloop.actorserviceprovider.impl;
23 import java.util.List;
24 import java.util.concurrent.CompletableFuture;
25 import java.util.concurrent.Executor;
26 import java.util.function.BiConsumer;
28 import org.apache.commons.lang3.tuple.Pair;
29 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
30 import org.onap.policy.common.utils.coder.CoderException;
31 import org.onap.policy.common.utils.coder.StandardCoderObject;
32 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
33 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
34 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
35 import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
36 import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
37 import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
38 import org.onap.policy.controlloop.policy.PolicyResult;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
43 * Operation that uses a bidirectional topic.
45 * @param <S> response type
48 public abstract class BidirectionalTopicOperation<Q, S> extends OperationPartial {
49 private static final Logger logger = LoggerFactory.getLogger(BidirectionalTopicOperation.class);
55 SUCCESS, FAILURE, STILL_WAITING
59 * Configuration for this operation.
61 private final BidirectionalTopicConfig config;
66 private final Class<S> responseClass;
68 // fields extracted from "config"
70 private final BidirectionalTopicHandler topicHandler;
71 private final Forwarder forwarder;
75 * Constructs the object.
77 * @param params operation parameters
78 * @param config configuration for this operation
79 * @param clazz response class
81 public BidirectionalTopicOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config,
83 super(params, config);
85 this.responseClass = clazz;
86 this.forwarder = config.getForwarder();
87 this.topicHandler = config.getTopicHandler();
90 public long getTimeoutMs() {
91 return config.getTimeoutMs();
95 * If no timeout is specified, then it returns the default timeout.
98 protected long getTimeoutMs(Integer timeoutSec) {
99 // TODO move this method to the superclass
100 return (timeoutSec == null || timeoutSec == 0 ? getTimeoutMs() : super.getTimeoutMs(timeoutSec));
104 * Publishes the request and arranges to receive the response.
107 protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
109 final Pair<String,Q> pair = makeRequest(attempt);
110 final Q request = pair.getRight();
111 outcome.setSubRequestId(pair.getLeft());
113 final List<String> expectedKeyValues = getExpectedKeyValues(attempt, request);
115 final PipelineControllerFuture<OperationOutcome> controller = new PipelineControllerFuture<>();
116 final Executor executor = params.getExecutor();
118 // register a listener BEFORE publishing
120 BiConsumer<String, StandardCoderObject> listener = (rawResponse, scoResponse) -> {
121 OperationOutcome latestOutcome = processResponse(outcome, rawResponse, scoResponse);
122 if (latestOutcome != null) {
123 // final response - complete the controller
124 controller.completeAsync(() -> latestOutcome, executor);
128 forwarder.register(expectedKeyValues, listener);
130 // ensure listener is unregistered if the controller is canceled
131 controller.add(() -> forwarder.unregister(expectedKeyValues, listener));
133 // publish the request
135 publishRequest(request);
136 } catch (RuntimeException e) {
137 logger.warn("{}: failed to publish request for {}", getFullName(), params.getRequestId());
138 forwarder.unregister(expectedKeyValues, listener);
148 * @param attempt operation attempt
149 * @return a pair containing sub request ID, which may be {@code null} and the new
152 protected abstract Pair<String, Q> makeRequest(int attempt);
155 * Gets values, expected in the response, that should match the selector keys.
157 * @param attempt operation attempt
158 * @param request request to be published
159 * @return a list of the values to be matched by the selector keys
161 protected abstract List<String> getExpectedKeyValues(int attempt, Q request);
164 * Publishes the request. Encodes the request, if it is not already a String.
166 * @param request request to be published
168 protected void publishRequest(Q request) {
171 if (request instanceof String) {
172 json = request.toString();
174 json = makeCoder().encode(request);
176 } catch (CoderException e) {
177 throw new IllegalArgumentException("cannot encode request", e);
180 logMessage(EventType.OUT, topicHandler.getSinkTopicCommInfrastructure(), topicHandler.getSinkTopic(), request);
182 if (!topicHandler.send(json)) {
183 throw new IllegalStateException("nothing published");
188 * Processes a response.
190 * @param infra communication infrastructure on which the response was received
191 * @param outcome outcome to be populated
192 * @param response raw response to process
193 * @param scoResponse response, as a {@link StandardCoderObject}
194 * @return the outcome, or {@code null} if still waiting for completion
196 protected OperationOutcome processResponse(OperationOutcome outcome, String rawResponse,
197 StandardCoderObject scoResponse) {
199 logger.info("{}.{}: response received for {}", params.getActor(), params.getOperation(), params.getRequestId());
201 logMessage(EventType.IN, topicHandler.getSourceTopicCommInfrastructure(), topicHandler.getSourceTopic(),
204 // decode the response
206 if (responseClass == String.class) {
207 response = responseClass.cast(rawResponse);
209 } else if (responseClass == StandardCoderObject.class) {
210 response = responseClass.cast(scoResponse);
214 response = makeCoder().decode(rawResponse, responseClass);
215 } catch (CoderException e) {
216 logger.warn("{}.{} cannot decode response for {}", params.getActor(), params.getOperation(),
217 params.getRequestId());
218 throw new IllegalArgumentException("cannot decode response", e);
223 switch (detmStatus(rawResponse, response)) {
225 logger.info("{}.{} request succeeded for {}", params.getActor(), params.getOperation(),
226 params.getRequestId());
227 setOutcome(outcome, PolicyResult.SUCCESS, response);
228 postProcessResponse(outcome, rawResponse, response);
232 logger.info("{}.{} request failed for {}", params.getActor(), params.getOperation(),
233 params.getRequestId());
234 return setOutcome(outcome, PolicyResult.FAILURE, response);
238 logger.info("{}.{} request incomplete for {}", params.getActor(), params.getOperation(),
239 params.getRequestId());
245 * Sets an operation's outcome and default message based on the result.
247 * @param outcome operation to be updated
248 * @param result result of the operation
249 * @param response response used to populate the outcome
250 * @return the updated operation
252 public OperationOutcome setOutcome(OperationOutcome outcome, PolicyResult result, S response) {
253 return setOutcome(outcome, result);
257 * Processes a successful response.
259 * @param outcome outcome to be populated
260 * @param rawResponse raw response
261 * @param response decoded response
263 protected void postProcessResponse(OperationOutcome outcome, String rawResponse, S response) {
268 * Determines the status of the response.
270 * @param rawResponse raw response
271 * @param response decoded response
272 * @return the status of the response
274 protected abstract Status detmStatus(String rawResponse, S response);