1 <?xml version="1.0" encoding="UTF-8"?>
3 ============LICENSE_START=======================================================
5 ================================================================================
6 Copyright (C) 2016 - 2017 AT&T
7 ================================================================================
8 Licensed under the Apache License, Version 2.0 (the "License");
9 you may not use this file except in compliance with the License.
10 You may obtain a copy of the License at
12 http://www.apache.org/licenses/LICENSE-2.0
14 Unless required by applicable law or agreed to in writing, software
15 distributed under the License is distributed on an "AS IS" BASIS,
16 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 See the License for the specific language governing permissions and
18 limitations under the License.
19 ============LICENSE_END=========================================================
23 Licensed to the Apache Software Foundation (ASF) under one or more
24 contributor license agreements. See the NOTICE file distributed with
25 this work for additional information regarding copyright ownership.
26 The ASF licenses this file to You under the Apache License, Version 2.0
27 (the "License"); you may not use this file except in compliance with
28 the License. You may obtain a copy of the License at
30 http://www.apache.org/licenses/LICENSE-2.0
32 Unless required by applicable law or agreed to in writing, software
33 distributed under the License is distributed on an "AS IS" BASIS,
34 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
35 See the License for the specific language governing permissions and
36 limitations under the License.
40 <mbean name="TomcatJDBCPool"
41 description="Provides per diagnostic metrics and notifications for JDBC operations"
44 type="org.apache.tomcat.jdbc.pool.DataSource">
46 <attribute name="className"
47 description="Fully qualified class name of the managed object"
48 type="java.lang.String"
51 <attribute name="size"
52 description="The number of established connections in the pool, idle and in use"
53 type="java.lang.Integer"
56 <attribute name="idle"
57 description="The number of established connections in the pool that are idle"
58 type="java.lang.Integer"
61 <attribute name="numIdle"
62 description="Same as the idle attribute"
63 type="java.lang.Integer"
66 <attribute name="active"
67 description="The number of established connections in the pool that are in use"
68 type="java.lang.Integer"
71 <attribute name="numActive"
72 description="Same as the active attribute"
73 type="java.lang.Integer"
76 <attribute name="poolSweeperEnabled"
77 description="Returns true if the pool has a background thread running"
78 type="java.lang.Boolean"
83 description="The JDBC url for this connection pool"
84 type="java.lang.String"
87 <attribute name="driverClassName"
88 description="The JDBC driver class for this connection pool"
89 type="java.lang.String"
92 <attribute name="defaultAutoCommit"
93 description="The JDBC auto commit setting for new connections"
94 type="java.lang.Boolean"
98 <attribute name="defaultReadOnly"
99 description="The JDBC read only setting for new connections"
100 type="java.lang.Boolean"
104 <attribute name="defaultTransactionIsolation"
105 description="The JDBC transaction isolation setting for new connections"
106 type="java.lang.Integer"
109 <attribute name="connectionProperties"
110 description="The connection properties that will be set for new connections. Format of the string will be [propertyName=property;]*"
111 type="java.lang.String"
114 <attribute name="defaultCatalog"
115 description="The JDBC transaction isolation setting for new connections"
116 type="java.lang.String"
119 <attribute name="initialSize"
120 description="The number of connections opened at pool startup"
121 type="java.lang.Integer"
124 <attribute name="maxActive"
125 description="The maximum number of open connections"
126 type="java.lang.Integer"
129 <attribute name="maxIdle"
130 description="The max number of idle connections"
131 type="java.lang.Integer"
134 <attribute name="minIdle"
135 description="The minimum number of open connections"
136 type="java.lang.Integer"
139 <attribute name="maxWait"
140 description="The time to wait in milliseconds before a SQLException is thrown when a connection is requested"
141 type="java.lang.Integer"
144 <attribute name="validationQuery"
145 description="The query to run during validation"
146 type="java.lang.String"
149 <attribute name="validationQueryTimeout"
150 description="The timeout in seconds before a connection validation queries fail"
151 type="java.lang.Integer"
154 <attribute name="testOnBorrow"
155 description="True if validation happens when a connection is requested"
156 type="java.lang.Boolean"
160 <attribute name="testOnReturn"
161 description="True if validation happens when a connection is returned"
162 type="java.lang.Boolean"
166 <attribute name="testWhileIdle"
167 description="True if validation happens when a connection is not in use (idle)"
168 type="java.lang.Boolean"
172 <attribute name="timeBetweenEvictionRunsMillis"
173 description="Sleep time for background thread in between pool checks"
174 type="java.lang.Integer"
177 <attribute name="numTestsPerEvictionRun"
178 description="Not in use"
179 type="java.lang.Integer"
182 <attribute name="minEvictableIdleTimeMillis"
183 description="Minimum amount of time a connection stays idle before it is evicted"
184 type="java.lang.Integer"
187 <attribute name="accessToUnderlyingConnectionAllowed"
188 description="Returns true if one can retrieve the actual JDBC connection"
189 type="java.lang.Boolean"
193 <attribute name="removeAbandoned"
194 description="Returns true if connection in use can be timed out"
195 type="java.lang.Boolean"
199 <attribute name="removeAbandonedTimeout"
200 description="Timeout in seconds for connections in use"
201 type="java.lang.Integer"
204 <attribute name="logAbandoned"
205 description="If true, stack trace will be recorded and printed out for timed out connection"
206 type="java.lang.Boolean"
210 <attribute name="loginTimeout"
211 description="Not in use"
212 type="java.lang.Integer"
216 <attribute name="name"
217 description="The name of the connection pool, will be used in the ObjectName of the actual pool"
218 type="java.lang.String"
221 <attribute name="password"
222 description="For security purposes,this doesn't return anything"
223 type="java.lang.String"
226 <attribute name="username"
227 description="The username used to open connections"
228 type="java.lang.String"
231 <attribute name="validationInterval"
232 description="If larger than zero than validation will only occur after the interval milliseconds has passed"
233 type="java.lang.Long"
236 <attribute name="initSQL"
237 description="A SQL executed once per connection, when it is established"
238 type="java.lang.String"
241 <attribute name="testOnConnect"
242 description="Validate connection after connection has been established"
243 type="java.lang.Boolean"
247 <attribute name="jdbcInterceptors"
248 description="The interceptors configured for this pool"
249 type="java.lang.String"
252 <attribute name="jmxEnabled"
253 description="Register the pool with JMX or not"
254 type="java.lang.Boolean"
258 <attribute name="fairQueue"
259 description="a fair queue is being used by the connection pool"
260 type="java.lang.Boolean"
264 <attribute name="abandonWhenPercentageFull"
265 description="Connections that have been abandoned isn't closed unless connections in use are above this percentage"
266 type="java.lang.Integer"
269 <attribute name="maxAge"
270 description="Time in milliseconds to keep this connection alive even when used"
271 type="java.lang.Long"
274 <attribute name="useEquals"
275 description="Set to true if you wish the ProxyConnection class to use String.equals and set to false when you wish to use == when comparing method names"
276 type="java.lang.Boolean"
280 <attribute name="useLock"
281 description="If true, use a lock when operations are performed on the connection object"
282 type="java.lang.Boolean"
286 <attribute name="suspectTimeout"
287 description="Timeout in seconds for connection that suspected to have been abandoned"
288 type="java.lang.Integer"
291 <attribute name="rollbackOnReturn"
292 description="If autoCommit==false then the pool can terminate the transaction by calling rollback on the connection as it is returned to the pool"
293 type="java.lang.Boolean"
297 <attribute name="commitOnReturn"
298 description="If autoCommit==false then the pool can complete the transaction by calling commit on the connection as it is returned to the pool"
299 type="java.lang.Boolean"
303 <attribute name="alternateUsernameAllowed"
304 description="If true, getConnection(username,password) is allowed"
305 type="java.lang.Boolean"
309 <attribute name="dataSource"
310 description="Data source that is injected into the pool"
311 type="javax.sql.DataSource"
314 <attribute name="dataSourceJNDI"
315 description="The JNDI name for a data source to be looked up"
316 type="java.lang.String"
319 <attribute name="useDisposableConnectionFacade"
320 description="If true, connection pool is configured to use a connection facade to prevent re-use of connection after close() has been invoked"
321 type="java.lang.Boolean"
325 <attribute name="logValidationErrors"
326 description="Log errors during the validation phase to the log file"
327 type="java.lang.Boolean"
331 <attribute name="validatorClassName"
332 description="The name of validator class which implements org.apache.tomcat.jdbc.pool.Validator interface"
333 type="java.lang.String"
336 <attribute name="waitCount"
337 description="The number of threads waiting for a connection"
338 type="java.lang.Integer"
341 <attribute name="propagateInterruptState"
342 description="If true, propagate the interrupt state for a thread that has been interrupted"
343 type="java.lang.Boolean"
347 <attribute name="ignoreExceptionOnPreLoad"
348 description="If true, ignore error of connection creation while initializing the pool"
349 type="java.lang.Boolean"
353 <attribute name="borrowedCount"
354 description="The total number of connections borrowed from this pool"
355 type="java.lang.Long"
358 <attribute name="createdCount"
359 description="The total number of connections created by this pool"
360 type="java.lang.Long"
363 <attribute name="returnedCount"
364 description="The total number of connections returned to this pool"
365 type="java.lang.Long"
368 <attribute name="releasedCount"
369 description="The total number of connections released from this pool"
370 type="java.lang.Long"
373 <attribute name="reconnectedCount"
374 description="The total number of connections reconnected by this pool."
375 type="java.lang.Long"
378 <attribute name="removeAbandonedCount"
379 description="The total number of connections released by remove abandoned."
380 type="java.lang.Long"
383 <attribute name="releasedIdleCount"
384 description="The total number of connections released by eviction."
385 type="java.lang.Long"
388 <operation name="checkIdle"
389 description="forces a check of idle connections"
393 <operation name="checkAbandoned"
394 description="forces a check of abandoned connections"
398 <operation name="testIdle"
399 description="forces a validation of abandoned connections"
403 <operation name="purge"
404 description="Purges all connections in the pool"
408 <operation name="purgeOnReturn"
409 description="Purges connections when they are returned from the pool"
413 <operation name="resetStats"
414 description="reset the statistics of this pool."
420 </mbeans-descriptors>