src/main/java/org/onap/dcae/restapi/ApiException.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * org.onap.dcaegen2.collectors.ves
   4  * ================================================================================
   5  * Copyright (C) 2020 Nokia. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20 package org.onap.dcae.restapi;
  21
  22 import com.google.common.base.CaseFormat;
  23 import org.json.JSONObject;
  24
  25 import java.util.ArrayList;
  26 import java.util.List;
  27
  28 /**
  29  * @author Pawel Szalapski (pawel.szalapski@nokia.com)
  30  */
  31 public enum ApiException {
  32
  33     INVALID_JSON_INPUT(ExceptionType.SERVICE_EXCEPTION, "SVC0002", "Incorrect JSON payload", 400),
  34     SCHEMA_VALIDATION_FAILED(ExceptionType.SERVICE_EXCEPTION, "SVC0002", "Bad Parameter (JSON does not conform to schema)", 400),
  35     INVALID_CONTENT_TYPE(ExceptionType.SERVICE_EXCEPTION, "SVC0002", "Bad Parameter (Incorrect request Content-Type)", 400),
  36     UNAUTHORIZED_USER(ExceptionType.POLICY_EXCEPTION, "POL2000", "Unauthorized user", 401),
  37     INVALID_CUSTOM_HEADER(ExceptionType.SERVICE_EXCEPTION, "SVC0002", "Bad Parameter (Incorrect request api version)", 400),
  38     MISSING_NAMESPACE_PARAMETER(ExceptionType.SERVICE_EXCEPTION, "SVC2006", "Mandatory input %1 %2 is missing from request", List.of("attribute", "event.commonEventHeader.stndDefinedNamespace"), 400),
  39     EMPTY_NAMESPACE_PARAMETER(ExceptionType.SERVICE_EXCEPTION, "SVC2006", "Mandatory input %1 %2 is empty in request", List.of("attribute", "event.commonEventHeader.stndDefinedNamespace"), 400),
  40     NO_SERVER_RESOURCES(ExceptionType.SERVICE_EXCEPTION, "SVC1000", "No server resources (internal processing queue full)", 503),
  41     STND_DEFINED_VALIDATION_FAILED(ExceptionType.SERVICE_EXCEPTION, "SVC2000", "The following service error occurred: %1. Error code is %2", List.of("event.stndDefinedFields.data invalid against event.stndDefinedFields.schemaReference", "400"), 400),
  42     NO_LOCAL_SCHEMA_REFERENCE(ExceptionType.SERVICE_EXCEPTION, "SVC2004", "Invalid input value for %1 %2: %3", List.of("attribute", "event.stndDefinedFields.schemaReference", "Referred external schema not present in schema repository"), 400),
  43     INCORRECT_INTERNAL_FILE_REFERENCE(ExceptionType.SERVICE_EXCEPTION, "SVC2000", "The following service error occurred: %1. Error code is %2", List.of("event.stndDefinedFields.schemaReference value does not correspond to any external event schema file in externalSchema repo", "400"), 400);
  44
  45
  46     public final int httpStatusCode;
  47     private final ExceptionType type;
  48     private final String code;
  49     private final String details;
  50     private final List<String> variables;
  51
  52     ApiException(ExceptionType type, String code, String details, int httpStatusCode) {
  53         this(type, code, details, new ArrayList<>(), httpStatusCode);
  54     }
  55
  56     ApiException(ExceptionType type, String code, String details, List<String> variables, int httpStatusCode) {
  57         this.type = type;
  58         this.code = code;
  59         this.details = details;
  60         this.variables = variables;
  61         this.httpStatusCode = httpStatusCode;
  62     }
  63
  64     public JSONObject toJSON() {
  65         JSONObject exceptionTypeNode = new JSONObject();
  66         exceptionTypeNode.put("messageId", code);
  67         exceptionTypeNode.put("text", details);
  68         if(!variables.isEmpty()) {
  69             exceptionTypeNode.put("variables", variables);
  70         }
  71
  72         JSONObject requestErrorNode = new JSONObject();
  73         requestErrorNode.put(type.toString(), exceptionTypeNode);
  74
  75         JSONObject rootNode = new JSONObject();
  76         rootNode.put("requestError", requestErrorNode);
  77         return rootNode;
  78     }
  79
  80     public enum ExceptionType {
  81         SERVICE_EXCEPTION, POLICY_EXCEPTION;
  82
  83         @Override
  84         public String toString() {
  85             return CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.UPPER_CAMEL, this.name());
  86         }
  87     }
  88
  89 }