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.Map;
  24 import java.util.concurrent.CompletableFuture;
  25 import javax.ws.rs.client.Entity;
  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.aai.AaiCqResponse;
  30 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
  31 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
  32 import org.onap.policy.common.utils.coder.StandardCoderObject;
  33 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  34 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
  35 import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
  36 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39
  40 /**
  41  * A&AI Custom Query. Stores the {@link AaiCqResponse} in the context. In addition, if the
  42  * context does not contain the "tenant" data for the vserver, then it will request that,
  43  * as well.
  44  */
  45 public class AaiCustomQueryOperation extends HttpOperation<String> {
  46     private static final Logger logger = LoggerFactory.getLogger(AaiCustomQueryOperation.class);
  47
  48     public static final String NAME = "CustomQuery";
  49
  50     public static final String RESOURCE_LINK = "resource-link";
  51     public static final String RESULT_DATA = "result-data";
  52
  53     private static final String PREFIX = "/aai/v16";
  54
  55     /**
  56      * Constructs the object.
  57      *
  58      * @param params operation parameters
  59      * @param operator operator that created this operation
  60      */
  61     public AaiCustomQueryOperation(ControlLoopOperationParams params, HttpOperator operator) {
  62         super(params, operator, String.class);
  63     }
  64
  65     /**
  66      * Queries the vserver, if necessary.
  67      */
  68     @Override
  69     protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
  70         String vserver = params.getTargetEntity();
  71
  72         ControlLoopOperationParams tenantParams = params.toBuilder().actor(AaiConstants.ACTOR_NAME)
  73                         .operation(AaiGetOperation.TENANT).payload(null).retry(null).timeoutSec(null).build();
  74
  75         return params.getContext().obtain(AaiGetOperation.getTenantKey(vserver), tenantParams);
  76     }
  77
  78     @Override
  79     protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
  80
  81         Map<String, String> request = makeRequest();
  82
  83         Entity<Map<String, String>> entity = Entity.entity(request, MediaType.APPLICATION_JSON);
  84
  85         Map<String, Object> headers = makeHeaders();
  86
  87         headers.put("Accept", MediaType.APPLICATION_JSON);
  88         String url = makeUrl();
  89
  90         logMessage(EventType.OUT, CommInfrastructure.REST, url, request);
  91
  92         // @formatter:off
  93         return handleResponse(outcome, url,
  94             callback -> operator.getClient().put(callback, makePath(), entity, headers));
  95         // @formatter:on
  96     }
  97
  98     /**
  99      * Constructs the custom query using the previously retrieved tenant data.
 100      */
 101     private Map<String, String> makeRequest() {
 102         String vserver = params.getTargetEntity();
 103         StandardCoderObject tenant = params.getContext().getProperty(AaiGetOperation.getTenantKey(vserver));
 104
 105         String resourceLink = tenant.getString(RESULT_DATA, 0, RESOURCE_LINK);
 106         if (resourceLink == null) {
 107             throw new IllegalArgumentException("cannot perform custom query - no resource-link");
 108         }
 109
 110         resourceLink = resourceLink.replace(PREFIX, "");
 111
 112         return Map.of("start", resourceLink, "query", "query/closed-loop");
 113     }
 114
 115     @Override
 116     protected Map<String, Object> makeHeaders() {
 117         return AaiUtil.makeHeaders(params);
 118     }
 119
 120     /**
 121      * Injects the response into the context.
 122      */
 123     @Override
 124     protected void postProcessResponse(OperationOutcome outcome, String url, Response rawResponse, String response) {
 125
 126         logger.info("{}: caching response for {}", getFullName(), params.getRequestId());
 127         params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, new AaiCqResponse(response));
 128     }
 129 }