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.actor.sdnr;
23 import java.util.List;
24 import java.util.concurrent.CompletableFuture;
25 import org.onap.policy.controlloop.ControlLoopResponse;
26 import org.onap.policy.controlloop.VirtualControlLoopEvent;
27 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
28 import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation;
29 import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
30 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
31 import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey;
32 import org.onap.policy.controlloop.policy.PolicyResult;
33 import org.onap.policy.sdnr.PciBody;
34 import org.onap.policy.sdnr.PciCommonHeader;
35 import org.onap.policy.sdnr.PciMessage;
36 import org.onap.policy.sdnr.PciRequest;
37 import org.onap.policy.sdnr.PciResponse;
38 import org.onap.policy.sdnr.util.StatusCodeEnum;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
42 public class SdnrOperation extends BidirectionalTopicOperation<PciMessage, PciMessage> {
43 private static final Logger logger = LoggerFactory.getLogger(SdnrOperation.class);
46 * Operation name as it should appear within config files.
48 public static final String NAME = "any";
51 * Keys used to match the response with the request listener. The sub request ID is a
52 * UUID, so it can be used to uniquely identify the response.
54 * Note: if these change, then {@link #getExpectedKeyValues(int, PciMessage)} must be
55 * updated accordingly.
57 public static final List<SelectorKey> SELECTOR_KEYS =
58 List.of(new SelectorKey("body", "output", "CommonHeader", "SubRequestID"));
60 public SdnrOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config) {
61 super(params, config, PciMessage.class);
65 * Note: these values must be in correspondence with {@link #SELECTOR_KEYS}.
68 protected List<String> getExpectedKeyValues(int attempt, PciMessage request) {
69 return List.of(getSubRequestId());
73 protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
74 return startGuardAsync();
78 * NOTE: This should avoid throwing exceptions, so that a ControlLoopResponse can be
79 * added to the outcome. Consequently, it returns FAILURE if a required field is
80 * missing from the response.
83 protected Status detmStatus(String rawResponse, PciMessage responseWrapper) {
84 PciResponse response = responseWrapper.getBody().getOutput();
86 if (response.getStatus() == null) {
87 logger.warn("SDNR response is missing the response status");
88 return Status.FAILURE;
91 StatusCodeEnum code = StatusCodeEnum.fromStatusCode(response.getStatus().getCode());
94 logger.warn("unknown SDNR response status code: {}", response.getStatus().getCode());
95 return Status.FAILURE;
100 case PARTIAL_SUCCESS:
101 return Status.SUCCESS;
103 case PARTIAL_FAILURE:
104 return Status.FAILURE;
107 logger.warn("SDNR request was not accepted, code={}", code);
108 return Status.FAILURE;
111 // awaiting a "final" response
112 return Status.STILL_WAITING;
117 * Sets the message to the status description, if available.
120 public OperationOutcome setOutcome(OperationOutcome outcome, PolicyResult result, PciMessage responseWrapper) {
121 if (responseWrapper.getBody() == null || responseWrapper.getBody().getOutput() == null) {
122 outcome.setControlLoopResponse(makeControlLoopResponse(null));
123 return setOutcome(outcome, result);
126 PciResponse response = responseWrapper.getBody().getOutput();
127 if (response.getStatus() == null || response.getStatus().getValue() == null) {
128 outcome.setControlLoopResponse(makeControlLoopResponse(response.getPayload()));
129 return setOutcome(outcome, result);
132 outcome.setResult(result);
133 outcome.setMessage(response.getStatus().getValue());
134 outcome.setControlLoopResponse(makeControlLoopResponse(response.getPayload()));
139 * Converts the SDNR response to a ControlLoopResponse.
141 * @param responsePayload payload from the response
143 * @return a new ControlLoopResponse
145 private ControlLoopResponse makeControlLoopResponse(String responsePayload) {
146 VirtualControlLoopEvent event = params.getContext().getEvent();
148 ControlLoopResponse clRsp = new ControlLoopResponse();
149 clRsp.setPayload(responsePayload);
150 clRsp.setFrom(params.getActor());
151 clRsp.setTarget("DCAE");
152 clRsp.setClosedLoopControlName(event.getClosedLoopControlName());
153 clRsp.setPolicyName(event.getPolicyName());
154 clRsp.setPolicyVersion(event.getPolicyVersion());
155 clRsp.setRequestId(event.getRequestId());
156 clRsp.setVersion(event.getVersion());
162 protected PciMessage makeRequest(int attempt) {
163 VirtualControlLoopEvent onset = params.getContext().getEvent();
164 String subRequestId = getSubRequestId();
166 /* Construct an SDNR request using pci Model */
168 PciMessage dmaapRequest = new PciMessage();
169 dmaapRequest.setVersion("1.0");
170 dmaapRequest.setCorrelationId(onset.getRequestId() + "-" + subRequestId);
171 dmaapRequest.setType("request");
172 dmaapRequest.setRpcName(params.getOperation().toLowerCase());
174 /* This is the actual request that is placed in the dmaap wrapper. */
175 final PciRequest sdnrRequest = new PciRequest();
177 /* The common header is a required field for all SDNR requests. */
178 PciCommonHeader requestCommonHeader = new PciCommonHeader();
179 requestCommonHeader.setRequestId(onset.getRequestId());
180 requestCommonHeader.setSubRequestId(subRequestId);
182 sdnrRequest.setCommonHeader(requestCommonHeader);
183 sdnrRequest.setPayload(onset.getPayload());
184 sdnrRequest.setAction(params.getOperation());
187 * Once the pci request is constructed, add it into the body of the dmaap wrapper.
189 PciBody body = new PciBody();
190 body.setInput(sdnrRequest);
191 dmaapRequest.setBody(body);
193 /* Return the request to be sent through dmaap. */