ConnectionLifecycleInterceptor.java
5.01 KB
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
/*
Copyright (c) 2007, 2014, Oracle and/or its affiliates. All rights reserved.
The MySQL Connector/J is licensed under the terms of the GPLv2
<http://www.gnu.org/licenses/old-licenses/gpl-2.0.html>, like most MySQL Connectors.
There are special exceptions to the terms and conditions of the GPLv2 as it is applied to
this software, see the FOSS License Exception
<http://www.mysql.com/about/legal/licensing/foss-exception.html>.
This program is free software; you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation; version 2
of the License.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this
program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth
Floor, Boston, MA 02110-1301 USA
*/
package com.mysql.jdbc;
import java.sql.SQLException;
import java.sql.Savepoint;
/**
* Implementors of this interface can be installed via the "connectionLifecycleInterceptors" configuration property and receive events and alter behavior of
* "lifecycle" methods on our connection implementation.
*
* The driver will create one instance of a given interceptor per-connection.
*/
public interface ConnectionLifecycleInterceptor extends Extension {
/**
* Called when an application calls Connection.close(), before the driver
* processes its own internal logic for close.
*
* @throws SQLException
*/
public abstract void close() throws SQLException;
/**
* Called when an application calls Connection.commit(), before the
* driver processes its own internal logic for commit().
*
* Interceptors should return "true" if the driver should perform
* its own internal logic for commit(), or "false" if not.
*
* @return "true" if the driver should perform
* its own internal logic for commit(), or "false" if not.
*
* @throws SQLException
* if an error occurs
*/
public abstract boolean commit() throws SQLException;
/**
* Called when an application calls Connection.rollback(), before the
* driver processes its own internal logic for rollback().
*
* Interceptors should return "true" if the driver should perform
* its own internal logic for rollback(), or "false" if not.
*
* @return "true" if the driver should perform
* its own internal logic for rollback(), or "false" if not.
*
* @throws SQLException
* if an error occurs
*/
public abstract boolean rollback() throws SQLException;
/**
* Called when an application calls Connection.rollback(), before the
* driver processes its own internal logic for rollback().
*
* Interceptors should return "true" if the driver should perform
* its own internal logic for rollback(), or "false" if not.
*
* @return "true" if the driver should perform
* its own internal logic for rollback(), or "false" if not.
*
* @throws SQLException
* if an error occurs
*/
public abstract boolean rollback(Savepoint s) throws SQLException;
/**
* Called when an application calls Connection.setAutoCommit(), before the
* driver processes its own internal logic for setAutoCommit().
*
* Interceptors should return "true" if the driver should perform
* its own internal logic for setAutoCommit(), or "false" if not.
*
* @return "true" if the driver should perform
* its own internal logic for setAutoCommit(), or "false" if not.
*
* @throws SQLException
* if an error occurs
*/
public abstract boolean setAutoCommit(boolean flag) throws SQLException;
/**
* Called when an application calls Connection.setCatalog(), before the
* driver processes its own internal logic for setCatalog().
*
* Interceptors should return "true" if the driver should perform
* its own internal logic for setCatalog(), or "false" if not.
*
* @return "true" if the driver should perform
* its own internal logic for setCatalog(), or "false" if not.
*
* @throws SQLException
* if an error occurs
*/
public abstract boolean setCatalog(String catalog) throws SQLException;
/**
* Called when the driver has been told by the server that a transaction
* is now in progress (when one has not been currently in progress).
*/
public abstract boolean transactionBegun() throws SQLException;
/**
* Called when the driver has been told by the server that a transaction
* has completed, and no transaction is currently in progress.
*/
public abstract boolean transactionCompleted() throws SQLException;
}