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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * ONAP : APPC
   4  * ================================================================================
   5  * Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.appc.provider.lcm.service;
  23
  24 import com.att.eelf.configuration.EELFLogger;
  25 import com.att.eelf.configuration.EELFManager;
  26 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.Action;
  27 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.Payload;
  28 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.RebootInput;
  29 import org.opendaylight.yang.gen.v1.org.onap.appc.lcm.rev160108.RebootOutputBuilder;
  30 import org.onap.appc.executor.objects.LCMCommandStatus;
  31 import org.onap.appc.requesthandler.objects.RequestHandlerInput;
  32 import org.onap.appc.util.JsonUtil;
  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
  37 import java.io.IOException;
  38 import java.util.Arrays;
  39 import java.util.EnumSet;
  40 import java.util.List;
  41 import java.util.Map;
  42
  43 /**
  44  * Provide LCM command service for rebooting virtual machine (VM)
  45  */
  46 public class RebootService extends AbstractBaseService {
  47     private final EELFLogger myLogger = EELFManager.getInstance().getLogger(RebootService.class);
  48     private static final String REBOOT_TYPE_PARAMETER = "type";
  49     private final List<String> rebootTypeList = Arrays.asList("HARD", "SOFT");
  50
  51     /**
  52      * Constructor
  53      */
  54     public RebootService() {
  55         super(Action.Reboot);
  56     }
  57
  58     public RebootOutputBuilder reboot(RebootInput input) {
  59
  60         validate(input);
  61         if (status == null) {
  62             proceedAction(input);
  63         }
  64
  65         RebootOutputBuilder outputBuilder = new RebootOutputBuilder();
  66         outputBuilder.setCommonHeader(input.getCommonHeader());
  67         outputBuilder.setStatus(status);
  68         return outputBuilder;
  69     }
  70
  71     void proceedAction(RebootInput input) {
  72         RequestHandlerInput requestHandlerInput = getRequestHandlerInput(
  73                 input.getCommonHeader(), input.getActionIdentifiers(), input.getPayload(), this.getClass().getName());
  74         if (requestHandlerInput != null) {
  75             executeAction(requestHandlerInput);
  76         }
  77     }
  78
  79     /**
  80      * Validate the input.
  81      *
  82      * @param input of RebootInput from the REST API input
  83      */
  84     void validate(RebootInput input) {
  85         status = validateVserverIdVnfId(input.getCommonHeader(), input.getAction(), input.getActionIdentifiers());
  86         if (status != null) {
  87             return;
  88         }
  89         // validate payload
  90         String keyName = "payload";
  91         if (input.getPayload() == null) {
  92             status = buildStatusForParamName(LCMCommandStatus.MISSING_MANDATORY_PARAMETER, keyName);
  93             return;
  94         }
  95         String payloadString = input.getPayload().getValue();
  96         status = validateMustHaveParamValue(
  97                 payloadString == null ? payloadString : payloadString.trim(), "payload");
  98         if (status != null) {
  99             return;
 100         }
 101
 102         try {
 103             Map<String, String> payloadMap = JsonUtil.convertJsonStringToFlatMap(payloadString);
 104             //reboot-type validation
 105             final String rebootType = payloadMap.get(REBOOT_TYPE_PARAMETER);
 106             if (rebootType == null) {
 107                 return;
 108             } else if (!rebootTypeList.contains(rebootType)) {
 109                 status = buildStatusForErrorMsg(LCMCommandStatus.INVALID_INPUT_PARAMETER, REBOOT_TYPE_PARAMETER);
 110                 return;
 111             }
 112         } catch (IOException e) {
 113             logger.error(String.format("VolumeService (%s) got IOException when converting payload", rpcName), e);
 114             status = buildStatusForErrorMsg(LCMCommandStatus.UNEXPECTED_ERROR, e.getMessage());
 115         }
 116     }
 117
 118     Status validateVserverIdVnfId(CommonHeader commonHeader, Action action, ActionIdentifiers actionIdentifiers ) {
 119         Status validatedStatus = validateInput(commonHeader, action, actionIdentifiers);
 120
 121         if (validatedStatus != null) {
 122             return validatedStatus;
 123         }
 124
 125         validatedStatus = validateMustHaveParamValue(actionIdentifiers.getVserverId(), "vserver-id");
 126         if (validatedStatus == null) {
 127             validatedStatus = validateMustHaveParamValue(actionIdentifiers.getVnfId(), "vnf-id");
 128             logger.debug("check for vnf-id");
 129         }
 130         if (validatedStatus == null) {
 131             validatedStatus = validateExcludedActIds(actionIdentifiers, EnumSet.of(ACTID_KEYS.VSERVER_ID, ACTID_KEYS.VNF_ID));
 132         }
 133         logger.debug("check for ActIds");
 134         return validatedStatus;
 135     }
 136 }