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.aai;
23 import java.util.Collections;
25 import java.util.Map.Entry;
26 import java.util.concurrent.CompletableFuture;
27 import javax.ws.rs.client.Invocation.Builder;
28 import javax.ws.rs.client.WebTarget;
29 import javax.ws.rs.core.Response;
30 import org.onap.policy.common.utils.coder.StandardCoderObject;
31 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
32 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
33 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
34 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
35 import org.slf4j.Logger;
36 import org.slf4j.LoggerFactory;
39 * Superclass of A&AI operators that use "get" to perform their request and store their
40 * response within the context as a {@link StandardCoderObject}. The property name under
41 * which they are stored is ${actor}.${operation}.${targetEntity}.
43 public class AaiGetOperation extends HttpOperation<StandardCoderObject> {
44 private static final Logger logger = LoggerFactory.getLogger(AaiGetOperation.class);
46 public static final int DEFAULT_RETRY = 3;
50 * Responses that are retrieved from A&AI are placed in the operation context under
51 * the name "${propertyPrefix}.${targetEntity}".
53 private final String propertyPrefix;
56 * Constructs the object.
58 * @param params operation parameters
59 * @param config configuration for this operation
61 public AaiGetOperation(ControlLoopOperationParams params, HttpConfig config) {
62 super(params, config, StandardCoderObject.class, Collections.emptyList());
63 this.propertyPrefix = getFullName() + ".";
67 public void generateSubRequestId(int attempt) {
68 setSubRequestId(String.valueOf(attempt));
72 * Adds a query parameter to a web target.
74 * @param web target to which the parameter should be added
75 * @param str the separator and parameter are appended here, for logging purposes
76 * @param separator separator to be added to "str"; that's its only use
77 * @param name parameter name
78 * @param value parameter value
81 protected WebTarget addQuery(WebTarget web, StringBuilder str, String separator, String name, String value) {
82 str.append(separator);
87 return web.queryParam(name, value);
91 * Adds headers to the web builder.
93 * @param webldr builder to which the headers should be added
94 * @param headers headers to be added
96 protected void addHeaders(Builder webldr, Map<String, Object> headers) {
97 for (Entry<String, Object> header : headers.entrySet()) {
98 webldr.header(header.getKey(), header.getValue());
103 protected Map<String, Object> makeHeaders() {
104 return AaiUtil.makeHeaders(params);
108 * Injects the response into the context.
111 protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
112 Response rawResponse, StandardCoderObject response) {
113 String entity = params.getTargetEntity();
115 if (params.getContext() != null) {
116 logger.info("{}: caching response of {} for {}", getFullName(), entity, params.getRequestId());
117 params.getContext().setProperty(propertyPrefix + entity, response);
120 return super.postProcessResponse(outcome, url, rawResponse, response);
124 * Provides a default retry value, if none specified.
127 protected int getRetry(Integer retry) {
128 return (retry == null ? DEFAULT_RETRY : retry);