dblib/common/src/main/java/org/apache/tomcat/jdbc/pool/mbeans-descriptors.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3   ============LICENSE_START=======================================================
   4   openecomp
   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
  11
  12        http://www.apache.org/licenses/LICENSE-2.0
  13
  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=========================================================
  20   -->
  21
  22 <!--
  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
  29
  30       http://www.apache.org/licenses/LICENSE-2.0
  31
  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.
  37 -->
  38 <mbeans-descriptors>
  39
  40     <mbean        name="TomcatJDBCPool"
  41            description="Provides per diagnostic metrics and notifications for JDBC operations"
  42                 domain="tomcat"
  43                  group="jdbc"
  44                   type="org.apache.tomcat.jdbc.pool.DataSource">
  45
  46     <attribute    name="className"
  47            description="Fully qualified class name of the managed object"
  48                   type="java.lang.String"
  49              writeable="false"/>
  50
  51     <attribute    name="size"
  52            description="The number of established connections in the pool, idle and in use"
  53                   type="java.lang.Integer"
  54              writeable="false"/>
  55
  56     <attribute    name="idle"
  57            description="The number of established connections in the pool that are idle"
  58                   type="java.lang.Integer"
  59              writeable="false"/>
  60
  61     <attribute    name="numIdle"
  62            description="Same as the idle attribute"
  63                   type="java.lang.Integer"
  64              writeable="false"/>
  65
  66     <attribute    name="active"
  67            description="The number of established connections in the pool that are in use"
  68                   type="java.lang.Integer"
  69              writeable="false"/>
  70
  71     <attribute    name="numActive"
  72            description="Same as the active attribute"
  73                   type="java.lang.Integer"
  74              writeable="false"/>
  75
  76     <attribute    name="poolSweeperEnabled"
  77            description="Returns true if the pool has a background thread running"
  78                   type="java.lang.Boolean"
  79                     is="true"
  80              writeable="false"/>
  81
  82     <attribute    name="url"
  83            description="The JDBC url for this connection pool"
  84                   type="java.lang.String"
  85              writeable="false"/>
  86
  87     <attribute    name="driverClassName"
  88            description="The JDBC driver class for this connection pool"
  89                   type="java.lang.String"
  90              writeable="false"/>
  91
  92     <attribute    name="defaultAutoCommit"
  93            description="The JDBC auto commit setting for new connections"
  94                   type="java.lang.Boolean"
  95                     is="true"
  96              writeable="false"/>
  97
  98     <attribute    name="defaultReadOnly"
  99            description="The JDBC read only setting for new connections"
 100                   type="java.lang.Boolean"
 101                     is="true"
 102              writeable="false"/>
 103
 104     <attribute    name="defaultTransactionIsolation"
 105            description="The JDBC transaction isolation setting for new connections"
 106                   type="java.lang.Integer"
 107              writeable="false"/>
 108
 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"
 112              writeable="false"/>
 113
 114     <attribute    name="defaultCatalog"
 115            description="The JDBC transaction isolation setting for new connections"
 116                   type="java.lang.String"
 117              writeable="false"/>
 118
 119     <attribute    name="initialSize"
 120            description="The number of connections opened at pool startup"
 121                   type="java.lang.Integer"
 122              writeable="false"/>
 123
 124     <attribute    name="maxActive"
 125            description="The maximum number of open connections"
 126                   type="java.lang.Integer"
 127              writeable="false"/>
 128
 129     <attribute    name="maxIdle"
 130            description="The max number of idle connections"
 131                   type="java.lang.Integer"
 132              writeable="false"/>
 133
 134     <attribute    name="minIdle"
 135            description="The minimum number of open connections"
 136                   type="java.lang.Integer"
 137              writeable="false"/>
 138
 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"
 142              writeable="false"/>
 143
 144     <attribute    name="validationQuery"
 145            description="The query to run during validation"
 146                   type="java.lang.String"
 147              writeable="false"/>
 148
 149     <attribute    name="validationQueryTimeout"
 150            description="The timeout in seconds before a connection validation queries fail"
 151                   type="java.lang.Integer"
 152              writeable="false" />
 153
 154     <attribute    name="testOnBorrow"
 155            description="True if validation happens when a connection is requested"
 156                   type="java.lang.Boolean"
 157                     is="true"
 158              writeable="false"/>
 159
 160     <attribute    name="testOnReturn"
 161            description="True if validation happens when a connection is returned"
 162                   type="java.lang.Boolean"
 163                     is="true"
 164              writeable="false"/>
 165
 166     <attribute    name="testWhileIdle"
 167            description="True if validation happens when a connection is not in use (idle)"
 168                   type="java.lang.Boolean"
 169                     is="true"
 170              writeable="false"/>
 171
 172     <attribute    name="timeBetweenEvictionRunsMillis"
 173            description="Sleep time for background thread in between pool checks"
 174                   type="java.lang.Integer"
 175              writeable="false"/>
 176
 177     <attribute    name="numTestsPerEvictionRun"
 178            description="Not in use"
 179                   type="java.lang.Integer"
 180              writeable="false"/>
 181
 182     <attribute    name="minEvictableIdleTimeMillis"
 183            description="Minimum amount of time a connection stays idle before it is evicted"
 184                   type="java.lang.Integer"
 185              writeable="false"/>
 186
 187     <attribute    name="accessToUnderlyingConnectionAllowed"
 188            description="Returns true if one can retrieve the actual JDBC connection"
 189                   type="java.lang.Boolean"
 190                     is="true"
 191              writeable="false"/>
 192
 193     <attribute    name="removeAbandoned"
 194            description="Returns true if connection in use can be timed out"
 195                   type="java.lang.Boolean"
 196                     is="true"
 197              writeable="false"/>
 198
 199     <attribute    name="removeAbandonedTimeout"
 200            description="Timeout in seconds for connections in use"
 201                   type="java.lang.Integer"
 202              writeable="false"/>
 203
 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"
 207                     is="true"
 208              writeable="false"/>
 209
 210     <attribute    name="loginTimeout"
 211            description="Not in use"
 212                   type="java.lang.Integer"
 213              writeable="false"/>
 214
 215
 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"
 219              writeable="false"/>
 220
 221     <attribute    name="password"
 222            description="For security purposes,this doesn't return anything"
 223                   type="java.lang.String"
 224              writeable="false"/>
 225
 226     <attribute    name="username"
 227            description="The username used to open connections"
 228                   type="java.lang.String"
 229              writeable="false"/>
 230
 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"
 234              writeable="false"/>
 235
 236     <attribute    name="initSQL"
 237            description="A SQL executed once per connection, when it is established"
 238                   type="java.lang.String"
 239              writeable="false"/>
 240
 241     <attribute    name="testOnConnect"
 242            description="Validate connection after connection has been established"
 243                   type="java.lang.Boolean"
 244                     is="true"
 245              writeable="false"/>
 246
 247     <attribute    name="jdbcInterceptors"
 248            description="The interceptors configured for this pool"
 249                   type="java.lang.String"
 250              writeable="false"/>
 251
 252     <attribute    name="jmxEnabled"
 253            description="Register the pool with JMX or not"
 254                   type="java.lang.Boolean"
 255                     is="true"
 256              writeable="false"/>
 257
 258     <attribute    name="fairQueue"
 259            description="a fair queue is being used by the connection pool"
 260                   type="java.lang.Boolean"
 261                     is="true"
 262              writeable="false"/>
 263
 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"
 267              writeable="false"/>
 268
 269     <attribute    name="maxAge"
 270            description="Time in milliseconds to keep this connection alive even when used"
 271                   type="java.lang.Long"
 272              writeable="false"/>
 273
 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"
 277                     is="true"
 278              writeable="false"/>
 279
 280     <attribute    name="useLock"
 281            description="If true, use a lock when operations are performed on the connection object"
 282                   type="java.lang.Boolean"
 283                     is="false"
 284              writeable="false"/>
 285
 286     <attribute    name="suspectTimeout"
 287            description="Timeout in seconds for connection that suspected to have been abandoned"
 288                   type="java.lang.Integer"
 289              writeable="false"/>
 290
 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"
 294                     is="false"
 295              writeable="false"/>
 296
 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"
 300                     is="false"
 301              writeable="false"/>
 302
 303     <attribute    name="alternateUsernameAllowed"
 304            description="If true, getConnection(username,password) is allowed"
 305                   type="java.lang.Boolean"
 306                     is="true"
 307              writeable="false"/>
 308
 309     <attribute    name="dataSource"
 310            description="Data source that is injected into the pool"
 311                   type="javax.sql.DataSource"
 312              writeable="false"/>
 313
 314     <attribute    name="dataSourceJNDI"
 315            description="The JNDI name for a data source to be looked up"
 316                   type="java.lang.String"
 317              writeable="false"/>
 318
 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"
 322                     is="false"
 323              writeable="false"/>
 324
 325     <attribute    name="logValidationErrors"
 326            description="Log errors during the validation phase to the log file"
 327                   type="java.lang.Boolean"
 328                     is="false"
 329              writeable="false"/>
 330
 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"
 334              writeable="false"/>
 335
 336     <attribute    name="waitCount"
 337            description="The number of threads waiting for a connection"
 338                   type="java.lang.Integer"
 339              writeable="false"/>
 340
 341     <attribute    name="propagateInterruptState"
 342            description="If true, propagate the interrupt state for a thread that has been interrupted"
 343                   type="java.lang.Boolean"
 344                     is="false"
 345              writeable="false"/>
 346
 347     <attribute    name="ignoreExceptionOnPreLoad"
 348            description="If true, ignore error of connection creation while initializing the pool"
 349                   type="java.lang.Boolean"
 350                     is="true"
 351              writeable="false"/>
 352
 353     <attribute    name="borrowedCount"
 354            description="The total number of connections borrowed from this pool"
 355                   type="java.lang.Long"
 356              writeable="false"/>
 357
 358     <attribute    name="createdCount"
 359            description="The total number of connections created by this pool"
 360                   type="java.lang.Long"
 361              writeable="false"/>
 362
 363     <attribute    name="returnedCount"
 364            description="The total number of connections returned to this pool"
 365                   type="java.lang.Long"
 366              writeable="false"/>
 367
 368     <attribute    name="releasedCount"
 369            description="The total number of connections released from this pool"
 370                   type="java.lang.Long"
 371              writeable="false"/>
 372
 373     <attribute    name="reconnectedCount"
 374            description="The total number of connections reconnected by this pool."
 375                   type="java.lang.Long"
 376              writeable="false"/>
 377
 378     <attribute    name="removeAbandonedCount"
 379            description="The total number of connections released by remove abandoned."
 380                   type="java.lang.Long"
 381              writeable="false"/>
 382
 383     <attribute    name="releasedIdleCount"
 384            description="The total number of connections released by eviction."
 385                   type="java.lang.Long"
 386              writeable="false"/>
 387
 388     <operation    name="checkIdle"
 389                   description="forces a check of idle connections"
 390                   impact="ACTION"
 391                   returnType="void" />
 392
 393     <operation    name="checkAbandoned"
 394                   description="forces a check of abandoned connections"
 395                   impact="ACTION"
 396                   returnType="void" />
 397
 398     <operation    name="testIdle"
 399                   description="forces a validation of abandoned connections"
 400                   impact="ACTION"
 401                   returnType="void" />
 402
 403     <operation    name="purge"
 404                   description="Purges all connections in the pool"
 405                   impact="ACTION"
 406                   returnType="void" />
 407
 408     <operation    name="purgeOnReturn"
 409                   description="Purges connections when they are returned from the pool"
 410                   impact="ACTION"
 411                   returnType="void" />
 412
 413     <operation    name="resetStats"
 414                   description="reset the statistics of this pool."
 415                   impact="ACTION"
 416                   returnType="void" />
 417
 418   </mbean>
 419
 420 </mbeans-descriptors>