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;
25 import java.util.concurrent.CompletableFuture;
26 import javax.ws.rs.core.MediaType;
27 import javax.ws.rs.core.Response;
28 import org.onap.policy.aai.AaiConstants;
29 import org.onap.policy.common.utils.coder.StandardCoderObject;
30 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
31 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
32 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
33 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
38 * Superclass of A&AI operators that use "get" to perform their request and store their
39 * response within the context as a {@link StandardCoderObject}. The property name under
40 * which they are stored is ${actor}.${operation}.${targetEntity}.
42 public class AaiGetOperation extends HttpOperation<StandardCoderObject> {
43 private static final Logger logger = LoggerFactory.getLogger(AaiGetOperation.class);
45 public static final int DEFAULT_RETRY = 3;
48 public static final String TENANT = "Tenant";
51 private static final String TENANT_KEY_PREFIX = AaiConstants.CONTEXT_PREFIX + TENANT + ".";
54 * Operation names supported by this operator.
56 public static final Set<String> OPERATIONS = Set.of(TENANT);
60 * Responses that are retrieved from A&AI are placed in the operation context under
61 * the name "${propertyPrefix}.${targetEntity}".
63 private final String propertyPrefix;
66 * Constructs the object.
68 * @param params operation parameters
69 * @param operator operator that created this operation
71 public AaiGetOperation(ControlLoopOperationParams params, HttpOperator operator) {
72 super(params, operator, StandardCoderObject.class);
73 this.propertyPrefix = operator.getFullName() + ".";
77 * Gets the "context key" for the tenant query response associated with the given
80 * @param targetEntity target entity
81 * @return the "context key" for the response associated with the given target
83 public static String getTenantKey(String targetEntity) {
84 return (TENANT_KEY_PREFIX + targetEntity);
88 protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
90 Map<String, Object> headers = makeHeaders();
92 headers.put("Accept", MediaType.APPLICATION_JSON);
93 String url = makeUrl();
95 logRestRequest(url, null);
98 return handleResponse(outcome, url,
99 callback -> operator.getClient().get(callback, makePath(), headers));
104 protected Map<String, Object> makeHeaders() {
105 return AaiUtil.makeHeaders(params);
109 public String makePath() {
110 return (operator.getPath() + "/" + params.getTargetEntity());
114 * Injects the response into the context.
117 protected void postProcessResponse(OperationOutcome outcome, String url, Response rawResponse,
118 StandardCoderObject response) {
119 String entity = params.getTargetEntity();
121 logger.info("{}: caching response of {} for {}", getFullName(), entity, params.getRequestId());
123 params.getContext().setProperty(propertyPrefix + entity, response);
127 * Provides a default retry value, if none specified.
130 protected int getRetry(Integer retry) {
131 return (retry == null ? DEFAULT_RETRY : retry);