|
1 /* |
|
2 * Copyright (c) 2006, 2013, Oracle and/or its affiliates. All rights reserved. |
|
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 * |
|
5 * This code is free software; you can redistribute it and/or modify it |
|
6 * under the terms of the GNU General Public License version 2 only, as |
|
7 * published by the Free Software Foundation. Oracle designates this |
|
8 * particular file as subject to the "Classpath" exception as provided |
|
9 * by Oracle in the LICENSE file that accompanied this code. |
|
10 * |
|
11 * This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 * version 2 for more details (a copy is included in the LICENSE file that |
|
15 * accompanied this code). |
|
16 * |
|
17 * You should have received a copy of the GNU General Public License version |
|
18 * 2 along with this work; if not, write to the Free Software Foundation, |
|
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 * |
|
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 * or visit www.oracle.com if you need additional information or have any |
|
23 * questions. |
|
24 */ |
|
25 |
|
26 package java.sql; |
|
27 |
|
28 /** |
|
29 * The subclass of {@link SQLException} thrown in situations where a |
|
30 * previously failed operation might be able to succeed if the application performs |
|
31 * some recovery steps and retries the entire transaction or in the case of a |
|
32 * distributed transaction, the transaction branch. At a minimum, |
|
33 * the recovery operation must include closing the current connection and getting |
|
34 * a new connection. |
|
35 * |
|
36 * @since 1.6 |
|
37 */ |
|
38 public class SQLRecoverableException extends java.sql.SQLException { |
|
39 |
|
40 /** |
|
41 * Constructs a <code>SQLRecoverableException</code> object. |
|
42 * The <code>reason</code>, <code>SQLState</code> are initialized |
|
43 * to <code>null</code> and the vendor code is initialized to 0. |
|
44 * |
|
45 * The <code>cause</code> is not initialized, and may subsequently be |
|
46 * initialized by a call to the |
|
47 * {@link Throwable#initCause(java.lang.Throwable)} method. |
|
48 * |
|
49 * @since 1.6 |
|
50 */ |
|
51 public SQLRecoverableException() { |
|
52 super(); |
|
53 } |
|
54 |
|
55 /** |
|
56 * Constructs a <code>SQLRecoverableException</code> object |
|
57 * with a given <code>reason</code>. The <code>SQLState</code> |
|
58 * is initialized to <code>null</code> and the vendor code is initialized |
|
59 * to 0. |
|
60 * |
|
61 * The <code>cause</code> is not initialized, and may subsequently be |
|
62 * initialized by a call to the |
|
63 * {@link Throwable#initCause(java.lang.Throwable)} method. |
|
64 * |
|
65 * @param reason a description of the exception |
|
66 * @since 1.6 |
|
67 */ |
|
68 public SQLRecoverableException(String reason) { |
|
69 super(reason); |
|
70 } |
|
71 |
|
72 /** |
|
73 * Constructs a <code>SQLRecoverableException</code> object |
|
74 * with a given <code>reason</code> and <code>SQLState</code>. |
|
75 * |
|
76 * The <code>cause</code> is not initialized, and may subsequently be |
|
77 * initialized by a call to the |
|
78 * {@link Throwable#initCause(java.lang.Throwable)} method. The vendor code |
|
79 * is initialized to 0. |
|
80 * |
|
81 * @param reason a description of the exception |
|
82 * @param SQLState an XOPEN or SQL:2003 code identifying the exception |
|
83 * @since 1.6 |
|
84 */ |
|
85 public SQLRecoverableException(String reason, String SQLState) { |
|
86 super(reason, SQLState); |
|
87 } |
|
88 |
|
89 /** |
|
90 * Constructs a <code>SQLRecoverableException</code> object |
|
91 * with a given <code>reason</code>, <code>SQLState</code> and |
|
92 * <code>vendorCode</code>. |
|
93 * |
|
94 * The <code>cause</code> is not initialized, and may subsequently be |
|
95 * initialized by a call to the |
|
96 * {@link Throwable#initCause(java.lang.Throwable)} method. |
|
97 * |
|
98 * @param reason a description of the exception |
|
99 * @param SQLState an XOPEN or SQL:2003 code identifying the exception |
|
100 * @param vendorCode a database vendor specific exception code |
|
101 * @since 1.6 |
|
102 */ |
|
103 public SQLRecoverableException(String reason, String SQLState, int vendorCode) { |
|
104 super(reason, SQLState, vendorCode); |
|
105 } |
|
106 |
|
107 /** |
|
108 * Constructs a <code>SQLRecoverableException</code> object |
|
109 * with a given <code>cause</code>. |
|
110 * The <code>SQLState</code> is initialized |
|
111 * to <code>null</code> and the vendor code is initialized to 0. |
|
112 * The <code>reason</code> is initialized to <code>null</code> if |
|
113 * <code>cause==null</code> or to <code>cause.toString()</code> if |
|
114 * <code>cause!=null</code>. |
|
115 * |
|
116 * @param cause the underlying reason for this <code>SQLException</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating |
|
117 * the cause is non-existent or unknown. |
|
118 * @since 1.6 |
|
119 */ |
|
120 public SQLRecoverableException(Throwable cause) { |
|
121 super(cause); |
|
122 } |
|
123 |
|
124 /** |
|
125 * Constructs a <code>SQLRecoverableException</code> object |
|
126 * with a given |
|
127 * <code>reason</code> and <code>cause</code>. |
|
128 * The <code>SQLState</code> is initialized to <code>null</code> |
|
129 * and the vendor code is initialized to 0. |
|
130 * |
|
131 * @param reason a description of the exception. |
|
132 * @param cause the underlying reason for this <code>SQLException</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating |
|
133 * the cause is non-existent or unknown. |
|
134 * @since 1.6 |
|
135 */ |
|
136 public SQLRecoverableException(String reason, Throwable cause) { |
|
137 super(reason, cause); |
|
138 } |
|
139 |
|
140 /** |
|
141 * Constructs a <code>SQLRecoverableException</code> object |
|
142 * with a given |
|
143 * <code>reason</code>, <code>SQLState</code> and <code>cause</code>. |
|
144 * The vendor code is initialized to 0. |
|
145 * |
|
146 * @param reason a description of the exception. |
|
147 * @param SQLState an XOPEN or SQL:2003 code identifying the exception |
|
148 * @param cause the underlying reason for this <code>SQLException</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating |
|
149 * the cause is non-existent or unknown. |
|
150 * @since 1.6 |
|
151 */ |
|
152 public SQLRecoverableException(String reason, String SQLState, Throwable cause) { |
|
153 super(reason, SQLState, cause); |
|
154 } |
|
155 |
|
156 /** |
|
157 * Constructs a <code>SQLRecoverableException</code> object |
|
158 * with a given |
|
159 * <code>reason</code>, <code>SQLState</code>, <code>vendorCode</code> |
|
160 * and <code>cause</code>. |
|
161 * |
|
162 * @param reason a description of the exception |
|
163 * @param SQLState an XOPEN or SQL:2003 code identifying the exception |
|
164 * @param vendorCode a database vendor-specific exception code |
|
165 * @param cause the underlying reason for this <code>SQLException</code> (which is saved for later retrieval by the <code>getCause()</code> method); may be null indicating |
|
166 * the cause is non-existent or unknown. |
|
167 * @since 1.6 |
|
168 */ |
|
169 public SQLRecoverableException(String reason, String SQLState, int vendorCode, Throwable cause) { |
|
170 super(reason, SQLState, vendorCode, cause); |
|
171 } |
|
172 |
|
173 private static final long serialVersionUID = -4144386502923131579L; |
|
174 } |