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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
/*
* 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
*
* http://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.pool2.impl;
import java.util.Set;
/**
* Defines the methods that will be made available via JMX.
* <h2>Note</h2>
* <p>
* This interface exists only to define those attributes and methods that will be made available via JMX. It must not be implemented by clients as it is subject
* to change between major, minor and patch version releases of commons pool. Clients that implement this interface may not, therefore, be able to upgrade to a
* new minor or patch release without requiring code changes.
* </p>
*
* @since 2.0
*/
public interface GenericObjectPoolMXBean {
/**
* See {@link GenericObjectPool#getBlockWhenExhausted()}.
*
* @return See {@link GenericObjectPool#getBlockWhenExhausted()}.
*/
boolean getBlockWhenExhausted();
/**
* See {@link GenericObjectPool#getBorrowedCount()}.
*
* @return See {@link GenericObjectPool#getBorrowedCount()}.
*/
long getBorrowedCount();
/**
* See {@link GenericObjectPool#getCreatedCount()}.
*
* @return See {@link GenericObjectPool#getCreatedCount()}.
*/
long getCreatedCount();
/**
* See {@link GenericObjectPool#getCreationStackTrace()}.
*
* @return See {@link GenericObjectPool#getCreationStackTrace()}.
*/
String getCreationStackTrace();
/**
* See {@link GenericObjectPool#getDestroyedByBorrowValidationCount()}.
*
* @return See {@link GenericObjectPool#getDestroyedByBorrowValidationCount()}.
*/
long getDestroyedByBorrowValidationCount();
/**
* See {@link GenericObjectPool#getDestroyedByEvictorCount()}.
*
* @return See {@link GenericObjectPool#getDestroyedByEvictorCount()}.
*/
long getDestroyedByEvictorCount();
/**
* See {@link GenericObjectPool#getDestroyedCount()}.
*
* @return See {@link GenericObjectPool#getDestroyedCount()}.
*/
long getDestroyedCount();
/**
* See {@link GenericObjectPool#getFactoryType()}.
*
* @return See {@link GenericObjectPool#getFactoryType()}.
*/
String getFactoryType();
/**
* See {@link GenericObjectPool#getLifo()}.
*
* @return See {@link GenericObjectPool#getLifo()}.
*/
boolean getFairness();
/**
* See {@link GenericObjectPool#getFairness()}.
*
* @return See {@link GenericObjectPool#getFairness()}.
*/
boolean getLifo();
/**
* See {@link GenericObjectPool#getLogAbandoned()}.
*
* @return See {@link GenericObjectPool#getLogAbandoned()}.
*/
boolean getLogAbandoned();
/**
* See {@link GenericObjectPool#getMaxBorrowWaitTimeMillis()}.
*
* @return See {@link GenericObjectPool#getMaxBorrowWaitTimeMillis()}.
*/
@SuppressWarnings("javadoc")
long getMaxBorrowWaitTimeMillis();
/**
* See {@link GenericObjectPool#getMaxIdle()}.
*
* @return See {@link GenericObjectPool#getMaxIdle()}.
*/
int getMaxIdle();
/**
* See {@link GenericObjectPool#getMaxTotal()}.
*
* @return See {@link GenericObjectPool#getMaxTotal()}.
*/
int getMaxTotal();
/**
* See {@link GenericObjectPool#getMaxWaitDuration()}.
*
* @return See {@link GenericObjectPool#getMaxWaitDuration()}.
*/
long getMaxWaitMillis();
/**
* See {@link GenericObjectPool#getMeanActiveTimeMillis()}.
*
* @return See {@link GenericObjectPool#getMeanActiveTimeMillis()}.
*/
@SuppressWarnings("javadoc")
long getMeanActiveTimeMillis();
/**
* See {@link GenericObjectPool#getMeanBorrowWaitTimeMillis()}.
*
* @return See {@link GenericObjectPool#getMeanBorrowWaitTimeMillis()}.
*/
@SuppressWarnings("javadoc")
long getMeanBorrowWaitTimeMillis();
// Getters for monitoring attributes
/**
* See {@link GenericObjectPool#getMeanIdleTimeMillis()}.
*
* @return See {@link GenericObjectPool#getMeanIdleTimeMillis()}.
*/
@SuppressWarnings("javadoc")
long getMeanIdleTimeMillis();
/**
* See {@link GenericObjectPool#getMinEvictableIdleDuration()}.
*
* @return See {@link GenericObjectPool#getMinEvictableIdleDuration()}.
*/
long getMinEvictableIdleTimeMillis();
/**
* See {@link GenericObjectPool#getMinIdle()}.
*
* @return See {@link GenericObjectPool#getMinIdle()}.
*/
int getMinIdle();
/**
* See {@link GenericObjectPool#getNumActive()}.
*
* @return See {@link GenericObjectPool#getNumActive()}.
*/
int getNumActive();
/**
* See {@link GenericObjectPool#getNumIdle()}.
*
* @return See {@link GenericObjectPool#getNumIdle()}.
*/
int getNumIdle();
/**
* See {@link GenericObjectPool#getNumTestsPerEvictionRun()}.
*
* @return See {@link GenericObjectPool#getNumTestsPerEvictionRun()}.
*/
int getNumTestsPerEvictionRun();
/**
* See {@link GenericObjectPool#getNumWaiters()}.
*
* @return See {@link GenericObjectPool#getNumWaiters()}.
*/
int getNumWaiters();
/**
* See {@link GenericObjectPool#getRemoveAbandonedOnBorrow()}.
*
* @return See {@link GenericObjectPool#getRemoveAbandonedOnBorrow()}.
*/
boolean getRemoveAbandonedOnBorrow();
/**
* See {@link GenericObjectPool#getRemoveAbandonedOnMaintenance()}.
*
* @return See {@link GenericObjectPool#getRemoveAbandonedOnMaintenance()}.
*/
boolean getRemoveAbandonedOnMaintenance();
/**
* See {@link GenericObjectPool#getRemoveAbandonedTimeoutDuration()}.
*
* @return See {@link GenericObjectPool#getRemoveAbandonedTimeoutDuration()}.
*/
int getRemoveAbandonedTimeout();
/**
* See {@link GenericObjectPool#getReturnedCount()}.
*
* @return See {@link GenericObjectPool#getReturnedCount()}.
*/
long getReturnedCount();
/**
* See {@link GenericObjectPool#getTestOnBorrow()}.
*
* @return See {@link GenericObjectPool#getTestOnBorrow()}.
*/
boolean getTestOnBorrow();
// Getters for abandoned object removal configuration
/**
* See {@link GenericObjectPool#getTestOnCreate()}.
*
* @return See {@link GenericObjectPool#getTestOnCreate()}.
* @since 2.2
*/
boolean getTestOnCreate();
/**
* See {@link GenericObjectPool#getTestOnReturn()}.
*
* @return See {@link GenericObjectPool#getTestOnReturn()}.
*/
boolean getTestOnReturn();
/**
* See {@link GenericObjectPool#getTestWhileIdle()}.
*
* @return See {@link GenericObjectPool#getTestWhileIdle()}.
*/
boolean getTestWhileIdle();
/**
* See {@link GenericObjectPool#getDurationBetweenEvictionRuns()}.
*
* @return See {@link GenericObjectPool#getDurationBetweenEvictionRuns()}.
*/
long getTimeBetweenEvictionRunsMillis();
/**
* See {@link GenericObjectPool#isAbandonedConfig()}.
*
* @return See {@link GenericObjectPool#isAbandonedConfig()}.
*/
boolean isAbandonedConfig();
/**
* See {@link GenericObjectPool#isClosed()}.
*
* @return See {@link GenericObjectPool#isClosed()}.
*/
boolean isClosed();
/**
* See {@link GenericObjectPool#listAllObjects()}.
*
* @return See {@link GenericObjectPool#listAllObjects()}.
*/
Set<DefaultPooledObjectInfo> listAllObjects();
}
|
