models-base/src/main/java/org/onap/policy/models/base/PfModelRuntimeException.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.models.base;
  22
  23 import javax.ws.rs.core.Response;
  24
  25 import lombok.Getter;
  26 import lombok.ToString;
  27
  28 /**
  29  * This class is a base model run time exception from which all model run time exceptions are sub
  30  * classes.
  31  */
  32 @Getter
  33 @ToString
  34 public class PfModelRuntimeException extends RuntimeException {
  35     private static final long serialVersionUID = -8507246953751956974L;
  36
  37     // The return code on the exception
  38     private final Response.Status statusCode;
  39
  40     // The object on which the exception was thrown
  41     private final transient Object object;
  42
  43     /**
  44      * Instantiates a new model runtime exception.
  45      *
  46      * @param statusCode the return code for the exception
  47      * @param message the message on the exception
  48      */
  49     public PfModelRuntimeException(final Response.Status statusCode, final String message) {
  50         this(statusCode, message, null);
  51     }
  52
  53     /**
  54      * Instantiates a new model runtime exception.
  55      *
  56      * @param statusCode the return code for the exception
  57      * @param message the message on the exception
  58      * @param object the object that the exception was thrown on
  59      */
  60     public PfModelRuntimeException(final Response.Status statusCode, final String message, final Object object) {
  61         super(message);
  62         this.object = object;
  63         this.statusCode = statusCode;
  64     }
  65
  66     /**
  67      * Instantiates a new model runtime exception.
  68      *
  69      * @param statusCode the return code for the exception
  70      * @param message the message on the exception
  71      * @param exception the exception that caused this model exception
  72      */
  73     public PfModelRuntimeException(final Response.Status statusCode, final String message, final Exception exception) {
  74         this(statusCode, message, exception, null);
  75     }
  76
  77     /**
  78      * Instantiates a new model runtime exception.
  79      *
  80      * @param statusCode the return code for the exception
  81      * @param message the message on the exception
  82      * @param exception the exception that caused this model exception
  83      * @param object the object that the exception was thrown on
  84      */
  85     public PfModelRuntimeException(final Response.Status statusCode, final String message, final Exception exception,
  86             final Object object) {
  87         super(message, exception);
  88         this.object = object;
  89         this.statusCode = statusCode;
  90     }
  91
  92     /**
  93      * Get the message from this exception and its causes.
  94      *
  95      * @return the message of this exception and all the exceptions that caused this exception
  96      */
  97     public String getCascadedMessage() {
  98         return PfModelException.buildCascadedMessage(this);
  99     }
 100 }