appc-oam/appc-oam-bundle/src/main/java/org/openecomp/appc/oam/OAMCommandStatus.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.oam;
  26
  27 import org.openecomp.appc.executor.objects.Params;
  28 import org.openecomp.appc.util.MessageFormatter;
  29
  30 import java.util.Map;
  31
  32 public enum OAMCommandStatus {
  33
  34     ACCEPTED(100,          "ACCEPTED - request accepted"),
  35     UNEXPECTED_ERROR(200,  "UNEXPECTED ERROR - ${errorMsg}"),
  36     REJECTED(300,          "REJECTED - ${errorMsg}"),
  37     INVALID_PARAMETER(302, "INVALID PARAMETER - ${errorMsg}" ),
  38     TIMEOUT(303,           "OPERATION TIMEOUT REACHED - ${errorMsg}"),
  39     ABORT(304,             "OPERATION ABORT - ${errorMsg}"),
  40     SUCCESS(400,           "SUCCESS - request has been processed successfully");
  41
  42     final String TO_STRING_FORMAT = "OAMCommandStatus{responseCode=%d, responseMessage='%s'}";
  43
  44     private int responseCode;
  45     private String responseMessage;
  46
  47     OAMCommandStatus(int responseCode, String responseMessage) {
  48         this.responseCode = responseCode;
  49         this.responseMessage = responseMessage;
  50     }
  51
  52     public String getResponseMessage() {
  53         return responseMessage;
  54     }
  55
  56     public int getResponseCode() {
  57         return responseCode;
  58     }
  59
  60     /**
  61      * Get formated message of passed in params
  62      *
  63      * @param params of Params object with name value pairs for message
  64      * @return  message string
  65      */
  66     public String getFormattedMessage(Params params) {
  67         Map<String,Object> paramsMap = params != null ? params.getParams() : null;
  68         return MessageFormatter.format(getResponseMessage(), paramsMap);
  69     }
  70
  71     @Override
  72     public String toString() {
  73         return String.format(TO_STRING_FORMAT, responseCode, responseMessage);
  74     }}