appc-provider/appc-provider-bundle/src/main/java/org/onap/appc/provider/lcm/service/VolumeService.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Copyright (C) 2017 Amdocs
   8  * =============================================================================
   9  * Licensed under the Apache License, Version 2.0 (the "License");
  10  * you may not use this file except in compliance with the License.
  11  * You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  *
  21  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  22  * ============LICENSE_END=========================================================
  23  */
  24
  25 package org.onap.appc.provider.lcm.service;
  26
  27 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.Action;
  28 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.AttachVolumeInput;
  29 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.AttachVolumeOutputBuilder;
  30 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.DetachVolumeInput;
  31 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.DetachVolumeOutputBuilder;
  32 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.Payload;
  33 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.action.identifiers.ActionIdentifiers;
  34 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.common.header.CommonHeader;
  35 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.status.Status;
  36 import org.onap.appc.executor.objects.LCMCommandStatus;
  37 import org.onap.appc.requesthandler.objects.RequestHandlerInput;
  38 import org.onap.appc.util.JsonUtil;
  39 import java.util.EnumSet;
  40 import java.io.IOException;
  41 import java.util.Map;
  42
  43 /**
  44  * Provide LCM command service for attach/detach a cinder to a VM
  45  */
  46 public class VolumeService extends AbstractBaseService {
  47     /**
  48      * Constructor
  49      *
  50      * @param isAttachVolume boolean to indicate if this VolumeSerivce is created for attaching or detaching cinder
  51      */
  52     public VolumeService(boolean isAttachVolume) {
  53         super(isAttachVolume ? Action.AttachVolume : Action.DetachVolume);
  54         logger.debug("VolumeService starts ", isAttachVolume);
  55     }
  56
  57     /**
  58      * Attach a cinder to the VM volume
  59      *
  60      * @param input of AttachVolumeInput from the REST API input
  61      * @return AttachVolumeOutputBuilder which has the details of the request results
  62      */
  63     public AttachVolumeOutputBuilder attachVolume(AttachVolumeInput input) {
  64         CommonHeader commonHeader = input.getCommonHeader();
  65         ActionIdentifiers actionIdentifiers = input.getActionIdentifiers();
  66         Payload payload = input.getPayload();
  67
  68         validate(commonHeader, input.getAction(), actionIdentifiers,payload);
  69         if (status == null) {
  70             proceedAction(commonHeader, actionIdentifiers, payload);
  71         }
  72
  73         AttachVolumeOutputBuilder outputBuilder = new AttachVolumeOutputBuilder();
  74         outputBuilder.setStatus(status);
  75         outputBuilder.setCommonHeader(input.getCommonHeader());
  76         return outputBuilder;
  77     }
  78
  79     /**
  80      * Detach a cinder to the VM volume
  81      *
  82      * @param input of DetachVolumeInput from the REST API input
  83      * @return DetachVolumeOutputBuilder which has the details of the request results
  84      */
  85     public DetachVolumeOutputBuilder detachVolume(DetachVolumeInput input) {
  86         CommonHeader commonHeader = input.getCommonHeader();
  87         ActionIdentifiers actionIdentifiers = input.getActionIdentifiers();
  88         Payload payload = input.getPayload();
  89
  90         validate(commonHeader, input.getAction(), actionIdentifiers,payload);
  91         if (status == null) {
  92             proceedAction(commonHeader, actionIdentifiers, payload);
  93         }
  94
  95         DetachVolumeOutputBuilder outputBuilder = new DetachVolumeOutputBuilder();
  96         outputBuilder.setStatus(status);
  97         outputBuilder.setCommonHeader(input.getCommonHeader());
  98         return outputBuilder;
  99     }
 100
 101     void validate(CommonHeader commonHeader,
 102                   Action action,
 103                   ActionIdentifiers actionIdentifiers,
 104                   Payload payload) {
 105         status = validateVserverIdVnfId(commonHeader, action, actionIdentifiers);
 106         if (status != null) {
 107             return;
 108         }
 109
 110         // validate payload
 111         String keyName = "payload";
 112         if (payload == null) {
 113             status = buildStatusForParamName(LCMCommandStatus.MISSING_MANDATORY_PARAMETER, keyName);
 114             return;
 115         }
 116         String payloadString = payload.getValue();
 117         status = validateMustHaveParamValue(
 118             payloadString == null ? payloadString : payloadString.trim(), "payload");
 119         if (status != null) {
 120             return;
 121         }
 122
 123         try {
 124             Map<String, String> payloadMap = JsonUtil.convertJsonStringToFlatMap(payloadString);
 125             validateMustHaveParamValue(payloadMap.get(keyName), keyName);
 126         } catch (IOException e) {
 127             logger.error(String.format("VolumeService (%s) got IOException when converting payload", rpcName), e);
 128             status = buildStatusForErrorMsg(LCMCommandStatus.UNEXPECTED_ERROR, e.getMessage());
 129         }
 130     }
 131
 132     Status validateVserverIdVnfId(CommonHeader commonHeader, Action action, ActionIdentifiers actionIdentifiers ) {
 133         Status validatedStatus = validateInput(commonHeader, action, actionIdentifiers);
 134
 135         if (validatedStatus != null) {
 136         return validatedStatus;
 137         }
 138
 139         validatedStatus = validateMustHaveParamValue(actionIdentifiers.getVserverId(), "vserver-id");
 140         if (validatedStatus == null) {
 141         validatedStatus = validateMustHaveParamValue(actionIdentifiers.getVserverId(), "vnf-id");
 142         logger.debug("check for vnf-id");
 143         }
 144         if (validatedStatus == null) {
 145         validatedStatus = validateExcludedActIds(actionIdentifiers, EnumSet.of(ACTID_KEYS.VSERVER_ID, ACTID_KEYS.VNF_ID));
 146         }
 147         logger.debug("check for ActIds");
 148         return validatedStatus;
 149         }
 150     /**
 151      * Proceed to action for the attach or detach volume.
 152      * @param commonHeader of the input
 153      * @param actionIdentifiers of the input
 154      * @param payload of the input
 155      */
 156     void proceedAction(CommonHeader commonHeader,
 157                        ActionIdentifiers actionIdentifiers,
 158                        Payload payload) {
 159         RequestHandlerInput requestHandlerInput =
 160             getRequestHandlerInput(commonHeader, actionIdentifiers, payload, this.getClass().getName());
 161         if (requestHandlerInput != null) {
 162             executeAction(requestHandlerInput);
 163         }
 164     }
 165 }