package org.onap.policy.controlloop.actor.so;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+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.impl.HttpOperation;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.onap.policy.controlloop.policy.Target;
+import org.onap.policy.so.SoCloudConfiguration;
import org.onap.policy.so.SoModelInfo;
import org.onap.policy.so.SoRequest;
import org.onap.policy.so.SoRequestInfo;
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
+ private final String modelCustomizationId;
+ private final String modelInvariantId;
+ private final String modelVersionId;
- /**
- * Number of "get" requests issued so far, on the current operation attempt.
- */
- @Getter
- private int getCount;
+ private final String vfCountKey;
/**
*
* @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;
+ public SoOperation(ControlLoopOperationParams params, HttpPollingConfig config, List<String> propertyNames) {
+ super(params, config, SoResponse.class, propertyNames);
+
+ setUsePolling();
+
+ verifyNotNull("Target information", params.getTarget());
+
+ this.modelCustomizationId = params.getTarget().getModelCustomizationId();
+ this.modelInvariantId = params.getTarget().getModelInvariantId();
+ this.modelVersionId = params.getTarget().getModelVersionId();
+
+ vfCountKey = SoConstants.VF_COUNT_PREFIX + "[" + modelCustomizationId + "][" + modelInvariantId + "]["
+ + modelVersionId + "]";
+ }
+
+ @Override
+ protected void resetPollCount() {
+ super.resetPollCount();
+ setSubRequestId(null);
}
/**
- * Subclasses should invoke this before issuing their first HTTP request.
+ * Validates that the parameters contain the required target information to extract
+ * the VF count from the custom query.
*/
- protected void resetGetCount() {
- getCount = 0;
+ protected void validateTarget() {
+ verifyNotNull("modelCustomizationId", modelCustomizationId);
+ verifyNotNull("modelInvariantId", modelInvariantId);
+ verifyNotNull("modelVersionId", modelVersionId);
+ }
+
+ private void verifyNotNull(String type, Object value) {
+ if (value == null) {
+ throw new IllegalArgumentException("missing " + type + " for guard payload");
+ }
}
/**
}
/**
- * If the response does not indicate that the request has been completed, then sleep a
- * bit and issue a "get".
+ * Gets the VF Count.
+ *
+ * @return a future to cancel or await the VF Count
*/
- @Override
- protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url,
- Response rawResponse, SoResponse response) {
+ @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);
+ }
+
+ /**
+ * 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);
- // see if the request has "completed", whether or not it was successful
+ params.getContext().setProperty(vfCountKey, vfcount);
+ }
+
+ return null;
+ }
+
+ protected int getVfCount() {
+ if (containsProperty(OperationProperties.DATA_VF_COUNT)) {
+ return getProperty(OperationProperties.DATA_VF_COUNT);
+ }
+
+ return params.getContext().getProperty(vfCountKey);
+ }
+
+ protected void setVfCount(int vfCount) {
+ if (containsProperty(OperationProperties.DATA_VF_COUNT)) {
+ setProperty(OperationProperties.DATA_VF_COUNT, vfCount);
+ return;
+ }
+
+ params.getContext().setProperty(vfCountKey, vfCount);
+ }
+
+ @Override
+ protected Status detmStatus(Response rawResponse, SoResponse response) {
if (rawResponse.getStatus() == 200) {
String requestState = getRequestState(response);
if (COMPLETE.equalsIgnoreCase(requestState)) {
- return CompletableFuture
- .completedFuture(setOutcome(outcome, PolicyResult.SUCCESS, rawResponse, response));
+ extractSubRequestId(response);
+ return Status.SUCCESS;
}
if (FAILED.equalsIgnoreCase(requestState)) {
- return CompletableFuture
- .completedFuture(setOutcome(outcome, PolicyResult.FAILURE, rawResponse, response));
+ extractSubRequestId(response);
+ return Status.FAILURE;
}
}
// still incomplete
// need a request ID with which to query
- if (response.getRequestReferences() == null || response.getRequestReferences().getRequestId() == null) {
+ 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);
- }
-
- // sleep and then perform a "get" operation
- Function<Void, CompletableFuture<OperationOutcome>> doGet = unused -> issueGet(outcome, response);
- return sleep(getWaitMsGet(), TimeUnit.MILLISECONDS).thenComposeAsync(doGet);
+ return Status.STILL_WAITING;
}
- /**
- * 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;
+ @Override
+ protected String getPollingPath() {
+ return super.getPollingPath() + getSubRequestId();
+ }
- logger.debug("{}: 'get' count {} for {}", getFullName(), getCount, params.getRequestId());
+ @Override
+ public void generateSubRequestId(int attempt) {
+ setSubRequestId(null);
+ }
- logMessage(EventType.OUT, CommInfrastructure.REST, url, null);
+ private boolean extractSubRequestId(SoResponse response) {
+ if (response == null || response.getRequestReferences() == null
+ || response.getRequestReferences().getRequestId() == null) {
+ return false;
+ }
- // TODO should this use "path" or the full "url"?
- return handleResponse(outcome, url, callback -> getClient().get(callback, path, null));
+ setSubRequestId(response.getRequestReferences().getRequestId());
+ return true;
}
/**
// set default result and message
setOutcome(outcome, result);
- outcome.setMessage(rawResponse.getStatus() + " " + outcome.getMessage());
+ int code = (result == PolicyResult.FAILURE_TIMEOUT ? SO_RESPONSE_CODE : rawResponse.getStatus());
+
+ outcome.setResponse(response);
+ outcome.setMessage(code + " " + outcome.getMessage());
return outcome;
}
/**
* Builds the request parameters from the policy payload.
*/
- protected SoRequestParameters buildRequestParameters() {
+ protected Optional<SoRequestParameters> buildRequestParameters() {
if (params.getPayload() == null) {
- return null;
+ return Optional.empty();
}
- String json = params.getPayload().get(REQ_PARAM_NM);
- if (json == null) {
- return null;
+ Object data = params.getPayload().get(REQ_PARAM_NM);
+ if (data == null) {
+ return Optional.empty();
}
try {
- return coder.decode(json, SoRequestParameters.class);
+ return Optional.of(coder.decode(data.toString(), SoRequestParameters.class));
} catch (CoderException e) {
throw new IllegalArgumentException("invalid payload value: " + REQ_PARAM_NM);
}
/**
* Builds the configuration parameters from the policy payload.
*/
- protected List<Map<String, String>> buildConfigurationParameters() {
+ protected Optional<List<Map<String, String>>> buildConfigurationParameters() {
if (params.getPayload() == null) {
- return null;
+ return Optional.empty();
}
- String json = params.getPayload().get(CONFIG_PARAM_NM);
- if (json == null) {
- return null;
+ Object data = params.getPayload().get(CONFIG_PARAM_NM);
+ if (data == null) {
+ return Optional.empty();
}
try {
@SuppressWarnings("unchecked")
- List<Map<String, String>> result = coder.decode(json, ArrayList.class);
- return result;
+ List<Map<String, String>> result = coder.decode(data.toString(), ArrayList.class);
+ return Optional.of(result);
} catch (CoderException | RuntimeException e) {
throw new IllegalArgumentException("invalid payload value: " + CONFIG_PARAM_NM);
}
}
- /*
- * These methods extract data from the Custom Query and throw an
- * IllegalArgumentException if the desired data item is not found.
+ /**
+ * Construct cloudConfiguration for the SO requestDetails. Overridden for custom
+ * query.
+ *
+ * @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());
+ return cloudConfiguration;
+ }
- protected GenericVnf getVnfItem(AaiCqResponse aaiCqResponse, SoModelInfo soModelInfo) {
- GenericVnf vnf = aaiCqResponse.getGenericVnfByVfModuleModelInvariantId(soModelInfo.getModelInvariantId());
- if (vnf == null) {
- throw new IllegalArgumentException("missing generic VNF");
- }
-
- return vnf;
+ /**
+ * Create simple HTTP headers for unauthenticated requests to SO.
+ *
+ * @return the HTTP headers
+ */
+ protected Map<String, Object> createSimpleHeaders() {
+ Map<String, Object> headers = new HashMap<>();
+ headers.put("Accept", MediaType.APPLICATION_JSON);
+ return headers;
}
- protected ServiceInstance getServiceInstance(AaiCqResponse aaiCqResponse) {
- ServiceInstance vnfService = aaiCqResponse.getServiceInstance();
- if (vnfService == null) {
- throw new IllegalArgumentException("missing VNF Service Item");
+ /**
+ * Gets an item from a property. If the property is not found, then it invokes the
+ * given function to retrieve it from the custom query data. If that fails as well,
+ * then an exception is thrown.
+ *
+ * @param propName property name
+ * @param getter method to extract the value from the custom query data
+ * @param errmsg error message to include in any exception
+ * @return the retrieved item
+ */
+ protected <T> T getItem(String propName, Function<AaiCqResponse, T> getter, String errmsg) {
+ if (containsProperty(propName)) {
+ return getProperty(propName);
+ }
+
+ final AaiCqResponse aaiCqResponse = params.getContext().getProperty(AaiCqResponse.CONTEXT_KEY);
+ T item = getter.apply(aaiCqResponse);
+ if (item == null) {
+ throw new IllegalArgumentException(errmsg);
}
- return vnfService;
+ return item;
}
- protected Tenant getDefaultTenant(AaiCqResponse aaiCqResponse) {
- Tenant tenant = aaiCqResponse.getDefaultTenant();
- if (tenant == null) {
- throw new IllegalArgumentException("missing Tenant Item");
- }
+ /*
+ * These methods extract data from the Custom Query and throw an
+ * IllegalArgumentException if the desired data item is not found.
+ */
- return tenant;
+ protected GenericVnf getVnfItem(SoModelInfo soModelInfo) {
+ // @formatter:off
+ return getItem(OperationProperties.AAI_VNF,
+ cq -> cq.getGenericVnfByVfModuleModelInvariantId(soModelInfo.getModelInvariantId()),
+ "missing generic VNF");
+ // @formatter:on
}
- protected CloudRegion getDefaultCloudRegion(AaiCqResponse aaiCqResponse) {
- CloudRegion cloudRegion = aaiCqResponse.getDefaultCloudRegion();
- if (cloudRegion == null) {
- throw new IllegalArgumentException("missing Cloud Region");
- }
+ protected ServiceInstance getServiceInstance() {
+ return getItem(OperationProperties.AAI_SERVICE, AaiCqResponse::getServiceInstance, "missing VNF Service Item");
+ }
- return cloudRegion;
+ protected Tenant getDefaultTenant() {
+ // @formatter:off
+ return getItem(OperationProperties.AAI_DEFAULT_TENANT,
+ AaiCqResponse::getDefaultTenant,
+ "missing Default Tenant Item");
+ // @formatter:on
}
- // these may be overridden by junit tests
+ protected CloudRegion getDefaultCloudRegion() {
+ // @formatter:off
+ return getItem(OperationProperties.AAI_DEFAULT_CLOUD_REGION,
+ AaiCqResponse::getDefaultCloudRegion,
+ "missing Default Cloud Region");
+ // @formatter:on
+ }
- /**
- * 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);
+ protected ModelVer getVnfModel(GenericVnf vnfItem) {
+ // @formatter:off
+ return getItem(OperationProperties.AAI_VNF_MODEL,
+ cq -> cq.getModelVerByVersionId(vnfItem.getModelVersionId()),
+ "missing generic VNF Model");
+ // @formatter:on
}
- public int getMaxGets() {
- return config.getMaxGets();
+ protected ModelVer getServiceModel(ServiceInstance vnfServiceItem) {
+ // @formatter:off
+ return getItem(OperationProperties.AAI_SERVICE_MODEL,
+ cq -> cq.getModelVerByVersionId(vnfServiceItem.getModelVersionId()),
+ "missing Service Model");
+ // @formatter:on
}
- public String getPathGet() {
- return config.getPathGet();
+ // these may be overridden by junit tests
+
+ @Override
+ protected Coder getCoder() {
+ return coder;
}
- public int getWaitSecGet() {
- return config.getWaitSecGet();
+ private static class SoCoder extends StandardCoder {
+
+ /**
+ * Gson object used to encode and decode messages.
+ */
+ private static final Gson SO_GSON;
+
+ /**
+ * 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