appc-oam/appc-oam-bundle/src/main/java/org/onap/appc/oam/OAMCommandStatus.java

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