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.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
29 import org.onap.policy.common.utils.coder.CoderException;
30 import org.onap.policy.common.utils.coder.StandardCoderObject;
31 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
32 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
33 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
34 import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
35 import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
36 import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
37 import org.onap.policy.controlloop.policy.PolicyResult;
38 import org.slf4j.Logger;
39 import org.slf4j.LoggerFactory;
42 * Operation that uses a bidirectional topic.
44 * @param <S> response type
47 public abstract class BidirectionalTopicOperation<Q, S> extends OperationPartial {
48 private static final Logger logger = LoggerFactory.getLogger(BidirectionalTopicOperation.class);
54 SUCCESS, FAILURE, STILL_WAITING
58 * Configuration for this operation.
60 private final BidirectionalTopicConfig config;
65 private final Class<S> responseClass;
67 // fields extracted from "config"
69 private final BidirectionalTopicHandler topicHandler;
70 private final Forwarder forwarder;
74 * Constructs the object.
76 * @param params operation parameters
77 * @param config configuration for this operation
78 * @param clazz response class
80 public BidirectionalTopicOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config,
82 super(params, config);
84 this.responseClass = clazz;
85 this.forwarder = config.getForwarder();
86 this.topicHandler = config.getTopicHandler();
89 public long getTimeoutMs() {
90 return config.getTimeoutMs();
94 * If no timeout is specified, then it returns the default timeout.
97 protected long getTimeoutMs(Integer timeoutSec) {
98 // TODO move this method to the superclass
99 return (timeoutSec == null || timeoutSec == 0 ? getTimeoutMs() : super.getTimeoutMs(timeoutSec));
103 * Publishes the request and arranges to receive the response.
106 protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
108 final Q request = makeRequest(attempt);
109 final List<String> expectedKeyValues = getExpectedKeyValues(attempt, request);
111 final PipelineControllerFuture<OperationOutcome> controller = new PipelineControllerFuture<>();
112 final Executor executor = params.getExecutor();
114 // register a listener BEFORE publishing
116 BiConsumer<String, StandardCoderObject> listener = (rawResponse, scoResponse) -> {
117 OperationOutcome latestOutcome = processResponse(outcome, rawResponse, scoResponse);
118 if (latestOutcome != null) {
119 // final response - complete the controller
120 controller.completeAsync(() -> latestOutcome, executor);
124 forwarder.register(expectedKeyValues, listener);
126 // ensure listener is unregistered if the controller is canceled
127 controller.add(() -> forwarder.unregister(expectedKeyValues, listener));
129 // publish the request
131 publishRequest(request);
132 } catch (RuntimeException e) {
133 logger.warn("{}: failed to publish request for {}", getFullName(), params.getRequestId());
134 forwarder.unregister(expectedKeyValues, listener);
144 * @param attempt operation attempt
145 * @return a new request
147 protected abstract Q makeRequest(int attempt);
150 * Gets values, expected in the response, that should match the selector keys.
152 * @param attempt operation attempt
153 * @param request request to be published
154 * @return a list of the values to be matched by the selector keys
156 protected abstract List<String> getExpectedKeyValues(int attempt, Q request);
159 * Publishes the request. Encodes the request, if it is not already a String.
161 * @param request request to be published
163 protected void publishRequest(Q request) {
166 if (request instanceof String) {
167 json = request.toString();
169 json = makeCoder().encode(request);
171 } catch (CoderException e) {
172 throw new IllegalArgumentException("cannot encode request", e);
175 if (!topicHandler.send(json)) {
176 throw new IllegalStateException("nothing published");
179 logMessage(EventType.OUT, topicHandler.getSinkTopicCommInfrastructure(), topicHandler.getSinkTopic(), request);
183 * Processes a response.
185 * @param infra communication infrastructure on which the response was received
186 * @param outcome outcome to be populated
187 * @param response raw response to process
188 * @param scoResponse response, as a {@link StandardCoderObject}
189 * @return the outcome, or {@code null} if still waiting for completion
191 protected OperationOutcome processResponse(OperationOutcome outcome, String rawResponse,
192 StandardCoderObject scoResponse) {
194 logger.info("{}.{}: response received for {}", params.getActor(), params.getOperation(), params.getRequestId());
196 logMessage(EventType.IN, topicHandler.getSourceTopicCommInfrastructure(), topicHandler.getSourceTopic(),
199 // decode the response
201 if (responseClass == String.class) {
202 response = responseClass.cast(rawResponse);
204 } else if (responseClass == StandardCoderObject.class) {
205 response = responseClass.cast(scoResponse);
209 response = makeCoder().decode(rawResponse, responseClass);
210 } catch (CoderException e) {
211 logger.warn("{}.{} cannot decode response for {}", params.getActor(), params.getOperation(),
212 params.getRequestId());
213 throw new IllegalArgumentException("cannot decode response", e);
218 switch (detmStatus(rawResponse, response)) {
220 logger.info("{}.{} request succeeded for {}", params.getActor(), params.getOperation(),
221 params.getRequestId());
222 setOutcome(outcome, PolicyResult.SUCCESS, response);
223 postProcessResponse(outcome, rawResponse, response);
227 logger.info("{}.{} request failed for {}", params.getActor(), params.getOperation(),
228 params.getRequestId());
229 return setOutcome(outcome, PolicyResult.FAILURE, response);
233 logger.info("{}.{} request incomplete for {}", params.getActor(), params.getOperation(),
234 params.getRequestId());
240 * Sets an operation's outcome and default message based on the result.
242 * @param outcome operation to be updated
243 * @param result result of the operation
244 * @param response response used to populate the outcome
245 * @return the updated operation
247 public OperationOutcome setOutcome(OperationOutcome outcome, PolicyResult result, S response) {
248 return setOutcome(outcome, result);
252 * Processes a successful response.
254 * @param outcome outcome to be populated
255 * @param rawResponse raw response
256 * @param response decoded response
258 protected void postProcessResponse(OperationOutcome outcome, String rawResponse, S response) {
263 * Determines the status of the response.
265 * @param rawResponse raw response
266 * @param response decoded response
267 * @return the status of the response
269 protected abstract Status detmStatus(String rawResponse, S response);