main/src/main/java/org/onap/policy/api/main/exception/PolicyApiRuntimeException.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Samsung Electronics Co., Ltd. All rights reserved.
   4  *  Modifications Copyright (C) 2022 Bell Canada. All rights reserved.
   5  * ================================================================================
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * SPDX-License-Identifier: Apache-2.0
  19  * ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.policy.api.main.exception;
  23
  24 import java.util.UUID;
  25 import lombok.Getter;
  26 import org.onap.policy.models.errors.concepts.ErrorResponse;
  27
  28 /**
  29  * This runtime exception will be called if a runtime error occurs when using policy api.
  30  */
  31 public class PolicyApiRuntimeException extends RuntimeException {
  32
  33     private static final long serialVersionUID = -8507246953751956974L;
  34
  35     @Getter
  36     private final UUID requestId;
  37     @Getter
  38     private final ErrorResponse errorResponse;
  39
  40     /**
  41      * Instantiates a new policy api runtime exception with a message.
  42      *
  43      * @param message the message
  44      */
  45     public PolicyApiRuntimeException(final String message) {
  46         super(message);
  47         this.requestId = null;
  48         this.errorResponse = null;
  49     }
  50
  51     /**
  52      * Instantiates a new policy api runtime exception with a message and a caused by exception.
  53      *
  54      * @param message the message
  55      * @param exp the exception that caused this exception to be thrown
  56      */
  57     public PolicyApiRuntimeException(final String message, final Exception exp) {
  58         super(message, exp);
  59         this.requestId = null;
  60         this.errorResponse = null;
  61     }
  62
  63     /**
  64      * Instantiates a new policy api runtime exception with requestId, errorResponse object
  65      * along with message and a caused by exception.
  66      *
  67      * @param message the message
  68      * @param cause the exception that caused this exception to be thrown
  69      * @param requestId request identifier
  70      * @param errorResponse error response object
  71      */
  72     public PolicyApiRuntimeException(final String message, final Throwable cause,
  73                                      final ErrorResponse errorResponse, final UUID requestId) {
  74         super(message, cause);
  75         this.requestId = requestId;
  76         this.errorResponse = errorResponse;
  77     }
  78 }