* ============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) 2020 Wipro Limited.
+ * 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.so;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import jakarta.ws.rs.core.MediaType;
+import jakarta.ws.rs.core.Response;
+import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.TimeUnit;
-import java.util.function.Function;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
-import lombok.Getter;
import org.onap.aai.domain.yang.CloudRegion;
import org.onap.aai.domain.yang.GenericVnf;
+import org.onap.aai.domain.yang.ModelVer;
import org.onap.aai.domain.yang.ServiceInstance;
import org.onap.aai.domain.yang.Tenant;
-import org.onap.policy.aai.AaiConstants;
-import org.onap.policy.aai.AaiCqResponse;
-import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
-import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
+import org.onap.policy.common.gson.GsonMessageBodyHandler;
import org.onap.policy.common.utils.coder.Coder;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
+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.OperationResult;
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.onap.policy.controlloop.policy.PolicyResult;
-import org.onap.policy.controlloop.policy.Target;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig;
import org.onap.policy.so.SoCloudConfiguration;
import org.onap.policy.so.SoModelInfo;
import org.onap.policy.so.SoRequest;
import org.onap.policy.so.SoRequestParameters;
import org.onap.policy.so.SoRequestStatus;
import org.onap.policy.so.SoResponse;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
+import org.onap.policy.so.util.SoLocalDateTimeTypeAdapter;
/**
- * Superclass for SDNC Operators. Note: subclasses should invoke {@link #resetGetCount()}
+ * Superclass for SDNC Operators. Note: subclasses should invoke {@link #resetPollCount()}
* each time they issue an HTTP request.
*/
public abstract class SoOperation extends HttpOperation<SoResponse> {
- private static final Logger logger = LoggerFactory.getLogger(SoOperation.class);
- private static final Coder coder = new StandardCoder();
+ private static final Coder coder = new SoCoder();
- public static final String PAYLOAD_KEY_VF_COUNT = "vfCount";
public static final String FAILED = "FAILED";
public static final String COMPLETE = "COMPLETE";
public static final int SO_RESPONSE_CODE = 999;
public static final String REQ_PARAM_NM = "requestParameters";
public static final String CONFIG_PARAM_NM = "configurationParameters";
- private final SoConfig config;
-
- // values extracted from the parameter Target
+ /* Values extracted from the parameter Target. These fields are required by any
+ subclasses that make use of prepareSoModelInfo().
+ */
private final String modelCustomizationId;
private final String modelInvariantId;
private final String modelVersionId;
+ private final String modelName;
+ private final String modelVersion;
- private final String vfCountKey;
-
- /**
- * Number of "get" requests issued so far, on the current operation attempt.
- */
- @Getter
- private int getCount;
/**
*
* @param params operation parameters
* @param config configuration for this operation
+ * @param propertyNames names of properties required by this operation
*/
- public SoOperation(ControlLoopOperationParams params, HttpConfig config) {
- super(params, config, SoResponse.class);
- this.config = (SoConfig) config;
-
- verifyNotNull("Target information", params.getTarget());
+ protected SoOperation(ControlLoopOperationParams params, HttpPollingConfig config, List<String> propertyNames) {
+ super(params, config, SoResponse.class, propertyNames);
- this.modelCustomizationId = params.getTarget().getModelCustomizationId();
- this.modelInvariantId = params.getTarget().getModelInvariantId();
- this.modelVersionId = params.getTarget().getModelVersionId();
+ this.modelCustomizationId = null;
+ this.modelInvariantId = null;
+ this.modelVersionId = null;
+ this.modelVersion = null;
+ this.modelName = null;
- vfCountKey = SoConstants.VF_COUNT_PREFIX + "[" + modelCustomizationId + "][" + modelInvariantId + "]["
- + modelVersionId + "]";
+ verifyNotNull("Target information", params.getTargetType());
}
/**
- * Subclasses should invoke this before issuing their first HTTP request.
- */
- protected void resetGetCount() {
- getCount = 0;
- }
-
- /**
- * Validates that the parameters contain the required target information to extract
- * the VF count from the custom query.
+ * Constructs the object.
+ *
+ * @param params operation parameters
+ * @param config configuration for this operation
+ * @param propertyNames names of properties required by this operation
+ * @param targetEntityIds Target Entity information
*/
- protected void validateTarget() {
- verifyNotNull("modelCustomizationId", modelCustomizationId);
- verifyNotNull("modelInvariantId", modelInvariantId);
- verifyNotNull("modelVersionId", modelVersionId);
+ protected SoOperation(ControlLoopOperationParams params, HttpPollingConfig config, List<String> propertyNames,
+ Map<String, String> targetEntityIds) {
+ super(params, config, SoResponse.class, propertyNames);
+
+ verifyNotNull("Target entity Ids information", targetEntityIds);
+
+ this.modelCustomizationId = targetEntityIds
+ .get(ControlLoopOperationParams.PARAMS_ENTITY_MODEL_CUSTOMIZATION_ID);
+ this.modelInvariantId = targetEntityIds
+ .get(ControlLoopOperationParams.PARAMS_ENTITY_MODEL_INVARIANT_ID);
+ this.modelVersionId = targetEntityIds
+ .get(ControlLoopOperationParams.PARAMS_ENTITY_MODEL_VERSION_ID);
+ this.modelVersion = targetEntityIds
+ .get(ControlLoopOperationParams.PARAMS_ENTITY_MODEL_VERSION);
+ this.modelName = targetEntityIds
+ .get(ControlLoopOperationParams.PARAMS_ENTITY_MODEL_NAME);
+
+ verifyNotNull("Target information", params.getTargetType());
}
- private void verifyNotNull(String type, Object value) {
- if (value == null) {
- throw new IllegalArgumentException("missing " + type + " for guard payload");
- }
- }
-
- /**
- * Starts the GUARD.
- */
@Override
- protected CompletableFuture<OperationOutcome> startPreprocessorAsync() {
- return startGuardAsync();
+ protected void resetPollCount() {
+ super.resetPollCount();
+ setSubRequestId(null);
}
/**
- * Gets the VF Count.
- *
- * @return a future to cancel or await the VF Count
+ * Validates that the parameters contain the required target information to construct
+ * the request.
*/
- @SuppressWarnings("unchecked")
- protected CompletableFuture<OperationOutcome> obtainVfCount() {
- if (params.getContext().contains(vfCountKey)) {
- // already have the VF count
- return null;
- }
-
- // need custom query from which to extract the VF count
- ControlLoopOperationParams cqParams = params.toBuilder().actor(AaiConstants.ACTOR_NAME)
- .operation(AaiCqResponse.OPERATION).payload(null).retry(null).timeoutSec(null).build();
-
- // run Custom Query and then extract the VF count
- return sequence(() -> params.getContext().obtain(AaiCqResponse.CONTEXT_KEY, cqParams), this::storeVfCount);
+ protected void validateTarget() {
+ verifyNotNull(ControlLoopOperationParams.PARAMS_ENTITY_MODEL_CUSTOMIZATION_ID, modelCustomizationId);
+ verifyNotNull(ControlLoopOperationParams.PARAMS_ENTITY_MODEL_INVARIANT_ID, modelInvariantId);
+ verifyNotNull(ControlLoopOperationParams.PARAMS_ENTITY_MODEL_VERSION_ID, modelVersionId);
}
- /**
- * Stores the VF count.
- *
- * @return {@code null}
- */
- private CompletableFuture<OperationOutcome> storeVfCount() {
- if (!params.getContext().contains(vfCountKey)) {
- AaiCqResponse cq = params.getContext().getProperty(AaiCqResponse.CONTEXT_KEY);
- int vfcount = cq.getVfModuleCount(modelCustomizationId, modelInvariantId, modelVersionId);
-
- params.getContext().setProperty(vfCountKey, vfcount);
+ private void verifyNotNull(String type, Object value) {
+ if (value == null) {
+ throw new IllegalArgumentException("missing Target." + type);
}
-
- return null;
}
protected int getVfCount() {
- return params.getContext().getProperty(vfCountKey);
+ return getRequiredProperty(OperationProperties.DATA_VF_COUNT, "VF Count");
}
protected void setVfCount(int vfCount) {
- params.getContext().setProperty(vfCountKey, vfCount);
+ setProperty(OperationProperties.DATA_VF_COUNT, vfCount);
}
- /**
- * If the response does not indicate that the request has been completed, then sleep a
- * bit and issue a "get".
- */
@Override
- protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
- Response rawResponse, SoResponse response) {
-
- // see if the request has "completed", whether or not it was successful
+ protected Status detmStatus(Response rawResponse, SoResponse response) {
if (rawResponse.getStatus() == 200) {
String requestState = getRequestState(response);
if (COMPLETE.equalsIgnoreCase(requestState)) {
extractSubRequestId(response);
- successfulCompletion();
- return CompletableFuture
- .completedFuture(setOutcome(outcome, PolicyResult.SUCCESS, rawResponse, response));
+ return Status.SUCCESS;
}
if (FAILED.equalsIgnoreCase(requestState)) {
extractSubRequestId(response);
- return CompletableFuture
- .completedFuture(setOutcome(outcome, PolicyResult.FAILURE, rawResponse, response));
+ return Status.FAILURE;
}
}
// still incomplete
// need a request ID with which to query
- if (!extractSubRequestId(response)) {
+ if (getSubRequestId() == null && !extractSubRequestId(response)) {
throw new IllegalArgumentException("missing request ID in response");
}
- // see if the limit for the number of "gets" has been reached
- if (getCount++ >= getMaxGets()) {
- logger.warn("{}: execeeded 'get' limit {} for {}", getFullName(), getMaxGets(), params.getRequestId());
- setOutcome(outcome, PolicyResult.FAILURE_TIMEOUT);
- outcome.setMessage(SO_RESPONSE_CODE + " " + outcome.getMessage());
- return CompletableFuture.completedFuture(outcome);
- }
+ return Status.STILL_WAITING;
+ }
- // sleep and then perform a "get" operation
- Function<Void, CompletableFuture<OperationOutcome>> doGet = unused -> issueGet(outcome, response);
- return sleep(getWaitMsGet(), TimeUnit.MILLISECONDS).thenComposeAsync(doGet);
+ @Override
+ protected String getPollingPath() {
+ return super.getPollingPath() + getSubRequestId();
}
@Override
return true;
}
- /**
- * Invoked when a request completes successfully.
- */
- protected void successfulCompletion() {
- // do nothing
- }
-
- /**
- * Issues a "get" request to see if the original request is complete yet.
- *
- * @param outcome outcome to be populated with the response
- * @param response previous response
- * @return a future that can be used to cancel the "get" request or await its response
- */
- private CompletableFuture<OperationOutcome> issueGet(OperationOutcome outcome, SoResponse response) {
- String path = getPathGet() + response.getRequestReferences().getRequestId();
- String url = getClient().getBaseUrl() + path;
-
- logger.debug("{}: 'get' count {} for {}", getFullName(), getCount, params.getRequestId());
-
- logMessage(EventType.OUT, CommInfrastructure.REST, url, null);
-
- // TODO should this use "path" or the full "url"?
- return handleResponse(outcome, url, callback -> getClient().get(callback, path, null));
- }
-
/**
* Gets the request state of a response.
*
* Prepends the message with the http status code.
*/
@Override
- public OperationOutcome setOutcome(OperationOutcome outcome, PolicyResult result, Response rawResponse,
+ public OperationOutcome setOutcome(OperationOutcome outcome, OperationResult result, Response rawResponse,
SoResponse response) {
// set default result and message
setOutcome(outcome, result);
- outcome.setMessage(rawResponse.getStatus() + " " + outcome.getMessage());
+ int code = (result == OperationResult.FAILURE_TIMEOUT ? SO_RESPONSE_CODE : rawResponse.getStatus());
+
+ outcome.setResponse(response);
+ outcome.setMessage(code + " " + outcome.getMessage());
return outcome;
}
protected SoModelInfo prepareSoModelInfo() {
- Target target = params.getTarget();
- if (target == null) {
- throw new IllegalArgumentException("missing Target");
- }
-
- if (target.getModelCustomizationId() == null || target.getModelInvariantId() == null
- || target.getModelName() == null || target.getModelVersion() == null
- || target.getModelVersionId() == null) {
- throw new IllegalArgumentException("missing VF Module model");
- }
-
- SoModelInfo soModelInfo = new SoModelInfo();
- soModelInfo.setModelCustomizationId(target.getModelCustomizationId());
- soModelInfo.setModelInvariantId(target.getModelInvariantId());
- soModelInfo.setModelName(target.getModelName());
- soModelInfo.setModelVersion(target.getModelVersion());
- soModelInfo.setModelVersionId(target.getModelVersionId());
+ var soModelInfo = new SoModelInfo();
+ soModelInfo.setModelCustomizationId(modelCustomizationId);
+ soModelInfo.setModelInvariantId(modelInvariantId);
+ soModelInfo.setModelName(modelName);
+ soModelInfo.setModelVersion(modelVersion);
+ soModelInfo.setModelVersionId(modelVersionId);
soModelInfo.setModelType("vfModule");
return soModelInfo;
}
* @return SO request information
*/
protected SoRequestInfo constructRequestInfo() {
- SoRequestInfo soRequestInfo = new SoRequestInfo();
+ var soRequestInfo = new SoRequestInfo();
soRequestInfo.setSource("POLICY");
soRequestInfo.setSuppressRollback(false);
soRequestInfo.setRequestorId("policy");
}
/**
- * Construct cloudConfiguration for the SO requestDetails. Overridden for custom
- * query.
+ * Construct cloudConfiguration for the SO requestDetails.
*
* @param tenantItem tenant item from A&AI named-query response
* @return SO cloud configuration
*/
- protected SoCloudConfiguration constructCloudConfigurationCq(Tenant tenantItem, CloudRegion cloudRegionItem) {
- SoCloudConfiguration cloudConfiguration = new SoCloudConfiguration();
- cloudConfiguration.setTenantId(tenantItem.getTenantId());
- cloudConfiguration.setLcpCloudRegionId(cloudRegionItem.getCloudRegionId());
+ protected SoCloudConfiguration constructCloudConfiguration(Tenant tenantItem, CloudRegion cloudRegionItem) {
+ var cloudConfiguration = new SoCloudConfiguration();
+ cloudConfiguration.setTenantId(getRequiredText("tenant ID", tenantItem.getTenantId()));
+ cloudConfiguration.setLcpCloudRegionId(getRequiredText("cloud region ID", cloudRegionItem.getCloudRegionId()));
return cloudConfiguration;
}
+ /**
+ * Verifies that a value is not {@code null}.
+ *
+ * @param name value name
+ * @param value value to check
+ * @return the value
+ */
+ protected String getRequiredText(String name, String value) {
+ if (value == null) {
+ throw new IllegalArgumentException("missing " + name);
+ }
+
+ return value;
+ }
+
/**
* Create simple HTTP headers for unauthenticated requests to SO.
*
* IllegalArgumentException if the desired data item is not found.
*/
- protected GenericVnf getVnfItem(AaiCqResponse aaiCqResponse, SoModelInfo soModelInfo) {
- GenericVnf vnf = aaiCqResponse.getGenericVnfByVfModuleModelInvariantId(soModelInfo.getModelInvariantId());
- if (vnf == null) {
- throw new IllegalArgumentException("missing generic VNF");
- }
-
- return vnf;
+ protected GenericVnf getVnfItem() {
+ return getRequiredProperty(OperationProperties.AAI_VNF, "generic VNF");
}
- protected ServiceInstance getServiceInstance(AaiCqResponse aaiCqResponse) {
- ServiceInstance vnfService = aaiCqResponse.getServiceInstance();
- if (vnfService == null) {
- throw new IllegalArgumentException("missing VNF Service Item");
- }
-
- return vnfService;
+ protected ServiceInstance getServiceInstance() {
+ return getRequiredProperty(OperationProperties.AAI_SERVICE, "VNF Service Item");
}
- protected Tenant getDefaultTenant(AaiCqResponse aaiCqResponse) {
- Tenant tenant = aaiCqResponse.getDefaultTenant();
- if (tenant == null) {
- throw new IllegalArgumentException("missing Tenant Item");
- }
+ protected Tenant getDefaultTenant() {
+ return getRequiredProperty(OperationProperties.AAI_DEFAULT_TENANT, "Default Tenant Item");
+ }
- return tenant;
+ protected CloudRegion getDefaultCloudRegion() {
+ return getRequiredProperty(OperationProperties.AAI_DEFAULT_CLOUD_REGION, "Default Cloud Region");
}
- protected CloudRegion getDefaultCloudRegion(AaiCqResponse aaiCqResponse) {
- CloudRegion cloudRegion = aaiCqResponse.getDefaultCloudRegion();
- if (cloudRegion == null) {
- throw new IllegalArgumentException("missing Cloud Region");
- }
+ protected ModelVer getVnfModel() {
+ return getRequiredProperty(OperationProperties.AAI_VNF_MODEL, "generic VNF Model");
+ }
- return cloudRegion;
+ protected ModelVer getServiceModel() {
+ return getRequiredProperty(OperationProperties.AAI_SERVICE_MODEL, "Service Model");
}
// these may be overridden by junit tests
- /**
- * Gets the wait time, in milliseconds, between "get" requests.
- *
- * @return the wait time, in milliseconds, between "get" requests
- */
- public long getWaitMsGet() {
- return TimeUnit.MILLISECONDS.convert(getWaitSecGet(), TimeUnit.SECONDS);
+ @Override
+ protected Coder getCoder() {
+ return coder;
}
- public int getMaxGets() {
- return config.getMaxGets();
- }
+ private static class SoCoder extends StandardCoder {
- public String getPathGet() {
- return config.getPathGet();
- }
+ /**
+ * Gson object used to encode and decode messages.
+ */
+ private static final Gson SO_GSON;
- public int getWaitSecGet() {
- return config.getWaitSecGet();
+ /**
+ * Gson object used to encode messages in "pretty" format.
+ */
+ private static final Gson SO_GSON_PRETTY;
+
+ static {
+ GsonBuilder builder = GsonMessageBodyHandler
+ .configBuilder(new GsonBuilder().registerTypeAdapter(StandardCoderObject.class,
+ new StandardTypeAdapter()))
+ .registerTypeAdapter(LocalDateTime.class, new SoLocalDateTimeTypeAdapter());
+
+ SO_GSON = builder.create();
+ SO_GSON_PRETTY = builder.setPrettyPrinting().create();
+ }
+
+ public SoCoder() {
+ super(SO_GSON, SO_GSON_PRETTY);
+ }
}
}
Code Review / policy / models.git / blobdiff