models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleCreate.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP
   4  * ================================================================================
   5  * Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
   6  * Modifications Copyright (C) 2020 Wipro Limited.
   7  * ================================================================================
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *      http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing, software
  15  * distributed under the License is distributed on an "AS IS" BASIS,
  16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  17  * See the License for the specific language governing permissions and
  18  * limitations under the License.
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.controlloop.actor.so;
  23
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.concurrent.CompletableFuture;
  27 import javax.ws.rs.client.Entity;
  28 import javax.ws.rs.core.MediaType;
  29 import javax.ws.rs.core.Response;
  30 import org.apache.commons.lang3.tuple.Pair;
  31 import org.onap.aai.domain.yang.ModelVer;
  32 import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
  33 import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
  34 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
  35 import org.onap.policy.controlloop.actorserviceprovider.OperationProperties;
  36 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
  37 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig;
  38 import org.onap.policy.so.SoModelInfo;
  39 import org.onap.policy.so.SoOperationType;
  40 import org.onap.policy.so.SoRelatedInstance;
  41 import org.onap.policy.so.SoRelatedInstanceListElement;
  42 import org.onap.policy.so.SoRequest;
  43 import org.onap.policy.so.SoRequestDetails;
  44 import org.onap.policy.so.SoRequestParameters;
  45 import org.onap.policy.so.SoResponse;
  46
  47 /**
  48  * Operation to create a VF Module. When this completes successfully, it increments its VF
  49  * Count property.
  50  */
  51 public class VfModuleCreate extends SoOperation {
  52     public static final String NAME = "VF Module Create";
  53
  54     private static final String PATH_PREFIX = "/";
  55
  56     // @formatter:off
  57     private static final List<String> PROPERTY_NAMES = List.of(
  58                             OperationProperties.AAI_SERVICE,
  59                             OperationProperties.AAI_SERVICE_MODEL,
  60                             OperationProperties.AAI_VNF,
  61                             OperationProperties.AAI_VNF_MODEL,
  62                             OperationProperties.AAI_DEFAULT_CLOUD_REGION,
  63                             OperationProperties.AAI_DEFAULT_TENANT,
  64                             OperationProperties.DATA_VF_COUNT);
  65     // @formatter:off
  66
  67     /**
  68      * Constructs the object.
  69      *
  70      * @param params operation parameters
  71      * @param config configuration for this operation
  72      */
  73     public VfModuleCreate(ControlLoopOperationParams params, HttpPollingConfig config) {
  74         super(params, config, PROPERTY_NAMES, params.getTargetEntityIds());
  75
  76         setUsePolling();
  77         // ensure we have the necessary parameters
  78         validateTarget();
  79     }
  80
  81     @Override
  82     protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
  83
  84         // starting a whole new attempt - reset the count
  85         resetPollCount();
  86
  87         Pair<String, SoRequest> pair = makeRequest();
  88         String path = getPath() + pair.getLeft();
  89         SoRequest request = pair.getRight();
  90
  91         String url = getClient().getBaseUrl() + path;
  92
  93         String strRequest = prettyPrint(request);
  94         logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
  95
  96         Entity<String> entity = Entity.entity(strRequest, MediaType.APPLICATION_JSON);
  97
  98         Map<String, Object> headers = createSimpleHeaders();
  99
 100         return handleResponse(outcome, url, callback -> getClient().post(callback, path, entity, headers));
 101     }
 102
 103     /**
 104      * Increments the VF count that's stored in the context, if the request was
 105      * successful.
 106      */
 107     @Override
 108     protected Status detmStatus(Response rawResponse, SoResponse response) {
 109         var status = super.detmStatus(rawResponse, response);
 110
 111         if (status == Status.SUCCESS) {
 112             setVfCount(getVfCount() + 1);
 113         }
 114
 115         return status;
 116     }
 117
 118     /**
 119      * Makes a request.
 120      *
 121      * @return a pair containing the request URL and the new request
 122      */
 123     protected Pair<String, SoRequest> makeRequest() {
 124         final var soModelInfo = prepareSoModelInfo();
 125         final var vnfItem = getVnfItem();
 126         final var vnfServiceItem = getServiceInstance();
 127         final var tenantItem = getDefaultTenant();
 128         final var cloudRegionItem = getDefaultCloudRegion();
 129         final ModelVer vnfModel = getVnfModel();
 130         final ModelVer vnfServiceModel = getServiceModel();
 131
 132         var request = new SoRequest();
 133         request.setOperationType(SoOperationType.SCALE_OUT);
 134
 135         //
 136         //
 137         // Do NOT send SO the requestId, they do not support this field
 138         //
 139         request.setRequestDetails(new SoRequestDetails());
 140         request.getRequestDetails().setRequestParameters(new SoRequestParameters());
 141         request.getRequestDetails().getRequestParameters().setUserParams(null);
 142
 143         // cloudConfiguration
 144         request.getRequestDetails().setCloudConfiguration(constructCloudConfiguration(tenantItem, cloudRegionItem));
 145
 146         // modelInfo
 147         request.getRequestDetails().setModelInfo(soModelInfo);
 148
 149         // requestInfo
 150         request.getRequestDetails().setRequestInfo(constructRequestInfo());
 151         request.getRequestDetails().getRequestInfo().setInstanceName("vfModuleName");
 152
 153         // relatedInstanceList
 154         var relatedInstanceListElement1 = new SoRelatedInstanceListElement();
 155         var relatedInstanceListElement2 = new SoRelatedInstanceListElement();
 156         relatedInstanceListElement1.setRelatedInstance(new SoRelatedInstance());
 157         relatedInstanceListElement2.setRelatedInstance(new SoRelatedInstance());
 158
 159         // Service Item
 160         relatedInstanceListElement1.getRelatedInstance().setInstanceId(vnfServiceItem.getServiceInstanceId());
 161         relatedInstanceListElement1.getRelatedInstance().setModelInfo(new SoModelInfo());
 162         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelType("service");
 163         relatedInstanceListElement1.getRelatedInstance().getModelInfo()
 164                         .setModelInvariantId(vnfServiceItem.getModelInvariantId());
 165         relatedInstanceListElement1.getRelatedInstance().getModelInfo()
 166                         .setModelVersionId(vnfServiceItem.getModelVersionId());
 167         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelName(vnfModel.getModelName());
 168         relatedInstanceListElement1.getRelatedInstance().getModelInfo().setModelVersion(vnfModel.getModelVersion());
 169
 170         // VNF Item
 171         relatedInstanceListElement2.getRelatedInstance().setInstanceId(vnfItem.getVnfId());
 172         relatedInstanceListElement2.getRelatedInstance().setModelInfo(new SoModelInfo());
 173         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelType("vnf");
 174         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 175                         .setModelInvariantId(vnfItem.getModelInvariantId());
 176         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelVersionId(vnfItem.getModelVersionId());
 177
 178         relatedInstanceListElement2.getRelatedInstance().getModelInfo().setModelName(vnfServiceModel.getModelName());
 179         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 180                         .setModelVersion(vnfServiceModel.getModelVersion());
 181
 182         relatedInstanceListElement2.getRelatedInstance().getModelInfo()
 183                         .setModelCustomizationId(vnfItem.getModelCustomizationId());
 184
 185         // Insert the Service Item and VNF Item
 186         request.getRequestDetails().getRelatedInstanceList().add(relatedInstanceListElement1);
 187         request.getRequestDetails().getRelatedInstanceList().add(relatedInstanceListElement2);
 188
 189         // Request Parameters
 190         buildRequestParameters().ifPresent(request.getRequestDetails()::setRequestParameters);
 191
 192         // Configuration Parameters
 193         buildConfigurationParameters().ifPresent(request.getRequestDetails()::setConfigurationParameters);
 194
 195         // compute the path
 196         String svcId = getRequiredText("service instance ID", vnfServiceItem.getServiceInstanceId());
 197         String path = PATH_PREFIX + svcId + "/vnfs/" + vnfItem.getVnfId() + "/vfModules/scaleOut";
 198
 199         return Pair.of(path, request);
 200     }
 201 }