models-base/src/main/java/org/onap/policy/models/base/PfModelExceptionInfo.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 /**
  26  * Interface implemented bu Policy framework model exceptions to allow uniform reading of status codes and cascaded
  27  * messages.
  28  *
  29  * @author Liam Fallon (liam.fallon@est.tech)
  30  */
  31 public interface PfModelExceptionInfo {
  32
  33     /**
  34      * Get the status code associated with an exception.
  35      * @return the status code
  36      */
  37     public Response.Status getStatusCode();
  38
  39     /**
  40      * Get the messages for all the cascaded exceptions in an exception.
  41      *
  42      * @return the cascaded message
  43      */
  44     public String getCascadedMessage();
  45
  46     /**
  47      * Get the object associated with an exception.
  48      *
  49      * @return the object associated with an exception
  50      */
  51     public Object getObject();
  52
  53     /**
  54      * Get the stack trace of the exception as a string.
  55      *
  56      * @return the stack trace of this message as a string
  57      */
  58     public String getStackTraceAsString();
  59 }