* ============LICENSE_START=======================================================
* ONAP
* ================================================================================
- * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2023 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
package org.onap.policy.controlloop.actor.aai;
+import jakarta.ws.rs.client.Entity;
+import jakarta.ws.rs.client.Invocation.Builder;
+import jakarta.ws.rs.client.WebTarget;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import java.util.List;
import java.util.Map;
+import java.util.Map.Entry;
import java.util.concurrent.CompletableFuture;
-import javax.ws.rs.client.Entity;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
-import org.onap.policy.aai.AaiConstants;
import org.onap.policy.aai.AaiCqResponse;
-import org.onap.policy.common.utils.coder.StandardCoderObject;
+import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
+import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
+import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
+import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
-import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
/**
* A&AI Custom Query. Stores the {@link AaiCqResponse} in the context. In addition, if the
* context does not contain the "tenant" data for the vserver, then it will request that,
- * as well.
+ * as well. Note: this ignores the "target entity" in the parameters as this query always
+ * applies to the vserver, thus the target entity may be set to an empty string.
*/
public class AaiCustomQueryOperation extends HttpOperation<String> {
- private static final Logger logger = LoggerFactory.getLogger(AaiCustomQueryOperation.class);
-
- public static final String NAME = "CustomQuery";
+ public static final String NAME = AaiCqResponse.OPERATION;
+ public static final String VSERVER_VSERVER_NAME = "vserver.vserver-name";
public static final String RESOURCE_LINK = "resource-link";
public static final String RESULT_DATA = "result-data";
- private static final String PREFIX = "/aai/v16";
+ private static final List<String> PROPERTY_NAMES = List.of(OperationProperties.AAI_VSERVER_LINK);
/**
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public AaiCustomQueryOperation(ControlLoopOperationParams params, HttpOperator operator) {
- super(params, operator, String.class);
+ public AaiCustomQueryOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config, String.class, PROPERTY_NAMES);
}
- /**
- * Queries the vserver, if necessary.
- */
@Override
- protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
- String vserver = params.getTargetEntity();
-
- ControlLoopOperationParams tenantParams = params.toBuilder().actor(AaiConstants.ACTOR_NAME)
- .operation(AaiGetOperation.TENANT).payload(null).retry(null).timeoutSec(null).build();
-
- return params.getContext().obtain(AaiGetOperation.getTenantKey(vserver), tenantParams);
+ public void generateSubRequestId(int attempt) {
+ setSubRequestId(String.valueOf(attempt));
}
@Override
protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
+ outcome.setSubRequestId(String.valueOf(attempt));
- Map<String, String> request = makeRequest();
+ final Map<String, String> request = makeRequest();
+ Map<String, Object> headers = makeHeaders();
- Entity<Map<String, String>> entity = Entity.entity(request, MediaType.APPLICATION_JSON);
+ var str = new StringBuilder(getClient().getBaseUrl());
- Map<String, Object> headers = makeHeaders();
+ String path = getPath();
+ WebTarget web = getClient().getWebTarget().path(path);
+ str.append(path);
+
+ web = addQuery(web, str, "?", "format", "resource");
+
+ Builder webldr = web.request();
+ for (Entry<String, Object> header : headers.entrySet()) {
+ webldr.header(header.getKey(), header.getValue());
+ }
+
+ var url = str.toString();
+
+ String strRequest = prettyPrint(request);
+ logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
+
+ Entity<String> entity = Entity.entity(strRequest, MediaType.APPLICATION_JSON);
- headers.put("Accept", MediaType.APPLICATION_JSON);
- String url = makeUrl();
+ return handleResponse(outcome, url, callback -> webldr.async().put(entity, callback));
+ }
- logRestRequest(url, request);
+ private WebTarget addQuery(WebTarget web, StringBuilder str, String separator, String name, String value) {
+ str.append(separator);
+ str.append(name);
+ str.append('=');
+ str.append(value);
- // @formatter:off
- return handleResponse(outcome, url,
- callback -> operator.getClient().put(callback, makePath(), entity, headers));
- // @formatter:on
+ return web.queryParam(name, value);
}
/**
* Constructs the custom query using the previously retrieved tenant data.
*/
private Map<String, String> makeRequest() {
- String vserver = params.getTargetEntity();
- StandardCoderObject tenant = params.getContext().getProperty(AaiGetOperation.getTenantKey(vserver));
-
- String resourceLink = tenant.getString(RESULT_DATA, 0, RESOURCE_LINK);
- if (resourceLink == null) {
- throw new IllegalArgumentException("cannot perform custom query - no resource-link");
- }
-
- resourceLink = resourceLink.replace(PREFIX, "");
+ return Map.of("start", getVserverLink(), "query", "query/closed-loop");
+ }
- return Map.of("start", resourceLink, "query", "query/closed-loop");
+ /**
+ * Gets the vserver link, first checking the properties, and then the tenant data.
+ *
+ * @return the vserver link
+ */
+ protected String getVserverLink() {
+ return getRequiredProperty(OperationProperties.AAI_VSERVER_LINK, "vserver link");
}
@Override
return AaiUtil.makeHeaders(params);
}
- /**
- * Injects the response into the context.
- */
@Override
- protected void postProcessResponse(OperationOutcome outcome, String url, Response rawResponse, String response) {
+ public OperationOutcome setOutcome(OperationOutcome outcome, OperationResult result, Response rawResponse,
+ String response) {
+
+ super.setOutcome(outcome, result, rawResponse, response);
+
+ if (response != null) {
+ outcome.setResponse(new AaiCqResponse(response));
+ }
- logger.info("{}: caching response for {}", getFullName(), params.getRequestId());
- params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, new AaiCqResponse(response));
+ return outcome;
}
}