aboutsummaryrefslogtreecommitdiffstats
path: root/common/src/main/java/org/onap/policy/clamp/controlloop/common/exception/ControlLoopRuntimeException.java
blob: b110a43629dcd33f23621ae6985bebd44ba77c85 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/*-
 * ============LICENSE_START=======================================================
 * Copyright (C) 2021 Nordix Foundation.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

package org.onap.policy.clamp.controlloop.common.exception;

import javax.ws.rs.core.Response;
import lombok.Getter;
import lombok.ToString;
import org.onap.policy.models.errors.concepts.ErrorResponse;
import org.onap.policy.models.errors.concepts.ErrorResponseInfo;
import org.onap.policy.models.errors.concepts.ErrorResponseUtils;

/**
 * This class is a base control loop run time exception from which all control loop run time exceptions are sub classes.
 */
@Getter
@ToString
public class ControlLoopRuntimeException extends RuntimeException implements ErrorResponseInfo {
    private static final long serialVersionUID = -8507246953751956974L;

    // The error response of the exception
    private final ErrorResponse errorResponse = new ErrorResponse();

    // The object on which the exception was thrown
    private final transient Object object;

    /**
     * Instantiates a new control loop runtime exception.
     *
     * @param statusCode the return code for the exception
     * @param message the message on the exception
     */
    public ControlLoopRuntimeException(final Response.Status statusCode, final String message) {
        this(statusCode, message, null);
    }

    /**
     * Instantiates a new control loop runtime exception.
     *
     * @param statusCode the return code for the exception
     * @param message the message on the exception
     * @param object the object that the exception was thrown on
     */
    public ControlLoopRuntimeException(final Response.Status statusCode, final String message, final Object object) {
        super(message);
        this.object = object;
        errorResponse.setResponseCode(statusCode);
        ErrorResponseUtils.getExceptionMessages(errorResponse, this);
    }

    /**
     * Instantiates a new control loop runtime exception.
     *
     * @param statusCode the return code for the exception
     * @param message the message on the exception
     * @param exception the exception that caused this control loop exception
     */
    public ControlLoopRuntimeException(final Response.Status statusCode, final String message,
            final Exception exception) {
        this(statusCode, message, exception, null);
    }

    /**
     * Instantiates a new model runtime exception from a ControlLoopException instance.
     *
     * @param exception the exception that caused this control loop exception
     */
    public ControlLoopRuntimeException(final ControlLoopException exception) {
        super(exception.getMessage(), exception);
        this.object = exception.getObject();
        errorResponse.setResponseCode(exception.getErrorResponse().getResponseCode());
        ErrorResponseUtils.getExceptionMessages(errorResponse, this);
    }

    /**
     * Instantiates a new control loop runtime exception.
     *
     * @param statusCode the return code for the exception
     * @param message the message on the exception
     * @param exception the exception that caused this control loop exception
     * @param object the object that the exception was thrown on
     */
    public ControlLoopRuntimeException(final Response.Status statusCode, final String message,
            final Exception exception, final Object object) {
        super(message, exception);
        this.object = object;
        errorResponse.setResponseCode(statusCode);
        ErrorResponseUtils.getExceptionMessages(errorResponse, this);
    }
}