summaryrefslogtreecommitdiffstats
path: root/env/src/main/java/org/onap/aaf/inno/env/APIException.java
blob: 016eea7161b88c1910408297678596e4a0895102 (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
/*******************************************************************************
 * ============LICENSE_START====================================================
 * * org.onap.aaf
 * * ===========================================================================
 * * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
 * * ===========================================================================
 * * 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.
 * * ============LICENSE_END====================================================
 * *
 * * ECOMP is a trademark and service mark of AT&T Intellectual Property.
 * *
 ******************************************************************************/
package org.onap.aaf.inno.env;


/**
 * An Exception with the ability to hold a payload.<p>
 * 
 * This is important, because sometimes, the output of a Framework
 * may be a descriptive object which doesn't inherit from Throwable
 * and thus cannot be attached in "initCause".<p>
 * 
 * Examples may be a SOAP Fault.
 * 
 *
 */
public class APIException extends Exception {
	
	private Object payload = null;
	
	/**
	 * @param t
	 */
	public APIException(Throwable t) {
		super(t);
	}
	
	/**
	 * @param string
	 */
	public APIException(String string) {
		super(string);
	}

	/**
	 * @param errorMessage
	 * @param t
	 */
	public APIException(String errorMessage, Throwable t) {
		super(errorMessage,t);
	}

	/**
	 * Return payload, or null if none was set.  Type is up to the calling
	 * System.
	 * 
	 * @return Object
	 */
	public Object getPayload() {
		return payload;
	}

	/**
	 * Set a specific payload into this Exception, which doesn't necessarily
	 * inherit from Throwable.
	 * 
	 * @param payload
	 * @return APIException
	 */
	public APIException setPayload(Object payload) {
		this.payload = payload;
		return this;
	}

	/**
	 * Java expected serial ID
	 */
	private static final long serialVersionUID = 3505343458251445169L;
}