* ONAP
* ================================================================================
* Copyright (C) 2020 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.Invocation.Builder;
+import jakarta.ws.rs.client.WebTarget;
+import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
-import java.util.Set;
-import java.util.concurrent.CompletableFuture;
-import javax.ws.rs.client.Invocation.Builder;
-import javax.ws.rs.client.WebTarget;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
-import org.onap.policy.aai.AaiConstants;
-import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
-import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.common.utils.coder.StandardCoderObject;
-import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
+import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
/**
* Superclass of A&AI operators that use "get" to perform their request and store their
* which they are stored is ${actor}.${operation}.${targetEntity}.
*/
public class AaiGetOperation extends HttpOperation<StandardCoderObject> {
- private static final Logger logger = LoggerFactory.getLogger(AaiGetOperation.class);
-
public static final int DEFAULT_RETRY = 3;
- // operation names
- public static final String TENANT = "Tenant";
-
- // property prefixes
- private static final String TENANT_KEY_PREFIX = AaiConstants.CONTEXT_PREFIX + TENANT + ".";
-
- /**
- * Operation names supported by this operator.
- */
- public static final Set<String> OPERATIONS = Set.of(TENANT);
-
-
- /**
- * Responses that are retrieved from A&AI are placed in the operation context under
- * the name "${propertyPrefix}.${targetEntity}".
- */
- private final String propertyPrefix;
+ private static final List<String> PROPERTY_NAMES = List.of(OperationProperties.AAI_TARGET_ENTITY);
/**
* Constructs the object.
* @param config configuration for this operation
*/
public AaiGetOperation(ControlLoopOperationParams params, HttpConfig config) {
- super(params, config, StandardCoderObject.class);
- this.propertyPrefix = getFullName() + ".";
- }
-
- /**
- * Gets the "context key" for the tenant query response associated with the given
- * target entity.
- *
- * @param targetEntity target entity
- * @return the "context key" for the response associated with the given target
- */
- public static String getTenantKey(String targetEntity) {
- return (TENANT_KEY_PREFIX + targetEntity);
+ super(params, config, StandardCoderObject.class, PROPERTY_NAMES);
}
@Override
- protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
- outcome.setSubRequestId(String.valueOf(attempt));
-
- Map<String, Object> headers = makeHeaders();
-
- headers.put("Accept", MediaType.APPLICATION_JSON);
-
- StringBuilder str = new StringBuilder(getClient().getBaseUrl());
-
- String path = getPath();
- WebTarget web = getClient().getWebTarget().path(path);
- str.append(path);
-
- web = addQuery(web, str, "?", "search-node-type", "vserver");
- web = addQuery(web, str, "&", "filter", "vserver-name:EQUALS:" + params.getTargetEntity());
-
- Builder webldr = web.request();
- for (Entry<String, Object> header : headers.entrySet()) {
- webldr.header(header.getKey(), header.getValue());
- }
-
- String url = str.toString();
-
- logMessage(EventType.OUT, CommInfrastructure.REST, url, null);
-
- return handleResponse(outcome, url, callback -> webldr.async().get(callback));
+ public void generateSubRequestId(int attempt) {
+ setSubRequestId(String.valueOf(attempt));
}
- private WebTarget addQuery(WebTarget web, StringBuilder str, String separator, String name, String value) {
+ /**
+ * Adds a query parameter to a web target.
+ *
+ * @param web target to which the parameter should be added
+ * @param str the separator and parameter are appended here, for logging purposes
+ * @param separator separator to be added to "str"; that's its only use
+ * @param name parameter name
+ * @param value parameter value
+ * @return "web"
+ */
+ protected WebTarget addQuery(WebTarget web, StringBuilder str, String separator, String name, String value) {
str.append(separator);
str.append(name);
str.append('=');
return web.queryParam(name, value);
}
- @Override
- protected Map<String, Object> makeHeaders() {
- return AaiUtil.makeHeaders(params);
- }
-
/**
- * Injects the response into the context.
+ * Adds headers to the web builder.
+ *
+ * @param webldr builder to which the headers should be added
+ * @param headers headers to be added
*/
- @Override
- protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
- Response rawResponse, StandardCoderObject response) {
- String entity = params.getTargetEntity();
-
- logger.info("{}: caching response of {} for {}", getFullName(), entity, params.getRequestId());
-
- params.getContext().setProperty(propertyPrefix + entity, response);
+ protected void addHeaders(Builder webldr, Map<String, Object> headers) {
+ for (Entry<String, Object> header : headers.entrySet()) {
+ webldr.header(header.getKey(), header.getValue());
+ }
+ }
- return super.postProcessResponse(outcome, url, rawResponse, response);
+ @Override
+ protected Map<String, Object> makeHeaders() {
+ return AaiUtil.makeHeaders(params);
}
/**