models-interactions/model-actors/actor.aai/src/main/java/org/onap/policy/controlloop/actor/aai/AaiCustomQueryOperation.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   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
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  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=========================================================
  19  */
  20
  21 package org.onap.policy.controlloop.actor.aai;
  22
  23 import java.util.List;
  24 import java.util.Map;
  25 import java.util.Map.Entry;
  26 import java.util.concurrent.CompletableFuture;
  27 import javax.ws.rs.client.Entity;
  28 import javax.ws.rs.client.Invocation.Builder;
  29 import javax.ws.rs.client.WebTarget;
  30 import javax.ws.rs.core.MediaType;
  31 import javax.ws.rs.core.Response;
  32 import org.apache.commons.lang3.StringUtils;
  33 import org.onap.policy.aai.AaiConstants;
  34 import org.onap.policy.aai.AaiCqResponse;
  35 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
  36 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
  37 import org.onap.policy.common.utils.coder.StandardCoderObject;
  38 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  39 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
  40 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
  41 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  42 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
  43 import org.onap.policy.controlloop.policy.PolicyResult;
  44 import org.slf4j.Logger;
  45 import org.slf4j.LoggerFactory;
  46
  47 /**
  48  * A&AI Custom Query. Stores the {@link AaiCqResponse} in the context. In addition, if the
  49  * context does not contain the "tenant" data for the vserver, then it will request that,
  50  * as well. Note: this ignores the "target entity" in the parameters as this query always
  51  * applies to the vserver, thus the target entity may be set to an empty string.
  52  */
  53 public class AaiCustomQueryOperation extends HttpOperation<String> {
  54     private static final Logger logger = LoggerFactory.getLogger(AaiCustomQueryOperation.class);
  55
  56     public static final String NAME = AaiCqResponse.OPERATION;
  57
  58     public static final String VSERVER_VSERVER_NAME = "vserver.vserver-name";
  59     public static final String RESOURCE_LINK = "resource-link";
  60     public static final String RESULT_DATA = "result-data";
  61
  62     private static final List<String> PROPERTY_NAMES = List.of(OperationProperties.AAI_VSERVER_LINK);
  63
  64     // TODO make this configurable
  65     private static final String PREFIX = "/aai/v16";
  66
  67     /**
  68      * Constructs the object.
  69      *
  70      * @param params operation parameters
  71      * @param config configuration for this operation
  72      */
  73     public AaiCustomQueryOperation(ControlLoopOperationParams params, HttpConfig config) {
  74         super(params, config, String.class, PROPERTY_NAMES);
  75     }
  76
  77     /**
  78      * Gets the vserver name from the enrichment data.
  79      *
  80      * @return the vserver name
  81      */
  82     protected String getVserver() {
  83         String vserver = this.params.getContext().getEnrichment().get(VSERVER_VSERVER_NAME);
  84         if (StringUtils.isBlank(vserver)) {
  85             throw new IllegalArgumentException("missing " + VSERVER_VSERVER_NAME + " in enrichment data");
  86         }
  87
  88         return vserver;
  89     }
  90
  91     /**
  92      * Queries the vserver, if necessary.
  93      */
  94     @Override
  95     protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
  96         if (params.isPreprocessed()) {
  97             return null;
  98         }
  99
 100         String vserver = getVserver();
 101         ControlLoopOperationParams tenantParams =
 102                         params.toBuilder().actor(AaiConstants.ACTOR_NAME).operation(AaiGetTenantOperation.NAME)
 103                                         .targetEntity(vserver).payload(null).retry(null).timeoutSec(null).build();
 104
 105         return params.getContext().obtain(AaiGetTenantOperation.getKey(vserver), tenantParams);
 106     }
 107
 108     @Override
 109     public void generateSubRequestId(int attempt) {
 110         setSubRequestId(String.valueOf(attempt));
 111     }
 112
 113     @Override
 114     protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
 115         outcome.setSubRequestId(String.valueOf(attempt));
 116
 117         final Map<String, String> request = makeRequest();
 118         Map<String, Object> headers = makeHeaders();
 119
 120         StringBuilder str = new StringBuilder(getClient().getBaseUrl());
 121
 122         String path = getPath();
 123         WebTarget web = getClient().getWebTarget().path(path);
 124         str.append(path);
 125
 126         web = addQuery(web, str, "?", "format", "resource");
 127
 128         Builder webldr = web.request();
 129         for (Entry<String, Object> header : headers.entrySet()) {
 130             webldr.header(header.getKey(), header.getValue());
 131         }
 132
 133         String url = str.toString();
 134
 135         String strRequest = prettyPrint(request);
 136         logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
 137
 138         Entity<String> entity = Entity.entity(strRequest, MediaType.APPLICATION_JSON);
 139
 140         return handleResponse(outcome, url, callback -> webldr.async().put(entity, callback));
 141     }
 142
 143     private WebTarget addQuery(WebTarget web, StringBuilder str, String separator, String name, String value) {
 144         str.append(separator);
 145         str.append(name);
 146         str.append('=');
 147         str.append(value);
 148
 149         return web.queryParam(name, value);
 150     }
 151
 152     /**
 153      * Constructs the custom query using the previously retrieved tenant data.
 154      */
 155     private Map<String, String> makeRequest() {
 156         return Map.of("start", getVserverLink(), "query", "query/closed-loop");
 157     }
 158
 159     /**
 160      * Gets the vserver link, first checking the properties, and then the tenant data.
 161      *
 162      * @return the vserver link
 163      */
 164     protected String getVserverLink() {
 165         String resourceLink = getProperty(OperationProperties.AAI_VSERVER_LINK);
 166         if (resourceLink != null) {
 167             return resourceLink;
 168         }
 169
 170         String vserver = getVserver();
 171         StandardCoderObject tenant = params.getContext().getProperty(AaiGetTenantOperation.getKey(vserver));
 172         if (tenant == null) {
 173             throw new IllegalStateException("cannot perform custom query - cannot determine resource-link");
 174         }
 175
 176         resourceLink = tenant.getString(RESULT_DATA, 0, RESOURCE_LINK);
 177         if (resourceLink == null) {
 178             throw new IllegalArgumentException("cannot perform custom query - no resource-link");
 179         }
 180
 181         resourceLink = resourceLink.replace(PREFIX, "");
 182         return resourceLink;
 183     }
 184
 185     @Override
 186     protected Map<String, Object> makeHeaders() {
 187         return AaiUtil.makeHeaders(params);
 188     }
 189
 190     @Override
 191     public OperationOutcome setOutcome(OperationOutcome outcome, PolicyResult result, Response rawResponse,
 192                     String response) {
 193
 194         super.setOutcome(outcome, result, rawResponse, response);
 195
 196         if (response != null) {
 197             outcome.setResponse(new AaiCqResponse(response));
 198         }
 199
 200         return outcome;
 201     }
 202
 203     /**
 204      * Injects the response into the context.
 205      */
 206     @Override
 207     protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
 208                     Response rawResponse, String response) {
 209
 210         if (params.getContext() != null) {
 211             logger.info("{}: caching response for {}", getFullName(), params.getRequestId());
 212             params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, new AaiCqResponse(response));
 213         }
 214
 215         return super.postProcessResponse(outcome, url, rawResponse, response);
 216     }
 217 }