appc-dispatcher/appc-command-executor/appc-command-executor-api/src/main/java/org/openecomp/appc/executor/objects/LCMCommandStatus.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * openECOMP : APP-C
   4  * ================================================================================
   5  * Copyright (C) 2017 AT&T Intellectual Property. All rights
   6  *                                              reserved.
   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.openecomp.appc.executor.objects;
  23
  24
  25 import org.apache.commons.lang3.StringUtils;
  26 import org.openecomp.appc.domainmodel.lcm.Status;
  27 import org.openecomp.appc.util.MessageFormatter;
  28
  29 import java.util.Map;
  30
  31 public enum LCMCommandStatus {
  32
  33     ACCEPTED(100,"ACCEPTED - request accepted"),
  34
  35     //ERROR(2xx) – request can’t be handled due to some technical error
  36     UNEXPECTED_ERROR(200,"UNEXPECTED ERROR - ${errorMsg}"),
  37
  38     //REJECT(3xx) – request has been rejected due to some business reason (e.g. no such service-instance-id, command is not supported, etc)
  39     REJECTED(300,"REJECTED - ${errorMsg}"),
  40     INVALID_INPUT_PARAMETER(301,"INVALID INPUT PARAMETER - ${errorMsg}"),// TODO 77777777 to support "${paramName} with invalid value ${paramValue}"
  41     MISSING_MANDATORY_PARAMETER(302,"MISSING MANDATORY PARAMETER - Parameter/s ${paramName} is/are missing" ),
  42     REQUEST_PARSING_FAILED(303,"REQUEST PARSING FAILED - ${errorMsg}"),
  43     NO_TRANSITION_DEFINE(304,"ACTION IS NOT ALLOWED - Action ${actionName} is not allowed for VNF in state ${currentState}"),
  44     INVALID_VNF_STATE(305,"Request rejected because VNF status in A&AI is - ${currentState}" ),
  45     VNF_NOT_FOUND(306,"VNF NOT FOUND - VNF with ID ${vnfId} was not found" ),
  46     DG_WORKFLOW_NOT_FOUND(307,"DG WORKFLOW NOT FOUND - No DG workflow found for the combination of ${dgModule} module ${dgName} name and ${dgVersion} version"),//TODO need to support it
  47     WORKFLOW_NOT_FOUND(308,"WORKFLOW NOT FOUND - No workflow found for VNF type ${vnfTypeVersion} and ${actionName} action"),
  48         UNSTABLE_VNF(309,"UNSTABLE VNF - VNF ${vnfId} is not stable to accept the command"),
  49     LOCKING_FAILURE(310,"LOCKING FAILURE - ${errorMsg}" ),
  50         EXPIRED_REQUEST(311,"EXPIRED REQUEST"),
  51     DUPLICATE_REQUEST(312,"DUPLICATE REQUEST"),
  52     MISSING_VNF_DATA_IN_AAI(313,"MISSING VNF DATA IN A&AI - ${attributeName} not found for VNF ID = ${vnfId}"),
  53
  54     SUCCESS(400,"SUCCESS - request has been processed successfully"),
  55
  56
  57     //        FAILURE(5xx) – request processing results with failure. The FAILURE response is always transmitted asynchronously, via DMaaP.
  58     DG_FAILURE(401,"DG FAILURE - ${errorMsg}"),
  59     NO_TRANSITION_DEFINE_FAILURE(402,"NO TRANSITION DEFINE - No Transition Defined for ${actionName} action and ${currentState} state"),
  60     UPDATE_AAI_FAILURE(403,"UPDATE_AAI_FAILURE - failed to update AAI. ${errorMsg}"),
  61     EXPIRED_REQUEST_FAILURE(404,"EXPIRED REQUEST FAILURE - failed after accepted because TTL expired"),
  62     UNEXPECTED_FAILURE(405,"UNEXPECTED FAILURE - ${errorMsg}"),
  63     UNSTABLE_VNF_FAILURE(406,"UNSTABLE VNF FAILURE - VNF ${vnfId} is not stable to accept the command"),
  64
  65         ;
  66
  67
  68     public static final String errorDgMessageParamName = "errorDgMessage";
  69
  70         private int responseCode;
  71         private String responseMessage;
  72
  73
  74
  75
  76     LCMCommandStatus(int responseCode, String responseMessage) {
  77         this.responseCode = responseCode;
  78         this.responseMessage = responseMessage;
  79             }
  80
  81     public String getResponseMessage() {
  82                 return responseMessage;
  83         }
  84
  85         public int getResponseCode() {
  86                 return responseCode;
  87         }
  88
  89
  90         /**
  91      *
  92      * @return  messageTemplate
  93      */
  94
  95
  96     public String getFormattedMessage(Params params){
  97             Map<String,Object> paramsMap = params != null ? params.getParams() : null;
  98             return MessageFormatter.format(getResponseMessage(),paramsMap);
  99
 100         }
 101
 102     public String getFormattedMessageWithCode(Params params){
 103         return getResponseCode()+"-" + getFormattedMessage(params);
 104     }
 105
 106     @Override
 107     public String toString() {
 108         return "LCMCommandStatus{" +
 109                 "responseCode=" + responseCode +
 110                 ", responseMessage='" + responseMessage + '\'' +
 111                 '}';
 112     }
 113
 114     public Status toStatus(Params params) {
 115         return new Status(responseCode, getFormattedMessage(params));
 116     }
 117 }
 118