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