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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
/*
* 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
*
* https://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.tomcat.dbcp.dbcp2;
import java.sql.Connection;
import java.sql.SQLException;
/**
* Defines the attributes and methods that will be exposed via JMX for {@link PoolableConnection} instances.
*
* @since 2.0
*/
public interface PoolableConnectionMXBean {
/**
* Clears the cached state. Call when you know that the underlying connection may have been accessed directly.
*/
void clearCachedState();
/**
* See {@link Connection#clearWarnings()}.
*
* @throws SQLException See {@link Connection#clearWarnings()}.
*/
void clearWarnings() throws SQLException;
/**
* Returns this instance to my containing pool.
*
* @throws SQLException Throw if this instance cannot be returned.
*/
void close() throws SQLException;
/**
* See {@link Connection#getAutoCommit()}.
*
* @return See {@link Connection#getAutoCommit()}.
* @throws SQLException See {@link Connection#getAutoCommit()}.
*/
boolean getAutoCommit() throws SQLException;
/**
* Gets whether to cache properties. The cached properties are:
* <ul>
* <li>auto-commit</li>
* <li>catalog</li>
* <li>schema</li>
* <li>read-only</li>
* </ul>
*
* @return The value for the state caching flag.
*/
boolean getCacheState();
/**
* See {@link Connection#getCatalog()}.
*
* @return See {@link Connection#getCatalog()}.
* @throws SQLException See {@link Connection#getCatalog()}.
*/
String getCatalog() throws SQLException;
/**
* See {@link Connection#getHoldability()}.
*
* @return See {@link Connection#getHoldability()}.
* @throws SQLException See {@link Connection#getHoldability()}.
*/
int getHoldability() throws SQLException;
/**
* See {@link Connection#getSchema()}.
*
* @return See {@link Connection#getSchema()}.
* @throws SQLException See {@link Connection#getSchema()}.
*/
String getSchema() throws SQLException;
/**
* Gets the value of the {@link Object#toString()} method via a bean getter, so it can be read as a property via JMX.
*
* @return the value of the {@link Object#toString()}.
*/
String getToString();
/**
* See {@link Connection#getTransactionIsolation()}.
*
* @return See {@link Connection#getTransactionIsolation()}.
* @throws SQLException See {@link Connection#getTransactionIsolation()}.
*/
int getTransactionIsolation() throws SQLException;
/**
* See {@link Connection#isClosed()}.
*
* @return See {@link Connection#isClosed()}.
* @throws SQLException See {@link Connection#isClosed()}.
*/
boolean isClosed() throws SQLException;
/**
* See {@link Connection#isReadOnly()}.
*
* @return See {@link Connection#isReadOnly()}.
* @throws SQLException See {@link Connection#isReadOnly()}.
*/
boolean isReadOnly() throws SQLException;
/**
* Closes the underlying {@link Connection}.
*
* @throws SQLException Thrown if the connection can be closed.
*/
void reallyClose() throws SQLException;
/**
* See {@link Connection#setAutoCommit(boolean)}.
*
* @param autoCommit See {@link Connection#setAutoCommit(boolean)}.
* @throws SQLException See {@link Connection#setAutoCommit(boolean)}.
*/
void setAutoCommit(boolean autoCommit) throws SQLException;
/**
* Sets whether to cache properties. The cached properties are:
* <ul>
* <li>auto-commit</li>
* <li>catalog</li>
* <li>schema</li>
* <li>read-only</li>
* </ul>
*
* @param cacheState The new value for the state caching flag
*/
void setCacheState(boolean cacheState);
/**
* See {@link Connection#setCatalog(String)}.
*
* @param catalog See {@link Connection#setCatalog(String)}.
* @throws SQLException See {@link Connection#setCatalog(String)}.
*/
void setCatalog(String catalog) throws SQLException;
/**
* See {@link Connection#setHoldability(int)}.
*
* @param holdability {@link Connection#setHoldability(int)}.
* @throws SQLException See {@link Connection#setHoldability(int)}.
*/
void setHoldability(int holdability) throws SQLException;
/**
* See {@link Connection#setReadOnly(boolean)}.
*
* @param readOnly See {@link Connection#setReadOnly(boolean)}.
* @throws SQLException See {@link Connection#setReadOnly(boolean)}.
*/
void setReadOnly(boolean readOnly) throws SQLException;
/**
* See {@link Connection#setSchema(String)}.
*
* @param schema See {@link Connection#setSchema(String)}.
* @throws SQLException See {@link Connection#setSchema(String)}.
*/
void setSchema(String schema) throws SQLException;
/**
* See {@link Connection#setTransactionIsolation(int)}.
*
* @param level See {@link Connection#setTransactionIsolation(int)}.
* @throws SQLException See {@link Connection#setTransactionIsolation(int)}.
*/
void setTransactionIsolation(int level) throws SQLException;
}
|
