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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
/*
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*
*/
package org.apache.qpid;
import org.apache.qpid.framing.AMQShortString;
import org.apache.qpid.protocol.AMQConstant;
/**
* AMQException forms the root exception of all exceptions relating to the AMQ protocol. It provides space to associate
* a required AMQ error code with the exception, which is a numeric value, with a meaning defined by the protocol.
*
* <p/><table id="crc"><caption>CRC Card</caption>
* <tr><th> Responsibilities <th> Collaborations
* <tr><td> Represents an exception condition associated with an AMQ protocol status code.
* </table>
*
* @todo This exception class is also used as a generic exception throughout Qpid code. This usage may not be strictly
* correct if this is to signify a protocol exception. Should review.
*/
public class AMQException extends Exception
{
/** Holds the AMQ error code constant associated with this exception. */
private AMQConstant _errorCode;
private boolean _isHardError;
/**
* Creates an exception with an optional error code, optional message and optional underlying cause.
*
* @param errorCode The error code. May be null if not to be set.
* @param msg The exception message. May be null if not to be set.
* @param cause The underlying cause of the exception. May be null if not to be set.
*/
public AMQException(AMQConstant errorCode, String msg, Throwable cause)
{
// isHardError is defaulted to true to avoid unnessacery modification to
// existing code.
this(errorCode,true,msg,cause);
}
/**
* Creates an exception with an optional error code, optional message and optional underlying cause.
*
* @param errorCode The error code. May be null if not to be set.
* @param isHardError Denotes if the underlying error is considered a hard error.
* @param msg The exception message. May be null if not to be set.
* @param cause The underlying cause of the exception. May be null if not to be set.
*/
public AMQException(AMQConstant errorCode, boolean isHardError, String msg, Throwable cause)
{
super(((msg == null) ? "" : msg), cause);
_errorCode = errorCode;
_isHardError = isHardError;
}
/*
* Deprecated constructors brought from M2.1
*/
@Deprecated
public AMQException(String msg)
{
this(null, (msg == null) ? "" : msg);
}
@Deprecated
public AMQException(AMQConstant errorCode, String msg)
{
this(errorCode, (msg == null) ? "" : msg, null);
}
@Deprecated
public AMQException(String msg, Throwable cause)
{
this(null, msg, cause);
}
@Override
public String toString()
{
return getClass().getName() + ": " + getMessage() + (_errorCode == null ? "" : " [error code " + _errorCode + "]");
}
/**
* Gets the AMQ protocol exception code associated with this exception.
*
* @return The AMQ protocol exception code associated with this exception.
*/
public AMQConstant getErrorCode()
{
return _errorCode;
}
public boolean isHardError()
{
return _isHardError;
}
/**
* Rethrown this exception as a new exception.
*
* Attempt to create a new exception of the same class if they have the default constructor of:
* {AMQConstant.class, String.class, Throwable.class}
* <p>
* Individual subclasses may override as requried to create a new instance.
*/
public AMQException cloneForCurrentThread()
{
Class amqeClass = this.getClass();
Class<?>[] paramClasses = {AMQConstant.class, String.class, Throwable.class};
Object[] params = {getErrorCode(), getMessage(), this};
AMQException newAMQE;
try
{
newAMQE = (AMQException) amqeClass.getConstructor(paramClasses).newInstance(params);
}
catch (Exception creationException)
{
newAMQE = new AMQException(getErrorCode(), getMessage(), this);
}
return newAMQE;
}
}
|
