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